Update README.md

This commit is contained in:
fekt
2024-04-10 20:38:00 -04:00
parent 704f6611dc
commit 030d5d58b6

View File

@@ -1,18 +1,18 @@
# SilentDragonLite
# SilentDragonXLite
SilentDragonLite is a lightwallet for HUSH ($HUSH) runs on Linux and Windows which does not require you to download the full blockchain. This is experimental software under active development!
SilentDragonXLite is a lightwallet for DRAGONX ($DRAGONX) runs on Linux and Windows which does not require you to download the full blockchain. This is experimental software under active development!
<img src="res/images/silentdragonlite.png" width="750">
## PRIVACY NOTICE
SilentDragonLite contacts a few different external websites to get various bits of data.
SilentDragonXLite contacts a few different external websites to get various bits of data.
The first two are option features, to get real-time price data feeds and if you want
to look at explorer details. Price feed can be turned off in Settings and you can set
a custom block explorer URL as well.
* coingecko.com for price data API (optional)
* explorer.hush.is for explorer links (optional)
* explorer.dragonx.is for explorer links (optional)
* various community-run lite wallet servers to provide basic functionality (required)
This means your IP address is known to these servers. Enable Tor setting in your wallet to prevent this, or better yet, use TAILS: https://tails.boum.org/
@@ -21,10 +21,10 @@ or https://qubes-os.org
## Installation
Choose to install a binary release or compile it yourself.
For Arch Linux users, we have a silentdragonlite package on [AUR](https://aur.archlinux.org/).
For Arch Linux users, we have a silentdragonxlite package on [AUR](https://aur.archlinux.org/).
### Option 1: Binary Release
Go to the [releases page](https://git.hush.is/hush/SilentDragonLite/releases) and grab the latest binary.
Go to the [releases page](https://git.hush.is/dragonx/SilentDragonXLite/releases) and grab the latest binary.
### Option 2: Compile Release Yourself
@@ -63,14 +63,14 @@ sudo apt-get -y install build-essential qt5-default qt5-qmake qtcreator qttools5
Compiling can take some time, so be patient and wait for it to finish. It will take potentially a long time for slower systems. Be Patient and please report compiler problems!
```shell script
git clone https://git.hush.is/hush/SilentDragonLite
cd SilentDragonLite
git clone https://git.hush.is/hush/SilentDragonXLite
cd SilentDragonXLite
./build.sh linguist
# This defaults to using 2 cores to compile
./build.sh
# To use a custom number of cores to compile, such as 8 :
# ./build.sh -j8
./SilentDragonLite
./SilentDragonXLite
```
### Other notes
@@ -89,27 +89,25 @@ NOTE: Tor server is currently under maintenance.
* Open the folder of SDL in a Terminal -> Enter: TORSOCKS_LOG_LEVEL=1 torsocks -i ./SilentDragonLite
```
### 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, which are now enforced via consensus rules
* Sapling funds need at least 2 confirmations before they can be spent (150 seconds on average for HUSH mainnet)
* Sapling funds need at least 2 confirmations before they can be spent (60 seconds on average for DRAGONX mainnet)
* Can select funds from multiple shielded addresses in the same transaction (via raw transactions)
* 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)
## Where is my wallet stored?
Linux: `~/.silentdragonlite`
Linux: `~/.silentdragonxlite`
Windows 10: `C:\Users\%user\AppData\Roaming\silentdragonlite`
Windows 10: `C:\Users\%user\AppData\Roaming\silentdragonxlite`
Mac: `~/Library/Application Support/silentdragonlite`
Mac: `~/Library/Application Support/silentdragonxlite`
## Support
For support join us on [Telegram Support](https://hush.is/telegram_support), or our [Main Telegram](https://hush.is/telegram), or toot at our [Mastodon](https://fosstodon.org/@myhushteam), or [file an issue](https://git.hush.is/hush/SilentDragonLite/issues).
You can also subscribe to our channels on [PeerTube](https://videos.hush.is), on [YouTube](https://hush.is/yt), or on [Odyssee/LBRY](https://odysee.com/@MyHushTeam:3).
For support join us on [Telegram](https://dragonx.is/tg) or [file an issue](https://git.hush.is/dragonx/SilentDragonXLite/issues).
## License