Function Attributes and Macros

On this page you will learn about function attributes and macros.

If you are looking for a reference of function macros, go here.

Private functions #[private]

A private function operates on private information, and is executed by the user on their device. Annotate the function with the #[private] attribute to tell the compiler it's a private function. This will make the private context available within the function's execution scope. The compiler will create a circuit to define this function.

#[private] is just syntactic sugar. At compile time, the Aztec.nr framework inserts code that allows the function to interact with the kernel.

To help illustrate how this interacts with the internals of Aztec and its kernel circuits, we can take an example private function, and explore what it looks like after Aztec.nr's macro expansion.

Before expansion

simple_macro_example
#[private]
fn simple_macro_example(a: Field, b: Field) -> Field {
    a + b
}

^{_{Source code: noir-projects/noir-contracts/contracts/docs_example_contract/src/main.nr#L315-L320}}

After expansion

simple_macro_example_expanded
fn simple_macro_example_expanded(
    // ************************************************************
    // The private context inputs are made available to the circuit by the kernel
    inputs: PrivateContextInputs,
    // ************************************************************
    // Our original inputs!
    a: Field,
    b: Field, // The actual return type of our circuit is the PrivateCircuitPublicInputs struct, this will be the
    // input to our kernel!
) -> pub PrivateCircuitPublicInputs {
    // ************************************************************
    // The hasher is a structure used to generate a hash of the circuits inputs.
    let mut args_hasher = dep::aztec::hash::ArgsHasher::new();
    args_hasher.add(a);
    args_hasher.add(b);
    // The context object is created with the inputs and the hash of the inputs
    let mut context = PrivateContext::new(inputs, args_hasher.hash());
    let mut storage = Storage::init(&mut context);
    // ************************************************************
    // Our actual program
    let result = a + b;
    // ************************************************************
    // Return values are pushed into the context
    let mut return_hasher = dep::aztec::hash::ArgsHasher::new();
    return_hasher.add(result);
    context.set_return_hash(return_hasher);
    // The context is returned to be consumed by the kernel circuit!
    context.finish()
    // ************************************************************
}

^{_{Source code: noir-projects/noir-contracts/contracts/docs_example_contract/src/main.nr#L321-L366}}

The expansion broken down

Viewing the expanded Aztec contract uncovers a lot about how Aztec contracts interact with the kernel. To aid with developing intuition, we will break down each inserted line.

Receiving context from the kernel.

context-example-inputs
inputs: PrivateContextInputs,

^{_{Source code: noir-projects/noir-contracts/contracts/docs_example_contract/src/main.nr#L325-L327}}

Private function calls are able to interact with each other through orchestration from within the kernel circuits. The kernel circuit forwards information to each contract function (recall each contract function is a circuit). This information then becomes part of the private context. For example, within each private function we can access some global variables. To access them we can call on the context, e.g. context.chain_id(). The value of the chain ID comes from the values passed into the circuit from the kernel.

The kernel checks that all of the values passed to each circuit in a function call are the same.

Returning the context to the kernel.

context-example-return
) -> pub PrivateCircuitPublicInputs {

^{_{Source code: noir-projects/noir-contracts/contracts/docs_example_contract/src/main.nr#L333-L335}}

The contract function must return information about the execution back to the kernel. This is done through a rigid structure we call the PrivateCircuitPublicInputs.

Why is it called the PrivateCircuitPublicInputs? When verifying zk programs, return values are not computed at verification runtime, rather expected return values are provided as inputs and checked for correctness. Hence, the return values are considered public inputs.

This structure contains a host of information about the executed program. It will contain any newly created nullifiers, any messages to be sent to l2 and most importantly it will contain the return values of the function.

Hashing the function inputs.

context-example-hasher
let mut args_hasher = dep::aztec::hash::ArgsHasher::new();
args_hasher.add(a);
args_hasher.add(b);

^{_{Source code: noir-projects/noir-contracts/contracts/docs_example_contract/src/main.nr#L338-L342}}

What is the hasher and why is it needed?

Inside the kernel circuits, the inputs to functions are reduced to a single value; the inputs hash. This prevents the need for multiple different kernel circuits; each supporting differing numbers of inputs. The hasher abstraction that allows us to create an array of all of the inputs that can be reduced to a single value.

Creating the function's context.

context-example-context
let mut context = PrivateContext::new(inputs, args_hasher.hash());

^{_{Source code: noir-projects/noir-contracts/contracts/docs_example_contract/src/main.nr#L344-L346}}

Each Aztec function has access to a context object. This object, although labelled a global variable, is created locally on a users' device. It is initialized from the inputs provided by the kernel, and a hash of the function's inputs.

context-example-context-return
let mut return_hasher = dep::aztec::hash::ArgsHasher::new();
return_hasher.add(result);
context.set_return_hash(return_hasher);

^{_{Source code: noir-projects/noir-contracts/contracts/docs_example_contract/src/main.nr#L355-L359}}

We use the kernel to pass information between circuits. This means that the return values of functions must also be passed to the kernel (where they can be later passed on to another function). We achieve this by pushing return values to the execution context, which we then pass to the kernel.

Making the contract's storage available

storage-example-context
let mut storage = Storage::init(&mut context);

^{_{Source code: noir-projects/noir-contracts/contracts/docs_example_contract/src/main.nr#L347-L349}}

When a Storage struct is declared within a contract, the storage keyword is made available. As shown in the macro expansion above, this calls the init function on the storage struct with the current function's context.

Any state variables declared in the Storage struct can now be accessed as normal struct members.

Returning the function context to the kernel.

context-example-finish
context.finish()

^{_{Source code: noir-projects/noir-contracts/contracts/docs_example_contract/src/main.nr#L361-L363}}

This function takes the application context, and converts it into the PrivateCircuitPublicInputs structure. This structure is then passed to the kernel circuit.

Unconstrained functions

Unconstrained functions are an underlying part of Noir. In short, they are functions which are not directly constrained and therefore should be seen as un-trusted. That they are un-trusted means that the developer must make sure to constrain their return values when used. Note: Calling an unconstrained function from a private function means that you are injecting unconstrained values.

Defining a function as unconstrained tells Aztec to simulate it completely client-side in the ACIR simulator without generating proofs. They are useful for extracting information from a user through an oracle.

When an unconstrained function is called, it prompts the ACIR simulator to

generate the execution environment
execute the function within this environment

To generate the environment, the simulator gets the blockheader from the PXE database and passes it along with the contract address to ViewDataOracle. This creates a context that simulates the state of the blockchain at a specific block, allowing the unconstrained function to access and interact with blockchain data as it would appear in that block, but without affecting the actual blockchain state.

Once the execution environment is created, execute_unconstrained_function is invoked:

execute_unconstrained_function
/**
 * Execute an unconstrained function and return the decoded values.
 */
export async function executeUnconstrainedFunction(
  oracle: ViewDataOracle,
  artifact: FunctionArtifact,
  contractAddress: AztecAddress,
  functionSelector: FunctionSelector,
  args: Fr[],
  log = createDebugLogger('aztec:simulator:unconstrained_execution'),
): Promise<AbiDecoded> {
  log.verbose(`Executing unconstrained function ${contractAddress}:${functionSelector}(${artifact.name})`);

  const acir = artifact.bytecode;
  const initialWitness = toACVMWitness(0, args);
  const acirExecutionResult = await acvm(acir, initialWitness, new Oracle(oracle)).catch((err: Error) => {
    throw new ExecutionError(
      err.message,
      {
        contractAddress,
        functionSelector,
      },
      extractCallStack(err, artifact.debug),
      { cause: err },
    );
  });

  const returnWitness = witnessMapToFields(acirExecutionResult.returnWitness);
  return decodeFromAbi(artifact.returnTypes, returnWitness);
}

^{_{Source code: yarn-project/simulator/src/client/unconstrained_execution.ts#L11-L42}}

This:

Prepares the ACIR for execution
Converts args into a format suitable for the ACVM (Abstract Circuit Virtual Machine), creating an initial witness (witness = set of inputs required to compute the function). args might be an oracle to request a user's balance
Executes the function in the ACVM, which involves running the ACIR with the initial witness and the context. If requesting a user's balance, this would query the balance from the PXE database
Extracts the return values from the partialWitness and decodes them based on the artifact to get the final function output. The artifact is the compiled output of the contract, and has information like the function signature, parameter types, and return types

Beyond using them inside your other functions, they are convenient for providing an interface that reads storage, applies logic and returns values to a UI or test. Below is a snippet from exposing the balance_of_private function from a token implementation, which allows a user to easily read their balance, similar to the balanceOf function in the ERC20 standard.

balance_of_private
pub(crate) unconstrained fn balance_of_private(owner: AztecAddress) -> pub Field {
    storage.balances.at(owner).balance_of().to_field()
}

^{_{Source code: noir-projects/noir-contracts/contracts/token_contract/src/main.nr#L834-L838}}

info

Note, that unconstrained functions can have access to both public and private data when executed on the user's device. This is possible since it is not actually part of the circuits that are executed in contract execution.

`Public` Functions #[public]

A public function is executed by the sequencer and has access to a state model that is very similar to that of the EVM and Ethereum. Even though they work in an EVM-like model for public transactions, they are able to write data into private storage that can be consumed later by a private function.

note

All data inserted into private storage from a public function will be publicly viewable (not private).

To create a public function you can annotate it with the #[public] attribute. This will make the public context available within the function's execution scope.

set_minter
#[public]
fn set_minter(minter: AztecAddress, approve: bool) {
    assert(storage.admin.read().eq(context.msg_sender()), "caller is not admin");
    storage.minters.at(minter).write(approve);
}

^{_{Source code: noir-projects/noir-contracts/contracts/token_contract/src/main.nr#L186-L196}}

Under the hood:

Context Creation: The macro inserts code at the beginning of the function to create aPublicContext object:

let mut context = PublicContext::new(args_hasher);

This context provides access to public state and transaction information

Storage Access: If the contract has a storage struct defined, the macro inserts code to initialize the storage:

let storage = Storage::init(&mut context);

Function Body Wrapping: The original function body is wrapped in a new scope that handles the context and return value
Visibility Control: The function is marked as pub, making it accessible from outside the contract.
Unconstrained Execution: Public functions are marked as unconstrained, meaning they don't generate proofs and are executed directly by the sequencer.

Constrained `view` Functions #[view]

The #[view] attribute is used to define constrained view functions in Aztec contracts. These functions are similar to view functions in Solidity, in that they are read-only and do not modify the contract's state. They are similar to the unconstrained keyword but are executed in a constrained environment. It is not possible to update state within an #[view] function.

This means the results of these functions are verifiable and can be trusted, as they are part of the proof generation and verification process. This is unlike unconstrained functions, where results are provided by the PXE and are not verified.

This makes #[view] functions suitable for critical read-only operations where the integrity of the result is crucial. Unconstrained functions, on the other hand, are executed entirely client-side without generating any proofs. It is better to use #[view] if the result of the function will be used in another function that will affect state, and they can be used for cross-contract calls.

#[view] functions can be combined with other Aztec attributes like #[private] or #[public].

`Initializer` Functions #[initializer]

This is used to designate functions as initializers (or constructors) for an Aztec contract. These functions are responsible for setting up the initial state of the contract when it is first deployed. The macro does two important things:

assert_initialization_matches_address_preimage(context): This checks that the arguments and sender to the initializer match the commitments from the address preimage
mark_as_initialized(&mut context): This is called at the end of the function to emit the initialization nullifier, marking the contract as fully initialized and ensuring this function cannot be called again

Key things to keep in mind:

A contract can have multiple initializer functions defined, but only one initializer function should be called for the lifetime of a contract instance
Other functions in the contract will have an initialization check inserted, ie they cannot be called until the contract is initialized, unless they are marked with #[noinitcheck]

#[noinitcheck]

In normal circumstances, all functions in an Aztec contract (except initializers) have an initialization check inserted at the beginning of the function body. This check ensures that the contract has been initialized before any other function can be called. However, there may be scenarios where you want a function to be callable regardless of the contract's initialization state. This is when you would use #[noinitcheck].

When a function is annotated with #[noinitcheck]:

The Aztec macro processor skips the insertion of the initialization check for this specific function
The function can be called at any time, even if the contract hasn't been initialized yet

`Internal` functions #[internal]

This macro inserts a check at the beginning of the function to ensure that the caller is the contract itself. This is done by adding the following assertion:

assert(context.msg_sender() == context.this_address(), "Function can only be called internally");

Custom notes #[note]

The #[note] attribute is used to define custom note types in Aztec contracts. Learn more about notes here.

When a struct is annotated with #[note], the Aztec macro applies a series of transformations and generates implementations to turn it into a note that can be used in contracts to store private data.

NoteInterface Implementation: The macro automatically implements most methods of the NoteInterface trait for the annotated struct. This includes:
- serialize_content and deserialize_content
- get_header and set_header
- get_note_type_id
- compute_note_hiding_point
- to_be_bytes
- A properties method in the note's implementation
Automatic Header Field: If the struct doesn't already have a header field of type NoteHeader, one is automatically created
Note Type ID Generation: A unique note_type_id is automatically computed for the note type using a Keccak hash of the struct name
Serialization and Deserialization: Methods for converting the note to and from a series of Field elements are generated, assuming each field can be converted to/from a Field
Property Metadata: A separate struct is generated to describe the note's fields, which is used for efficient retrieval of note data
Export Information: The note type and its ID are automatically exported

Before expansion

Here is how you could define a custom note:

#[note]
struct CustomNote {
    data: Field,
    owner: Address,
}

After expansion

impl CustomNote {
    fn serialize_content(self: CustomNote) -> [Field; NOTE_SERIALIZED_LEN] {
        [self.data, self.owner.to_field()]
    }

    fn deserialize_content(serialized_note: [Field; NOTE_SERIALIZED_LEN]) -> Self {
        CustomNote {
            data: serialized_note[0] as Field,
            owner: Address::from_field(serialized_note[1]),
            header: NoteHeader::empty()
        }
    }

    fn get_note_type_id() -> Field {
        // Automatically generated unique ID based on Keccak hash of the struct name
        0xd2de93eaab1d59abddf06134e737665f076f556feb7b6d3d72ca557b430b14d2
    }

    fn get_header(note: CustomNote) -> aztec::note::note_header::NoteHeader {
        note.header
    }

    fn set_header(self: &mut CustomNote, header: aztec::note::note_header::NoteHeader) {
        self.header = header;
    }

    fn compute_note_hiding_point(self: CustomNote) -> Point {
        aztec::hash::pedersen_commitment(
            self.serialize_content(),
            aztec::protocol_types::constants::GENERATOR_INDEX__NOTE_HIDING_POINT
        )
    }

      fn to_be_bytes(self, storage_slot: Field) -> [u8; 128] {
            assert(128 == 2 * 32 + 64, "Note byte length must be equal to (serialized_length * 32) + 64 bytes");
            let serialized_note = self.serialize_content();

            let mut buffer: [u8; 128] = [0; 128];

            let storage_slot_bytes = storage_slot.to_be_bytes(32);
            let note_type_id_bytes = CustomNote::get_note_type_id().to_be_bytes(32);

            for i in 0..32 {
                buffer[i] = storage_slot_bytes[i];
                buffer[32 + i] = note_type_id_bytes[i];
            }

            for i in 0..serialized_note.len() {
                let bytes = serialized_note[i].to_be_bytes(32);
                for j in 0..32 {
                    buffer[64 + i * 32 + j] = bytes[j];
                }
            }
            buffer
        }

    pub fn properties() -> CustomNoteProperties {
        CustomNoteProperties {
            data: aztec::note::note_getter_options::PropertySelector { index: 0, offset: 0, length: 32 },
            owner: aztec::note::note_getter_options::PropertySelector { index: 1, offset: 0, length: 32 }
        }
    }
}

struct CustomNoteProperties {
    data: aztec::note::note_getter_options::PropertySelector,
    owner: aztec::note::note_getter_options::PropertySelector,
}

Key things to keep in mind:

Developers can override any of the auto-generated methods by specifying a note interface
The note's fields are automatically serialized and deserialized in the order they are defined in the struct

Storage struct #[storage]

The #[storage] attribute is used to define the storage structure for an Aztec contract.

When a struct is annotated with #[storage], the macro does this under the hood:

Context Injection: injects a Context generic parameter into the storage struct and all its fields. This allows the storage to interact with the Aztec context, eg when using context.msg_sender()
Storage Implementation Generation: generates an impl block for the storage struct with an init function. The developer can override this by implementing a impl block themselves
Storage Slot Assignment: automatically assigns storage slots to each field in the struct based on their serialized length
Storage Layout Generation: a StorageLayout struct and a global variable are generated to export the storage layout information for use in the contract artifact

Before expansion

#[storage]
struct Storage {
    balance: PublicMutable<Field>,
    owner: PublicMutable<Address>,
    token_map: Map<Address, Field>,
}

After expansion

struct Storage<Context> {
    balance: PublicMutable<Field, Context>,
    owner: PublicMutable<Address, Context>,
    token_map: Map<Address, Field, Context>,
}

impl<Context> Storage<Context> {
    fn init(context: Context) -> Self {
        Storage {
            balance: PublicMutable::new(context, 1),
            owner: PublicMutable::new(context, 2),
            token_map: Map::new(context, 3, |context, slot| Field::new(context, slot)),
        }
    }
}

struct StorageLayout {
    balance: dep::aztec::prelude::Storable,
    owner: dep::aztec::prelude::Storable,
    token_map: dep::aztec::prelude::Storable,
}

#[abi(storage)]
global CONTRACT_NAME_STORAGE_LAYOUT = StorageLayout {
    balance: dep::aztec::prelude::Storable { slot: 1 },
    owner: dep::aztec::prelude::Storable { slot: 2 },
    token_map: dep::aztec::prelude::Storable { slot: 3 },
};

Key things to keep in mind:

Only one storage struct can be defined per contract
Map types and private Note types always occupy a single storage slot

Private functions #[private]​

Before expansion​

After expansion​

The expansion broken down​

Unconstrained functions​

Public Functions #[public]​

Constrained view Functions #[view]​

Initializer Functions #[initializer]​

#[noinitcheck]​

Internal functions #[internal]​

Custom notes #[note]​

Before expansion​

After expansion​

Storage struct #[storage]​

Before expansion​

After expansion​

Further reading​

Private functions #[private]

Before expansion

After expansion

The expansion broken down

Unconstrained functions

`Public` Functions #[public]

Constrained `view` Functions #[view]

`Initializer` Functions #[initializer]

#[noinitcheck]

`Internal` functions #[internal]

Custom notes #[note]

Before expansion

After expansion

Storage struct #[storage]

Before expansion

After expansion

Further reading