Skip to content

Commit

Permalink
[PLA-1398] Update readme (#4)
Browse files Browse the repository at this point in the history
* Update docs

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

* Create CHANGELOG.md

* Update README.md

* Create CONTRIBUTING.md

* Update README.md

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update README.md

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>

* Update CHANGELOG.md

* Delete CONTRIBUTING.md

* Update README.md

---------

Co-authored-by: Brad Bayliss <919214+Bradez@users.noreply.github.com>
  • Loading branch information
leonardocustodio and Bradez authored Nov 2, 2023
1 parent 2ca821c commit ee8fc38
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 10 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.0] - 2023-11-02

- Initial release
80 changes: 70 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,76 @@
# enjin_wallet_daemon
# Enjin Wallet Daemon UI

A new Flutter project.
[![License: LGPL 3.0](https://img.shields.io/badge/license-LGPL_3.0-purple)](https://opensource.org/license/lgpl-3-0/)
[![GitHub Release](https://img.shields.io/github/release/enjin/wallet-daemon-ui.svg?style=flat)](https://github.com/enjin/wallet-daemon-ui/releases/latest)

## Getting Started
This repository contains a flutter desktop application for macOS / Linux / Windows. It makes it easier to run the [Enjin Wallet Daemon](https://github.com/enjin/wallet-daemon) for people that want to try out [Enjin Platform Cloud](https://platform.canary.enjin.io). For a production environment, we recommend that you run the Enjin Wallet Daemon on [an isolated server](https://docs.enjin.io/enjin-platform/getting-started/wallet-daemon#running-the-daemon-in-isolation).

This project is a starting point for a Flutter application.
## Build from source

A few resources to get you started if this is your first Flutter project:
To build from source you need the following requirements:

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
- [Flutter](https://docs.flutter.dev/get-started/install)

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
You can then clone the repository and run the application through flutter with:

`flutter run <platform>`

## Binaries

Or you can download the [latest binaries](https://github.com/enjin/wallet-daemon-ui/releases/latest) directly, extract and run.

## Security

The Enjin Wallet Daemon UI is just a wrapper around the [Enjin Wallet Daemon](https://github.com/enjin/wallet-daemon). When you first start the application, it will download the latest release of the daemon and ask you for a password.

> [!WARNING]
> We generate an encryption key with the password. This key will be used to encrypt the database that contains your **seed phrase**.
> It is important that you **DO NOT LOSE** this password. There is absolutely no way to recover your information if you lose it.
> Also, make sure you use a safe password and do not share with anyone.
After you start the daemon for the first time, a new random seed phrase will be generated for you. You can find your generated seed under `Configs >> Seed Phrase`.
The seed phrase together with the password `Configs >> Password` is all of the information needed to import your daemon wallet anywhere.

> [!NOTE]
> Just the seed phrase is not enough to import or have access to your daemon wallet.
> You **DO** need both the seed phrase and the wallet password, **not the UI password**, please make sure you save those in a secure place.
> Anyone that may have access to those will have full control over your daemon wallet.
## Enjin Platform Cloud

For your daemon to work with Enjin Platform Cloud you need to set up your Platform API keys into `Configs`. You may set one key for each of the environment: [Enjin Blockchain](https://platform.enjin.io) and [Canary Blockchain (testnet)](https://platform.canary.enjin.io).

The Canary Blockchain is a test network and can be used for making tests without spending real money. **It is strongly recommend that you start with the Canary Blockchain.** You can use the [Canary Faucet](https://faucet.canary.enjin.io/) to get some initial funds and get started.

## Self-hosted Platform

If you are self-hosting an Enjin Platform, you can input its URL and credentials in the `Custom Endpoint` field.

- **Platform Endpoint**: You need to input the `graphql` endpoint of your platform.
- **Authentication Token**: The token that you use to access it. If you are using our [starter repository](https://github.com/enjin/platform) this token (`BASIC_AUTH_TOKEN`) can be found [here](https://github.com/enjin/platform/blob/master/configs/core/.env#L9), it will be auto generated after you first start the platform.
- **Blockchain Node**: That's the RPC url to a node, it needs to be a websocket url and you need to include the port. Example: you can use `wss://rpc.matrix.blockchain.enjin.io:443` for Enjin Blockchain and `wss://rpc.matrix.canary.enjin.io:443` for Canary Blockchain.

## Locking

It is possible to keep running the daemon while the interface is locked. You only need to click in the lock button. This lock screen will also appear everytime you start the application after the first time.

The password used here is what you have input in the onboard. **Remember** if you lose it, you will need to reset the platform UI and you will lose access to your daemon wallet.

## Background service

Since the UI is only a wrapper around the Enjin Wallet Daemon, both applications are run in separate processes. If you close the UI normally through the close button it will stop the service automatically. **BUT** if you force close it through the task manager or if it crashes for any reason, the daemon service may still keep running in the background.

If you want to check if the service is still running you can search for the `wallet` process in the task manager.

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Credits

- [Enjin](https://github.com/enjin)
- [All Contributors](../../contributors)

## License

The LGPL 3.0 License. Please see [License File](LICENSE) for more information.

0 comments on commit ee8fc38

Please sign in to comment.