zebra.zfnd.org
Open in
urlscan Pro
199.36.158.100
Public Scan
Submitted URL: http://zebra.zfnd.org/
Effective URL: https://zebra.zfnd.org/
Submission: On May 11 via api from US — Scanned from DE
Effective URL: https://zebra.zfnd.org/
Submission: On May 11 via api from US — Scanned from DE
Form analysis 1 forms found in the DOM
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>Text Content
1. Zebra
2. 1. User Documentation
3. 1. 1.1. System Requirements
2. 1.2. Supported Platforms
3. 1. 1.2.1. Platform Tier Policy
4. 1.3. Installing Zebra
5. 1.4. Running Zebra
6. 1.5. Zebra with Docker
7. 1.6. Tracing Zebra
8. 1.7. Zebra Metrics
9. 1.8. Lightwalletd
10. 1.9. zk-SNARK Parameters
11. 1.10. Mining
12. 1. 1.10.1. Testnet Mining with s-nomp
2. 1.10.2. Mining with Zebra in Docker
13. 1.11. Shielded Scanning
14. 1. 1.11.1. Shielded Scanning gRPC Server
15. 1.12. Kibana blockchain explorer
16. 1.13. Forking the Zcash Testnet with Zebra
17. 1.14. OpenAPI specification
18. 1.15. Troubleshooting
4. 2. Developer Documentation
5. 1. 2.1. Contribution Guide
2. 2.2. Design Overview
3. 2.3. Diagrams
4. 1. 2.3.1. Network Architecture
5. 2.4. Upgrading the State Database
6. 2.5. Zebra versioning and releases
7. 2.6. Continuous Integration
8. 2.7. Continuous Delivery
9. 2.8. Generating Zebra Checkpoints
10. 2.9. Doing Mass Renames
11. 2.10. Updating the ECC dependencies
12. 2.11. Zebra RFCs
13. 1. 2.11.1. Pipelinable Block Lookup
2. 2.11.2. Parallel Verification
3. 2.11.3. Inventory Tracking
4. 2.11.4. Asynchronous Script Verification
5. 2.11.5. State Updates
6. 2.11.6. Contextual Difficulty Validation
7. 2.11.7. Zebra Client
8. 2.11.8. V5 Transaction
9. 2.11.9. Async Rust in Zebra
10. 2.11.10. Value Pools
6. 3. API Reference
* Light
* Rust
* Coal
* Navy
* Ayu
THE ZEBRA BOOK
--------------------------------------------------------------------------------
CONTENTS
* About
* Getting Started
* Docker
* Building Zebra
* Optional Configs & Features
* Known Issues
* Future Work
* Documentation
* User support
* Security
* License
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 zcashd wallet.
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.
Around every 6 weeks, we release a new Zebra version.
Below are quick summaries for installing the dependencies on your machine.
GENERAL INSTRUCTIONS FOR INSTALLING DEPENDENCIES
1. Install cargo and rustc.
2. 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, or
llvm-dev.
* clang or another C++ compiler: g++ (all platforms) or Xcode (macOS).
* protoc
> [!NOTE] Zebra uses the --experimental_allow_proto3_optional flag with protoc
> during 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 of protoc
> older 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:
* prometheus for Prometheus metrics
* sentry for Sentry monitoring
* elasticsearch for experimental Elasticsearch support
* shielded-scan for 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 getpeerinfo RPC 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.
* Experimental Tor support is disabled until Zebra upgrades to the latest
arti-client. This happened due to a Rust dependency conflict (#5492) and is
still an issue due to another dependency conflict.
DOCUMENTATION
The Zcash Foundation maintains the following resources documenting Zebra:
* The Zebra Book:
* General Introduction,
* User Documentation,
* Developer Documentation.
* The documentation of the public APIs for the latest releases of the
individual Zebra crates.
* The documentation of the internal APIs for the main branch 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.