Skip to content
A consensus-compatible Zcash node client written in Rust. 🦓
Branch: master
Clone or download
dependabot-preview and dconnolly Bump parking_lot from 0.8.0 to 0.9.0
Bumps [parking_lot](https://github.com/Amanieu/parking_lot) from 0.8.0 to 0.9.0.
- [Release notes](https://github.com/Amanieu/parking_lot/releases)
- [Changelog](https://github.com/Amanieu/parking_lot/blob/master/CHANGELOG.md)
- [Commits](Amanieu/parking_lot@0.8.0...0.9.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Latest commit ca5a86e Jul 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Gcloud build (#116) Jul 8, 2019
doc Merge branch 'master' of github.com:paritytech/parity-bitcoin into csv May 3, 2017
fuzz Prefix workspace crates with zebra- (#70) Jul 2, 2019
res fix test and new verifying key Apr 29, 2019
snap Renaming (#1) Jun 17, 2019
tools Tidy travis (#76) Jul 2, 2019
zebra-bencher Move workspace members (#98) Jul 2, 2019
zebra-chain Move workspace members (#98) Jul 2, 2019
zebra-crypto Move workspace members (#98) Jul 2, 2019
zebra-db Bump parking_lot from 0.8.0 to 0.9.0 Jul 19, 2019
zebra-import Move workspace members (#98) Jul 2, 2019
zebra-keys Move workspace members (#98) Jul 2, 2019
zebra-logs Bump env_logger from 0.5.13 to 0.6.2 (#110) Jul 5, 2019
zebra-message Move workspace members (#98) Jul 2, 2019
zebra-miner Move workspace members (#98) Jul 2, 2019
zebra-network Move workspace members (#98) Jul 2, 2019
zebra-p2p Bump parking_lot from 0.8.0 to 0.9.0 Jul 19, 2019
zebra-primitives Move workspace members (#98) Jul 2, 2019
zebra-rpc Bump jsonrpc-pubsub from 12.0.0 to 12.1.0 Jul 15, 2019
zebra-script Move workspace members (#98) Jul 2, 2019
zebra-serialization Move workspace members (#98) Jul 2, 2019
zebra-serialization_derive Move workspace members (#98) Jul 2, 2019
zebra-storage Bump parking_lot from 0.8.0 to 0.9.0 Jul 19, 2019
zebra-sync Bump parking_lot from 0.8.0 to 0.9.0 Jul 19, 2019
zebra-test-data Move workspace members (#98) Jul 2, 2019
zebra-verification Bump parking_lot from 0.8.0 to 0.9.0 Jul 19, 2019
zebra_old Bump env_logger from 0.5.13 to 0.6.2 (#110) Jul 5, 2019
zebrad Update zebrad/Cargo.toml Jul 10, 2019
.dockerignore Add GitHub Actions CI workflow, including fuzzers (#36) Jun 21, 2019
.editorconfig tests for block hash, .editorconfig and bitcoin network enum Aug 16, 2016
.gitignore Add GitHub Actions CI workflow, including fuzzers (#36) Jun 21, 2019
.gitlab-ci.yml Remove tools/test.sh and replace it with cargo test --all May 10, 2018
.travis.yml Test and build simultaneously, smarter nightly job (#112) Jul 10, 2019
AUTHORS.md Prefix workspace crates with zebra- (#70) Jul 2, 2019
CLI.md Renaming (#1) Jun 17, 2019
Cargo.lock Bump parking_lot from 0.8.0 to 0.9.0 Jul 19, 2019
Cargo.toml Add abscissa-generated zebrad skeleton Jul 2, 2019
Dockerfile Gcloud build (#116) Jul 8, 2019
JSON-RPC.md Update JSON_RPC.md to mention regtest mode (#45) Jun 23, 2019
LICENSE Initial commit Aug 15, 2016
README.md Update README re current code flux, alpha status (#50) Jun 25, 2019
cloudbuild.yaml Gcloud build (#116) Jul 8, 2019

README.md

Zebra: the Zcash Foundation client.

Build Status

⚠️ Zebra is currently alpha software and subject to change. We do not recommend running Zebra on mainnet yet. ⚠️

We are currently in the process of heavy refactoring; for the next several weeks, it's very likely that external PRs may fall out of sync or have code refactored out from under them.

Blog: Parity teams up with Zcash Foundation for Parity Zcash client

Installing from source

Installing zebra from source requires rustc and cargo.

Minimal supported version is rustc 1.35.0 (fd19989 2019-05-23), and we generally target the stable channel.

Install rustc and cargo

Both rustc and cargo are a part of rust tool-chain.

An easy way to install the stable binaries for Linux and Mac is to run this in your shell:

curl https://sh.rustup.rs -sSf | sh

Windows binaries can be downloaded from rust-lang website.

Install C and C++ compilers

You will need the clang and gcc compilers plus cmake to build some of the dependencies.

On macOS

You will need to make sure you have Xcode installed. If you already have Homebrew installed, you probably also already have the Xcode tools installed as well. If not, you can run the command below:

xcode-select --install

On Linux

sudo apt-get update
sudo apt-get install build-essential cmake clang

Clone and build zebra

Now let's clone zebra and enter it's directory:

git clone https://github.com/ZcashFoundation/zebra
cd zebra

# builds zebra in release mode
cargo build -p zebra --release

zebra is now available at ./target/release/zebra.

Installing the snap

In any of the supported Linux distros:

sudo snap install zebra --edge

Running tests

zebra has internal unit tests and it conforms to external integration tests.

Running unit tests

Assuming that repository is already cloned, we can run unit tests with this command:

cargo test --all

Going online

By default parity connects to Zcash seednodes. Full list is here.

To start syncing the main network, just start the client without any arguments:

./target/release/zebra

To start syncing the testnet:

./target/release/zebra --testnet

To not print any syncing progress add --quiet flag:

./target/release/zebra --quiet

Importing zcashd database

It it is possible to import existing zcashd database:

# where $ZCASH_DB is path to your zcashd database. By default:
# on macOS: "/Users/user/Library/Application Support/Zcash"
# on Linux: "~/.zcash"
./target/release/zebra import "$ZCASH_DB/blocks"

By default, import verifies the imported blocks. You can disable this, by adding the --verification-level=none option.

./target/release/zebra --verification-level=none import "$ZCASH_DB/blocks"

Command line interface

Full list of CLI options, which is available under zebra --help: see here

Logging

This is a section only for developers and power users.

You can enable detailed client logging by setting the environment variable RUST_LOG, e.g.,

RUST_LOG=verification=info ./target/release/zebra

zebra started with this environment variable will print all logs coming from verification module with verbosity info or higher. Available log levels are:

  • error
  • warn
  • info
  • debug
  • trace

It's also possible to start logging from multiple modules in the same time:

RUST_LOG=sync=trace,p2p=trace,verification=trace,db=trace ./target/release/zebra

Internal documentation

Once released, zebra documentation will be available here. Meanwhile it's only possible to build it locally:

cd zebra
./tools/doc.sh
open target/doc/zebra/index.html
You can’t perform that action at this time.