port to hush
This commit is contained in:
29
README.md
29
README.md
@@ -1,12 +1,12 @@
|
||||
## SilentDragonLite CLI - A command line SilentDragon light client.
|
||||
## SilentDragonLite CLI - A command line Hush 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`
|
||||
`silentdragonlite-cli` is a command line SilentDragonLite light client. To use it, download the latest binary from the releases page and run `./silentdragonlite-cli`
|
||||
|
||||
This will launch the interactive prompt. Type `help` to get a list of commands
|
||||
|
||||
## 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.
|
||||
You can also run `silentdragonlite-cli` in non-interactive mode by passing the command you want to run as an argument. For example, `silentdragonlite-cli addresses` will list all wallet addresses and exit.
|
||||
Run `silentdragonlite-cli help` to see a list of all commands.
|
||||
|
||||
## Privacy
|
||||
* While all the keys and transaction detection happens on the client, the server can learn what blocks contain your shielded transactions.
|
||||
@@ -14,18 +14,17 @@ Run `zecwallet-cli help` to see a list of all commands.
|
||||
* Also remember that t-addresses don't provide any privacy protection.
|
||||
|
||||
## Notes:
|
||||
* 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.
|
||||
* If you want to run your own server, please see [SilentDragonLite-cli lightwalletd](https://github.com/MyHush/lightwalletd), and then run `./silentdragonlite-cli --server http://127.0.0.1:9069`. 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`
|
||||
* The log file is in `~/.komodo/HUSH3/silentdragonlite-cli.debug.log`. Wallet is stored in `~/.komodo/HUSH3/silentdragonlite-cli.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:
|
||||
silentdragonlite 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)
|
||||
* When sending an outgoing transaction to a shielded address, silentdragonlite 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
|
||||
|
||||
@@ -34,17 +33,17 @@ Zecwallet-CLI does automatic note and utxo management, which means it doesn't al
|
||||
* Run `rustup update` to get the latest version of Rust if you already have it installed
|
||||
|
||||
```
|
||||
git clone https://github.com/adityapk00/zecwallet-light-cli.git
|
||||
git clone https://github.com/MyHush/silentdragonlite-cli.git
|
||||
cargo build --release
|
||||
./target/release/zecwallet-cli
|
||||
./target/release/silentdragonlite-cli
|
||||
```
|
||||
|
||||
## Options
|
||||
Here are some CLI arguments you can pass to `zecwallet-cli`. Please run `zecwallet-cli --help` for the full list.
|
||||
Here are some CLI arguments you can pass to `silentdragonlite-cli`. Please run `silentdragonlite-cli --help` for the full list.
|
||||
|
||||
* `--server`: Connect to a custom zecwallet lightwalletd server.
|
||||
* Example: `./zecwallet-cli --server 127.0.0.1:9067`
|
||||
* `--server`: Connect to a custom SilentDragonLite lightwalletd server.
|
||||
* Example: `./silentdragonlite-cli --server 127.0.0.1:9069`
|
||||
* `--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"`
|
||||
* Example: `./silentdragonlite-cli --seed "twenty four words seed phrase"`
|
||||
* `--recover`: Attempt to recover the seed phrase from a corrupted wallet
|
||||
|
||||
|
||||
Reference in New Issue
Block a user