change(doc): Refactor `README.md` (#5443)
* Add #4649 to `README.md` * Increase disk usage in `README.md` * Remove a note on validation * Cosmetics * Make disk size bigger Co-authored-by: teor <teor@riseup.net> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
This commit is contained in:
parent
b17e647f18
commit
e8138becef
13
README.md
13
README.md
|
@ -1,6 +1,7 @@
|
||||||

|

|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
[](https://github.com/ZcashFoundation/zebra/actions/workflows/continous-integration-docker.yml) [](https://github.com/ZcashFoundation/zebra/actions/workflows/continous-integration-os.yml) [](https://github.com/ZcashFoundation/zebra/actions/workflows/continous-delivery.yml) [](https://github.com/ZcashFoundation/zebra/actions/workflows/coverage.yml) [](https://codecov.io/gh/ZcashFoundation/zebra) [](https://github.com/ZcashFoundation/zebra/actions/workflows/docs.yml) [](https://github.com/ZcashFoundation/zebra/actions/workflows/zcash-lightwalletd.yml) [](https://github.com/ZcashFoundation/zebra/actions/workflows/zcash-params.yml)
|
[](https://github.com/ZcashFoundation/zebra/actions/workflows/continous-integration-docker.yml) [](https://github.com/ZcashFoundation/zebra/actions/workflows/continous-integration-os.yml) [](https://github.com/ZcashFoundation/zebra/actions/workflows/continous-delivery.yml) [](https://github.com/ZcashFoundation/zebra/actions/workflows/coverage.yml) [](https://codecov.io/gh/ZcashFoundation/zebra) [](https://github.com/ZcashFoundation/zebra/actions/workflows/docs.yml) [](https://github.com/ZcashFoundation/zebra/actions/workflows/zcash-lightwalletd.yml) [](https://github.com/ZcashFoundation/zebra/actions/workflows/zcash-params.yml)
|
||||||
|
|
||||||

|

|
||||||
|
@ -65,9 +66,6 @@ and Zebra implements all the features required to reach Zcash network consensus.
|
||||||
Zebra also supports the [`lightwalletd` backend JSON-RPCs](https://github.com/ZcashFoundation/zebra#configuring-json-rpc-for-lightwalletd).
|
Zebra also supports the [`lightwalletd` backend JSON-RPCs](https://github.com/ZcashFoundation/zebra#configuring-json-rpc-for-lightwalletd).
|
||||||
|
|
||||||
Currently, Zebra validates all of the Zcash consensus rules for the NU5 network upgrade.
|
Currently, Zebra validates all of the Zcash consensus rules for the NU5 network upgrade.
|
||||||
But it may not validate any:
|
|
||||||
- Undocumented rules derived from Bitcoin
|
|
||||||
- Undocumented network protocol requirements
|
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
|
@ -208,7 +206,7 @@ See our [roadmap](#future-work) for details.
|
||||||
|
|
||||||
### Disk Usage
|
### Disk Usage
|
||||||
|
|
||||||
Zebra uses around 100 GB of space for cached mainnet data, and 10 GB of space for cached testnet data.
|
Zebra uses around 200 GB of space for cached mainnet data, and 10 GB of space for cached testnet data.
|
||||||
We expect disk usage to grow over time, so we recommend reserving at least 300 GB for mainnet nodes.
|
We expect disk usage to grow over time, so we recommend reserving at least 300 GB for mainnet nodes.
|
||||||
|
|
||||||
Zebra's database cleans up outdated data periodically, and when Zebra is shut down and restarted.
|
Zebra's database cleans up outdated data periodically, and when Zebra is shut down and restarted.
|
||||||
|
@ -226,6 +224,13 @@ So Zebra's state should always be valid, unless your OS or disk hardware is corr
|
||||||
|
|
||||||
There are a few bugs in Zebra that we're still working on fixing:
|
There are a few bugs in Zebra that we're still working on fixing:
|
||||||
|
|
||||||
|
- Zebra falsely estimates that it's close to the tip when the network connection goes down [#4649](https://github.com/ZcashFoundation/zebra/issues/4649)
|
||||||
|
|
||||||
|
- One of the consequences of this issue is that Zebra might add unwanted load
|
||||||
|
to other peers when the connection goes back up. This load will last only
|
||||||
|
for a short period of time because Zebra will quickly find out that it's
|
||||||
|
still not close to the tip.
|
||||||
|
|
||||||
- Zebra requires Rust 1.63, due to [a compiler performance regression in Rust 1.64](https://github.com/ZcashFoundation/zebra/issues/5091)
|
- Zebra requires Rust 1.63, due to [a compiler performance regression in Rust 1.64](https://github.com/ZcashFoundation/zebra/issues/5091)
|
||||||
- If Zebra fails downloading the Zcash parameters, use [the Zcash parameters download script](https://github.com/zcash/zcash/blob/master/zcutil/fetch-params.sh) instead. This script might be needed on macOS, even with Rust 1.63.
|
- If Zebra fails downloading the Zcash parameters, use [the Zcash parameters download script](https://github.com/zcash/zcash/blob/master/zcutil/fetch-params.sh) instead. This script might be needed on macOS, even with Rust 1.63.
|
||||||
- No Windows support [#3801](https://github.com/ZcashFoundation/zebra/issues/3801)
|
- No Windows support [#3801](https://github.com/ZcashFoundation/zebra/issues/3801)
|
||||||
|
|
Loading…
Reference in New Issue