Skip to main content
Version: Alpha (v4.2.0-aztecnr-rc.2)

Aztec.nr Dependencies

This page lists the available Aztec.nr libraries. Add dependencies to the [dependencies] section of your Nargo.toml:

[dependencies]
aztec = { git="https://github.com/AztecProtocol/aztec-nr/", tag="v4.2.0-aztecnr-rc.2", directory="aztec" }
# Add other libraries as needed

Core​

Aztec (required)​

aztec = { git="https://github.com/AztecProtocol/aztec-nr/", tag="v4.2.0-aztecnr-rc.2", directory="aztec" }

The core Aztec library required for every Aztec.nr smart contract.

Note Types​

Address Note​

address_note = { git="https://github.com/AztecProtocol/aztec-nr/", tag="v4.2.0-aztecnr-rc.2", directory="address-note" }

Provides AddressNote, a note type for storing AztecAddress values.

Field Note​

field_note = { git="https://github.com/AztecProtocol/aztec-nr/", tag="v4.2.0-aztecnr-rc.2", directory="field-note" }

Provides FieldNote, a note type for storing a single Field value.

Uint Note​

uint_note = { git="https://github.com/AztecProtocol/aztec-nr/", tag="v4.2.0-aztecnr-rc.2", directory="uint-note" }

Provides UintNote, a note type for storing u128 values. Also includes PartialUintNote for partial note workflows where the value is completed in public execution.

State Variables​

Balance Set​

balance_set = { git="https://github.com/AztecProtocol/aztec-nr/", tag="v4.2.0-aztecnr-rc.2", directory="balance-set" }

Provides BalanceSet, a state variable for managing private balances. Includes helper functions for adding, subtracting, and querying balances.

Utilities​

Compressed String​

compressed_string = { git="https://github.com/AztecProtocol/aztec-nr/", tag="v4.2.0-aztecnr-rc.2", directory="compressed-string" }

Provides CompressedString and FieldCompressedString utilities for working with compressed string data.

Updating your aztec dependencies​

When aztec compile warns that your aztec dependency tag does not match the CLI version, update the tag field in every Aztec.nr entry in your Nargo.toml to match the CLI version you are running.

For example, if your CLI is v4.2.0-aztecnr-rc.2, change:

aztec = { git="https://github.com/AztecProtocol/aztec-nr/", tag="v<old-version>", directory="aztec" }

to:

aztec = { git="https://github.com/AztecProtocol/aztec-nr/", tag="v4.2.0-aztecnr-rc.2", directory="aztec" }

Repeat for every other Aztec.nr dependency in your Nargo.toml (e.g. address_note, balance_set, etc.). You can check your current CLI version with aztec --version.