Browse Source

rename to zecwallet-cli

pull/5/head
Aditya Kulkarni 5 years ago
parent
commit
761a22733e
  1. 2
      Cargo.toml
  2. 24
      README.md
  3. 6
      src/main.rs

2
Cargo.toml

@ -1,5 +1,5 @@
[package]
name = "zeclite-cli"
name = "zecwallet-cli"
version = "0.1.0"
edition = "2018"

24
README.md

@ -1,24 +1,24 @@
# Zeclite CLI - A command line ZecWallet light client.
# Zecwallet CLI - A command line ZecWallet light client.
`zeclite-cli` is a command line ZecWallet light client. To use it, download the latest binary from the releases page and run `./zeclite-cli`
`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
**zeclite-cli is currently in beta**
**zecwallet-cli is currently in beta**
## 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 [zeclite lightwalletd](https://github.com/adityapk00/lightwalletd), and then run `./zeclite-cli --server http://127.0.0.1:9067`
* The log file is in `~/.zcash/zeclite.debug.log`. Wallet is stored in `~/.zcash/zeclite.wallet.dat`
* 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`
* The log file is in `~/.zcash/zecwallet-light-wallet.debug.log`. Wallet is stored in `~/.zcash/zecwallet-light-wallet.dat`
### Note Management
Zeclite 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:
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, Zeclite 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)
* 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
@ -29,13 +29,13 @@ Zeclite does automatic note and utxo management, which means it doesn't allow yo
```
git clone https://github.com/adityapk00/lightwalletclient.git
cargo build --release
./target/release/zeclite-cli
./target/release/zecwallet-cli
```
## Options
CLI arguments you can pass to `zeclite-cli`
CLI arguments you can pass to `zecwallet-cli`
* `--server`: Connect to a custom zeclite lightwalletd server.
* Example: `./zeclite-cli --server 127.0.0.1:9067`
* `--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: `./zeclite-cli --seed "twenty four words seed phrase"`
* Example: `./zecwallet-cli --seed "twenty four words seed phrase"`

6
src/main.rs

@ -35,8 +35,8 @@ const ANCHOR_OFFSET: u32 = 4;
pub fn main() {
// Get command line arguments
let matches = App::new("ZecLite CLI")
.version("0.1.0")
let matches = App::new("Zecwallet CLI")
.version("0.2.1")
.arg(Arg::with_name("seed")
.short("s")
.long("seed")
@ -94,7 +94,7 @@ pub fn main() {
// Startup
info!(""); // Blank line
info!("Starting ZecLite CLI");
info!("Starting Zecwallet-CLI");
info!("Light Client config {:?}", config);
let lightclient = match LightClient::new(seed, &config, info.block_height) {

Loading…
Cancel
Save