700ba96726
|
||
|---|---|---|
| bencher | ||
| chain | ||
| crypto | ||
| db | ||
| doc | ||
| docker | ||
| import | ||
| keys | ||
| logs | ||
| message | ||
| miner | ||
| network | ||
| p2p | ||
| primitives | ||
| pzec | ||
| res | ||
| rpc | ||
| script | ||
| serialization | ||
| serialization_derive | ||
| snap | ||
| storage | ||
| sync | ||
| test-data | ||
| tools | ||
| verification | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .gitmodules | ||
| .travis.yml | ||
| CLI.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| JSON-RPC.md | ||
| LICENSE | ||
| README.md | ||
README.md
The Parity Zcash client.
Gitter 
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 -sSf https://static.rust-lang.org/rustup.sh | 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.
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, passing selected fork flag. For example:
./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 bitcoind database:
# where $BITCOIND_DB is path to your bitcoind database, e.g., "/Users/user/Library/Application Support"
./target/release/pzec import "$BITCOIND_DB/Bitcoin/blocks"
By default import verifies imported the blocks. You can disable this, by adding --verification-level==none flag.
./target/release/pzec import "#BITCOIND_DB/Bitcoin/blocks" --verification-level==none
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:
errorwarninfodebugtrace
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