4579722833
* removed derive copy from network, address and ledgerstate * changed is_max_block_time_enforced to accept ref * changed NetworkUpgrade::Current to accept ref * changed NetworkUpgrade::Next to accept ref * changed NetworkUpgrade::IsActivationHeight to accept ref * changed NetworkUpgrade::TargetSpacingForHeight to accept ref * changed NetworkUpgrade::TargetSpacings to accept ref * changed NetworkUpgrade::MinimumDifficultySpacing_forHeight to accept ref * changed NetworkUpgrade::IsTestnetMinDifficultyBlock to accept ref * changed NetworkUpgrade::AveragingWindowTimespanForHeight to accept ref * changed NetworkUpgrade::ActivationHeight to accept ref * changed sapling_activation_height to accept ref * fixed lifetime for target_spacings * fixed sapling_activation_height * changed transaction_to_fake_v5 and fake_v5_transactions_for_network to accept ref to network * changed Input::vec_strategy to accept ref to network * changed functions in zebra-chain/src/primitives/zcash_history.rs to accept ref to network * changed functions in zebra-chain/src/history_tree.rs to accept ref to network * changed functions in zebra-chain/src/history_tree.rs to accept ref to network * changed functions in zebra-chain/src/primitives/address.rs to accept ref to network * changed functions in zebra-chain/src/primitives/viewing_key* to accept ref to network * changed functions in zebra-chain/src/transparent/address.rs to accept ref to network * changed functions in zebra-chain/src/primitives/zcash_primitives.rs to accept ref to network * changed functions in zebra-chain/src/primitives/zcash_note_encryption.rs to accept ref to network * changed functions in zebra-chain/src/primitives/history_tree* to accept ref to network * changed functions in zebra-chain/src/block* to accept ref to network * fixed errors in zebra-chain::parameters::network * fixed errors in zebra-chain::parameters::network * fixed errors in zebra-chain * changed NonEmptyHistoryTree and InnerHistoryTree to hold value instead of ref * changed NonEmptyHistoryTree and InnerHistoryTree to hold value instead of ref * fixed errors in zebra-chain/src/block/arbitrary.rs * finished fixing errors in zebra-chain - all crate tests pass * changed functions in zebra-state::service::finalized_state to accept &Network * changed functions in zebra-state::service::non_finalized_state to accept &Network * zebra-state tests run but fail with overflow error * zebra-state tests all pass * converted zebra-network -- all crate tests pass * applied all requested changes from review * converted zebra-consensus -- all crate tests pass * converted zebra-scan -- all crate tests pass * converted zebra-rpc -- all crate tests pass * converted zebra-grpc -- all crate tests pass * converted zebrad -- all crate tests pass * applied all requested changes from review * fixed all clippy errors * fixed build error in zebrad/src/components/mempool/crawler.rs |
||
|---|---|---|
| .cargo | ||
| .github | ||
| book | ||
| docker | ||
| grafana | ||
| tower-batch-control | ||
| tower-fallback | ||
| zebra-chain | ||
| zebra-consensus | ||
| zebra-grpc | ||
| zebra-network | ||
| zebra-node-services | ||
| zebra-rpc | ||
| zebra-scan | ||
| zebra-script | ||
| zebra-state | ||
| zebra-test | ||
| zebra-utils | ||
| zebrad | ||
| .codespellrc | ||
| .dockerignore | ||
| .firebaserc | ||
| .gitattributes | ||
| .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 | ||
| openapi.yaml | ||
| prometheus.yaml | ||
| release.toml | ||
README.md
Contents
About
Zebra is the Zcash Foundation's independent, consensus-compatible implementation of a Zcash node.
Zebra's network stack is interoperable with zcashd, and Zebra implements all
the features required to reach Zcash network consensus, including the validation
of all the consensus rules for the NU5 network upgrade.
Here are some
benefits of Zebra.
Zebra validates blocks and transactions, but needs extra software to generate them:
- To generate transactions, run Zebra with
lightwalletd. - To generate blocks, use a mining pool or miner with Zebra's mining JSON-RPCs.
Currently Zebra can only send mining rewards to a single fixed address.
To distribute rewards, use mining software that creates its own distribution transactions,
a light wallet or the
zcashdwallet.
Please join us on Discord if you'd like to find out more or get involved!
Getting Started
You can run Zebra using our Docker image or you can build it manually. Please see the System Requirements section in the Zebra book for system requirements.
Docker
This command will run our latest release, and sync it to the tip:
docker run zfnd/zebra:latest
For more information, read our Docker documentation.
Building Zebra
Building Zebra requires Rust, libclang, and a C++ compiler.
Zebra is tested with the latest stable Rust version. Earlier versions are not
supported or tested. Any Zebra release can start depending on new features in the
latest stable Rust.
Every few weeks, we release a new Zebra version.
Below are quick summaries for installing the dependencies on your machine.
General instructions for installing dependencies
-
Install
cargoandrustc. -
Install Zebra's build dependencies:
- libclang is a library that might have different names depending on your
package manager. Typical names are
libclang,libclang-dev,llvm, orllvm-dev. - clang or another C++ compiler:
g++(all platforms) orXcode(macOS). protoc
- libclang is a library that might have different names depending on your
package manager. Typical names are
[!NOTE] Zebra uses the
--experimental_allow_proto3_optionalflag withprotocduring compilation. This flag was introduced in Protocol Buffers v3.12.0 released in May 16, 2020, so make sure you're not using a version ofprotocolder than 3.12.
Dependencies on Arch
sudo pacman -S rust clang protobuf
Note that the package clang includes libclang as well as the C++ compiler.
Once the dependencies are in place, you can build and install Zebra:
cargo install --locked zebrad
You can start Zebra by
zebrad start
See the Installing Zebra and Running Zebra sections in the book for more details.
Optional Configs & Features
Initializing Configuration File
zebrad generate -o ~/.config/zebrad.toml
The above command places the generated zebrad.toml config file in the default preferences directory of Linux. For other OSes default locations see here.
Configuring Progress Bars
Configure tracing.progress_bar in your zebrad.toml to
show key metrics in the terminal using progress bars.
When progress bars are active, Zebra automatically sends logs to a file.
There is a known issue where progress bar estimates become extremely large.
In future releases, the progress_bar = "summary" config will show a few key metrics,
and the "detailed" config will show all available metrics. Please let us know which metrics are
important to you!
Configuring Mining
Zebra can be configured for mining by passing a MINER_ADDRESS and port mapping to Docker.
See the mining support docs for more details.
Custom Build Features
You can also build Zebra with additional Cargo features:
prometheusfor Prometheus metricssentryfor Sentry monitoringelasticsearchfor experimental Elasticsearch supportshielded-scanfor experimental shielded scan support
You can combine multiple features by listing them as parameters of the --features flag:
cargo install --features="<feature1> <feature2> ..." ...
Our full list of experimental and developer features is in the API documentation.
Some debugging and monitoring features are disabled in release builds to increase performance.
Known Issues
There are a few bugs in Zebra that we're still working on fixing:
-
The
getpeerinfoRPC shows current and recent outbound connections, rather than current inbound and outbound connections. -
Progress bar estimates can become extremely large. We're waiting on a fix in the progress bar library.
-
Zebra currently gossips and connects to private IP addresses, we want to disable private IPs but provide a config (#3117) in an upcoming release
-
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 Zebra upgrades to the latest
arti-client. This happened due to a Rust dependency conflict, which could only be resolved byartiupgrading to a version ofx25519-dalekwith the dependency fix.
Documentation
The Zcash Foundation maintains the following resources documenting Zebra:
-
The Zebra Book:
-
The documentation of the public APIs for the latest releases of the individual Zebra crates.
-
The documentation of the internal APIs for the
mainbranch of the whole Zebra monorepo.
User support
For bug reports please open a bug report ticket in the Zebra repository.
Alternatively by chat, Join the Zcash Foundation Discord Server and find the #zebra-support channel.
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.
Some Zebra crates are distributed under the MIT license only, because some of their code was originally from MIT-licensed projects. See each crate's directory for details.