Skip to main content
Version: dev

Aztec CLI Reference

This documentation is auto-generated from the aztec CLI help output.

Generated: Fri 02 Jan 2026 14:36:39 UTC

Command: aztec

Table of Contents​

aztec​

Aztec command line interface

Usage:

aztec [options] [command]

Available Commands:

  • add-l1-validator [options] - Adds a validator to the L1 rollup contract via a direct deposit.
  • advance-epoch [options] - Use L1 cheat codes to warp time until the next epoch.
  • block-number [options] - Gets the current Aztec L2 block number.
  • bridge-erc20 [options] <amount> <recipient> - Bridges ERC20 tokens to L2.
  • check [options] - type-checks Noir code without compiling using nargo check
  • codegen [options] <noir-abi-path> - Validates and generates an Aztec Contract ABI from Noir ABI.
  • compile [options] - compiles Aztec Noir contracts
  • compute-selector <functionSignature> - Given a function signature, it computes a selector
  • debug-rollup [options] - Debugs the rollup contract.
  • decode-enr <enr> - Decodes an ENR record
  • deploy-l1-contracts [options] - Deploys all necessary Ethereum contracts for Aztec.
  • deploy-new-rollup [options] - Deploys a new rollup contract and adds it to the registry (if you are the owner).
  • deposit-governance-tokens [options] - Deposits governance tokens to the governance contract.
  • example-contracts - Lists the example contracts available to deploy from @aztec/noir-contracts.js
  • execute-governance-proposal [options] - Executes a governance proposal.
  • fast-forward-epochs [options] - Fast forwards the epoch of the L1 rollup contract.
  • fmt [options] - formats Noir code using nargo fmt
  • generate-bls-keypair [options] - Generate a BLS keypair with convenience flags
  • generate-bootnode-enr [options] <privateKey> <p2pIp> <p2pPort> - Generates the encoded ENR record for a bootnode.
  • generate-keys [options] - Generates encryption and signing private keys.
  • generate-l1-account [options] - Generates a new private key for an account on L1.
  • generate-p2p-private-key - Generates a LibP2P peer private key.
  • generate-secret-and-hash - Generates an arbitrary secret (Fr), and its hash (using aztec-nr defaults)
  • get-block [options] [blockNumber] - Gets info for a given block or latest.
  • get-canonical-sponsored-fpc-address - Gets the canonical SponsoredFPC address for this any testnet running on the same version as this CLI
  • get-current-min-fee [options] - Gets the current min fee.
  • get-l1-addresses [options] - Gets the addresses of the L1 contracts.
  • get-l1-balance [options] <who> - Gets the balance of an ERC token in L1 for the given Ethereum address.
  • get-l1-to-l2-message-witness [options] - Gets a L1 to L2 message witness.
  • get-logs [options] - Gets all the public logs from an intersection of all the filter params.
  • get-node-info [options] - Gets the information of an Aztec node from a PXE or directly from an Aztec node.
  • help [command] - display help for command
  • init [options] - creates a new Noir workspace in the current directory
  • inspect-contract <contractArtifactFile> - Shows list of external callable functions for a contract
  • lsp - starts the Nargo Language Server Protocol server
  • new <name> [options] - creates a new Noir workspace (or adds a contract to an existing workspace)
  • parse-parameter-struct [options] <encodedString> - Helper for parsing an encoded string into a contract's parameter struct.
  • preload-crs - Preload the points data needed for proving and verifying
  • propose-with-lock [options] - Makes a proposal to governance with a lock
  • prune-rollup [options] - Prunes the pending chain on the rollup contract.
  • remove-l1-validator [options] - Removes a validator to the L1 rollup contract.
  • sequencers [options] <command> [who] - Manages or queries registered sequencers on the L1 rollup contract.
  • setup-protocol-contracts [options] - Bootstrap the blockchain by initializing all the protocol contracts
  • start [options] - Starts Aztec modules. Options for each module can be set as key-value pairs (e.g. "option1=value1,option2=value2") or as environment variables.
  • test [options] - starts a dockerized TXE node via
  • trigger-seed-snapshot [options] - Triggers a seed snapshot for the next epoch.
  • update [options] [projectPath] - Updates Nodejs and Noir dependencies
  • validator-keys|valKeys - Manage validator keystores for node operators
  • vote-on-governance-proposal [options] - Votes on a governance proposal.

Options:

  • -V --version - output the version number
  • -h --help - display help for command

Subcommands​

aztec add-l1-validator​

Usage: aztec add-l1-validator [options]

Adds a validator to the L1 rollup contract via a direct deposit.

