aztec-nr - noir_aztec
Crate noir_aztec
Re-exports
pub use protocol_types;
Modules
- Authorization.
- Private, public and utility execution contexts.
- The
selfcontract value. - Event traits and utilities.
- Aztec hash functions.
- Proofs of Aztec history.
- Privacy keys (npk, ivsk, etc.).
- Definition of Aztec contract functions, storage, notes and events.
- Message encoding, encryption, delivery and processing.
- Note traits and utilities.
- Standard PXE oracles.
- Public contract deployment.
- Storage for contract state.
- The TestEnvironment utility and mock types.
- Miscellaneous utilities.
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.
If you don't know what aztec-nr is or how to install it, head to the aztec-nr documentation.
How to Use This Documentation
aztec-nr is split into multiple 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: the attributes applied to contract functions, such as[#external]and[#initializer], as well as definition of contract types such as[#storage]and[#event].state_vars: types for on-chain storage of contract state, such asPrivateMutable,PublicMutableandMap.test: for writing Aztec tests in Noir usingTestEnvironmentand mocks.