zecfoundation
/
lightwalletd
mirror of https://github.com/ZcashFoundation/lightwalletd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #303 from defuse/update-readme-warnings 

Make README warnings more accurate
This commit is contained in:
Taylor Hornby 2020-09-08 09:33:10 -06:00 committed by GitHub
parent 6aa9bdfc40 b9b16ae9c9
commit c7f040c849
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -2,16 +2,17 @@
[![pipeline status](https://gitlab.com/zcash/lightwalletd/badges/master/pipeline.svg)](https://gitlab.com/zcash/lightwalletd/commits/master) [![pipeline status](https://gitlab.com/zcash/lightwalletd/badges/master/pipeline.svg)](https://gitlab.com/zcash/lightwalletd/commits/master)
[![codecov](https://codecov.io/gh/zcash/lightwalletd/branch/master/graph/badge.svg)](https://codecov.io/gh/zcash/lightwalletd) [![codecov](https://codecov.io/gh/zcash/lightwalletd/branch/master/graph/badge.svg)](https://codecov.io/gh/zcash/lightwalletd)
# Disclaimer # Security Disclaimer
This is an alpha build and is currently under active development. Please be advised of the following:
- This code currently is not audited by an external security auditor, use it at your own risk Lightwalletd is under active development, some features are more stable than
- The code **has not been subjected to thorough review** by engineers at the Electric Coin Company others. The code has not been subjected to a thorough review by an external
- We **are actively changing** the codebase and adding features where/when needed auditor, and recent code changes have not yet received security review from
Electric Coin Company's security team.
🔒 Security Warnings Developers should familiarize themselves with the [wallet app threat
model](https://zcash.readthedocs.io/en/latest/rtd_pages/wallet_threat_model.html),
The Lightwalletd Server is experimental and a work in progress. Use it at your own risk. Developers should familiarize themselves with the [wallet app threat model](https://zcash.readthedocs.io/en/latest/rtd_pages/wallet_threat_model.html), since it contains important information about the security and privacy limitations of light wallets that use Lightwalletd. since it contains important information about the security and privacy
limitations of light wallets that use Lightwalletd.
--- ---
@ -21,8 +22,6 @@ The Lightwalletd Server is experimental and a work in progress. Use it at your o
lightwalletd is a backend service that provides a bandwidth-efficient interface to the Zcash blockchain for mobile and other wallets, such as [Zecwallet](https://github.com/adityapk00/zecwallet-lite-lib). lightwalletd is a backend service that provides a bandwidth-efficient interface to the Zcash blockchain for mobile and other wallets, such as [Zecwallet](https://github.com/adityapk00/zecwallet-lite-lib).
Lightwalletd has not yet undergone audits or been subject to rigorous testing. It lacks some affordances necessary for production-level reliability. We do not recommend using it to handle customer funds at this time (April 2020).
To view status of [CI pipeline](https://gitlab.com/zcash/lightwalletd/pipelines) To view status of [CI pipeline](https://gitlab.com/zcash/lightwalletd/pipelines)
To view detailed [Codecov](https://codecov.io/gh/zcash/lightwalletd) report To view detailed [Codecov](https://codecov.io/gh/zcash/lightwalletd) report