Options:
  --l1-rpc-urls <string>       List of Ethereum host URLs. Chain identifiers
                               localhost and testnet can be used (comma
                               separated) (default:
                               ["http://host.docker.internal:8545"], env:
                               ETHEREUM_HOSTS)
  --network <string>           Network to execute against (env: NETWORK)
  -pk, --private-key <string>  The private key to use sending the transaction
  -m, --mnemonic <string>      The mnemonic to use sending the transaction
                               (default: "test test test test test test test
                               test test test test junk")
  -c, --l1-chain-id <number>   Chain ID of the ethereum host (default: 31337,
                               env: L1_CHAIN_ID)
  --attester <address>         ethereum address of the attester
  --withdrawer <address>       ethereum address of the withdrawer
  --bls-secret-key <string>    The BN254 scalar field element used as a secret
                               key for BLS signatures. Will be associated with
                               the attester address.
  --move-with-latest-rollup    Whether to move with the latest rollup (default:
                               true)
  --rollup <string>            Rollup contract address
  -h, --help                   display help for command

aztec advance-epoch​

Usage: aztec advance-epoch [options]

Use L1 cheat codes to warp time until the next epoch.

Options:
  --l1-rpc-urls <string>   List of Ethereum host URLs. Chain identifiers
                           localhost and testnet can be used (comma separated)
                           (default: ["http://host.docker.internal:8545"], env:
                           ETHEREUM_HOSTS)
  -n, --node-url <string>  URL of the Aztec node (default:
                           "http://host.docker.internal:8080", env:
                           AZTEC_NODE_URL)
  -h, --help               display help for command

aztec block-number​

Usage: aztec block-number [options]

Gets the current Aztec L2 block number.

Options:
  -n, --node-url <string>  URL of the Aztec node (default:
                           "http://host.docker.internal:8080", env:
                           AZTEC_NODE_URL)
  -h, --help               display help for command

aztec bridge-erc20​

Usage: aztec bridge-erc20 [options] <amount> <recipient>

Bridges ERC20 tokens to L2.

Arguments:
  amount                      The amount of Fee Juice to mint and bridge.
  recipient                   Aztec address of the recipient.

Options:
  --l1-rpc-urls <string>      List of Ethereum host URLs. Chain identifiers
                              localhost and testnet can be used (comma
                              separated) (default:
                              ["http://host.docker.internal:8545"], env:
                              ETHEREUM_HOSTS)
  -m, --mnemonic <string>     The mnemonic to use for deriving the Ethereum
                              address that will mint and bridge (default: "test
                              test test test test test test test test test test
                              junk")
  --mint                      Mint the tokens on L1 (default: false)
  --private                   If the bridge should use the private flow
                              (default: false)
  -c, --l1-chain-id <number>  Chain ID of the ethereum host (default: 31337,
                              env: L1_CHAIN_ID)
  -t, --token <string>        The address of the token to bridge
  -p, --portal <string>       The address of the portal contract
  -f, --faucet <string>       The address of the faucet contract (only used if
                              minting)
  --l1-private-key <string>   The private key to use for deployment
  --json                      Output the claim in JSON format
  -h, --help                  display help for command

aztec check​

Check a local package and all of its dependencies for errors

Usage: nargo check [OPTIONS]

Options:
      --package <PACKAGE>
          The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory

      --workspace
          Run on all packages in the workspace

      --overwrite
          Force overwrite of existing files

      --expression-width <EXPRESSION_WIDTH>
          Specify the backend expression width that should be targeted

      --bounded-codegen
          Generate ACIR with the target backend expression width. The default is to generate ACIR without a bound and split expressions after code generation. Activating this flag can sometimes provide optimizations for certain programs

      --force
          Force a full recompilation

      --print-acir
          Display the ACIR for compiled circuit

      --deny-warnings
          Treat all warnings as errors

      --silence-warnings
          Suppress warnings

      --debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>
          Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "package_name/src/main.nr"

      --skip-underconstrained-check
          Flag to turn off the compiler check for under constrained values. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code

      --skip-brillig-constraints-check
          Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code

      --count-array-copies
          Count the number of arrays that are copied in an unconstrained context for performance debugging

      --enable-brillig-constraints-check-lookback
          Flag to turn on the lookback feature of the Brillig call constraints check, allowing tracking argument values before the call happens preventing certain rare false positives (leads to a slowdown on large rollout functions)

      --inliner-aggressiveness <INLINER_AGGRESSIVENESS>
          Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs

          [default: 9223372036854775807]

      --pedantic-solving
          Use pedantic ACVM solving, i.e. double-check some black-box function assumptions when solving. This is disabled by default

  -Z, --unstable-features <UNSTABLE_FEATURES>
          Unstable features to enable for this current build.

          If non-empty, it disables unstable features required in crate manifests.

      --no-unstable-features
          Disable any unstable features required in crate manifests

  -h, --help
          Print help (see a summary with '-h')

aztec codegen​

Usage: aztec codegen [options] <noir-abi-path>

Validates and generates an Aztec Contract ABI from Noir ABI.

Arguments:
  noir-abi-path        Path to the Noir ABI or project dir.

Options:
  -o, --outdir <path>  Output folder for the generated code.
  -f, --force          Force code generation even when the contract has not
                       changed.
  -h, --help           display help for command

aztec compile​

Aztec Compile - Compile Aztec Noir contracts

This command compiles Aztec Noir contracts using nargo and then automatically
postprocesses them to generate Aztec-specific artifacts including:
  - Transpiled contract artifacts
  - Verification keys

The compiled contracts will be placed in the target/ directory by default.

AZTEC-SPECIFIC NOTES:
  - Working directory must be under $HOME due to Docker containerization
  - Compilation automatically includes contract postprocessing
  - Use standard nargo compile options (see below)

ENVIRONMENT VARIABLES:
  AZTEC_PATH    Path to Aztec installation (default: $HOME/.aztec)
  VERSION       Aztec version to use (default: from $AZTEC_PATH/default_version)
  DOCKER_REPO   Docker repository (default: aztecprotocol/aztec)

---
Underlying nargo compile options:

Compile the program and its secret execution trace into ACIR format

Usage: nargo compile [OPTIONS]

Options:
      --package <PACKAGE>
          The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory

      --workspace
          Run on all packages in the workspace

      --expression-width <EXPRESSION_WIDTH>
          Specify the backend expression width that should be targeted

      --bounded-codegen
          Generate ACIR with the target backend expression width. The default is to generate ACIR without a bound and split expressions after code generation. Activating this flag can sometimes provide optimizations for certain programs

      --force
          Force a full recompilation

      --print-acir
          Display the ACIR for compiled circuit

      --deny-warnings
          Treat all warnings as errors

      --silence-warnings
          Suppress warnings

      --debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>
          Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "package_name/src/main.nr"

      --skip-underconstrained-check
          Flag to turn off the compiler check for under constrained values. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code

      --skip-brillig-constraints-check
          Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code

      --count-array-copies
          Count the number of arrays that are copied in an unconstrained context for performance debugging

      --enable-brillig-constraints-check-lookback
          Flag to turn on the lookback feature of the Brillig call constraints check, allowing tracking argument values before the call happens preventing certain rare false positives (leads to a slowdown on large rollout functions)

      --inliner-aggressiveness <INLINER_AGGRESSIVENESS>
          Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs

          [default: 9223372036854775807]

      --pedantic-solving
          Use pedantic ACVM solving, i.e. double-check some black-box function assumptions when solving. This is disabled by default

  -Z, --unstable-features <UNSTABLE_FEATURES>
          Unstable features to enable for this current build.

          If non-empty, it disables unstable features required in crate manifests.

      --no-unstable-features
          Disable any unstable features required in crate manifests

  -h, --help
          Print help (see a summary with '-h')

aztec compute-selector​

Usage: aztec compute-selector [options] <functionSignature>

Given a function signature, it computes a selector

Arguments:
  functionSignature  Function signature to compute selector for e.g. foo(Field)

Options:
  -h, --help         display help for command

aztec debug-rollup​

Usage: aztec debug-rollup [options]

Debugs the rollup contract.

Options:
  --l1-rpc-urls <string>      List of Ethereum host URLs. Chain identifiers
                              localhost and testnet can be used (comma
                              separated) (default:
                              ["http://host.docker.internal:8545"], env:
                              ETHEREUM_HOSTS)
  -c, --l1-chain-id <number>  Chain ID of the ethereum host (default: 31337,
                              env: L1_CHAIN_ID)
  --rollup <address>          ethereum address of the rollup contract
  -h, --help                  display help for command

aztec decode-enr​

Usage: aztec decode-enr [options] <enr>

Decodes and ENR record

Arguments:
  enr         The encoded ENR string

Options:
  -h, --help  display help for command

aztec deploy-l1-contracts​

Usage: aztec deploy-l1-contracts [options]

Deploys all necessary Ethereum contracts for Aztec.

Options:
  --l1-rpc-urls <string>             List of Ethereum host URLs. Chain
                                     identifiers localhost and testnet can be
                                     used (comma separated) (default:
                                     ["http://host.docker.internal:8545"], env:
                                     ETHEREUM_HOSTS)
  -pk, --private-key <string>        The private key to use for deployment
  --validators <string>              Comma separated list of validators
  -m, --mnemonic <string>            The mnemonic to use in deployment
                                     (default: "test test test test test test
                                     test test test test test junk")
  -i, --mnemonic-index <number>      The index of the mnemonic to use in
                                     deployment (default: 0)
  -c, --l1-chain-id <number>         Chain ID of the ethereum host (default:
                                     31337, env: L1_CHAIN_ID)
  --salt <number>                    The optional salt to use in deployment
  --json                             Output the contract addresses in JSON
                                     format
  --test-accounts                    Populate genesis state with initial fee
                                     juice for test accounts
  --sponsored-fpc                    Populate genesis state with a testing
                                     sponsored FPC contract
  --accelerated-test-deployments     Fire and forget deployment transactions,
                                     use in testing only (default: false)
  --real-verifier                    Deploy the real verifier (default: false)
  --existing-token <address>         Use an existing ERC20 for both fee and
                                     staking
  --create-verification-json [path]  Create JSON file for etherscan contract
                                     verification (default: false)
  -h, --help                         display help for command

aztec deploy-new-rollup​

Usage: aztec deploy-new-rollup [options]

Deploys a new rollup contract and adds it to the registry (if you are the
owner).

Options:
  -r, --registry-address <string>    The address of the registry contract
  --l1-rpc-urls <string>             List of Ethereum host URLs. Chain
                                     identifiers localhost and testnet can be
                                     used (comma separated) (default:
                                     ["http://host.docker.internal:8545"], env:
                                     ETHEREUM_HOSTS)
  -pk, --private-key <string>        The private key to use for deployment
  --validators <string>              Comma separated list of validators
  -m, --mnemonic <string>            The mnemonic to use in deployment
                                     (default: "test test test test test test
                                     test test test test test junk")
  -i, --mnemonic-index <number>      The index of the mnemonic to use in
                                     deployment (default: 0)
  -c, --l1-chain-id <number>         Chain ID of the ethereum host (default:
                                     31337, env: L1_CHAIN_ID)
  --salt <number>                    The optional salt to use in deployment
  --json                             Output the contract addresses in JSON
                                     format
  --test-accounts                    Populate genesis state with initial fee
                                     juice for test accounts
  --sponsored-fpc                    Populate genesis state with a testing
                                     sponsored FPC contract
  --real-verifier                    Deploy the real verifier (default: false)
  --create-verification-json [path]  Create JSON file for etherscan contract
                                     verification (default: false)
  -h, --help                         display help for command

aztec deposit-governance-tokens​

Usage: aztec deposit-governance-tokens [options]

Deposits governance tokens to the governance contract.

Options:
  -r, --registry-address <string>  The address of the registry contract
  --recipient <string>             The recipient of the tokens
  -a, --amount <string>            The amount of tokens to deposit
  --mint                           Mint the tokens on L1 (default: false)
  --l1-rpc-urls <string>           List of Ethereum host URLs. Chain
                                   identifiers localhost and testnet can be
                                   used (comma separated) (default:
                                   ["http://host.docker.internal:8545"], env:
                                   ETHEREUM_HOSTS)
  -c, --l1-chain-id <number>       Chain ID of the ethereum host (default:
                                   31337, env: L1_CHAIN_ID)
  -p, --private-key <string>       The private key to use to deposit
  -m, --mnemonic <string>          The mnemonic to use to deposit (default:
                                   "test test test test test test test test
                                   test test test junk")
  -i, --mnemonic-index <number>    The index of the mnemonic to use to deposit
                                   (default: 0)
  -h, --help                       display help for command

aztec example-contracts​

Usage: aztec example-contracts [options]

Lists the example contracts available to deploy from @aztec/noir-contracts.js

Options:
  -h, --help  display help for command

aztec execute-governance-proposal​

Usage: aztec execute-governance-proposal [options]

Executes a governance proposal.

Options:
  -p, --proposal-id <string>       The ID of the proposal
  -r, --registry-address <string>  The address of the registry contract
  --wait <boolean>                 Whether to wait until the proposal is
                                   executable
  --l1-rpc-urls <string>           List of Ethereum host URLs. Chain
                                   identifiers localhost and testnet can be
                                   used (comma separated) (default:
                                   ["http://host.docker.internal:8545"], env:
                                   ETHEREUM_HOSTS)
  -c, --l1-chain-id <number>       Chain ID of the ethereum host (default:
                                   31337, env: L1_CHAIN_ID)
  -pk, --private-key <string>      The private key to use to vote
  -m, --mnemonic <string>          The mnemonic to use to vote (default: "test
                                   test test test test test test test test test
                                   test junk")
  -i, --mnemonic-index <number>    The index of the mnemonic to use to vote
                                   (default: 0)
  -h, --help                       display help for command

aztec fast-forward-epochs​

Help for this command is currently unavailable due to a technical issue with option serialization.

aztec fmt​

Format the Noir files in a workspace

Usage: nargo fmt [OPTIONS]

Options:
      --check              Run noirfmt in check mode
      --package <PACKAGE>  The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory
      --workspace          Run on all packages in the workspace
  -h, --help               Print help

aztec generate-bls-keypair​

Usage: aztec generate-bls-keypair [options]

Generate a BLS keypair with convenience flags

Options:
  --mnemonic <mnemonic>  Mnemonic for BLS derivation
  --ikm <hex>            Initial keying material for BLS (alternative to
                         mnemonic)
  --bls-path <path>      EIP-2334 path (default m/12381/3600/0/0/0)
  --g2                   Derive on G2 subgroup
  --compressed           Output compressed public key
  --json                 Print JSON output to stdout
  --out <file>           Write output to file
  -h, --help             display help for command

aztec generate-bootnode-enr​

Usage: aztec generate-bootnode-enr [options] <privateKey> <p2pIp> <p2pPort>

Generates the encoded ENR record for a bootnode.

Arguments:
  privateKey                  The peer id private key of the bootnode
  p2pIp                       The bootnode P2P IP address
  p2pPort                     The bootnode P2P port

Options:
  -c, --l1-chain-id <number>  Chain ID of the ethereum host (default: 31337,
                              env: L1_CHAIN_ID)
  -h, --help                  display help for command

aztec generate-keys​

Usage: aztec generate-keys [options]

Generates and encryption and signing private key pair.

Options:
  --json      Output the keys in JSON format
  -h, --help  display help for command

aztec generate-l1-account​

Usage: aztec generate-l1-account [options]

Generates a new private key for an account on L1.

Options:
  --json      Output the private key in JSON format
  -h, --help  display help for command

aztec generate-p2p-private-key​

Usage: aztec generate-p2p-private-key [options]

Generates a private key that can be used for running a node on a LibP2P
network.

Options:
  -h, --help  display help for command

aztec generate-secret-and-hash​

Usage: aztec generate-secret-and-hash [options]

Generates an arbitrary secret (Fr), and its hash (using aztec-nr defaults)

Options:
  -h, --help  display help for command

aztec get-block​

Usage: aztec get-block [options] [blockNumber]

Gets info for a given block or latest.

Arguments:
  blockNumber              Block height

Options:
  -n, --node-url <string>  URL of the Aztec node (default:
                           "http://host.docker.internal:8080", env:
                           AZTEC_NODE_URL)
  -h, --help               display help for command

aztec get-canonical-sponsored-fpc-address​

Usage: aztec get-canonical-sponsored-fpc-address [options]

Gets the canonical SponsoredFPC address for this any testnet running on the
same version as this CLI

Options:
  -h, --help  display help for command

aztec get-current-min-fee​

Usage: aztec get-current-min-fee [options]

Gets the current min fee.

Options:
  -n, --node-url <string>  URL of the Aztec node (default:
                           "http://host.docker.internal:8080", env:
                           AZTEC_NODE_URL)
  -h, --help               display help for command

aztec get-l1-addresses​

Usage: aztec get-l1-addresses [options]

Gets the addresses of the L1 contracts.

Options:
  -r, --registry-address <string>  The address of the registry contract
  --l1-rpc-urls <string>           List of Ethereum host URLs. Chain
                                   identifiers localhost and testnet can be
                                   used (comma separated) (default:
                                   ["http://host.docker.internal:8545"], env:
                                   ETHEREUM_HOSTS)
  -v, --rollup-version <number>    The version of the rollup
  -c, --l1-chain-id <number>       Chain ID of the ethereum host (default:
                                   31337, env: L1_CHAIN_ID)
  --json                           Output the addresses in JSON format
  -h, --help                       display help for command

aztec get-l1-balance​

Usage: aztec get-l1-balance [options] <who>

Gets the balance of an ERC token in L1 for the given Ethereum address.

Arguments:
  who                         Ethereum address to check.

Options:
  --l1-rpc-urls <string>      List of Ethereum host URLs. Chain identifiers
                              localhost and testnet can be used (comma
                              separated) (default:
                              ["http://host.docker.internal:8545"], env:
                              ETHEREUM_HOSTS)
  -t, --token <string>        The address of the token to check the balance of
  -c, --l1-chain-id <number>  Chain ID of the ethereum host (default: 31337,
                              env: L1_CHAIN_ID)
  --json                      Output the balance in JSON format
  -h, --help                  display help for command

aztec get-l1-to-l2-message-witness​

Usage: aztec get-l1-to-l2-message-witness [options]

Gets a L1 to L2 message witness.

Options:
  -ca, --contract-address <address>  Aztec address of the contract.
  --message-hash <messageHash>       The L1 to L2 message hash.
  --secret <secret>                  The secret used to claim the L1 to L2
                                     message
  -n, --node-url <string>            URL of the Aztec node (default:
                                     "http://host.docker.internal:8080", env:
                                     AZTEC_NODE_URL)
  -h, --help                         display help for command

aztec get-logs​

Usage: aztec get-logs [options]

Gets all the public logs from an intersection of all the filter params.

Options:
  -tx, --tx-hash <txHash>            A transaction hash to get the receipt for.
  -fb, --from-block <blockNum>       Initial block number for getting logs
                                     (defaults to 1).
  -tb, --to-block <blockNum>         Up to which block to fetch logs (defaults
                                     to latest).
  -al --after-log <logId>            ID of a log after which to fetch the logs.
  -ca, --contract-address <address>  Contract address to filter logs by.
  -n, --node-url <string>            URL of the Aztec node (default:
                                     "http://host.docker.internal:8080", env:
                                     AZTEC_NODE_URL)
  --follow                           If set, will keep polling for new logs
                                     until interrupted.
  -h, --help                         display help for command

aztec get-node-info​

Usage: aztec get-node-info [options]

Gets the information of an Aztec node from a PXE or directly from an Aztec
node.

Options:
  --json                   Emit output as json
  -n, --node-url <string>  URL of the Aztec node (default:
                           "http://host.docker.internal:8080", env:
                           AZTEC_NODE_URL)
  -h, --help               display help for command

aztec init​

No help information available for this command.

aztec inspect-contract​

Usage: aztec inspect-contract [options] <contractArtifactFile>

Shows list of external callable functions for a contract

Arguments:
  contractArtifactFile  A compiled Noir contract's artifact in JSON format or
                        name of a contract artifact exported by
                        @aztec/noir-contracts.js

Options:
  -h, --help            display help for command

aztec lsp​

No help information available for this command.

aztec new​

No help information available for this command.

aztec parse-parameter-struct​

Usage: aztec parse-parameter-struct [options] <encodedString>

Helper for parsing an encoded string into a contract's parameter struct.

Arguments:
  encodedString                           The encoded hex string

Options:
  -c, --contract-artifact <fileLocation>  A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js
  -p, --parameter <parameterName>         The name of the struct parameter to decode into
  -h, --help                              display help for command

aztec preload-crs​

Usage: aztec preload-crs [options]

Preload the points data needed for proving and verifying

Options:
  -h, --help  display help for command

aztec propose-with-lock​

Usage: aztec propose-with-lock [options]

Makes a proposal to governance with a lock

Options:
  -r, --registry-address <string>  The address of the registry contract
  -p, --payload-address <string>   The address of the payload contract
  --l1-rpc-urls <string>           List of Ethereum host URLs. Chain
                                   identifiers localhost and testnet can be
                                   used (comma separated) (default:
                                   ["http://host.docker.internal:8545"], env:
                                   ETHEREUM_HOSTS)
  -c, --l1-chain-id <number>       Chain ID of the ethereum host (default:
                                   31337, env: L1_CHAIN_ID)
  -pk, --private-key <string>      The private key to use to propose
  -m, --mnemonic <string>          The mnemonic to use to propose (default:
                                   "test test test test test test test test
                                   test test test junk")
  -i, --mnemonic-index <number>    The index of the mnemonic to use to propose
                                   (default: 0)
  --json                           Output the proposal ID in JSON format
  -h, --help                       display help for command

aztec prune-rollup​

Usage: aztec prune-rollup [options]

Prunes the pending chain on the rollup contract.

Options:
  --l1-rpc-urls <string>       List of Ethereum host URLs. Chain identifiers
                               localhost and testnet can be used (comma
                               separated) (default:
                               ["http://host.docker.internal:8545"], env:
                               ETHEREUM_HOSTS)
  -pk, --private-key <string>  The private key to use for deployment
  -m, --mnemonic <string>      The mnemonic to use in deployment (default:
                               "test test test test test test test test test
                               test test junk")
  -c, --l1-chain-id <number>   Chain ID of the ethereum host (default: 31337,
                               env: L1_CHAIN_ID)
  --rollup <address>           ethereum address of the rollup contract
  -h, --help                   display help for command

aztec remove-l1-validator​

Usage: aztec remove-l1-validator [options]

Removes a validator to the L1 rollup contract.

Options:
  --l1-rpc-urls <string>       List of Ethereum host URLs. Chain identifiers
                               localhost and testnet can be used (comma
                               separated) (default:
                               ["http://host.docker.internal:8545"], env:
                               ETHEREUM_HOSTS)
  -pk, --private-key <string>  The private key to use for deployment
  -m, --mnemonic <string>      The mnemonic to use in deployment (default:
                               "test test test test test test test test test
                               test test junk")
  -c, --l1-chain-id <number>   Chain ID of the ethereum host (default: 31337,
                               env: L1_CHAIN_ID)
  --validator <address>        ethereum address of the validator
  --rollup <address>           ethereum address of the rollup contract
  -h, --help                   display help for command

aztec sequencers​

Usage: aztec sequencers [options] <command> [who]

Manages or queries registered sequencers on the L1 rollup contract.

Arguments:
  command                     Command to run: list, add, remove, who-next
  who                         Who to add/remove

Options:
  --l1-rpc-urls <string>      List of Ethereum host URLs. Chain identifiers
                              localhost and testnet can be used (comma
                              separated) (default:
                              ["http://host.docker.internal:8545"])
  -m, --mnemonic <string>     The mnemonic for the sender of the tx (default:
                              "test test test test test test test test test
                              test test junk")
  --block-number <number>     Block number to query next sequencer for
  -n, --node-url <string>     URL of the Aztec node (default:
                              "http://host.docker.internal:8080", env:
                              AZTEC_NODE_URL)
  -c, --l1-chain-id <number>  Chain ID of the ethereum host (default: 31337,
                              env: L1_CHAIN_ID)
  -h, --help                  display help for command

aztec setup-protocol-contracts​

Usage: aztec setup-protocol-contracts [options]

Bootstrap the blockchain by initializing all the protocol contracts

Options:
  -n, --node-url <string>  URL of the Aztec node (default:
                           "http://host.docker.internal:8080", env:
                           AZTEC_NODE_URL)
  --testAccounts           Deploy funded test accounts.
  --json                   Output the contract addresses in JSON format
  -h, --help               display help for command

aztec start​

MISC

  • --network <value> Network to run Aztec on Environment: $NETWORK

  • --auto-update <value> (default: disabled) The auto update mode for this node Environment: $AUTO_UPDATE

  • --auto-update-url <value> Base URL to check for updates Environment: $AUTO_UPDATE_URL

  • --sync-mode <value> (default: snapshot) Set sync mode to full to always sync via L1, snapshot to download a snapshot if there is no local data, force-snapshot to download even if there is local data. Environment: $SYNC_MODE

  • --snapshots-urls <value> Base URLs for snapshots index, comma-separated. Environment: $SYNC_SNAPSHOTS_URLS

  • --fisherman-mode Whether to run in fisherman mode. Environment: $FISHERMAN_MODE

  • --local-network Starts Aztec Local Network

  • --local-network.l1Mnemonic <value> (default: test test test test test test test test test test test junk) Mnemonic for L1 accounts. Will be used Environment: $MNEMONIC

  • --local-network.deployAztecContractsSalt <value> Numeric salt for deploying L1 Aztec contracts before starting the local network. Needs mnemonic or private key to be set. Environment: $DEPLOY_AZTEC_CONTRACTS_SALT

API

  • --port <value> (default: 8080) Port to run the Aztec Services on Environment: $AZTEC_PORT

  • --admin-port <value> (default: 8880) Port to run admin APIs of Aztec Services on Environment: $AZTEC_ADMIN_PORT

  • --api-prefix <value> Prefix for API routes on any service that is started Environment: $API_PREFIX

ETHEREUM

  • --l1-chain-id <value> The chain ID of the ethereum host. Environment: $L1_CHAIN_ID

  • --l1-rpc-urls <value> List of URLs of Ethereum RPC nodes that services will connect to (comma separated). Environment: $ETHEREUM_HOSTS

  • --l1-consensus-host-urls <value> List of URLs of the Ethereum consensus nodes that services will connect to (comma separated) Environment: $L1_CONSENSUS_HOST_URLS

  • --l1-consensus-host-api-keys <value> List of API keys for the corresponding L1 consensus clients, if needed. Added to the end of the corresponding URL as "?key=<api-key>" unless a header is defined Environment: $L1_CONSENSUS_HOST_API_KEYS

  • --l1-consensus-host-api-key-headers <value> List of header names for the corresponding L1 consensus client API keys, if needed. Added to the corresponding request as "<api-key-header>: <api-key>" Environment: $L1_CONSENSUS_HOST_API_KEY_HEADERS

  • --registry-address <value> The deployed L1 registry contract address. Environment: $REGISTRY_CONTRACT_ADDRESS

  • --rollup-version <value> The version of the rollup. Environment: $ROLLUP_VERSION

STORAGE

  • --data-directory <value> Optional dir to store data. If omitted will store in memory. Environment: $DATA_DIRECTORY

  • --data-store-map-size-kb <value> (default: 134217728) The maximum possible size of a data store DB in KB. Can be overridden by component-specific options. Environment: $DATA_STORE_MAP_SIZE_KB

WORLD STATE

  • --world-state-data-directory <value> Optional directory for the world state database Environment: $WS_DATA_DIRECTORY

  • --world-state-db-map-size-kb <value> The maximum possible size of the world state DB in KB. Overwrites the general dataStoreMapSizeKb. Environment: $WS_DB_MAP_SIZE_KB

  • --world-state-block-history <value> (default: 64) The number of historic blocks to maintain. Values less than 1 mean all history is maintained Environment: $WS_NUM_HISTORIC_BLOCKS

AZTEC NODE

  • --node Starts Aztec Node with options

ARCHIVER

  • --archiver Starts Aztec Archiver with options

  • --archiver.blobSinkUrl <value> The URL of the blob sink Environment: $BLOB_SINK_URL

  • --archiver.blobSinkMapSizeKb <value> The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKb. Environment: $BLOB_SINK_MAP_SIZE_KB

  • --archiver.blobAllowEmptySources <value> Whether to allow having no blob sources configured during startup Environment: $BLOB_ALLOW_EMPTY_SOURCES

  • --archiver.archiveApiUrl <value> The URL of the archive API Environment: $BLOB_SINK_ARCHIVE_API_URL

  • --archiver.archiverPollingIntervalMS <value> (default: 500) The polling interval in ms for retrieving new L2 blocks and encrypted logs. Environment: $ARCHIVER_POLLING_INTERVAL_MS

  • --archiver.archiverBatchSize <value> (default: 100) The number of L2 blocks the archiver will attempt to download at a time. Environment: $ARCHIVER_BATCH_SIZE

  • --archiver.maxLogs <value> (default: 1000) The max number of logs that can be obtained in 1 "getPublicLogs" call. Environment: $ARCHIVER_MAX_LOGS

  • --archiver.archiverStoreMapSizeKb <value> The maximum possible size of the archiver DB in KB. Overwrites the general dataStoreMapSizeKb. Environment: $ARCHIVER_STORE_MAP_SIZE_KB

  • --archiver.skipValidateBlockAttestations <value> Whether to skip validating block attestations (use only for testing).

  • --archiver.maxAllowedEthClientDriftSeconds <value> (default: 300) Maximum allowed drift in seconds between the Ethereum client and current time. Environment: $MAX_ALLOWED_ETH_CLIENT_DRIFT_SECONDS

  • --archiver.ethereumAllowNoDebugHosts <value> (default: true) Whether to allow starting the archiver without debug/trace method support on Ethereum hosts Environment: $ETHEREUM_ALLOW_NO_DEBUG_HOSTS

SEQUENCER

  • --sequencer Starts Aztec Sequencer with options

  • --sequencer.validatorPrivateKeys <value> (default: [Redacted]) List of private keys of the validators participating in attestation duties Environment: $VALIDATOR_PRIVATE_KEYS

  • --sequencer.validatorAddresses <value> List of addresses of the validators to use with remote signers Environment: $VALIDATOR_ADDRESSES

  • --sequencer.disableValidator <value> Do not run the validator Environment: $VALIDATOR_DISABLED

  • --sequencer.disabledValidators <value> Temporarily disable these specific validator addresses

  • --sequencer.attestationPollingIntervalMs <value> (default: 200) Interval between polling for new attestations Environment: $VALIDATOR_ATTESTATIONS_POLLING_INTERVAL_MS

  • --sequencer.validatorReexecute <value> (default: true) Re-execute transactions before attesting Environment: $VALIDATOR_REEXECUTE

  • --sequencer.validatorReexecuteDeadlineMs <value> (default: 6000) Will re-execute until this many milliseconds are left in the slot Environment: $VALIDATOR_REEXECUTE_DEADLINE_MS

  • --sequencer.alwaysReexecuteBlockProposals <value> Whether to always reexecute block proposals, even for non-validator nodes (useful for monitoring network status). Environment: $ALWAYS_REEXECUTE_BLOCK_PROPOSALS

  • --sequencer.transactionPollingIntervalMS <value> (default: 500) The number of ms to wait between polling for pending txs. Environment: $SEQ_TX_POLLING_INTERVAL_MS

  • --sequencer.maxTxsPerBlock <value> (default: 32) The maximum number of txs to include in a block. Environment: $SEQ_MAX_TX_PER_BLOCK

  • --sequencer.minTxsPerBlock <value> (default: 1) The minimum number of txs to include in a block. Environment: $SEQ_MIN_TX_PER_BLOCK

  • --sequencer.publishTxsWithProposals <value> Whether to publish txs with proposals. Environment: $SEQ_PUBLISH_TXS_WITH_PROPOSALS

  • --sequencer.maxL2BlockGas <value> (default: 10000000000) The maximum L2 block gas. Environment: $SEQ_MAX_L2_BLOCK_GAS

  • --sequencer.maxDABlockGas <value> (default: 10000000000) The maximum DA block gas. Environment: $SEQ_MAX_DA_BLOCK_GAS

  • --sequencer.coinbase <value> Recipient of block reward. Environment: $COINBASE

  • --sequencer.feeRecipient <value> Address to receive fees. Environment: $FEE_RECIPIENT

  • --sequencer.acvmWorkingDirectory <value> The working directory to use for simulation/proving Environment: $ACVM_WORKING_DIRECTORY

  • --sequencer.acvmBinaryPath <value> The path to the ACVM binary Environment: $ACVM_BINARY_PATH

  • --sequencer.maxBlockSizeInBytes <value> (default: 1048576) Max block size Environment: $SEQ_MAX_BLOCK_SIZE_IN_BYTES

  • --sequencer.enforceTimeTable <value> (default: true) Whether to enforce the time table when building blocks Environment: $SEQ_ENFORCE_TIME_TABLE

  • --sequencer.governanceProposerPayload <value> (default: 0x0000000000000000000000000000000000000000) The address of the payload for the governanceProposer Environment: $GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS

  • --sequencer.maxL1TxInclusionTimeIntoSlot <value> How many seconds into an L1 slot we can still send a tx and get it mined. Environment: $SEQ_MAX_L1_TX_INCLUSION_TIME_INTO_SLOT

  • --sequencer.attestationPropagationTime <value> (default: 2) How many seconds it takes for proposals and attestations to travel across the p2p layer (one-way) Environment: $SEQ_ATTESTATION_PROPAGATION_TIME

  • --sequencer.secondsBeforeInvalidatingBlockAsCommitteeMember <value> (default: 144) How many seconds to wait before trying to invalidate a block from the pending chain as a committee member (zero to never invalidate). The next proposer is expected to invalidate, so the committee acts as a fallback. Environment: $SEQ_SECONDS_BEFORE_INVALIDATING_BLOCK_AS_COMMITTEE_MEMBER

  • --sequencer.secondsBeforeInvalidatingBlockAsNonCommitteeMember <value> (default: 432) How many seconds to wait before trying to invalidate a block from the pending chain as a non-committee member (zero to never invalidate). The next proposer is expected to invalidate, then the committee, so other sequencers act as a fallback. Environment: $SEQ_SECONDS_BEFORE_INVALIDATING_BLOCK_AS_NON_COMMITTEE_MEMBER

  • --sequencer.broadcastInvalidBlockProposal <value> Broadcast invalid block proposals with corrupted state (for testing only)

  • --sequencer.injectFakeAttestation <value> Inject a fake attestation (for testing only)

  • --sequencer.shuffleAttestationOrdering <value> Shuffle attestation ordering to create invalid ordering (for testing only)

  • --sequencer.txPublicSetupAllowList <value> The list of functions calls allowed to run in setup Environment: $TX_PUBLIC_SETUP_ALLOWLIST

  • --sequencer.keyStoreDirectory <value> Location of key store directory Environment: $KEY_STORE_DIRECTORY

  • --sequencer.publisherPrivateKeys <value> The private keys to be used by the publisher. Environment: $SEQ_PUBLISHER_PRIVATE_KEYS

  • --sequencer.publisherAddresses <value> The addresses of the publishers to use with remote signers Environment: $SEQ_PUBLISHER_ADDRESSES

  • --sequencer.publisherAllowInvalidStates <value> (default: true) True to use publishers in invalid states (timed out, cancelled, etc) if no other is available Environment: $SEQ_PUBLISHER_ALLOW_INVALID_STATES

  • --sequencer.publisherForwarderAddress <value> Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only) Environment: $SEQ_PUBLISHER_FORWARDER_ADDRESS

  • --sequencer.blobSinkUrl <value> The URL of the blob sink Environment: $BLOB_SINK_URL

  • --sequencer.blobAllowEmptySources <value> Whether to allow having no blob sources configured during startup Environment: $BLOB_ALLOW_EMPTY_SOURCES

  • --sequencer.archiveApiUrl <value> The URL of the archive API Environment: $BLOB_SINK_ARCHIVE_API_URL

BLOB SINK

  • --blob-sink Starts Aztec Blob Sink with options

  • --blobSink.port <value> The port to run the blob sink server on Environment: $BLOB_SINK_PORT

  • --blobSink.blobSinkMapSizeKb <value> The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKb. Environment: $BLOB_SINK_MAP_SIZE_KB

  • --blobSink.blobAllowEmptySources <value> Whether to allow having no blob sources configured during startup Environment: $BLOB_ALLOW_EMPTY_SOURCES

  • --blobSink.archiveApiUrl <value> The URL of the archive API Environment: $BLOB_SINK_ARCHIVE_API_URL

PROVER NODE

  • --prover-node Starts Aztec Prover Node with options

  • --proverNode.keyStoreDirectory <value> Location of key store directory Environment: $KEY_STORE_DIRECTORY

  • --proverNode.acvmWorkingDirectory <value> The working directory to use for simulation/proving Environment: $ACVM_WORKING_DIRECTORY

  • --proverNode.acvmBinaryPath <value> The path to the ACVM binary Environment: $ACVM_BINARY_PATH

  • --proverNode.bbWorkingDirectory <value> The working directory to use for proving Environment: $BB_WORKING_DIRECTORY

  • --proverNode.bbBinaryPath <value> The path to the bb binary Environment: $BB_BINARY_PATH

  • --proverNode.bbSkipCleanup <value> Whether to skip cleanup of bb temporary files Environment: $BB_SKIP_CLEANUP

  • --proverNode.numConcurrentIVCVerifiers <value> (default: 8) Max number of chonk verifiers to run concurrently Environment: $BB_NUM_IVC_VERIFIERS

  • --proverNode.bbIVCConcurrency <value> (default: 1) Number of threads to use for IVC verification Environment: $BB_IVC_CONCURRENCY

  • --proverNode.nodeUrl <value> The URL to the Aztec node to take proving jobs from Environment: $AZTEC_NODE_URL

  • --proverNode.proverId <value> Hex value that identifies the prover. Defaults to the address used for submitting proofs if not set. Environment: $PROVER_ID

  • --proverNode.failedProofStore <value> Store for failed proof inputs. Google cloud storage is only supported at the moment. Set this value as gs://bucket-name/path/to/store. Environment: $PROVER_FAILED_PROOF_STORE

  • --proverNode.publisherAllowInvalidStates <value> (default: true) True to use publishers in invalid states (timed out, cancelled, etc) if no other is available Environment: $PROVER_PUBLISHER_ALLOW_INVALID_STATES

  • --proverNode.publisherForwarderAddress <value> Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only) Environment: $PROVER_PUBLISHER_FORWARDER_ADDRESS

  • --proverNode.publisherPrivateKeys <value> The private keys to be used by the publisher. Environment: $PROVER_PUBLISHER_PRIVATE_KEYS

  • --proverNode.publisherAddresses <value> The addresses of the publishers to use with remote signers Environment: $PROVER_PUBLISHER_ADDRESSES

  • --proverNode.proverNodeMaxPendingJobs <value> (default: 10) The maximum number of pending jobs for the prover node Environment: $PROVER_NODE_MAX_PENDING_JOBS

  • --proverNode.proverNodePollingIntervalMs <value> (default: 1000) The interval in milliseconds to poll for new jobs Environment: $PROVER_NODE_POLLING_INTERVAL_MS

  • --proverNode.proverNodeMaxParallelBlocksPerEpoch <value> (default: 32) The Maximum number of blocks to process in parallel while proving an epoch Environment: $PROVER_NODE_MAX_PARALLEL_BLOCKS_PER_EPOCH

  • --proverNode.proverNodeFailedEpochStore <value> File store where to upload node state when an epoch fails to be proven Environment: $PROVER_NODE_FAILED_EPOCH_STORE

  • --proverNode.proverNodeEpochProvingDelayMs <value> Optional delay in milliseconds to wait before proving a new epoch

  • --proverNode.txGatheringIntervalMs <value> (default: 1000) How often to check that tx data is available Environment: $PROVER_NODE_TX_GATHERING_INTERVAL_MS

  • --proverNode.txGatheringBatchSize <value> (default: 10) How many transactions to gather from a node in a single request Environment: $PROVER_NODE_TX_GATHERING_BATCH_SIZE

  • --proverNode.txGatheringMaxParallelRequestsPerNode <value> (default: 100) How many tx requests to make in parallel to each node Environment: $PROVER_NODE_TX_GATHERING_MAX_PARALLEL_REQUESTS_PER_NODE

  • --proverNode.txGatheringTimeoutMs <value> (default: 120000) How long to wait for tx data to be available before giving up Environment: $PROVER_NODE_TX_GATHERING_TIMEOUT_MS

  • --proverNode.proverNodeDisableProofPublish <value> Whether the prover node skips publishing proofs to L1 Environment: $PROVER_NODE_DISABLE_PROOF_PUBLISH

PROVER BROKER

  • --prover-broker Starts Aztec proving job broker

  • --proverBroker.proverBrokerJobTimeoutMs <value> (default: 30000) Jobs are retried if not kept alive for this long Environment: $PROVER_BROKER_JOB_TIMEOUT_MS

  • --proverBroker.proverBrokerPollIntervalMs <value> (default: 1000) The interval to check job health status Environment: $PROVER_BROKER_POLL_INTERVAL_MS

  • --proverBroker.proverBrokerJobMaxRetries <value> (default: 3) If starting a prover broker locally, the max number of retries per proving job Environment: $PROVER_BROKER_JOB_MAX_RETRIES

  • --proverBroker.proverBrokerBatchSize <value> (default: 100) The prover broker writes jobs to disk in batches Environment: $PROVER_BROKER_BATCH_SIZE

  • --proverBroker.proverBrokerBatchIntervalMs <value> (default: 50) How often to flush batches to disk Environment: $PROVER_BROKER_BATCH_INTERVAL_MS

  • --proverBroker.proverBrokerMaxEpochsToKeepResultsFor <value> (default: 1) The maximum number of epochs to keep results for Environment: $PROVER_BROKER_MAX_EPOCHS_TO_KEEP_RESULTS_FOR

  • --proverBroker.proverBrokerStoreMapSizeKb <value> The size of the prover broker's database. Will override the dataStoreMapSizeKb if set. Environment: $PROVER_BROKER_STORE_MAP_SIZE_KB

PROVER AGENT

  • --prover-agent Starts Aztec Prover Agent with options

  • --proverAgent.proverAgentCount <value> (default: 1) Whether this prover has a local prover agent Environment: $PROVER_AGENT_COUNT

  • --proverAgent.proverAgentPollIntervalMs <value> (default: 1000) The interval agents poll for jobs at Environment: $PROVER_AGENT_POLL_INTERVAL_MS

  • --proverAgent.proverAgentProofTypes <value> The types of proofs the prover agent can generate Environment: $PROVER_AGENT_PROOF_TYPES

  • --proverAgent.proverBrokerUrl <value> The URL where this agent takes jobs from Environment: $PROVER_BROKER_HOST

  • --proverAgent.realProofs <value> (default: true) Whether to construct real proofs Environment: $PROVER_REAL_PROOFS

  • --proverAgent.proverTestDelayType <value> (default: fixed) The type of artificial delay to introduce Environment: $PROVER_TEST_DELAY_TYPE

  • --proverAgent.proverTestDelayMs <value> Artificial delay to introduce to all operations to the test prover. Environment: $PROVER_TEST_DELAY_MS

  • --proverAgent.proverTestDelayFactor <value> (default: 1) If using realistic delays, what percentage of realistic times to apply. Environment: $PROVER_TEST_DELAY_FACTOR

  • --proverAgent.proverTestVerificationDelayMs <value> (default: 10) The delay (ms) to inject during fake proof verification Environment: $PROVER_TEST_VERIFICATION_DELAY_MS

  • --p2p-enabled [value] Enable P2P subsystem Environment: $P2P_ENABLED

  • --p2p.p2pDiscoveryDisabled <value> A flag dictating whether the P2P discovery system should be disabled. Environment: $P2P_DISCOVERY_DISABLED

  • --p2p.blockCheckIntervalMS <value> (default: 100) The frequency in which to check for new L2 blocks. Environment: $P2P_BLOCK_CHECK_INTERVAL_MS

  • --p2p.debugDisableColocationPenalty <value> DEBUG: Disable colocation penalty - NEVER set to true in production Environment: $DEBUG_P2P_DISABLE_COLOCATION_PENALTY

  • --p2p.peerCheckIntervalMS <value> (default: 30000) The frequency in which to check for new peers. Environment: $P2P_PEER_CHECK_INTERVAL_MS

  • --p2p.l2QueueSize <value> (default: 1000) Size of queue of L2 blocks to store. Environment: $P2P_L2_QUEUE_SIZE

  • --p2p.listenAddress <value> (default: 0.0.0.0) The listen address. ipv4 address. Environment: $P2P_LISTEN_ADDR

  • --p2p.p2pPort <value> (default: 40400) The port for the P2P service. Defaults to 40400 Environment: $P2P_PORT

  • --p2p.p2pBroadcastPort <value> The port to broadcast the P2P service on (included in the node's ENR). Defaults to P2PPORT. _Environment: $P2P_BROADCAST_PORT

  • --p2p.p2pIp <value> The IP address for the P2P service. ipv4 address. Environment: $P2P_IP

  • --p2p.peerIdPrivateKey <value> An optional peer id private key. If blank, will generate a random key. Environment: $PEER_ID_PRIVATE_KEY

  • --p2p.peerIdPrivateKeyPath <value> An optional path to store generated peer id private keys. If blank, will default to storing any generated keys in the root of the data directory. Environment: $PEER_ID_PRIVATE_KEY_PATH

  • --p2p.bootstrapNodes <value> A list of bootstrap peer ENRs to connect to. Separated by commas. Environment: $BOOTSTRAP_NODES

  • --p2p.bootstrapNodeEnrVersionCheck <value> Whether to check the version of the bootstrap node ENR. Environment: $P2P_BOOTSTRAP_NODE_ENR_VERSION_CHECK

  • --p2p.bootstrapNodesAsFullPeers <value> Whether to consider our configured bootnodes as full peers Environment: $P2P_BOOTSTRAP_NODES_AS_FULL_PEERS

  • --p2p.maxPeerCount <value> (default: 100) The maximum number of peers to connect to. Environment: $P2P_MAX_PEERS

  • --p2p.queryForIp <value> If announceUdpAddress or announceTcpAddress are not provided, query for the IP address of the machine. Default is false. Environment: $P2P_QUERY_FOR_IP

  • --p2p.gossipsubInterval <value> (default: 700) The interval of the gossipsub heartbeat to perform maintenance tasks. Environment: $P2P_GOSSIPSUB_INTERVAL_MS

  • --p2p.gossipsubD <value> (default: 8) The D parameter for the gossipsub protocol. Environment: $P2P_GOSSIPSUB_D

  • --p2p.gossipsubDlo <value> (default: 4) The Dlo parameter for the gossipsub protocol. Environment: $P2P_GOSSIPSUB_DLO

  • --p2p.gossipsubDhi <value> (default: 12) The Dhi parameter for the gossipsub protocol. Environment: $P2P_GOSSIPSUB_DHI

  • --p2p.gossipsubDLazy <value> (default: 8) The Dlazy parameter for the gossipsub protocol. Environment: $P2P_GOSSIPSUB_DLAZY

  • --p2p.gossipsubFloodPublish <value> Whether to flood publish messages. - For testing purposes only Environment: $P2P_GOSSIPSUB_FLOOD_PUBLISH

  • --p2p.gossipsubMcacheLength <value> (default: 6) The number of gossipsub interval message cache windows to keep. Environment: $P2P_GOSSIPSUB_MCACHE_LENGTH

  • --p2p.gossipsubMcacheGossip <value> (default: 3) How many message cache windows to include when gossiping with other peers. Environment: $P2P_GOSSIPSUB_MCACHE_GOSSIP

  • --p2p.gossipsubSeenTTL <value> (default: 1200000) How long to keep message IDs in the seen cache. Environment: $P2P_GOSSIPSUB_SEEN_TTL

  • --p2p.gossipsubTxTopicWeight <value> (default: 1) The weight of the tx topic for the gossipsub protocol. Environment: $P2P_GOSSIPSUB_TX_TOPIC_WEIGHT

  • --p2p.gossipsubTxInvalidMessageDeliveriesWeight <value> (default: -20) The weight of the tx invalid message deliveries for the gossipsub protocol. Environment: $P2P_GOSSIPSUB_TX_INVALID_MESSAGE_DELIVERIES_WEIGHT

  • --p2p.gossipsubTxInvalidMessageDeliveriesDecay <value> (default: 0.5) Determines how quickly the penalty for invalid message deliveries decays over time. Between 0 and 1. Environment: $P2P_GOSSIPSUB_TX_INVALID_MESSAGE_DELIVERIES_DECAY

  • --p2p.peerPenaltyValues <value> (default: 2,10,50) The values for the peer scoring system. Passed as a comma separated list of values in order: low, mid, high tolerance errors. Environment: $P2P_PEER_PENALTY_VALUES

  • --p2p.doubleSpendSeverePeerPenaltyWindow <value> (default: 30) The "age" (in L2 blocks) of a tx after which we heavily penalize a peer for sending it. Environment: $P2P_DOUBLE_SPEND_SEVERE_PEER_PENALTY_WINDOW

  • --p2p.blockRequestBatchSize <value> (default: 20) The number of blocks to fetch in a single batch. Environment: $P2P_BLOCK_REQUEST_BATCH_SIZE

  • --p2p.archivedTxLimit <value> The number of transactions that will be archived. If the limit is set to 0 then archiving will be disabled. Environment: $P2P_ARCHIVED_TX_LIMIT

  • --p2p.trustedPeers <value> A list of trusted peer ENRs that will always be persisted. Separated by commas. Environment: $P2P_TRUSTED_PEERS

  • --p2p.privatePeers <value> A list of private peer ENRs that will always be persisted and not be used for discovery. Separated by commas. Environment: $P2P_PRIVATE_PEERS

  • --p2p.preferredPeers <value> A list of preferred peer ENRs that will always be persisted and not be used for discovery. Separated by commas. Environment: $P2P_PREFERRED_PEERS

  • --p2p.p2pStoreMapSizeKb <value> The maximum possible size of the P2P DB in KB. Overwrites the general dataStoreMapSizeKb. Environment: $P2P_STORE_MAP_SIZE_KB

  • --p2p.txPublicSetupAllowList <value> The list of functions calls allowed to run in setup Environment: $TX_PUBLIC_SETUP_ALLOWLIST

  • --p2p.maxTxPoolSize <value> (default: 100000000) The maximum cumulative tx size of pending txs (in bytes) before evicting lower priority txs. Environment: $P2P_MAX_TX_POOL_SIZE

  • --p2p.txPoolOverflowFactor <value> (default: 1.1) How much the tx pool can overflow before it starts evicting txs. Must be greater than 1 Environment: $P2P_TX_POOL_OVERFLOW_FACTOR

  • --p2p.seenMessageCacheSize <value> (default: 100000) The number of messages to keep in the seen message cache Environment: $P2P_SEEN_MSG_CACHE_SIZE

  • --p2p.p2pDisableStatusHandshake <value> True to disable the status handshake on peer connected. Environment: $P2P_DISABLE_STATUS_HANDSHAKE

  • --p2p.p2pAllowOnlyValidators <value> True to only permit validators to connect. Environment: $P2P_ALLOW_ONLY_VALIDATORS

  • --p2p.p2pMaxFailedAuthAttemptsAllowed <value> (default: 3) Number of auth attempts to allow before peer is banned. Number is inclusive Environment: $P2P_MAX_AUTH_FAILED_ATTEMPTS_ALLOWED

  • --p2p.dropTransactions <value> True to simulate discarding transactions. - For testing purposes only Environment: $P2P_DROP_TX

  • --p2p.dropTransactionsProbability <value> The probability that a transaction is discarded (0 - 1). - For testing purposes only Environment: $P2P_DROP_TX_CHANCE

  • --p2p.disableTransactions <value> Whether transactions are disabled for this node. This means transactions will be rejected at the RPC and P2P layers. Environment: $TRANSACTIONS_DISABLED

  • --p2p.txPoolDeleteTxsAfterReorg <value> Whether to delete transactions from the pool after a reorg instead of moving them back to pending. Environment: $P2P_TX_POOL_DELETE_TXS_AFTER_REORG

  • --p2p.debugP2PInstrumentMessages <value> Alters the format of p2p messages to include things like broadcast timestamp FOR TESTING ONLY Environment: $DEBUG_P2P_INSTRUMENT_MESSAGES

  • --p2p.overallRequestTimeoutMs <value> (default: 10000) The overall timeout for a request response operation. Environment: $P2P_REQRESP_OVERALL_REQUEST_TIMEOUT_MS

  • --p2p.individualRequestTimeoutMs <value> (default: 10000) The timeout for an individual request response peer interaction. Environment: $P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS

  • --p2p.dialTimeoutMs <value> (default: 5000) How long to wait for the dial protocol to establish a connection Environment: $P2P_REQRESP_DIAL_TIMEOUT_MS

  • --p2p.p2pOptimisticNegotiation <value> Whether to use optimistic protocol negotiation when dialing to another peer (opposite of negotiateFully). Environment: $P2P_REQRESP_OPTIMISTIC_NEGOTIATION

  • --p2p.txCollectionFastNodesTimeoutBeforeReqRespMs <value> (default: 200) How long to wait before starting reqresp for fast collection Environment: $TX_COLLECTION_FAST_NODES_TIMEOUT_BEFORE_REQ_RESP_MS

  • --p2p.txCollectionSlowNodesIntervalMs <value> (default: 12000) How often to collect from configured nodes in the slow collection loop Environment: $TX_COLLECTION_SLOW_NODES_INTERVAL_MS

  • --p2p.txCollectionSlowReqRespIntervalMs <value> (default: 12000) How often to collect from peers via reqresp in the slow collection loop Environment: $TX_COLLECTION_SLOW_REQ_RESP_INTERVAL_MS

  • --p2p.txCollectionSlowReqRespTimeoutMs <value> (default: 20000) How long to wait for a reqresp response during slow collection Environment: $TX_COLLECTION_SLOW_REQ_RESP_TIMEOUT_MS

  • --p2p.txCollectionReconcileIntervalMs <value> (default: 60000) How often to reconcile found txs from the tx pool Environment: $TX_COLLECTION_RECONCILE_INTERVAL_MS

  • --p2p.txCollectionDisableSlowDuringFastRequests <value> (default: true) Whether to disable the slow collection loop if we are dealing with any immediate requests Environment: $TX_COLLECTION_DISABLE_SLOW_DURING_FAST_REQUESTS

  • --p2p.txCollectionFastNodeIntervalMs <value> (default: 500) How many ms to wait between retried request to a node via RPC during fast collection Environment: $TX_COLLECTION_FAST_NODE_INTERVAL_MS

  • --p2p.txCollectionNodeRpcUrls <value> A comma-separated list of Aztec node RPC URLs to use for tx collection Environment: $TX_COLLECTION_NODE_RPC_URLS

  • --p2p.txCollectionFastMaxParallelRequestsPerNode <value> (default: 4) Maximum number of parallel requests to make to a node during fast collection Environment: $TX_COLLECTION_FAST_MAX_PARALLEL_REQUESTS_PER_NODE

  • --p2p.txCollectionNodeRpcMaxBatchSize <value> (default: 50) Maximum number of transactions to request from a node in a single batch Environment: $TX_COLLECTION_NODE_RPC_MAX_BATCH_SIZE

  • --p2p-bootstrap Starts Aztec P2P Bootstrap with options

  • --p2pBootstrap.p2pBroadcastPort <value> The port to broadcast the P2P service on (included in the node's ENR). Defaults to P2PPORT. _Environment: $P2P_BROADCAST_PORT

  • --p2pBootstrap.peerIdPrivateKeyPath <value> An optional path to store generated peer id private keys. If blank, will default to storing any generated keys in the root of the data directory. Environment: $PEER_ID_PRIVATE_KEY_PATH

  • --p2pBootstrap.queryForIp <value> If announceUdpAddress or announceTcpAddress are not provided, query for the IP address of the machine. Default is false. Environment: $P2P_QUERY_FOR_IP

TELEMETRY

  • --tel.metricsCollectorUrl <value> The URL of the telemetry collector for metrics Environment: $OTEL_EXPORTER_OTLP_METRICS_ENDPOINT

  • --tel.tracesCollectorUrl <value> The URL of the telemetry collector for traces Environment: $OTEL_EXPORTER_OTLP_TRACES_ENDPOINT

  • --tel.logsCollectorUrl <value> The URL of the telemetry collector for logs Environment: $OTEL_EXPORTER_OTLP_LOGS_ENDPOINT

  • --tel.otelCollectIntervalMs <value> (default: 60000) The interval at which to collect metrics Environment: $OTEL_COLLECT_INTERVAL_MS

  • --tel.otelExportTimeoutMs <value> (default: 30000) The timeout for exporting metrics Environment: $OTEL_EXPORT_TIMEOUT_MS

  • --tel.otelExcludeMetrics <value> A list of metric prefixes to exclude from export Environment: $OTEL_EXCLUDE_METRICS

  • --tel.otelIncludeMetrics <value> A list of metric prefixes to include in export (ignored if OTELEXCLUDE_METRICS is set) _Environment: $OTEL_INCLUDE_METRICS

  • --tel.publicMetricsCollectorUrl <value> A URL to publish a subset of metrics for public consumption Environment: $PUBLIC_OTEL_EXPORTER_OTLP_METRICS_ENDPOINT

  • --tel.publicMetricsCollectFrom <value> The role types to collect metrics from Environment: $PUBLIC_OTEL_COLLECT_FROM

  • --tel.publicIncludeMetrics <value> A list of metric prefixes to publicly export Environment: $PUBLIC_OTEL_INCLUDE_METRICS

  • --tel.publicMetricsOptOut <value> (default: true) Whether to opt out of sharing optional telemetry Environment: $PUBLIC_OTEL_OPT_OUT

BOT

  • --bot Starts Aztec Bot with options

  • --bot.nodeUrl <value> The URL to the Aztec node to check for tx pool status. Environment: $AZTEC_NODE_URL

  • --bot.nodeAdminUrl <value> The URL to the Aztec node admin API to force-flush txs if configured. Environment: $AZTEC_NODE_ADMIN_URL

  • --bot.l1Mnemonic <value> The mnemonic for the account to bridge fee juice from L1. Environment: $BOT_L1_MNEMONIC

  • --bot.l1PrivateKey <value> The private key for the account to bridge fee juice from L1. Environment: $BOT_L1_PRIVATE_KEY

  • --bot.l1ToL2MessageTimeoutSeconds <value> (default: 3600) How long to wait for L1 to L2 messages to become available on L2 Environment: $BOT_L1_TO_L2_TIMEOUT_SECONDS

  • --bot.senderPrivateKey <value> Signing private key for the sender account. Environment: $BOT_PRIVATE_KEY

  • --bot.senderSalt <value> The salt to use to deploy the sender account. Environment: $BOT_ACCOUNT_SALT

  • --bot.tokenSalt <value> (default: 0x0000000000000000000000000000000000000000000000000000000000000001) The salt to use to deploy the token contract. Environment: $BOT_TOKEN_SALT

  • --bot.txIntervalSeconds <value> (default: 60) Every how many seconds should a new tx be sent. Environment: $BOT_TX_INTERVAL_SECONDS

  • --bot.privateTransfersPerTx <value> (default: 1) How many private token transfers are executed per tx. Environment: $BOT_PRIVATE_TRANSFERS_PER_TX

  • --bot.publicTransfersPerTx <value> (default: 1) How many public token transfers are executed per tx. Environment: $BOT_PUBLIC_TRANSFERS_PER_TX

  • --bot.feePaymentMethod <value> (default: fee_juice) How to handle fee payments. (Options: feejuice) _Environment: $BOT_FEE_PAYMENT_METHOD

  • --bot.minFeePadding <value> (default: 3) How much is the bot willing to overpay vs. the current min fee Environment: $BOT_MIN_FEE_PADDING

  • --bot.noStart <value> True to not automatically setup or start the bot on initialization. Environment: $BOT_NO_START

  • --bot.txMinedWaitSeconds <value> (default: 180) How long to wait for a tx to be mined before reporting an error. Environment: $BOT_TX_MINED_WAIT_SECONDS

  • --bot.followChain <value> (default: NONE) Which chain the bot follows Environment: $BOT_FOLLOW_CHAIN

  • --bot.maxPendingTxs <value> (default: 128) Do not send a tx if the node's tx pool already has this many pending txs. Environment: $BOT_MAX_PENDING_TXS

  • --bot.flushSetupTransactions <value> Make a request for the sequencer to build a block after each setup transaction. Environment: $BOT_FLUSH_SETUP_TRANSACTIONS

  • --bot.l2GasLimit <value> L2 gas limit for the tx (empty to have the bot trigger an estimate gas). Environment: $BOT_L2_GAS_LIMIT

  • --bot.daGasLimit <value> DA gas limit for the tx (empty to have the bot trigger an estimate gas). Environment: $BOT_DA_GAS_LIMIT

  • --bot.contract <value> (default: TokenContract) Token contract to use Environment: $BOT_TOKEN_CONTRACT

  • --bot.maxConsecutiveErrors <value> The maximum number of consecutive errors before the bot shuts down Environment: $BOT_MAX_CONSECUTIVE_ERRORS

  • --bot.stopWhenUnhealthy <value> Stops the bot if service becomes unhealthy Environment: $BOT_STOP_WHEN_UNHEALTHY

  • --bot.ammTxs <value> Deploy an AMM and send swaps to it Environment: $BOT_AMM_TXS

PXE

  • --pxe Starts Aztec PXE with options

  • --pxe.l2BlockBatchSize <value> (default: 50) Maximum amount of blocks to pull from the stream in one request when synchronizing Environment: $PXE_L2_BLOCK_BATCH_SIZE

  • --pxe.proverEnabled <value> (default: true) Enable real proofs Environment: $PXE_PROVER_ENABLED

  • --pxe.nodeUrl <value> Custom Aztec Node URL to connect to Environment: $AZTEC_NODE_URL

TXE

  • --txe Starts Aztec TXE with options

aztec test​

Run the tests for this program

Usage: nargo test [OPTIONS] [TEST_NAMES]...

Arguments:
  [TEST_NAMES]...
          If given, only tests with names containing this string will be run

Options:
      --show-output
          Display output of `println` statements

      --exact
          Only run tests that match exactly

      --package <PACKAGE>
          The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory

      --workspace
          Run on all packages in the workspace

      --expression-width <EXPRESSION_WIDTH>
          Specify the backend expression width that should be targeted

      --bounded-codegen
          Generate ACIR with the target backend expression width. The default is to generate ACIR without a bound and split expressions after code generation. Activating this flag can sometimes provide optimizations for certain programs

      --force
          Force a full recompilation

      --print-acir
          Display the ACIR for compiled circuit

      --deny-warnings
          Treat all warnings as errors

      --silence-warnings
          Suppress warnings

      --debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>
          Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "package_name/src/main.nr"

      --skip-underconstrained-check
          Flag to turn off the compiler check for under constrained values. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code

      --skip-brillig-constraints-check
          Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code

      --count-array-copies
          Count the number of arrays that are copied in an unconstrained context for performance debugging

      --enable-brillig-constraints-check-lookback
          Flag to turn on the lookback feature of the Brillig call constraints check, allowing tracking argument values before the call happens preventing certain rare false positives (leads to a slowdown on large rollout functions)

      --inliner-aggressiveness <INLINER_AGGRESSIVENESS>
          Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs

          [default: 9223372036854775807]

      --pedantic-solving
          Use pedantic ACVM solving, i.e. double-check some black-box function assumptions when solving. This is disabled by default

  -Z, --unstable-features <UNSTABLE_FEATURES>
          Unstable features to enable for this current build.

          If non-empty, it disables unstable features required in crate manifests.

      --no-unstable-features
          Disable any unstable features required in crate manifests

      --oracle-resolver <ORACLE_RESOLVER>
          JSON RPC url to solve oracle calls

      --test-threads <TEST_THREADS>
          Number of threads used for running tests in parallel

          [default: 14]

      --format <FORMAT>
          Configure formatting of output

          Possible values:
          - pretty: Print verbose output
          - terse:  Display one character per test
          - json:   Output a JSON Lines document

  -q, --quiet
          Display one character per test instead of one line

      --no-fuzz
          Do not run fuzz tests (tests that have arguments)

      --only-fuzz
          Only run fuzz tests (tests that have arguments)

      --corpus-dir <CORPUS_DIR>
          If given, load/store fuzzer corpus from this folder

      --minimized-corpus-dir <MINIMIZED_CORPUS_DIR>
          If given, perform corpus minimization instead of fuzzing and store results in the given folder

      --fuzzing-failure-dir <FUZZING_FAILURE_DIR>
          If given, store the failing input in the given folder

      --fuzz-timeout <FUZZ_TIMEOUT>
          Maximum time in seconds to spend fuzzing (default: 1 seconds)

          [default: 1]

      --fuzz-max-executions <FUZZ_MAX_EXECUTIONS>
          Maximum number of executions to run for each fuzz test (default: 100000)

          [default: 100000]

      --fuzz-show-progress
          Show progress of fuzzing (default: false)

  -h, --help
          Print help (see a summary with '-h')

aztec trigger-seed-snapshot​

Usage: aztec trigger-seed-snapshot [options]

Triggers a seed snapshot for the next epoch.

Options:
  -pk, --private-key <string>  The private key to use for deployment
  -m, --mnemonic <string>      The mnemonic to use in deployment (default:
                               "test test test test test test test test test
                               test test junk")
  --rollup <address>           ethereum address of the rollup contract
  --l1-rpc-urls <string>       List of Ethereum host URLs. Chain identifiers
                               localhost and testnet can be used (comma
                               separated) (default:
                               ["http://host.docker.internal:8545"], env:
                               ETHEREUM_HOSTS)
  -c, --l1-chain-id <number>   Chain ID of the ethereum host (default: 31337,
                               env: L1_CHAIN_ID)
  -h, --help                   display help for command

aztec update​

Usage: aztec update [options] [projectPath]

Updates Nodejs and Noir dependencies

Arguments:
  projectPath               Path to the project directory

Options:
  --contract [paths...]     Paths to contracts to update dependencies (default:
                            [])
  --aztec-version <semver>  The version to update Aztec packages to. Defaults
                            to latest (default: "latest")
  -h, --help                display help for command

aztec validator-keys|valKeys​

This subcommand does not provide its own help information.

aztec vote-on-governance-proposal​

Usage: aztec vote-on-governance-proposal [options]

Votes on a governance proposal.

Options:
  -p, --proposal-id <string>       The ID of the proposal
  -a, --vote-amount <string>       The amount of tokens to vote
  --in-favor <boolean>             Whether to vote in favor of the proposal.
                                   Use "yea" for true, any other value for
                                   false.
  --wait <boolean>                 Whether to wait until the proposal is active
  -r, --registry-address <string>  The address of the registry contract
  --l1-rpc-urls <string>           List of Ethereum host URLs. Chain
                                   identifiers localhost and testnet can be
                                   used (comma separated) (default:
                                   ["http://host.docker.internal:8545"], env:
                                   ETHEREUM_HOSTS)
  -c, --l1-chain-id <number>       Chain ID of the ethereum host (default:
                                   31337, env: L1_CHAIN_ID)
  -pk, --private-key <string>      The private key to use to vote
  -m, --mnemonic <string>          The mnemonic to use to vote (default: "test
                                   test test test test test test test test test
                                   test junk")
  -i, --mnemonic-index <number>    The index of the mnemonic to use to vote
                                   (default: 0)
  -h, --help                       display help for command