Skip to content

Instantly share code, notes, and snippets.

@wilmoore
Last active July 29, 2021 19:48
Show Gist options
  • Select an option

  • Save wilmoore/8ecc3b64eeae6ac9b46a4538c5cf77af to your computer and use it in GitHub Desktop.

Select an option

Save wilmoore/8ecc3b64eeae6ac9b46a4538c5cf77af to your computer and use it in GitHub Desktop.
Zcash :: ZECWallet CLI Getting Started Tutorial

Zcash :: ZECWallet CLI Getting Started Tutorial

❯ Made with 💜 by [email protected]


Table of Contents

What we will be learning in this tutorial

NOTE: it is not possible to purchase ZEC via zecwallet-cli.

  • Navigating the command-line through a terminal emulator
  • Installing ZECWallet-Light-CLI via Homebrew
  • Creating a ZEC compatible wallet and corresponding transparent & shielded addresses
  • Creating a Gemini centralized exchange account in order to purchase ZEC
  • Sending ZEC to our local ZEC compatible wallet
  • Backup & restore of wallet file
  • Destroy wallet file & import wallet from seed phrase
  • Send message with a memo to ZECPages via zecwallet-cli

What software must be pre-installed on your computer?

The only software needed to follow this tutorial is homebrew (BREW(1))

  • which brew

What you need to know

  • Understand how to launch and operate a terminal emulator (i.e. Terminal.app, Alacritty.app, iTerm.app)
  • Be familiar with installing packages via homebrew

Install ZECWallet CLI

❯ brew install zecwallet-cli

Version

❯ zecwallet-cli --version
Zecwallet CLI 1.7.2
~

Help

❯ zecwallet-cli --help
Zecwallet CLI 1.7.2

USAGE:
    zecwallet-cli [FLAGS] [OPTIONS] [ARGS]
FLAGS
  • -h, --help: Prints help information
  • -n, --nosync: Prevents automatic sync at startup.
OPTIONS
  • --birthday <birthday>: Specify wallet birthday when restoring from seed. This is the earlist block height where the wallet has a transaction.
  • --password <password>: When recovering seed, specify a password for the encrypted wallet
  • -s, --seed <seed_phrase>: Create a new wallet with the given 24-word seed phrase. Will fail if wallet already exists
  • --server <server>: Lightwalletd server to connect to. [default: https://lwdv3.zecwallet.co]
ARGS
  • <COMMAND>: Command to execute. If a command is not specified, zecwallet-cli will start in interactive mode.
  • <PARAMS>...: Params to execute command with. Run the 'help' command to get usage help.
COMMANDS
❯ zecwallet-cli help
  • new - Create a new address in this wallet
  • encryptmessage - Encrypt a memo to be sent to a z-address offline
  • balance - Show the current ZEC balance in the wallet
  • encrypt - Encrypt the wallet with a password
  • unlock - Unlock wallet encryption for spending
  • clear - Clear the wallet state, rolling back the wallet to an empty state.
  • addresses - List all addresses in the wallet
  • decryptmessage - Attempt to decrypt a message with all the view keys in the wallet.
  • sendprogress - Get the progress of any send transactions that are currently computing
  • defaultfee - Returns the default fee in zats for outgoing transactions
  • lock - Lock a wallet that's been temporarily unlocked
  • shield - Shield your transparent ZEC into a sapling address
  • list - List all transactions in the wallet
  • encryptionstatus - Check if the wallet is encrypted and if it is locked
  • zecprice - Get the latest ZEC price in the wallet's currency (USD)
  • export - Export private key for wallet addresses
  • quit - Quit the lightwallet, saving state to disk
  • decrypt - Completely remove wallet encryption
  • height - Get the latest block height that the wallet is at
  • syncstatus - Get the sync status of the wallet
  • import - Import spending or viewing keys into the wallet
  • info - Get the lightwalletd server's info
  • seed - Display the seed phrase
  • verify - Verify from the latest checkpoint
  • send - Send ZEC to the given address
  • notes - List all sapling notes and utxos in the wallet
  • rescan - Rescan the wallet, downloading and scanning all blocks and transactions
  • sync - Download CompactBlocks and sync to the server
  • save - Save wallet file to disk
  • help - Lists all available commands

Remove ZECWallet CLI Installation

❯ brew uninstall zcash/formulae/zecwallet-light-cli
❯ brew untap zcash/formulae
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment