Skip to content
Rust implementation of Zcash protocol
Branch: master
Clone or download
Latest commit ed8c907 May 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bencher do not verify headers twice Apr 4, 2019
chain groth16 proof struct helper Apr 10, 2019
crypto Point ed25519-dalek at the 1.0.0-prerelease.1 crate May 22, 2019
db fix comment Apr 10, 2019
doc Merge branch 'master' of github.com:paritytech/parity-bitcoin into csv May 3, 2017
docker updated Dockerfile Feb 12, 2018
import ignore zero-filled gaps in blk files Apr 11, 2019
keys new transparent address format Dec 25, 2018
logs update and dedup deps Mar 25, 2019
message changed max number of headers in the headers message Mar 20, 2019
miner unify fee calculation Apr 15, 2019
network fix default RPC ports May 14, 2019
p2p name all (excl main) threads Apr 5, 2019
primitives update and dedup deps Mar 25, 2019
pzec update user agent May 24, 2019
res fix test and new verifying key Apr 29, 2019
rpc fix couple of warnings May 21, 2019
script fix sighash May 16, 2019
serialization ignore zero-filled gaps in blk files Apr 11, 2019
serialization_derive overwinter + sapling transactions (start) Nov 19, 2018
snap Add the home plug to the snap Apr 18, 2018
storage fix test name Apr 10, 2019
sync added useful logs Apr 24, 2019
test-data fixed fee calculation in BlockCoinbaseMinerReward Apr 15, 2019
tools Fix typos Feb 2, 2019
verification fix couple of warnings May 21, 2019
.dockerignore basic docker setup Apr 5, 2017
.editorconfig tests for block hash, .editorconfig and bitcoin network enum Aug 16, 2016
.gitignore Merge branch 'master' into mempool Oct 16, 2016
.gitlab-ci.yml Remove tools/test.sh and replace it with cargo test --all May 10, 2018
.gitmodules Regtests on the CI (#244) Dec 2, 2016
.travis.yml Remove too verbose travis messaging Feb 6, 2019
CLI.md Bitcoin Core -> zcashd Apr 11, 2019
Cargo.lock Point ed25519-dalek at the 1.0.0-prerelease.1 crate May 22, 2019
Cargo.toml add patch for heapsize Mar 15, 2019
JSON-RPC.md updated JSON-RPC.md Mar 12, 2019
LICENSE Initial commit Aug 15, 2016
README.md Fix verification-level option Apr 6, 2019

README.md

The Parity Zcash client.

Build Status Snap Status

Gitter Gitter https://gitter.im/paritytech/parity-zcash

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

Installing from source

Installing pzec from source requires rustc and cargo.

Minimal supported version is rustc 1.23.0 (766bd11c8 2018-01-01)

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 cc and gcc compilers to build some of the dependencies.

On macOS

build-essential is a Debian package. 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

Clone and build pzec

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

git clone https://github.com/paritytech/parity-zcash
cd parity-zcash

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

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

Installing the snap

In any of the supported Linux distros:

sudo snap install parity-zcash --edge

Running tests

pzec 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/pzec

To start syncing the testnet:

./target/release/pzec --testnet

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

./target/release/pzec --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/pzec import "$ZCASH_DB/blocks"

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

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

Command line interface

Full list of CLI options, which is available under pzec --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/pzec

pzec 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/pzec

Internal documentation

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

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