Crate Index
The workspace members and their roles. Each crate has its own reference page with module layout, public types, and API notes.
| Crate | Purpose | Reference |
|---|---|---|
aztec-rs | Umbrella crate; re-exports the full stack | → |
aztec-core | Primitives: ABI, hashes, fees, errors, tx types | → |
aztec-rpc | JSON-RPC transport layer | → |
aztec-crypto | BN254/Grumpkin, Poseidon2, Pedersen, Schnorr, key derivation | → |
aztec-node-client | Aztec node HTTP client + polling | → |
aztec-pxe-client | PXE trait + shared request/response types | → |
aztec-pxe | Embedded PXE runtime (stores, execution, kernel, sync) | → |
aztec-wallet | BaseWallet + account-provider integration | → |
aztec-contract | Contract handles, deployment, authwits, events | → |
aztec-account | Account flavors, entrypoints, deployment helpers | → |
aztec-fee | Fee payment strategies | → |
aztec-ethereum | L1 client + L1↔L2 messaging | → |
API Documentation
The full rustdoc for every workspace crate is bundled with this book under api/.
| Crate | Rustdoc index |
|---|---|
aztec-rs | api/aztec_rs/ |
aztec-core | api/aztec_core/ |
aztec-rpc | api/aztec_rpc/ |
aztec-crypto | api/aztec_crypto/ |
aztec-node-client | api/aztec_node_client/ |
aztec-pxe-client | api/aztec_pxe_client/ |
aztec-pxe | api/aztec_pxe/ |
aztec-wallet | api/aztec_wallet/ |
aztec-contract | api/aztec_contract/ |
aztec-account | api/aztec_account/ |
aztec-fee | api/aztec_fee/ |
aztec-ethereum | api/aztec_ethereum/ |
Local regeneration:
# Whole workspace
cargo doc --workspace --no-deps --open
# Umbrella crate only (public-facing surface)
cargo doc --open
# Bundled build matching what CI produces
./docs/build.sh
The docs/build.sh script builds the mdBook and the workspace rustdoc together, placing the rustdoc at docs/book/api/ so the per-crate links above resolve.
Release Notes
Per-crate changes are tagged inline in the project Changelog — search for the crate name (e.g. (aztec-ethereum)) to filter.