Crate zebrad

source ·
Expand description

Zebra logotype

Zebra is a Zcash node written in Rust.

The zebrad binary uses a collection of zebra-* crates, which implement the different components of a Zcash node (networking, chain structures, validation, rpc, etc).

Rendered docs for the latest crate releases.

Rendered docs from the main branch.

Join us on the Zcash Foundation Engineering Discord.

About Zcash

Zcash is a cryptocurrency designed to preserve the user’s privacy. Like most cryptocurrencies, it works by a collection of software nodes run by members of the Zcash community or any other interested parties. The nodes talk to each other in peer-to-peer fashion in order to maintain the state of the Zcash blockchain. They also communicate with miners who create new blocks. When a Zcash user sends Zcash, their wallet broadcasts transactions to these nodes which will eventually reach miners, and the mined transaction will then go through Zcash nodes until they reach the recipient’s wallet which will report the received Zcash to the recipient.

Alternative Implementations

The original Zcash node is named zcashd and is developed by the Electric Coin Company as a fork of the original Bitcoin node. Zebra, on the other hand, is an independent Zcash node implementation developed from scratch. Since they implement the same protocol, zcashd and Zebra nodes can communicate with each other and maintain the Zcash network together.

Zebra Advantages

These are some of the advantages or benefits of Zebra:

  • Better performance: since it was implemented from scratch in an async, parallelized way, Zebra is currently faster than zcashd.
  • Better security: since it is developed in a memory-safe language (Rust), Zebra is less likely to be affected by memory-safety and correctness security bugs that could compromise the environment where it is run.
  • Better governance: with a new node deployment, there will be more developers who can implement different features for the Zcash network.
  • Dev accessibility: supports more developers, which gives new developers options for contributing to Zcash protocol development.
  • Runtime safety: with an independent implementation, the detection of consensus bugs can happen quicker, reducing the risk of consensus splits.
  • Spec safety: with several node implementations, it is much easier to notice bugs and ambiguity in protocol specification.
  • User options: different nodes present different features and tradeoffs for users to decide on their preferred options.
  • Additional contexts: wider target deployments for people to use a consensus node in more contexts e.g. mobile, wasm, etc.

Zebra Feature Flags

The following zebrad feature flags are available at compile time:

JSON-RPC

  • getblocktemplate-rpcs: Mining pool RPC support, enabled by default in production builds.

Metrics

  • configuring a tracing.progress_bar: shows key metrics in the terminal using progress bars, and automatically configures Zebra to send logs to a file. (The progress-bar feature is activated by default.)
  • prometheus: export metrics to prometheus.

Read the metrics section of the book for more details.

Tracing

Sending traces to different subscribers:

  • configuring a tracing.log_file: appends traces to a file on disk.
  • journald: send tracing spans and events to systemd-journald.
  • sentry: send crash and panic events to sentry.io.
  • flamegraph: generate a flamegraph of tracing spans.

Changing the traces that are collected:

  • filter-reload: dynamically reload tracing filters at runtime.
  • error-debug: enable extra debugging in release builds.
  • tokio-console: enable tokio’s console-subscriber (needs specific compiler flags)
  • A set of features that skip verbose tracing. The default features ignore debug and trace logs in release builds.

Read the tracing section of the book for more details.

Testing

  • proptest-impl: enable randomised test data generation.
  • lightwalletd-grpc-tests: enable Zebra JSON-RPC tests that query lightwalletd using gRPC.

Experimental

  • elasticsearch: save block data into elasticsearch database. Read the elasticsearch section of the book for more details.

Modules

  • application
    Zebrad Abscissa Application
  • commands
    Zebrad Subcommands
  • components
    Holds components of a Zebra node.
  • config
    Zebrad Config
  • prelude
    Application-local prelude: conveniently import types/functions/macros which are generally useful and should be available everywhere.
  • sentry
    Integration with sentry.io for event reporting.

Type Aliases

  • BoxError
    Error type alias to make working with tower traits easier.