zecwallet-lite/README.md

53 lines
2.3 KiB
Markdown
Raw Normal View History

2019-11-12 17:30:26 -08:00
## ZecWallet Lite
Zecwallet-Lite is z-Addr first, Sapling compatible lightwallet client for Zcash. It has full support for all Zcash features:
2019-11-07 10:31:01 -08:00
- Send + Receive fully shielded transactions
2019-11-01 12:29:30 -07:00
- Supports transparent addresses and transactions
- Full support for incoming and outgoing memos
- Fully encrypt your private keys, using viewkeys to sync the blockchain
2019-11-07 10:31:48 -08:00
## Download
Download compiled binaries from our [release page](https://github.com/adityapk00/zecwallet-lite/releases)
2019-11-01 12:26:58 -07:00
## Privacy
* While all the keys and transaction detection happens on the client, the server can learn what blocks contain your shielded transactions.
* The server also learns other metadata about you like your ip address etc...
* Also remember that t-addresses don't provide any privacy protection.
### Note Management
Zecwallet-Lite 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 5 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-Lite 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)
2018-12-07 10:42:43 -08:00
## Compiling from source
2021-03-22 10:39:02 -07:00
Zecwallet Lite is written in Electron/Javascript and can be build from source. It will also automatically compile the Rust SDK needed to run Zecwallet Lite.
2018-12-07 10:42:43 -08:00
2021-03-22 10:39:02 -07:00
#### Pre-Requisites
2020-03-18 15:44:51 -07:00
You need to have the following software installed before you can build Zecwallet Fullnode
2018-12-07 10:42:43 -08:00
2020-03-18 15:45:07 -07:00
* [Nodejs v12.16.1 or higher](https://nodejs.org)
* [Yarn](https://yarnpkg.com)
2020-03-18 15:45:55 -07:00
* [Rust v1.40+](https://www.rust-lang.org/tools/install)
2020-03-18 15:44:51 -07:00
```
2020-03-18 15:45:55 -07:00
git clone https://github.com/adityapk00/zecwallet-lite.git
cd zecwallet-lite
2020-03-18 15:44:51 -07:00
yarn install
yarn build
2018-12-07 10:42:43 -08:00
```
2020-03-18 15:44:51 -07:00
To start in development mode, run
```
yarn dev
2018-12-07 10:42:43 -08:00
```
2020-03-18 15:44:51 -07:00
To start in production mode, run
```
yarn start
```
2019-10-28 12:40:46 -07:00
_PS: Zecwallet-Lite is NOT an official wallet, and is not affiliated with the Electric Coin Company in any way._