Qortal/piratewallet-light-cli
3
0
Fork 0
mirror of https://github.com/Qortal/piratewallet-light-cli.git synced 2025-01-30 18:42:15 +00:00
Code Issues Projects Releases Wiki Activity
d2811f0b11
piratewallet-light-cli/README.md
adityapk00 d2811f0b11
Update README.md
2019-10-14 09:59:05 -07:00

2.3 KiB
Raw Blame History

Zecwallet CLI - A command line ZecWallet light client.

zecwallet-cli is a command line ZecWallet light client. To use it, download the latest binary from the releases page and run ./zecwallet-cli

This will launch the interactive prompt. Type help to get a list of commands

Notes:

  • The wallet is currently in beta, and connects to the mainnet by default. To connect to testnet, please pass --server https://lightd-test.zecwallet.co:443
  • If you want to run your own server, please see zecwallet lightwalletd, and then run ./zecwallet-cli --server http://127.0.0.1:9067
  • The log file is in ~/.zcash/zecwallet-light-wallet.debug.log. Wallet is stored in ~/.zcash/zecwallet-light-wallet.dat

Note Management

Zecwallet-CLI does automatic note and utxo management, which means it doesn't allow you to manually select which address to send outgoing transactions from. It follows these principles:

  • Defaults to sending shielded transactions, even if you're sending to a transparent address
  • Sapling funds need at least 4 confirmations before they can be spent
  • Can select funds from multiple shielded addresses in the same transaction
  • Will automatically shield your transparent funds at the first opportunity
    • When sending an outgoing transaction to a shielded address, Zecwallet-CLI can decide to use the transaction to additionally shield your transparent funds (i.e., send your transparent funds to your own shielded address in the same transaction)

Compiling from source

Pre-requisites

  • Rust v1.37 or higher.
    • Run rustup update to get the latest version of Rust if you already have it installed
git clone https://github.com/adityapk00/lightwalletclient.git
cargo build --release
./target/release/zecwallet-cli

Options

CLI arguments you can pass to zecwallet-cli

  • --server: Connect to a custom zecwallet lightwalletd server.
    • Example: ./zecwallet-cli --server 127.0.0.1:9067
  • --seed: Restore a wallet from a seed phrase. Note that this will fail if there is an existing wallet. Delete (or move) any existing wallet to restore from the 24-word seed phrase
    • Example: ./zecwallet-cli --seed "twenty four words seed phrase"
  • --recover: Attempt to recover the seed phrase from a corrupted wallet