Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Zakura is a consensus-compatible Zcash full node written in Rust, built for scale. Supporting payments at global scale requires on the order of 50k TPS, which translates to consensus processing at least 100 MB/s of block data. Today's chain peaks at 28 KB/s. With cryptographic optimizations to the Zcash protocol underway in Project Tachyon and at Valargroup, Zakura is the node implementation built to close that gap.
Zakura is forked from Zebra. This first release brings major improvements over existing Zcash node software:
- Performance: Blockchain sync is nearly 5× faster than Zebra. Block execution is notably faster than Zebra, especially on worst-case sandblast attacks.
- Pruning and snapshots: Native block pruning with configurable retention lets you operate a full node with substantially less disk space. We also publish snapshots (~11 GB pruned) that let you bootstrap a node 680× faster than syncing over the standard P2P network. See the snapshots page.
- zcashd compatibility: A compatibility mode reproduces the legacy zcashd RPC interface, so existing wallets and integrations keep working.
- Experimental P2P v2: We are building a new P2P transport layer for Zakura nodes, currently off by default on Mainnet. The goals are sub-500ms worst-case block propagation, mempool aggregation (used in Tachyon), sync at the speed of your bandwidth, and a future-proofed gossip protocol. The v2 stack has known DoS risks and is not yet production-hardened.
Getting Started
There are several ways to install the node software: an interactive installer that downloads the binary, Docker, or building from source or crates.io.
Installer
The simplest way to install Zakura on a new machine is using the interactive installer:
curl -fsSL https://zakura.com/install.sh | bash
The installer can set up either standard Zakura or its zcashd-compatible variant.
Docker
You can run Zakura using our Docker image or install it manually. The zcashd-compatible split-container mode uses the zakuracore/zcashd:v1.3.1 image.
This command will run our latest release and sync it to the tip:
The -p 8233:8233 flag exposes the P2P port so other Zcash nodes can connect to
yours, and -v persists the chain state across restarts (use port 18233 for
Testnet). For more information, see the image's
Docker Hub page.
Manual Install
Building Zakura requires Rust and a C++ compiler. Below are quick summaries for installing these dependencies.
General Instructions for Installing Dependencies
- Install
cargoandrustc. - Install a C++ compiler, such as
g++orclangon Linux, Xcode on macOS, or Visual Studio's MSVC on Windows.
Dependencies on Arch Linux
Once you have the dependencies in place, you can install Zakura with:
Alternatively, you can install it from GitHub:
Sprout JoinSplit proof and signature verification is disabled by default. When
bootstrapping from a snapshot, choose one at or
after NU7 activation for your network. To fully verify pre-NU7 blocks above the
last checkpoint, including Testnet sync from genesis with the current
checkpoints, enable the sprout Cargo feature:
Builds without sprout stall if they encounter such a block with a JoinSplit;
they do not mark it as consensus-invalid. You can also add --features sprout
to cargo install when installing a build with historical verification support.
Standard x86-64 builds enable Pasta field assembly through the default
x86_64-asm Cargo feature. Both BMI2 and ADX CPU extensions are required;
RUSTFLAGS is not needed:
This selects assembly at build time, with no CPU detection in arithmetic calls. The node checks CPU compatibility once at startup and exits with a clear error when either extension is missing. Official release binaries and Docker images use the same default. AArch64 assembly selection is unchanged.
For an older x86-64 CPU, enable the portable override:
The portable feature wins when both Cargo features are enabled, including
with --all-features. It only affects Pasta arithmetic: CPU-specific compiler
flags such as -C target-cpu=native can still emit instructions elsewhere that
require the build machine's CPU. Omit such flags when building a portable binary.
Builds that disable default features can still select assembly explicitly with
--features x86_64-asm, or through compiler target flags that enable BMI2 and ADX.
You can start Zakura by running
Run zakurad start --help for optional features and configuration details.
Documentation
The Zakura maintainers provide the following resources:
-
The Zakura website for user guides and announcements.
-
The documentation of the public APIs for the latest releases of the individual Zakura crates.
-
The documentation of the internal APIs for the
mainbranch of the whole Zakura monorepo.
User support
If Zakura doesn't behave the way you expected, open an issue. We regularly triage new issues and we will respond.
If you want to chat with us, use the GitHub issues for now.
Security
Zakura has a responsible disclosure policy, which we encourage security researchers to follow.
License
Zakura is distributed under the terms of both the MIT license and the Apache License (Version 2.0). Some Zakura crates are distributed under the MIT license only, because some of their code was originally from MIT-licensed projects. See each crate's directory for details.
See LICENSE-APACHE and LICENSE-MIT.