Lib.rs

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, 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.

sudo pacman -S rust clang pkgconf

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.

• 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 by arti upgrading to a version of x25519-dalek with the dependency fix.

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.