You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
dependabot[bot] 2e379811c3
build(deps): bump docker/build-push-action from 4.0.0 to 4.1.0 (#6902)
24 hours ago
.cargo fix(zebrad): accept default subcommand arguments and print consistent usage information for top-level 'help' subcommand (#6801) 4 days ago
.github build(deps): bump docker/build-push-action from 4.0.0 to 4.1.0 (#6902) 24 hours ago
book Add instructions for doing mass renames easily (#6865) 3 days ago
docker fix(deploy): allow the container to raise in MIGs (#6893) 1 day ago
grafana change(state): Add block channel metrics, in preparation for block fork metrics (#5327) 8 months ago
tower-batch build(deps): Upgrade to ed25519-zebra 4.0.0 (#6881) 2 days ago
tower-fallback Release 1.0.0-rc.9 (#6821) 3 days ago
zebra-chain build(deps): Upgrade to ed25519-zebra 4.0.0 (#6881) 2 days ago
zebra-consensus build(deps): bump serde from 1.0.163 to 1.0.164 (#6875) 2 days ago
zebra-network build(deps): bump serde from 1.0.163 to 1.0.164 (#6875) 2 days ago
zebra-node-services build(deps): bump serde from 1.0.163 to 1.0.164 (#6875) 2 days ago
zebra-rpc fix(app): Stop panicking at startup when parsing the app version - release blocker (#6888) 2 days ago
zebra-script Release 1.0.0-rc.9 (#6821) 3 days ago
zebra-state build(deps): bump serde from 1.0.163 to 1.0.164 (#6875) 2 days ago
zebra-test Release 1.0.0-rc.9 (#6821) 3 days ago
zebra-utils Release 1.0.0-rc.9 (#6821) 3 days ago
zebrad build(deps): bump clap from 4.3.2 to 4.3.3 (#6904) 1 day ago
.codespellrc build(deps): Bump `zcash_proofs` to 0.8.0 (#5481) 8 months ago
.dockerignore change(cd): Deploy testnet instances for every main branch push and release (#6842) 3 days ago
.gitattributes Show `Cargo.lock` files in the github diff view (#6249) 3 months ago
.gitignore fix: improve file and directories to be ignored by git and Docker (#3399) 1 year ago
CHANGELOG.md Release 1.0.0-rc.9 (#6821) 3 days ago
CODE_OF_CONDUCT.md CODE_OF_CONDUCT.md (#1097) 2 years ago
CONTRIBUTING.md release(docs): Refactor bug report template (#6858) 3 days ago
Cargo.lock build(deps): bump clap from 4.3.2 to 4.3.3 (#6904) 1 day ago
Cargo.toml fix(build): Fix new nightly clippy lints and cargo feature resolution (#6814) 4 days ago
LICENSE-APACHE Update copyright year in Apache License (#6140) 4 months ago
LICENSE-MIT Update copyright year in MIT License (#6131) 4 months ago
README.md fix(rust): Declare the correct compatibility with older Rust versions (#6892) 2 days ago
SECURITY.md Explicitly allow unencrypted disclosures for alpha releases (#2127) 2 years ago
clippy.toml
codecov.yml Re-enable code coverage comments on PRs (#3246) 1 year ago
deny.toml build(deps): Upgrade to ed25519-zebra 4.0.0 (#6881) 2 days ago
firebase.json
katex-header.html Add KaTeX to rendered docs. (#832) 3 years ago
prometheus.yaml

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:

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:1.0.0-rc.9

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

  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).
    • pkg-config

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 Zebra

cargo install --locked --git https://github.com/ZcashFoundation/zebra --tag v1.0.0-rc.9 zebrad

You can start Zebra by

zebrad start

See the Running Zebra section in the book for more details.

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

Network Ports

Zebra uses the following inbound and outbound TCP ports:

  • 8233 on Mainnet
  • 18233 on Testnet

Please see the Network Requirements section of the Zebra book for more details.

Known Issues

There are a few bugs in Zebra that we're still working on fixing:

Future Work

The Zebra team is currently working towards an audited stable release.

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. We also render API documentation for the external API of our crates, as well as internal documentation for private APIs.

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.