Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ZcashFoundation/zebra
Zcash - Financial Privacy in Rust 🦓
https://github.com/ZcashFoundation/zebra
rust zcash zcash-node zebra
Last synced: about 1 month ago
JSON representation
Zcash - Financial Privacy in Rust 🦓
- Host: GitHub
- URL: https://github.com/ZcashFoundation/zebra
- Owner: ZcashFoundation
- License: apache-2.0
- Created: 2019-08-29T21:48:14.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T22:15:58.000Z (8 months ago)
- Last Synced: 2024-04-14T06:47:10.483Z (8 months ago)
- Topics: rust, zcash, zcash-node, zebra
- Language: Rust
- Homepage: https://zfnd.org/zebra/
- Size: 27 MB
- Stars: 391
- Watchers: 21
- Forks: 88
- Open Issues: 161
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-blockchain-rust - Zebra
README
---
[](https://github.com/ZcashFoundation/zebra/actions/workflows/ci-tests.yml)
[](https://github.com/ZcashFoundation/zebra/actions/workflows/ci-unit-tests-os.yml)
[](https://github.com/ZcashFoundation/zebra/actions/workflows/cd-deploy-nodes-gcp.yml)
[](https://codecov.io/gh/ZcashFoundation/zebra)
[](https://github.com/ZcashFoundation/zebra/actions/workflows/docs-deploy-firebase.yml)
- [About](#about)
- [Getting Started](#getting-started)
- [Docker](#docker)
- [Manual Build](#manual-build)
- [Documentation](#documentation)
- [User support](#user-support)
- [Security](#security)
- [License](#license)
## About
[Zebra](https://zebra.zfnd.org/) is a Zcash full-node written in Rust.
Zebra implements all the features required to reach Zcash network consensus, and
the network stack is interoperable with `zcashd`.
[Here](https://docs.rs/zebrad/latest/zebrad/index.html#zebra-advantages) are
some benefits of Zebra.
Zebra validates blocks and transactions, but needs extra software to generate
them:
- To generate transactions, [run Zebra with `lightwalletd`](https://zebra.zfnd.org/user/lightwalletd.html).
- 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](https://discord.gg/na6QZNd) 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](https://zebra.zfnd.org/user/requirements.html)
section in the Zebra book for system requirements.
### Docker
This command will run our latest release, and sync it to the tip:
```sh
docker run zfnd/zebra:latest
```
For more information, read our [Docker documentation](https://zebra.zfnd.org/user/docker.html).
### Manual Build
Building Zebra requires [Rust](https://www.rust-lang.org/tools/install),
[libclang](https://clang.llvm.org/doxygen/group__CINDEX.html), 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](https://github.com/ZcashFoundation/zebra/releases).
Below are quick summaries for installing the dependencies on your machine.
[//]: # "The empty line in the `summary` tag below is required for correct Markdown rendering."
#### General instructions for installing dependencies
1. Install [`cargo` and `rustc`](https://www.rust-lang.org/tools/install).
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`](https://grpc.io/docs/protoc-installation/)**
> [!NOTE]
> Zebra uses the `--experimental_allow_proto3_optional` flag with `protoc`
> during compilation. This flag was introduced in [Protocol Buffers
> v3.12.0](https://github.com/protocolbuffers/protobuf/releases/tag/v3.12.0)
> released in May 16, 2020, so make sure you're not using a version of `protoc`
> older than 3.12.
[//]: # "The empty line in the `summary` tag below is required for correct Markdown rendering."
#### Dependencies on Arch
```sh
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:
```sh
cargo install --locked zebrad
```
You can start Zebra by
```sh
zebrad start
```
Refer to the [Installing Zebra](https://zebra.zfnd.org/user/install.html) and
[Running Zebra](https://zebra.zfnd.org/user/run.html) sections in the book for
enabling optional features, detailed configuration and further details.
## Documentation
The Zcash Foundation maintains the following resources documenting Zebra:
- The Zebra Book:
- [General Introduction](https://zebra.zfnd.org/index.html),
- [User Documentation](https://zebra.zfnd.org/user.html),
- [Developer Documentation](https://zebra.zfnd.org/dev.html).
- The [documentation of the public
APIs](https://docs.rs/zebrad/latest/zebrad/#zebra-crates) for the latest
releases of the individual Zebra crates.
- The [documentation of the internal APIs](https://doc-internal.zebra.zfnd.org)
for the `main` branch of the whole Zebra monorepo.
## User support
For bug reports please [open a bug report ticket in the Zebra repository](https://github.com/ZcashFoundation/zebra/issues/new?assignees=&labels=C-bug%2C+S-needs-triage&projects=&template=bug_report.yml&title=%5BUser+reported+bug%5D%3A+).
Alternatively by chat, [Join the Zcash Foundation Discord
Server](https://discord.com/invite/aRgNRVwsM8) and find the #zebra-support
channel.
We maintain a list of known issues in the
[Troubleshooting](https://zebra.zfnd.org/user/troubleshooting.html) section of
the book.
## Security
Zebra has a [responsible disclosure policy](https://github.com/ZcashFoundation/zebra/blob/main/SECURITY.md), 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](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT).
Some Zebra crates are distributed under the [MIT license only](LICENSE-MIT),
because some of their code was originally from MIT-licensed projects.
See each crate's directory for details.