> For the complete documentation index, see [llms.txt](/llms.txt)

# Aztec.nr API Reference

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

## View the API Documentation

[**Aztec.nr**](/aztec-nr-api/mainnet/noir_aztec/index.md)

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

### Core Crates

* [**noir\_aztec**](/aztec-nr-api/mainnet/noir_aztec/index.md) - Core Aztec contract framework including:

  <!-- -->

  * [`context`](/aztec-nr-api/mainnet/noir_aztec/context/index.md) - Private and public execution contexts
  * [`state_vars`](/aztec-nr-api/mainnet/noir_aztec/state_vars/index.md) - State variable types (PrivateMutable, PublicMutable, Map, etc.)
  * [`note`](/aztec-nr-api/mainnet/noir_aztec/note/index.md) - Note interfaces and utilities
  * [`authwit`](/aztec-nr-api/mainnet/noir_aztec/authwit/index.md) - Authentication witness support
  * [`history`](/aztec-nr-api/mainnet/noir_aztec/history/index.md) - Historical state proofs
  * [`messages`](/aztec-nr-api/mainnet/noir_aztec/messages/index.md) - Cross-chain messaging
  * [`oracle`](/aztec-nr-api/mainnet/noir_aztec/oracle/index.md) - Oracle interfaces
  * [`macros`](/aztec-nr-api/mainnet/noir_aztec/macros/index.md) - Contract macros and attributes
  * [`hash`](/aztec-nr-api/mainnet/noir_aztec/hash/index.md) - Hash functions and utilities
  * [`keys`](/aztec-nr-api/mainnet/noir_aztec/keys/index.md) - Key management utilities
  * [`event`](/aztec-nr-api/mainnet/noir_aztec/event/index.md) - Event emission and interfaces
  * [`test`](/aztec-nr-api/mainnet/noir_aztec/test/index.md) - Testing utilities
  * [`utils`](/aztec-nr-api/mainnet/noir_aztec/utils/index.md) - General utilities

### Note Types

* [**address\_note**](/aztec-nr-api/mainnet/address_note/index.md) - Note type for storing Aztec addresses
* [**field\_note**](/aztec-nr-api/mainnet/field_note/index.md) - Note type for storing a single Field value
* [**uint\_note**](/aztec-nr-api/mainnet/uint_note/index.md) - Note type for storing unsigned integers
* [**ecdsa\_public\_key\_note**](/aztec-nr-api/mainnet/ecdsa_public_key_note/index.md) - Note type for storing an ECDSA public key

### State Variables

* [**balance\_set**](/aztec-nr-api/mainnet/balance_set/index.md) - State variable for managing private balances

### Utilities

* [**compressed\_string**](/aztec-nr-api/mainnet/compressed_string/index.md) - Compressed string utilities for efficient storage

### Protocol Contract Interfaces

* [**contract\_instance\_registry\_interface**](/aztec-nr-api/mainnet/contract_instance_registry_interface/index.md) - Interface for calling the `ContractInstanceRegistry` protocol contract
* [**fee\_juice\_interface**](/aztec-nr-api/mainnet/fee_juice_interface/index.md) - Interface for calling the `FeeJuice` protocol contract