Go to file
Marek 2ba837470e
Bump `chrono` from 0.4.34 to 0.4.38 (#8400)
* Bump `chrono` from 0.4.34 to 0.4.38

* Stop using the deprecated `from_timestamp_opt`

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2024-04-19 23:23:57 +00:00
.cargo
.github build(deps): bump the devops group with 2 updates (#8408) 2024-04-19 09:25:56 +00:00
book Release v1.6.1 (#8396) 2024-04-15 23:24:40 +00:00
docker add(test): Check that scan task removes keys, unify scan task acceptance tests, and add test to CI (#8308) 2024-03-04 21:25:50 +00:00
grafana
tower-batch-control build(deps): bump the prod group with 21 updates (#8402) 2024-04-17 02:20:28 +00:00
tower-fallback build(deps): bump the prod group with 21 updates (#8402) 2024-04-17 02:20:28 +00:00
zebra-chain Bump `chrono` from 0.4.34 to 0.4.38 (#8400) 2024-04-19 23:23:57 +00:00
zebra-consensus Bump `chrono` from 0.4.34 to 0.4.38 (#8400) 2024-04-19 23:23:57 +00:00
zebra-grpc add(consensus/network): Add an empty `Parameters` struct in `Network::Testnet` (#8368) 2024-04-17 02:20:34 +00:00
zebra-network Bump `chrono` from 0.4.34 to 0.4.38 (#8400) 2024-04-19 23:23:57 +00:00
zebra-node-services build(deps): bump the prod group with 21 updates (#8402) 2024-04-17 02:20:28 +00:00
zebra-rpc Bump `chrono` from 0.4.34 to 0.4.38 (#8400) 2024-04-19 23:23:57 +00:00
zebra-scan Bump `chrono` from 0.4.34 to 0.4.38 (#8400) 2024-04-19 23:23:57 +00:00
zebra-script fix(beta-toolchain): Warnings (#8404) 2024-04-18 01:45:22 +00:00
zebra-state Bump `chrono` from 0.4.34 to 0.4.38 (#8400) 2024-04-19 23:23:57 +00:00
zebra-test fix(beta-toolchain): Warnings (#8404) 2024-04-18 01:45:22 +00:00
zebra-utils add(consensus): Add `activation_heights` field to `NetworkParameters` and implement `Parameters` for `Network` (#8383) 2024-04-19 01:20:34 +00:00
zebrad Bump `chrono` from 0.4.34 to 0.4.38 (#8400) 2024-04-19 23:23:57 +00:00
.codespellrc
.dockerignore
.firebaserc
.gitattributes
.gitignore feat(docker): allow users to use Zebra + LWD with persistent states (#8215) 2024-02-01 21:54:17 +00:00
CHANGELOG.md Release v1.6.1 (#8396) 2024-04-15 23:24:40 +00:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Update CONTRIBUTING.md (#8304) 2024-02-22 10:52:35 +00:00
Cargo.lock Bump `chrono` from 0.4.34 to 0.4.38 (#8400) 2024-04-19 23:23:57 +00:00
Cargo.toml
LICENSE-APACHE
LICENSE-MIT
README.md Release v1.6.1 (#8396) 2024-04-15 23:24:40 +00:00
SECURITY.md
clippy.toml
codecov.yml
deny.toml build(deps): bump the prod group with 14 updates (#8264) 2024-02-14 12:24:33 +00:00
firebase.json
katex-header.html
openapi.yaml feat(rpc): OpenAPI spec (#8342) 2024-03-14 15:04:19 +00:00
prometheus.yaml
release.toml change(release.toml): new crates owners list (#8247) 2024-02-07 23:17:43 +00:00

README.md

Zebra logotype


CI Docker CI OSes Continuous Delivery codecov Build docs License

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

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

  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:

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:

Documentation

The Zcash Foundation maintains the following resources documenting Zebra:

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.