1bb8a9c924
* adds ValidateBlock request to state * adds `Request` enum in block verifier skips solution check for BlockProposal requests calls CheckBlockValidity instead of Commit block for BlockProposal requests * uses new Request in references to chain verifier * adds getblocktemplate proposal mode response type * makes getblocktemplate-rpcs feature in zebra-consensus select getblocktemplate-rpcs in zebra-state * Adds PR review revisions * adds info log in CheckBlockProposalValidity * Reverts replacement of match statement * adds `GetBlockTemplate::capabilities` fn * conditions calling checkpoint verifier on !request.is_proposal * updates references to validate_and_commit_non_finalized * adds snapshot test, updates test vectors * adds `should_count_metrics` to NonFinalizedState * Returns an error from chain verifier for block proposal requests below checkpoint height adds feature flags * adds "proposal" to GET_BLOCK_TEMPLATE_CAPABILITIES_FIELD * adds back block::Request to zebra-consensus lib * updates snapshots * Removes unnecessary network arg * skips req in tracing intstrument for read state * Moves out block proposal validation to its own fn * corrects `difficulty_threshold_is_valid` docs adds/fixes some comments, adds TODOs general cleanup from a self-review. * Update zebra-state/src/service.rs * Apply suggestions from code review Co-authored-by: teor <teor@riseup.net> * Update zebra-rpc/src/methods/get_block_template_rpcs.rs Co-authored-by: teor <teor@riseup.net> * check best chain tip * Update zebra-state/src/service.rs Co-authored-by: teor <teor@riseup.net> * Applies cleanup suggestions from code review * updates gbt acceptance test to make a block proposal * fixes json parsing mistake * adds retries * returns reject reason if there are no retries left * moves result deserialization to RPCRequestClient method, adds docs, moves jsonrpc_core to dev-dependencies * moves sleep(EXPECTED_TX_TIME) out of loop * updates/adds info logs in retry loop * Revert "moves sleep(EXPECTED_TX_TIME) out of loop" This reverts commit f7f0926f4050519687a79afc16656c3f345c004b. * adds `allow(dead_code)` * tests with curtime, mintime, & maxtime * Fixes doc comment * Logs error responses from chain_verifier CheckProposal requests * Removes retry loop, adds num_txs log * removes verbose info log * sorts mempool_txs before generating merkle root * Make imports conditional on a feature * Disable new CI tests until bugs are fixed * adds support for getpeerinfo RPC * adds vector test * Always passes address_book to RpcServer * Update zebra-network/src/address_book.rs Co-authored-by: teor <teor@riseup.net> * Renames PeerObserver to AddressBookPeers * adds getpeerinfo acceptance test * Asserts that addresses parse into SocketAddr * adds launches_lightwalletd field to TestType::LaunchWithEmptyState and uses it from the get_peer_info test * renames peer_observer mod * uses SocketAddr as `addr` field type in PeerInfo Co-authored-by: teor <teor@riseup.net> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> |
||
|---|---|---|
| .cargo | ||
| .github | ||
| book | ||
| docker | ||
| grafana | ||
| tower-batch | ||
| tower-fallback | ||
| zebra-chain | ||
| zebra-client | ||
| zebra-consensus | ||
| zebra-network | ||
| zebra-node-services | ||
| zebra-rpc | ||
| zebra-script | ||
| zebra-state | ||
| zebra-test | ||
| zebra-utils | ||
| zebrad | ||
| .codespellrc | ||
| .dockerignore | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| SECURITY.md | ||
| clippy.toml | ||
| codecov.yml | ||
| deny.toml | ||
| firebase.json | ||
| katex-header.html | ||
| prometheus.yaml | ||
README.md
Contents
- Contents
- About
- Release Candidates
- Getting Started
- Known Issues
- Future Work
- Documentation
- Security
- License
About
Zebra is the Zcash Foundation's independent, consensus-compatible implementation of a Zcash node, currently under development. It can be used to join the Zcash peer-to-peer network, which helps keeping Zcash working by validating and broadcasting transactions, and maintaining the Zcash blockchain state in a distributed manner.
Zcash is a cryptocurrency designed to preserve the user's privacy. If you just want to send and receive Zcash then you don't need to use Zebra directly. You can download a Zcash wallet application which will handle that for you.
Please join us on Discord if you'd like to find out more or get involved!
Using Zebra
You would want to run Zebra if you want to contribute to the Zcash network: the more nodes are run, the more reliable the network will be in terms of speed and resistance to denial of service attacks, for example.
Zebra aims to be faster, more secure, and more easily extensible than other Zcash implementations.
Release Candidates
Every few weeks, we release a new Zebra version.
Zebra's network stack is interoperable with zcashd,
and Zebra implements all the features required to reach Zcash network consensus.
Currently, Zebra validates all of the Zcash consensus rules for the NU5 network upgrade.
Zebra validates blocks and transactions, but needs extra software to generate them:
- to generate transactions, configure
zebrad's JSON-RPC port, and use a light wallet withlightwalletdand Zebra. - to generate blocks, compile
zebradwith thegetblocktemplate-rpcsfeature, configure the JSON-RPC port, and use a mining pool or miner with Zebra's mining JSON-RPCs. Mining support is currently incomplete, experimental, and off by default.
Getting Started
You can run Zebra using our Docker image. This command will run our latest release, and sync it to the tip:
docker run zfnd/zebra:1.0.0-rc.3
For more information, read our Docker documentation.
You can also:
Build Instructions
If you want to build zebrad yourself, you'll need Rust, libclang, a C++ compiler, and some other dependencies.
To run zebrad, follow the instructions to compile zebrad
for your platform:
- Install
cargoandrustc.- Zebra is tested with the latest
stableRust version. Earlier versions are not supported or tested. (Zebra's code uses features introduced in Rust 1.65, or any later stable release.)
- Zebra is tested with the latest
- Install Zebra's build dependencies:
- libclang: the
libclang,libclang-dev,llvm, orllvm-devpackages (these packages will have different names depending on your package manager) - clang or another C++ compiler:
g++(all platforms) orXcode(macOS)
- libclang: the
- Run
cargo install --locked --git https://github.com/ZcashFoundation/zebra --tag v1.0.0-rc.3 zebrad - Run
zebrad start(see Running Zebra for more information)
For more detailed instructions, refer to the documentation.
Configuring JSON-RPC for lightwalletd
To use zebrad as a lightwalletd backend, give it this ~/.config/zebrad.toml:
[rpc]
# listen for RPC queries on localhost
listen_addr = '127.0.0.1:8232'
# automatically use multiple CPU threads
parallel_cpu_threads = 0
It is recommended to use adityapk00/lightwalletd because that is used in testing.
If using zcash/lightwalletd:
- note that it will require a zcash.conf file:
rpcuserandrpcpasswordare required bylightwalletd, but Zebra ignores them if it receives them fromlightwalletd- when using a non-default port, use
rpcport=28232andrpcbind=127.0.0.1 - when using testnet, use
testnet=1
WARNING: This config allows multiple Zebra instances to share the same RPC port. See the RPC config documentation for details.
Optional Features
For performance reasons, some debugging and monitoring features are disabled in release builds.
You can enable these features using:
cargo install --features=<name> ...
System Requirements
The recommended requirements for compiling and running zebrad are:
- 4 CPU cores
- 16 GB RAM
- 300 GB available disk space for building binaries and storing cached chain state
- 100 Mbps network connection, with 300 GB of uploads and downloads per month
We continuously test that our builds and tests pass on:
The latest GitHub Runners for:
- macOS
- Ubuntu
Docker:
- Debian Bullseye
Zebra's tests can take over an hour, depending on your machine. We're working on making them faster.
zebrad might build and run fine on smaller and slower systems - we haven't
tested its exact limits yet.
For more detailed requirements, refer to the documentation.
Memory Troubleshooting
If Zebra's build runs out of RAM, try setting:
export CARGO_BUILD_JOBS=2
If Zebra's tests timeout or run out of RAM, try running:
cargo test -- --test-threads=2
(cargo uses all the processor cores on your machine by default.)
macOS Test Troubleshooting
Some of Zebra's tests deliberately cause errors that make Zebra panic. macOS records these panics as crash reports.
If you are seeing "Crash Reporter" dialogs during Zebra tests, you can disable them using this Terminal.app command:
defaults write com.apple.CrashReporter DialogType none
Network Ports and Data Usage
Zebra uses the following inbound and outbound TCP ports:
- 8233 on Mainnet
- 18233 on Testnet
Outbound connections are required to sync, inbound connections are optional. Zebra also needs access to the Zcash DNS seeders, via the OS DNS resolver (usually port 53).
Zebra needs some peers which have a round-trip latency of 2 seconds or less. If this is a problem for you, please open a ticket.
zebrad's typical mainnet network usage is:
- Initial sync: 100 GB download, we expect the initial download to grow to hundreds of gigabytes over time
- Ongoing updates: 10 MB - 10 GB upload and download per day, depending on user-created transaction size and peer requests
Zebra performs an initial sync every time its internal database version changes, so some version upgrades might require a full download of the whole chain.
For more detailed information, refer to the documentation.
Network Troubleshooting
Some of Zebra's tests download Zcash blocks, so they might be unreliable depending on your network connection.
You can set ZEBRA_SKIP_NETWORK_TESTS=1 to skip the network tests.
Zebra may be unreliable on Testnet, and under less-than-perfect network conditions. See our roadmap for details.
Disk Usage
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.
Zebra's database cleans up outdated data periodically, and when Zebra is shut down and restarted.
Disk Troubleshooting
Zebra's state commits changes using RocksDB database transactions.
If you forcibly terminate Zebra, or it panics, any incomplete changes will be rolled back the next time it starts.
So Zebra's state should always be valid, unless your OS or disk hardware is corrupting data.
Known Issues
There are a few bugs in Zebra that we're still working on fixing:
-
If Zebra fails downloading the Zcash parameters, use the Zcash parameters download script instead.
-
Zebra falsely estimates that it's close to the tip when the network connection goes down #4649.
-
Block download and verification sometimes times out during Zebra's initial sync #5709. The full sync still finishes reasonably quickly.
-
No Windows support #3801. We used to test with Windows Server 2019, but not any more; see the issue for details.
-
Experimental Tor support is disabled until
arti-clientupgrades tox25519-dalek2.0.0 or later. This happens due to a Rust dependency conflict, which can only be resolved by upgrading to a version ofx25519-dalekwith the dependency fix. -
Output of
help,--helpflag, and usage of invalid commands or options are inconsistent #5502. See the issue for details.
Future Work
Performance and Reliability:
- Reliable syncing under poor network conditions
- Additional batch verification
- Performance tuning
Currently, the following features are out of scope:
- Optional Zcash network protocol messages
- Consensus rules removed before Canopy activation (Zebra checkpoints on Canopy activation)
Documentation
The Zebra website contains user documentation, such as how to run or configure Zebra, set up metrics integrations, etc., as well as developer documentation, such as design documents. We also render API documentation for the external API of our crates, as well as internal documentation for private APIs.
Security
Zebra has a responsible disclosure policy, which we encourage security researchers to follow.
License
Zebra is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See LICENSE-APACHE and LICENSE-MIT.