diff --git a/README.md b/README.md index 22a06ea..acbbcd1 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,83 @@ -## WalletShell - GUI wallet for TurtleCoin. +![WalletShell](docs/walletshell.png) +GoldWallet is a GUI wallet for DeroGold. ![WalletShell Screens](https://i.imgur.com/41Ujq0S.gif "WalletShell Screens") ### Features: +This wallet contains the basic functions required to manage your DeroGold assets: -This wallet contains the basic functions required to manage your TurtleCoin assets: - -* Wallet creation: - * Create new wallet. - * Import/recover from private keys OR mnemonic seed. -* Basic wallet operation/transactions: +* Wallet creation + * Create new wallet + * Import from private keys + * Import from mnemonic seed +* Basic wallet operation * Open an existing wallet * Display wallet address & balance - * Display & Backup private keys/seed - * Sending/transferring. Integrated Address or Payment ID are supported. Also provides address lookup from your addressbook. - * Transactions history listing/sorting/searching/detail. - * Incoming transaction notification. + * Display private keys/seed + * Export private keys/seed + * Transactions listing/sorting/searching + * Display transaction detail * Export incoming, outgoing, or all transactions to csv file. - * Rescan wallet from specific block height. - * Perform wallet optimization. - * Utilities: generate payment id and integrated address. -* Address book: - * Add/Edit/Delete address entry. - * Listing/sorting/searching existing entries. + * Incoming Transaction notification + * Send DEGO to single recipient address, allow to set payment id and custom fee. Provides address lookup from addressbook. + * Perform wallet optimization by creating fusion transactions + * Provides utility to generate payment id and integrated address +* Address book + * Add/Edit/Delete address entry (label/name, address and payment id) + * Listing/sorting/searching existing entries * Allow to store same wallet address with different payment id. * Autosave address after sending to new/unknown recipient - * Allow to optionally create password protected address book. -* Misc: +* Misc + * Provides setting to set local or public node address * Option to use system tray (on closing/minimizing wallet) - * Provides list of public nodes, fetch/updated daily from [turtlecoin-nodes-json](https://github.com/turtlecoin/turtlecoin-nodes-json) repo. - * Allow to add custom node address. + * Provides list of public nodes + * Custom node address that is not on the list will be added/remembered for future use * Theme: Dark & Light Mode * [Keyboard shortcuts](docs/shortcut.md) + +### Notes + +GoldWallet relies on `DeroGold-service` to manage wallet container & rpc communication. + +Release installer & packaged archived includes a ready to use `DeroGold-service` binary, which is unmodified copy of DeroGold release archive. + +On first launch, GoldWallet will try to detect location/path of bundled `DeroGold-service` binary, but if it's failed, you can manually set path to the `DeroGold-service` binary on the Settings screen. + +If you don't trust the bundled `DeroGold-service` file, you can compare the checksum (sha256sum) against one from the official release, or simply download and use the binary from official DeroGold release, which is available here: https://github.com/derogold/derogold/releases. Then, make sure to update your `DeroGold-service` path setting. + ### Download & Run WalletShell #### Windows: -1. Download the latest installer here: https://github.com/turtlecoin/turtle-wallet-electron/releases/latest -2. Run the installer (`walletshell--win-setup.exe`) and follow the installation wizard. -3. Launch WalletShell via start menu or desktop shortcut. +1. Download the latest installer here: https://github.com/derogold/GoldWallet/releases +2. Run the installer (`GoldWallet--win-setup.exe`) and follow the installation wizard. +3. Launch GoldWallet via start menu or desktop shortcut. #### GNU/Linux (AppImage): -1. Download latest AppImage bundle here: https://github.com/turtlecoin/turtle-wallet-electron/releases/latest -2. Make it executable, either via GUI file manager or command line, e.g. `chmod +x walletshell--linux.AppImage` -3. Run/execute the file, double click in file manager, or run via shell/command line (See: https://docs.appimage.org/user-guide/run-appimages.html) +1. Download latest AppImage bundle here: https://github.com/derogold/GoldWallet/releases +2. Make it executable, either via GUI file manager or command line, e.g. `chmod +x GoldWallet--linux.AppImage` +3. Run/execute the file, double click in file manager, or run via shell/command line. -#### macOS -1. Download latest archive here: https://github.com/turtlecoin/turtle-wallet-electron/releases/latest -2. Extract downloaded zip archived -3. Run the executable binary (`WalletShell.app/Contents/MacOs/WalletShell`) +See: https://docs.appimage.org/user-guide/run-appimages.html -### Using WalletShell -Please visit our wiki page: [WalletShell User Guide](../../wiki). +#### macOS (TBD/Untested) +1. Download latest archive here: https://github.com/derogold/GoldWallet/releases +2. Extract downloaded tar archived +3. Run the executable binary (`GoldWallet.app/Contents/MacOs/GoldWallet`) ?? -### Building/Packaging WalletShell +### Build You need to have `Node.js` and `npm` installed, go to https://nodejs.org and find out how to get it installed on your platform. Once you have Node+npm installed: ``` -# assuming you're building it on GNU/Linux -# first, download turtle-service binary for each platform -# from TurtleCoin official repo -# https://github.com/turtlecoin/turtlecoin/releases -# extract the turtle-service executable somewhere +# first, download DeroGold-service binary for each platform +# from DeroGold official repo +# https://github.com/derogold/derogold/releases +# extract the DeroGold-service executable somewhere # clone the repo -$ git clone https://github.com/turtlecoin/turtle-wallet-electron -$ cd turtle-wallet-electron +$ git clone https://github.com/derogold/GoldWallet +$ cd GoldWallet # install dependencies $ npm install @@ -79,23 +90,21 @@ $ cp ./src/assets/icon.* ./build/ # build GNU/Linux package $ mkdir -p ./bin/lin -$ cp /path/to/linux-version-of/turtle-service ./bin/lin/ +$ cp /path/to/linux-version-of/DeroGold-service ./bin/lin/ $ npm run dist-lin -# build Windows package (you need to have wine 2.0+ installed) +# build Windows package $ mkdir -p ./bin/win -$ cp /path/to/win-version-of/turtle-service.exe ./bin/win/ +$ cp /path/to/win-version-of/DeroGold-servicee.exe ./bin/win/ $ npm run dist-win # build OSX package $ mkdir -p ./bin/osx -$ cp /path/to/osx-version-of/turtle-service ./bin/osx/ +$ cp /path/to/osx-version-of/DeroGold-service ./bin/osx/ $ npm run dist-mac ``` Resulting packages or installer can be found inside `dist/` directory. -### Porting for another coin +### Porting for other coin Please see [this guide](docs/porting.md) if you want to adapt WalletShell to be use for your own TurtleCoin fork. - -![WalletShell](docs/walletshell.png)