WalletCLI - The-GNTL-Project/Documentation GitHub Wiki

Description

WalletCLI is available with almost all coins, and is much more stable than using a GUI Wallet, and is a low footprint on your PC, and it does not even have to be installed, as it's portable.

The paths used in these instructions are examples, so feel free to substitute them.

Some WalletCLI's use slightly different parameters, so we have shown an example from the common ones. If you see errors, just type in --help after the executable to show you the list of parameters.

Where you see PORT, substitute this to the coin's remote node port, which is shown on the Pool's homepage, as the Remote Node, e.g. 16662.

Where you see COIN, substitute this to the coin's Name, e.g. ARQ. There is an exception for the GNTL node, the COIN is just POOL

Installation

Pre-requisites

These are all required before you proceed:

  1. Latest version of the release.
  2. Remote node address and port (if you intend to use one). See Pool's homepage for these details..

Download and Extract

Let's now download and extract the required software:

  1. Exclude a folder from Anti-Virus scans, as mining related software is usually flagged up as malicious. e.g. C:\Data\WalletCLI.
  2. Download the latest release of CLI from the official source (details are available in the Getting Started section of the Pool).
  3. Extract the WalletCLI to a suitable location, e.g. C:\Data\WalletCLI.
  4. You can delete non-essential files, and keep only what is required, as listed below (example of filenames):
    1. COIN-wallet-cli.exe - This is the Wallet CLI (we want to keep this).
    2. COINd.exe - This is the Daemon (only required is you will run your own daemon, and sync the blockchain).

Run the Daemon (optional)

You can run your Daemon, which is the most secure way to use the Wallet CLI with, and it also supports the network, as other peers can also exchange data with your Daemon:

  1. Launch a Command Prompt (Start > type in Command Prompt > select Command Prompt).
    1. Change to the extracted zip location, e.g. cd /d C:\Data\WalletCLI\.
    2. Run the Daemon executable, which will launch and start to download the blockchain, showing you the progress in the Command Prompt:.
      1. COINd.

NOTE: It may take several hours or longer, to fully sync the blockchain, depending on your hardware and internet connection.

To exit the Daemon at any time: exit or simply use CTRL-C.

NOTE: Do not just close the Command Prompt, as this will not save the current progress, to allow you to continue later. The stopping of the daemon must be graceful.

Create your Wallet

Let's create the wallet and perform an initial sync with GNTL's remote node.

Best Practice: You should create the wallet, note down your details, including the seed phrase, delete wallet files, restore wallet from seed, compare wallet address. This tests that you wrote down your seed correctly, and proves a restore works (in case you need to use it in future).

NOTE: The folder structure for the wallet location must exist, as the WalletCLI is unable to create the structure for you, so either create C:\Data\Wallets, or change the wallet folder to another destination:

  1. Launch a Command Prompt (Start > type in Command Prompt > select Command Prompt).
    1. Change to the extracted zip location, e.g. cd /d C:\Data\WalletCLI\.
    2. Create a new wallet by running COIN-wallet-cli.exe --daemon-address COIN.gntl.uk:PORT --trusted-daemon --generate-new-wallet=C:\Data\Wallets\COIN.
      1. Follow the on screen instructions, which will create your wallet
      2. Assign it a blank password for now.
      3. Choose your language.
      4. Note down your Wallet Address.
      5. Note down your Recovery Seed (around 25 words) and in a secure location (as this is used to restore your wallet in the future).
      6. For the daemon is not set up to background mine option, choose No.
      7. The wallet will sync with the remote node, and should be quick, as it's brand new.
      8. Type in bc_height and note down the current height.
      9. Type in exit and press enter, to exit the wallet.
      10. Type in del C:\Data\Wallets\COIN*.* to delete the new wallet, as we will now restore it to test that the seed phrase was notes properly.
      11. Restore the wallet by running COIN-wallet-cli.exe --daemon-address COIN.gntl.uk:PORT --trusted-daemon --generate-new-wallet=C:\Data\Wallets\COIN --restore-deterministic-wallet
      12. Paste your seed phrase in.
      13. Assign a strong password.
      14. Type in the current height you noted down earlier.
      15. The restore is now complete. Confirm that the wallet address matches what you noted down earlier.
      16. Type in exit and press enter, to exit the wallet.
    3. You should now be back at the Command Prompt, which you can now close.

