Aztec.nr API Reference

The Aztec.nr API reference documentation is auto-generated from the source code using nargo doc.

View the API Documentation

Open Aztec.nr API Reference →

The API reference includes documentation for all public modules, functions, structs, and types in the aztec-nr workspace:

Core Crates

• noir_aztec - Core Aztec contract framework including:
  • context - Private and public execution contexts
  • state_vars - State variable types (PrivateMutable, PublicMutable, Map, etc.)
  • note - Note interfaces and utilities
  • authwit - Authentication witness support
  • history - Historical state proofs
  • messages - Cross-chain messaging
  • oracle - Oracle interfaces
  • macros - Contract macros and attributes
  • hash - Hash functions and utilities
  • keys - Key management utilities
  • event - Event emission and interfaces
  • test - Testing utilities
  • utils - General utilities

Note Types

• address_note - Note type for storing Aztec addresses
• value_note - Note type for storing field values
• uint_note - Note type for storing unsigned integers

Utilities

• compressed_string - Compressed string utilities for efficient storage
• easy_private_state - Simplified private state management