DragonX/silentdragonxlite-cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Search/Replace for dragonx

Browse Source
This commit is contained in:
fekt
2024-04-10 20:06:11 -04:00
parent 2425b2b361
commit 74c901a945
12 changed files with 83 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -1,12 +1,12 @@
# SilentDragonLite CLI
# SilentDragonXLite 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` or compile it yourself as documented below.
`silentdragonxlite-cli` is a command line SilentDragonXLite light client. To use it, download the latest binary from the releases page and run `./silentdragonxlite-cli` or compile it yourself as documented below.
This will launch the interactive prompt. Type `help` to get a list of commands
## Running in non-interactive mode:
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.
You can also run `silentdragonxlite-cli` in non-interactive mode by passing the command you want to run as an argument. For example, `silentdragonxlite-cli addresses` will list all wallet addresses and exit.
Run `silentdragonxlite-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,17 +14,17 @@ Run `silentdragonlite-cli help` to see a list of all commands.
* Also remember that t-addresses don't provide any privacy protection.
## Notes:
* If you want to run your own server, please see [SilentDragonLite-cli lightwalletd](https://git.hush.is/hush/lightwalletd), and then run `./silentdragonlite-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 [SilentDragonXLite-cli lightwalletd](https://git.hush.is/hush/lightwalletd), and then run `./silentdragonxlite-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 `~/.silentdragonlite/silentdragonlite-cli.debug.log`. Wallet is stored in `~/.silentdragonlite/silentdragonlite-cli.dat`
* The log file is in `~/.silentdragonxlite/silentdragonxlite-cli.debug.log`. Wallet is stored in `~/.silentdragonxlite/silentdragonxlite-cli.dat`
### Note Management
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:
silentdragonxlite 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 2 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, 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)
* When sending an outgoing transaction to a shielded address, silentdragonxlite 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
@@ -61,10 +61,10 @@ The above avoids piping the output of curl to bash (bad idea) and avoids using b
Run the following commands to compile on your computer.
```shell script
git clone https://git.hush.is/hush/silentdragonlite-cli
cd silentdragonlite-cli
git clone https://git.hush.is/dragonx/silentdragonxlite-cli
cd silentdragonxlite-cli
cargo build --release
./target/release/silentdragonlite-cli
./target/release/silentdragonxlite-cli
```
#### Or build with make
@@ -77,23 +77,23 @@ make build
```
## Options
Here are some CLI arguments you can pass to `silentdragonlite-cli`. Please run `silentdragonlite-cli --help` for the full list.
Here are some CLI arguments you can pass to `silentdragonxlite-cli`. Please run `silentdragonxlite-cli --help` for the full list.
* `--server`: Connect to a custom SilentDragonLite lightwalletd server.
* Example: `./silentdragonlite-cli --server 127.0.0.1:9067`
* Example: `./silentdragonlite-cli --server lite.hush.is`
* `--server`: Connect to a custom SilentDragonXLite lightwalletd server.
* Example: `./silentdragonxlite-cli --server 127.0.0.1:9067`
* Example: `./silentdragonxlite-cli --server lite.dragonx.is`
* `--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: `./silentdragonlite-cli --seed "twenty four words seed phrase"`
* Example: `./silentdragonxlite-cli --seed "twenty four words seed phrase"`
* `--recover`: Attempt to recover the seed phrase from a corrupted wallet
* `-n, --nosync`: By default, Silentdragonlite-cli will sync the wallet at startup, so use this option to prevent the automatic sync at startup
### Support
For support or other questions, join us on [Telegram](https://hush.is/telegram), or toot at our [Mastodon](https://fosstodon.org/@myhushteam) or join our [Telegram Support](https://hush.is/telegram_support) or [file an issue](https://git.hush.is/hush/silentdragonlite-cli/issues).
For support or other questions, join us on [Telegram](https://dragonx.is/telegram) or [file an issue](https://git.hush.is/dragonx/silentdragonxlite-cli/issues).
## Copyright
Copyright The Hush Developers 2019-2022
Copyright The Hush Developers 2019-2024
## License