Wallet Launcher

Let's now create a batch file, which you use to launch, sync and use your wallet:

  1. Create the file C:\Data\WalletCLI\COIN-Wallet.cmd using Notepad, with the following content (changing the variables):
@echo off
START "COIN Wallet" C:\Data\WalletCLI\COIN-wallet-cli --trusted-daemon --daemon-address COIN.gntl.uk:PORT --wallet-file=C:\Data\Wallets\COIN
  1. You can now launch directly into your wallet using the batch file. Make sure to exit using the exit command, else the wallet will not properly save.

Wallet Recovery

Let's look at how you can recover/restore your wallet, if it has become corrupted, deleted, or you have just forgotten your password:

  1. Launch a Command Prompt (Start > type in Command Prompt > select Command Prompt).
    1. Change to the extracted zip location, e.g. cd /d C:\Data\WalletCLI\.
    2. Restore your wallet by running COIN-wallet-cli.exe --daemon-address COIN.gntl.uk:PORT --trusted-daemon --generate-new-wallet=C:\Data\Wallets\COINnew --restore-deterministic-wallet.
      1. Follow the on screen instructions, which will restore your wallet from the Seed Phrase (which you would have saved when creating the wallet).
      2. For Specify Electrum seed, type/paste in your Seed Phrase (the 25 or so words).
      3. For Enter seed offset passphrase, you normally leave blank, unless you have one.
      4. Assign it a strong password.
      5. You should now see your the Wallet Address you are restoring, and it should match your Wallet Address.
      6. For Restore from specific blockchain height, only type in the height a few blocks before your 1st transaction, or a date. If in doubt, leave it blank.
      7. For the daemon is not set up to background mine option, choose No.
      8. The wallet will sync with the remote node, it will take a few minutes, depending on various factors, such as Internet traffic, the number of transactions to sync, height specified.
      9. For Enter password (output received), just type in your new password.
      10. Once the sync is complete, you should see your balance.
      11. Type in exit and press enter, to exit the wallet.
    3. You should now be back at the Command Prompt, which you can now close.

Useful Wallet Commands

Here are some useful commands you will need to use your wallet. You can type in help, which shows you all the commands available, with an explanation of each, but we'll look at the common ones:

Open your wallet, either manually, or by using the COIN-Wallet.cmd.

  • address - Displays the wallet's main address.
  • address all - Displays all the wallet's addresses.
  • address new LABEL - Creates a new sub-address labelled LABEL (name it whatever you want).
  • address_book add WALLET_ADDRESS Description - Allows you to save a destination wallet address in your address book.
  • balance - Shows your Balance, where Balance is your total balance, and Unlocked balance is your available balance.
  • bc_height - Displays the blockchain height.
  • password - Used to change your wallet password.
  • help - Displays help on all wallet commands.
  • refresh - Refreshes your wallet, in case the wallet lost an internet connection and stopped syncing.
  • rescan_bc - re-scans the entire blockchain, which is sometimes required if your wallet is missing transactions.
  • seed - Displays the wallet's seed phrase.
  • show_transfers - Shows all transfers in and out.
  • show_transfers in - Shows all transfers that came in.
  • show_transfers out - Shows all transfers that went out.
  • status - Displays the wallet's status:
  • sweep_all - Transfer entire balance. Typical usage is:
    • sweep_all address.
  • sweep_below nn - Transfer amounts below nn amount. This is used to combine multiple small outputs into a few larger ones. Typical usage is:
    • sweep_below nn address.
  • transfer - Used to transfer coins. Typical usage is:
    • transfer address amount.

Troubleshooting

Common Issues

Here you will find some common error codes, and their meanings: