2ac6921d60
* Patch equihash to use the solver branch * Add an internal-miner feature and set up its dependencies * Remove 'Experimental' from mining RPC docs * Fix a nightly clippy::question_mark lint * Move a byte array utility function to zebra-chain * fixup! Add an internal-miner feature and set up its dependencies * Add an equihash::Solution::solve() method with difficulty checks * Check solution is valid before returning it * Add a TODO to check for peers before mining * Move config validation into GetBlockTemplateRpcImpl::new() * fixup! fixup! Add an internal-miner feature and set up its dependencies * Use the same generic constraints for GetBlockTemplateRpcImpl struct and impls * Start adding an internal miner component * Add the miner task to the start command * Add basic miner code * Split out a method to mine one block * Spawn to a blocking thread * Wait until a valid template is available * Handle shutdown * Run mining on low priority threads * Ignore some invalid solutions * Use a difference nonce for each solver thread * Update TODOs * Change the patch into a renamed dependency to simplify crate releases * Clean up instrumentation and TODOs * Make RPC instances cloneable and clean up generics * Make LongPollId Copy so it's easier to use * Add API to restart mining if there's a new block template * Actually restart mining if there's a new block template * Tidy instrumentation * fixup! Move config validation into GetBlockTemplateRpcImpl::new() * fixup! Make RPC instances cloneable and clean up generics * Run the template generator and one miner concurrently * Reduce logging * Fix a bug in getblocktemplate RPC tip change detection * Work around some watch channel change bugs * Rate-limit template changes in the receiver * Run one mining solver per available core * Use updated C code with double-free protection * Update to the latest solver branch * Return and submit all valid solutions * Document what INPUT_LENGTH means * Fix watch channel change detection * Don't return early when a mining task fails * Spawn async miner tasks to avoid cooperative blocking, deadlocks, and improve shutdown responsiveness * Make existing parallelism docs and configs consistent * Add a mining parallelism config * Use the minimum of the configured or available threads for mining * Ignore optional feature fields in tests * Downgrade some frequent logs to debug * Document new zebrad features and tasks * Describe the internal-miner feature in the CHANGELOG * Update dependency to de-duplicate equihash solutions * Use futures::StreamExt instead of TryStreamExt * Fix a panic message typo |
||
|---|---|---|
| .cargo | ||
| .github | ||
| book | ||
| docker | ||
| grafana | ||
| tower-batch-control | ||
| tower-fallback | ||
| zebra-chain | ||
| zebra-consensus | ||
| 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 | ||
| 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, pkg-config, 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). - pkg-config
- libclang is a library that might have different names depending on your
package manager. Typical names are
Dependencies on Arch
sudo pacman -S rust clang pkgconf
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.
Future Work
We will continue to add new features as part of future network upgrades, and in response to community feedback.
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. It also renders
internal documentation for private APIs
on the main branch.
docs.rs renders API documentation
for the external API of the latest releases of our crates.
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.