Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting Started

This section covers setting up the repository, building zair, and running a quick sanity check. Afterwards, follow the step-by-step guide in the CLI Reference.

Setup and Building

The repo includes a Nix flake that provides all dependencies (Rust, protoc):

nix develop
cargo build --release

Without Nix

Prerequisites

  • Rust 1.85.1+ (2024 edition)
  • Protobuf (protoc) for lightwalletd gRPC bindings

Build with:

cargo build --release

Sanity check

Verify the CLI is available:

./target/release/zair --help

and inspect the command groups:

./target/release/zair key --help
./target/release/zair setup --help
./target/release/zair config --help
./target/release/zair claim --help
./target/release/zair verify --help

Feature flags

The proving pipeline is gated behind the prove feature for some crates/binaries, enabled by default.

If you only need verification, you may build without proving support for a lighter dependency.