> Aztec.nr API reference, v6.0.0 (mainnet and testnet). Index: https://docs.aztec.network/aztec-nr-api/mainnet/llms.txt

# Crate noir_aztec

Module: `noir_aztec`

The aztec-nr framework for writing Aztec smart contracts.

This is the detailed API reference for aztec-nr. It assumes that the reader is a developer familiar with Aztec contracts.

## Beginners

If you don't know what Aztec is, head to the [Aztec documentation](https://docs.aztec.network).

If you don't know what aztec-nr is or how to install it, head to the [aztec-nr documentation](https://docs.aztec.network/developers/docs/aztec-nr).

## How to Use This Documentation

aztec-nr is split into multiple [modules](/aztec-nr-api/mainnet/noir_aztec/index.md#modules), each of which deals with some high-level concept. If you already know which module you're interested in, just navigate to it directly. Here are some frequently used modules:

- [`macros`](/aztec-nr-api/mainnet/noir_aztec/macros/index.md): the attributes applied to contract functions, such as [`[#external]`](/aztec-nr-api/mainnet/noir_aztec/macros/functions/fn.external.md) and [`[#initializer]`](/aztec-nr-api/mainnet/noir_aztec/macros/functions/fn.initializer.md), as well as definition of contract types such as [`[#storage]`](/aztec-nr-api/mainnet/noir_aztec/macros/storage/fn.storage.md) and [`[#event]`](/aztec-nr-api/mainnet/noir_aztec/macros/events/fn.event.md).

- [`state_vars`](/aztec-nr-api/mainnet/noir_aztec/state_vars/index.md): types for onchain storage of contract state, such as [`PrivateMutable`](/aztec-nr-api/mainnet/noir_aztec/state_vars/struct.PrivateMutable.md), [`PublicMutable`](/aztec-nr-api/mainnet/noir_aztec/state_vars/struct.PublicMutable.md) and [`Map`](/aztec-nr-api/mainnet/noir_aztec/state_vars/struct.Map.md).

- [`test`](/aztec-nr-api/mainnet/noir_aztec/test/index.md): for writing Aztec tests in Noir using [`TestEnvironment`](/aztec-nr-api/mainnet/noir_aztec/test/helpers/test_environment/struct.TestEnvironment.md) and [mocks](/aztec-nr-api/mainnet/noir_aztec/test/mocks/index.md).

## Modules

- [authwit](/aztec-nr-api/mainnet/noir_aztec/authwit/index.md): Authorization.
- [capsules](/aztec-nr-api/mainnet/noir_aztec/capsules/index.md)
- [context](/aztec-nr-api/mainnet/noir_aztec/context/index.md): Private, public and utility execution contexts.
- [contract_self](/aztec-nr-api/mainnet/noir_aztec/contract_self/index.md)
- [ephemeral](/aztec-nr-api/mainnet/noir_aztec/ephemeral/index.md)
- [event](/aztec-nr-api/mainnet/noir_aztec/event/index.md): Event traits and utilities.
- [facts](/aztec-nr-api/mainnet/noir_aztec/facts/index.md): Per-contract storage of immutable facts grouped into collections.
- [hash](/aztec-nr-api/mainnet/noir_aztec/hash/index.md): Aztec hash functions.
- [history](/aztec-nr-api/mainnet/noir_aztec/history/index.md): Proofs of Aztec history.
- [keys](/aztec-nr-api/mainnet/noir_aztec/keys/index.md): Privacy keys (npk, ivsk, etc.).
- [macros](/aztec-nr-api/mainnet/noir_aztec/macros/index.md): Definition of Aztec contract functions, storage, notes and events.
- [messages](/aztec-nr-api/mainnet/noir_aztec/messages/index.md): Message encoding, encryption, delivery and processing.
- [note](/aztec-nr-api/mainnet/noir_aztec/note/index.md): Note traits and utilities
- [nullifier](/aztec-nr-api/mainnet/noir_aztec/nullifier/index.md): Nullifier-related utilities.
- [oracle](/aztec-nr-api/mainnet/noir_aztec/oracle/index.md): Standard PXE oracles.
- [protocol](/aztec-nr-api/mainnet/noir_aztec/protocol/index.md): Types and constants related to the Aztec protocol.
- [public_checks](/aztec-nr-api/mainnet/noir_aztec/public_checks/index.md)
- [publish_contract_instance](/aztec-nr-api/mainnet/noir_aztec/publish_contract_instance/index.md): Public contract deployment.
- [standard_addresses](/aztec-nr-api/mainnet/noir_aztec/standard_addresses/index.md)
- [state_vars](/aztec-nr-api/mainnet/noir_aztec/state_vars/index.md): Storage for contract state.
- [test](/aztec-nr-api/mainnet/noir_aztec/test/index.md): The [TestEnvironment](/aztec-nr-api/mainnet/noir_aztec/test/helpers/test_environment/struct.TestEnvironment.md) utility and mock types.
- [transient](/aztec-nr-api/mainnet/noir_aztec/transient/index.md)
- [unconstrained_array](/aztec-nr-api/mainnet/noir_aztec/unconstrained_array/index.md)
- [utils](/aztec-nr-api/mainnet/noir_aztec/utils/index.md): Miscellaneous utilities.