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

Installation

Prerequisites

  • Rust toolchain (edition 2021 or later), installed via rustup.
  • A running Aztec node for integration tests and examples (see Aztec docs).

Adding the Dependency

aztec-rs is not yet published to crates.io. Add it as a git dependency:

[dependencies]
aztec-rs = { git = "https://github.com/NethermindEth/aztec-rs.git", tag = "v0.5.1" }
tokio   = { version = "1", features = ["full"] }

The workspace applies the required [patch.crates-io] entries for pre-release noir crates automatically.

Subset Crates

If you only need part of the stack:

aztec-node-client = { git = "https://github.com/NethermindEth/aztec-rs.git", tag = "v0.5.1" }
aztec-wallet      = { git = "https://github.com/NethermindEth/aztec-rs.git", tag = "v0.5.1" }
aztec-contract    = { git = "https://github.com/NethermindEth/aztec-rs.git", tag = "v0.5.1" }

See the Crate Index for the full list.

Verifying the Install

cargo check

Continue with Connecting to a Node.