CLI interface to SDL
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

46 lines
2.7 KiB

5 years ago
## Zecwallet CLI - A command line ZecWallet light client.
5 years ago
`zecwallet-cli` is a command line ZecWallet light client. To use it, download the latest binary from the releases page and run `./zecwallet-cli`
5 years ago
This will launch the interactive prompt. Type `help` to get a list of commands
5 years ago
## Running in non-interactive mode:
You can also run `zecwallet-cli` in non-interactive mode by passing the command you want to run as an argument. For example, `zecwallet-cli addresses` will list all wallet addresses and exit.
Run `zecwallet-cli help` to see a list of all commands.
5 years ago
5 years ago
## Notes:
5 years ago
* The wallet 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](https://github.com/adityapk00/lightwalletd), and then run `./zecwallet-cli --server http://127.0.0.1:9067`. You might also need to pass `--dangerous` if you are using a self-signed TLS certificate.
* The log file is in `~/.zcash/zecwallet-light-wallet.debug.log`. Wallet is stored in `~/.zcash/zecwallet-light-wallet.dat`
5 years ago
### 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:
5 years ago
* Defaults to sending shielded transactions, even if you're sending to a transparent address
5 years ago
* Sapling funds need at least 4 confirmations before they can be spent
5 years ago
* Can select funds from multiple shielded addresses in the same transaction
5 years ago
* 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)
5 years ago
5 years ago
## Compiling from source
#### Pre-requisites
5 years ago
* 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
5 years ago
```
## Options
5 years ago
Here are some CLI arguments you can pass to `zecwallet-cli`. Please run `zecwallet-cli --help` for the full list.
5 years ago
* `--server`: Connect to a custom zecwallet lightwalletd server.
* Example: `./zecwallet-cli --server 127.0.0.1:9067`
5 years ago
* `--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"`
5 years ago
* `--recover`: Attempt to recover the seed phrase from a corrupted wallet