From e1105e3685be91da81d81bce1581eb53b6d81e3b Mon Sep 17 00:00:00 2001 From: Esau Date: Fri, 2 Jan 2026 23:03:15 +0800 Subject: [PATCH] init --- .github/workflows/nightly-docs-release.yml | 41 + .github/workflows/release-please.yml | 64 +- .../docs/cli/aztec_cli_reference.md | 2648 ++++++----------- .../docs/cli/bb_cli_reference.md | 4 +- .../docs/cli/aztec_cli_reference.md | 2648 ++++++----------- .../docs/cli/bb_cli_reference.md | 4 +- .../cli_reference_generation/cli_config.sh | 94 +- .../cli_docs_config.json | 51 + .../generate_all_cli_docs.sh | 314 ++ .../update_cli_docs.sh | 2 +- 10 files changed, 2322 insertions(+), 3548 deletions(-) create mode 100644 docs/scripts/cli_reference_generation/cli_docs_config.json create mode 100755 docs/scripts/cli_reference_generation/generate_all_cli_docs.sh diff --git a/.github/workflows/nightly-docs-release.yml b/.github/workflows/nightly-docs-release.yml index aa9c13b328d7..279150a78100 100644 --- a/.github/workflows/nightly-docs-release.yml +++ b/.github/workflows/nightly-docs-release.yml @@ -127,6 +127,44 @@ jobs: ./scripts/aztec_nr_docs_generation/generate_aztec_nr_docs.sh ${{ env.NIGHTLY_TAG }} echo "Generated Aztec.nr API docs for: ${{ env.NIGHTLY_TAG }}" + - name: Download bb from GitHub release + env: + GH_TOKEN: ${{ secrets.AZTEC_BOT_GITHUB_TOKEN }} + run: | + mkdir -p /tmp/bb-bin + gh release download ${{ env.NIGHTLY_TAG }} \ + --pattern "barretenberg-amd64-linux.tar.gz" \ + --dir /tmp/bb-bin + tar -xzf /tmp/bb-bin/barretenberg-amd64-linux.tar.gz -C /tmp/bb-bin + chmod +x /tmp/bb-bin/bb + echo "BB_PATH=/tmp/bb-bin" >> $GITHUB_ENV + + - name: Build aztec CLI + working-directory: ./yarn-project + run: | + ./bootstrap.sh + echo "AZTEC_CLI_PATH=$(pwd)/aztec/dest/bin" >> $GITHUB_ENV + + - name: Generate CLI documentation + working-directory: ./docs + continue-on-error: true + run: | + # Add bb from release to PATH + export PATH="${BB_PATH}:${PATH}" + + # Create wrapper for aztec CLI that runs the local build + mkdir -p /tmp/cli-bin + cat > /tmp/cli-bin/aztec << 'EOF' + #!/bin/bash + node "$AZTEC_CLI_PATH/index.js" "$@" + EOF + chmod +x /tmp/cli-bin/aztec + export PATH="/tmp/cli-bin:${PATH}" + + # Generate CLI docs using binaries (continue-on-error handles failures) + ./scripts/cli_reference_generation/generate_all_cli_docs.sh --skip-version-check + echo "CLI documentation generation attempted for: ${{ env.NIGHTLY_TAG }}" + - name: Create Aztec nightly docs version (Developer docs only) working-directory: ./docs run: | @@ -180,6 +218,9 @@ jobs: - name: Commit new Aztec and Barretenberg Docs version run: | + # Reset non-versioned CLI docs (only versioned copies should be committed) + git checkout -- docs/docs-developers/docs/cli/*_cli_reference.md || true + # Stash the docs changes git add . git stash push --staged -m "nightly docs for ${{ env.NIGHTLY_TAG }}" diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 13dc4c85a485..3f866889a8ff 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml @@ -20,12 +20,35 @@ jobs: release-pr: ${{ steps.release.outputs.pr }} release-version: ${{ steps.release.outputs.tag_name }} steps: + - name: Checkout to check config files + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 + with: + sparse-checkout: .github + token: ${{ secrets.AZTEC_BOT_GITHUB_TOKEN }} + + - name: Determine release-please config + id: config + run: | + BRANCH_CONFIG=".github/release-please-${{ github.ref_name }}.json" + DEFAULT_CONFIG=".github/release-please.json" + + if [[ -f "$BRANCH_CONFIG" ]]; then + echo "Using branch-specific config: $BRANCH_CONFIG" + echo "config-file=$BRANCH_CONFIG" >> $GITHUB_OUTPUT + elif [[ -f "$DEFAULT_CONFIG" ]]; then + echo "Branch config not found, using default: $DEFAULT_CONFIG" + echo "config-file=$DEFAULT_CONFIG" >> $GITHUB_OUTPUT + else + echo "::error::No release-please config found. Expected $BRANCH_CONFIG or $DEFAULT_CONFIG" + exit 1 + fi + - name: Run Release Please id: release uses: googleapis/release-please-action@7d28262f14160787a44a6be36146a18e6f575a3f with: token: ${{ secrets.AZTEC_BOT_GITHUB_TOKEN }} - config-file: .github/release-please-${{ github.ref_name }}.json + config-file: ${{ steps.config.outputs.config-file }} target-branch: ${{ github.ref_name }} auto-tag: @@ -79,10 +102,12 @@ jobs: exit 1 fi - if [[ "$MANIFEST_VERSION" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)$ ]]; then + # Accept stable versions (X.Y.Z) and prerelease versions (X.Y.Z-suffix.N) + if [[ "$MANIFEST_VERSION" =~ ^([0-9]+)\.([0-9]+)\.([0-9]+)(-[a-zA-Z0-9.]+)?$ ]]; then NEXT_VERSION="$MANIFEST_VERSION" else - echo "Error: Invalid manifest version format" + echo "Error: Invalid manifest version format: $MANIFEST_VERSION" + echo "Expected: X.Y.Z or X.Y.Z-prerelease.N" exit 1 fi @@ -179,6 +204,37 @@ jobs: ./scripts/aztec_nr_docs_generation/generate_aztec_nr_docs.sh ${{ steps.version.outputs.semver }} echo "Generated Aztec.nr API docs for: ${{ steps.version.outputs.semver }}" + - name: Build bb (uses cache if available) + working-directory: ./barretenberg/cpp + run: | + ./bootstrap.sh build_native + echo "BB_PATH=$(pwd)/build/bin" >> $GITHUB_ENV + + - name: Build aztec CLI + working-directory: ./yarn-project + run: | + ./bootstrap.sh + echo "AZTEC_CLI_PATH=$(pwd)/aztec/dest/bin" >> $GITHUB_ENV + + - name: Generate CLI documentation + working-directory: ./docs + run: | + # Add locally built binaries to PATH + export PATH="${BB_PATH}:${PATH}" + + # Create wrapper for aztec CLI that runs the local build + mkdir -p /tmp/cli-bin + cat > /tmp/cli-bin/aztec << 'EOF' + #!/bin/bash + node "$AZTEC_CLI_PATH/index.js" "$@" + EOF + chmod +x /tmp/cli-bin/aztec + export PATH="/tmp/cli-bin:${PATH}" + + # Generate CLI docs using locally built binaries + ./scripts/cli_reference_generation/generate_all_cli_docs.sh + echo "Generated CLI documentation for: ${{ steps.version.outputs.semver }}" + - name: Cut Aztec Developer Docs version working-directory: ./docs run: | @@ -207,6 +263,8 @@ jobs: - name: Commit new Aztec Docs version run: | + # Reset non-versioned CLI docs (only versioned copies should be committed) + git checkout -- docs/docs-developers/docs/cli/*_cli_reference.md || true git add . git commit -m "chore(docs): cut new aztec docs version for tag ${{ steps.version.outputs.semver }}" git push diff --git a/docs/developer_versioned_docs/version-v3.0.0-nightly.20260101/docs/cli/aztec_cli_reference.md b/docs/developer_versioned_docs/version-v3.0.0-nightly.20260101/docs/cli/aztec_cli_reference.md index 6c6461a82b1d..da407481e10a 100644 --- a/docs/developer_versioned_docs/version-v3.0.0-nightly.20260101/docs/cli/aztec_cli_reference.md +++ b/docs/developer_versioned_docs/version-v3.0.0-nightly.20260101/docs/cli/aztec_cli_reference.md @@ -1,6 +1,6 @@ --- title: Aztec CLI Reference -description: Comprehensive auto-generated reference for the Aztec CLI Reference command-line interface with all commands and options. +description: Comprehensive auto-generated reference for the Aztec CLI command-line interface with all commands and options. tags: [cli, reference, autogenerated] sidebar_position: 1 --- @@ -10,7 +10,7 @@ sidebar_position: 1 *This documentation is auto-generated from the `aztec` CLI help output.* -*Generated: Wed 24 Dec 2025 17:46:59 UTC* +*Generated: Thu 01 Jan 2026 11:01:00 UTC* *Command: `aztec`* @@ -21,17 +21,29 @@ sidebar_position: 1 - [aztec add-l1-validator](#aztec-add-l1-validator) - [aztec advance-epoch](#aztec-advance-epoch) - [aztec authorize-action](#aztec-authorize-action) + - [aztec authorize-action functionName](#aztec-authorize-action-functionname) + - [aztec authorize-action caller](#aztec-authorize-action-caller) - [aztec block-number](#aztec-block-number) - [aztec bridge-erc20](#aztec-bridge-erc20) + - [aztec bridge-erc20 amount](#aztec-bridge-erc20-amount) + - [aztec bridge-erc20 recipient](#aztec-bridge-erc20-recipient) - [aztec bridge-fee-juice](#aztec-bridge-fee-juice) + - [aztec bridge-fee-juice amount](#aztec-bridge-fee-juice-amount) + - [aztec bridge-fee-juice recipient](#aztec-bridge-fee-juice-recipient) - [aztec cancel-tx](#aztec-cancel-tx) - [aztec codegen](#aztec-codegen) + - [aztec codegen noir-abi-path](#aztec-codegen-noir-abi-path) - [aztec compute-selector](#aztec-compute-selector) + - [aztec compute-selector functionSignature](#aztec-compute-selector-functionsignature) - [aztec create-account](#aztec-create-account) - [aztec create-authwit](#aztec-create-authwit) + - [aztec create-authwit functionName](#aztec-create-authwit-functionname) + - [aztec create-authwit caller](#aztec-create-authwit-caller) - [aztec debug-rollup](#aztec-debug-rollup) - [aztec decode-enr](#aztec-decode-enr) + - [aztec decode-enr enr](#aztec-decode-enr-enr) - [aztec deploy](#aztec-deploy) + - [aztec deploy artifact](#aztec-deploy-artifact) - [aztec deploy-account](#aztec-deploy-account) - [aztec deploy-l1-contracts](#aztec-deploy-l1-contracts) - [aztec deploy-new-rollup](#aztec-deploy-new-rollup) @@ -41,40 +53,59 @@ sidebar_position: 1 - [aztec fast-forward-epochs](#aztec-fast-forward-epochs) - [aztec generate-bls-keypair](#aztec-generate-bls-keypair) - [aztec generate-bootnode-enr](#aztec-generate-bootnode-enr) + - [aztec generate-bootnode-enr privateKey](#aztec-generate-bootnode-enr-privatekey) + - [aztec generate-bootnode-enr p2pIp](#aztec-generate-bootnode-enr-p2pip) + - [aztec generate-bootnode-enr p2pPort](#aztec-generate-bootnode-enr-p2pport) - [aztec generate-keys](#aztec-generate-keys) - [aztec generate-l1-account](#aztec-generate-l1-account) - [aztec generate-p2p-private-key](#aztec-generate-p2p-private-key) - [aztec generate-secret-and-hash](#aztec-generate-secret-and-hash) - [aztec get-account](#aztec-get-account) + - [aztec get-account address](#aztec-get-account-address) - [aztec get-accounts](#aztec-get-accounts) - [aztec get-block](#aztec-get-block) + - [aztec get-block blockNumber](#aztec-get-block-blocknumber) - [aztec get-canonical-sponsored-fpc-address](#aztec-get-canonical-sponsored-fpc-address) - [aztec get-contract-data](#aztec-get-contract-data) + - [aztec get-contract-data contractAddress](#aztec-get-contract-data-contractaddress) - [aztec get-current-base-fee](#aztec-get-current-base-fee) - [aztec get-l1-addresses](#aztec-get-l1-addresses) - [aztec get-l1-balance](#aztec-get-l1-balance) + - [aztec get-l1-balance who](#aztec-get-l1-balance-who) - [aztec get-l1-to-l2-message-witness](#aztec-get-l1-to-l2-message-witness) - [aztec get-logs](#aztec-get-logs) - [aztec get-node-info](#aztec-get-node-info) - [aztec get-pxe-info](#aztec-get-pxe-info) - [aztec get-tx](#aztec-get-tx) + - [aztec get-tx txHash](#aztec-get-tx-txhash) - [aztec import-test-accounts](#aztec-import-test-accounts) - [aztec inspect-contract](#aztec-inspect-contract) + - [aztec inspect-contract contractArtifactFile](#aztec-inspect-contract-contractartifactfile) - [aztec parse-parameter-struct](#aztec-parse-parameter-struct) + - [aztec parse-parameter-struct encodedString](#aztec-parse-parameter-struct-encodedstring) - [aztec preload-crs](#aztec-preload-crs) - [aztec profile](#aztec-profile) + - [aztec profile functionName](#aztec-profile-functionname) - [aztec propose-with-lock](#aztec-propose-with-lock) - [aztec prune-rollup](#aztec-prune-rollup) - [aztec register-contract](#aztec-register-contract) + - [aztec register-contract address](#aztec-register-contract-address) + - [aztec register-contract artifact](#aztec-register-contract-artifact) - [aztec register-sender](#aztec-register-sender) + - [aztec register-sender address](#aztec-register-sender-address) - [aztec remove-l1-validator](#aztec-remove-l1-validator) - [aztec send](#aztec-send) + - [aztec send functionName](#aztec-send-functionname) - [aztec sequencers](#aztec-sequencers) + - [aztec sequencers command](#aztec-sequencers-command) + - [aztec sequencers who](#aztec-sequencers-who) - [aztec setup-protocol-contracts](#aztec-setup-protocol-contracts) - [aztec simulate](#aztec-simulate) + - [aztec simulate functionName](#aztec-simulate-functionname) - [aztec start](#aztec-start) - [aztec trigger-seed-snapshot](#aztec-trigger-seed-snapshot) - [aztec update](#aztec-update) + - [aztec update projectPath](#aztec-update-projectpath) - [aztec validator-keys|valKeys](#aztec-validator-keys|valkeys) - [aztec vote-on-governance-proposal](#aztec-vote-on-governance-proposal) ## aztec @@ -160,2221 +191,1351 @@ aztec [options] [command] ### aztec add-contract -``` -Usage: aztec add-contract [options] - Adds an existing contract to the PXE. This is useful if you have deployed a -contract outside of the PXE and want to use it with the PXE. - -Options: - -c, --contract-artifact A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js - -ca, --contract-address
Aztec address of the contract. - --init-hash Initialization hash - --salt Optional deployment salt - -p, --public-key Optional public key for this contract - --portal-address
Optional address to a portal contract on L1 - --deployer-address
Optional address of the contract deployer - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command - -``` - -### 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 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 Network to execute against (env: NETWORK) - -pk, --private-key The private key to use sending the transaction - -m, --mnemonic The mnemonic to use sending the transaction - (default: "test test test test test test test - test test test test junk") - -c, --l1-chain-id Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - --attester
ethereum address of the attester - --withdrawer
ethereum address of the withdrawer - --bls-secret-key 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 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 List of Ethereum host URLs. Chain identifiers - localhost and testnet can be used (comma separated) - (default: ["http://host.docker.internal:8545"], env: - ETHEREUM_HOSTS) - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command - -``` - -### aztec authorize-action - -``` -Usage: aztec authorize-action [options] - -Authorizes a public call on the caller, so they can perform an action on behalf -of the provided account - -Arguments: - functionName Name of function to authorize - caller Account to be authorized to perform the action - -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Function arguments (default: []) - -ca, --contract-address
Aztec address of the contract. - -c, --contract-artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - -h, --help display help for command - -``` - -### aztec block-number - -``` -Usage: aztec block-number [options] - -Gets the current Aztec L2 block number. - -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command - -``` - -### aztec bridge-erc20 - -``` -Usage: aztec bridge-erc20 [options] - -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 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 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 Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - -t, --token The address of the token to bridge - -p, --portal The address of the portal contract - -f, --faucet The address of the faucet contract (only used if - minting) - --l1-private-key The private key to use for deployment - --json Output the claim in JSON format - -h, --help display help for command - -``` - -### aztec bridge-fee-juice - -``` -Usage: aztec bridge-fee-juice [options] - -Mints L1 Fee Juice and pushes them to L2. - -Arguments: - amount The amount of Fee Juice to mint and bridge. - recipient Aztec address of the recipient. - -Options: - --l1-rpc-urls List of Ethereum host URLs. Chain identifiers - localhost and testnet can be used (comma - separated) (default: - ["http://host.docker.internal:8545"]) - -m, --mnemonic 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) - --l1-private-key The private key to the eth account bridging - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -c, --l1-chain-id Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - --json Output the claim in JSON format - --no-wait Wait for the bridged funds to be available in L2, - polling every 60 seconds - --interval The polling interval in seconds for the bridged - funds (default: "60") - -h, --help display help for command +**Usage:** +```bash +aztec add-contract [options] ``` -### aztec cancel-tx - -*Help for this command is currently unavailable due to a technical issue with option serialization.* - - -### aztec codegen - -``` -Usage: aztec codegen [options] +**Options:** -Validates and generates an Aztec Contract ABI from Noir ABI. +- `-c --contract-artifact ` - A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js +- `-ca --contract-address
` - Aztec address of the contract. +- `--init-hash ` - Initialization hash +- `--salt ` - Optional deployment salt +- `-p --public-key ` - Optional public key for this contract +- `--portal-address
` - Optional address to a portal contract on L1 +- `--deployer-address
` - Optional address of the contract deployer +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `-h --help` - display help for command -Arguments: - noir-abi-path Path to the Noir ABI or project dir. +### aztec add-l1-validator -Options: - -o, --outdir Output folder for the generated code. - -f, --force Force code generation even when the contract has not - changed. - -h, --help display help for command +Adds a validator to the L1 rollup contract via a direct deposit. +**Usage:** +```bash +aztec add-l1-validator [options] ``` -### aztec compute-selector - -``` -Usage: aztec compute-selector [options] +**Options:** -Given a function signature, it computes a selector +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `--network ` - Network to execute against (env: NETWORK) +- `-pk --private-key ` - The private key to use sending the transaction +- `-m --mnemonic ` - The mnemonic to use sending the transaction +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--attester
` - ethereum address of the attester +- `--withdrawer
` - ethereum address of the withdrawer +- `--bls-secret-key ` - The BN254 scalar field element used as a secret +- `--move-with-latest-rollup` - Whether to move with the latest rollup (default: +- `--rollup ` - Rollup contract address +- `-h --help` - display help for command -Arguments: - functionSignature Function signature to compute selector for e.g. foo(Field) +### aztec advance-epoch -Options: - -h, --help display help for command +Use L1 cheat codes to warp time until the next epoch. +**Usage:** +```bash +aztec advance-epoch [options] ``` -### aztec create-account - -``` -Usage: aztec create-account [options] +**Options:** -Creates an aztec account that can be used for sending transactions. Registers -the account on the PXE and deploys an account contract. Uses a Schnorr -single-key account which uses the same key for encryption and authentication -(not secure for production usage). - -Options: - --skip-initialization Skip initializing the account contract. Useful for publicly deploying an existing account. - --public-deploy Publishes the account contract instance (and the class, if needed). Needed if the contract contains public functions. - -p, --public-key Public key that identifies a private signing key stored outside of the wallet. Used for ECDSA SSH accounts over the secp256r1 curve. - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - -sk, --secret-key Secret key for account. Uses random by default. (env: SECRET_KEY) - -t, --type Type of account to create (choices: "schnorr", "ecdsasecp256r1", "ecdsasecp256r1ssh", "ecdsasecp256k1", default: "schnorr") - --register-only Just register the account on the PXE. Do not deploy or initialize the account contract. - --json Emit output as json - --no-wait Skip waiting for the contract to be deployed. Print the hash of deployment transaction - -v, --verbose Provide timings on all executed operations (synching, simulating, proving) (default: false) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - feePayer The account paying the fee. - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,feePayer=address,asset=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -``` +### aztec authorize-action -### aztec create-authwit +Authorizes a public call on the caller, so they can perform an action on behalf +**Usage:** +```bash +aztec authorize-action [options] ``` -Usage: aztec create-authwit [options] -Creates an authorization witness that can be privately sent to a caller so they -can perform an action on behalf of the provided account +**Available Commands:** -Arguments: - functionName Name of function to authorize - caller Account to be authorized to perform the action +- `functionName` - Name of function to authorize +- `caller` - Account to be authorized to perform the action -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Function arguments (default: []) - -ca, --contract-address
Aztec address of the contract. - -c, --contract-artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - -h, --help display help for command +**Options:** -``` +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Function arguments (default: []) +- `-ca --contract-address
` - Aztec address of the contract. +- `-c --contract-artifact ` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `-h --help` - display help for command -### aztec debug-rollup -``` -Usage: aztec debug-rollup [options] +#### Subcommands -Debugs the rollup contract. +#### aztec authorize-action functionName -Options: - --l1-rpc-urls 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 Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - --rollup
ethereum address of the rollup contract - -h, --help display help for command +*This command help is currently unavailable due to a technical issue.* -``` -### aztec decode-enr +#### aztec authorize-action caller -``` -Usage: aztec decode-enr [options] +*This command help is currently unavailable due to a technical issue.* -Decodes and ENR record -Arguments: - enr The encoded ENR string +### aztec block-number -Options: - -h, --help display help for command +Gets the current Aztec L2 block number. +**Usage:** +```bash +aztec block-number [options] ``` -### aztec deploy +**Options:** -``` -Usage: aztec deploy [options] [artifact] +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -Deploys a compiled Aztec.nr contract to Aztec. +### aztec bridge-erc20 -Arguments: - artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - -Options: - --init The contract initializer function to call (default: "constructor") - --no-init Leave the contract uninitialized - -k, --public-key Optional encryption public key for this address. Set this value only if this contract is expected to receive private notes, which will be encrypted using this public key. - -s, --salt Optional deployment salt as a hex string for generating the deployment address. - --universal Do not mix the sender address into the deployment. - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Constructor arguments (default: []) - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - --json Emit output as json - --no-wait Skip waiting for the contract to be deployed. Print the hash of deployment transaction - --no-class-registration Don't register this contract class - --no-public-deployment Don't emit this contract's public bytecode - --timeout The amount of time in seconds to wait for the deployment to post to L2 - -v, --verbose Provide timings on all executed operations (synching, simulating, proving) (default: false) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,asset=address,fpc=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command +Bridges ERC20 tokens to L2. +**Usage:** +```bash +aztec bridge-erc20 [options] ``` -### aztec deploy-account +**Available Commands:** -``` -Usage: aztec deploy-account [options] +- `amount` - The amount of Fee Juice to mint and bridge. +- `recipient` - Aztec address of the recipient. -Deploys an already registered aztec account that can be used for sending -transactions. - -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --json Emit output as json - --no-wait Skip waiting for the contract to be deployed. Print the hash of deployment transaction - --register-class Register the contract class (useful for when the contract class has not been deployed yet). - --public-deploy Publishes the account contract instance (and the class, if needed). Needed if the contract contains public functions. - -v, --verbose Provide timings on all executed operations (synching, simulating, proving) (default: false) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - feePayer The account paying the fee. - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,feePayer=address,asset=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command +**Options:** -``` +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-m --mnemonic ` - The mnemonic to use for deriving the Ethereum +- `--mint` - Mint the tokens on L1 (default: false) +- `--private` - If the bridge should use the private flow +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `-t --token ` - The address of the token to bridge +- `-p --portal ` - The address of the portal contract +- `-f --faucet ` - The address of the faucet contract (only used if +- `--l1-private-key ` - The private key to use for deployment +- `--json` - Output the claim in JSON format +- `-h --help` - display help for command -### aztec deploy-l1-contracts -``` -Usage: aztec deploy-l1-contracts [options] +#### Subcommands -Deploys all necessary Ethereum contracts for Aztec. +#### aztec bridge-erc20 amount -Options: - --l1-rpc-urls 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 The private key to use for deployment - --validators Comma separated list of validators - -m, --mnemonic The mnemonic to use in deployment - (default: "test test test test test test - test test test test test junk") - -i, --mnemonic-index The index of the mnemonic to use in - deployment (default: 0) - -c, --l1-chain-id Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - --salt 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
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 +*This command help is currently unavailable due to a technical issue.* -``` -### aztec deploy-new-rollup +#### aztec bridge-erc20 recipient -``` -Usage: aztec deploy-new-rollup [options] +*This command help is currently unavailable due to a technical issue.* -Deploys a new rollup contract and adds it to the registry (if you are the -owner). - -Options: - -r, --registry-address The address of the registry contract - --l1-rpc-urls 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 The private key to use for deployment - --validators Comma separated list of validators - -m, --mnemonic The mnemonic to use in deployment - (default: "test test test test test test - test test test test test junk") - -i, --mnemonic-index The index of the mnemonic to use in - deployment (default: 0) - -c, --l1-chain-id Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - --salt 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 bridge-fee-juice -### aztec deposit-governance-tokens +Mints L1 Fee Juice and pushes them to L2. +**Usage:** +```bash +aztec bridge-fee-juice [options] ``` -Usage: aztec deposit-governance-tokens [options] -Deposits governance tokens to the governance contract. - -Options: - -r, --registry-address The address of the registry contract - --recipient The recipient of the tokens - -a, --amount The amount of tokens to deposit - --mint Mint the tokens on L1 (default: false) - --l1-rpc-urls 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 Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - -p, --private-key The private key to use to deposit - -m, --mnemonic The mnemonic to use to deposit (default: - "test test test test test test test test - test test test junk") - -i, --mnemonic-index The index of the mnemonic to use to deposit - (default: 0) - -h, --help display help for command +**Available Commands:** -``` +- `amount` - The amount of Fee Juice to mint and bridge. +- `recipient` - Aztec address of the recipient. -### aztec example-contracts +**Options:** -``` -Usage: aztec example-contracts [options] +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-m --mnemonic ` - The mnemonic to use for deriving the Ethereum +- `--mint` - Mint the tokens on L1 (default: false) +- `--l1-private-key ` - The private key to the eth account bridging +- `-u --rpc-url ` - URL of the PXE (default: +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--json` - Output the claim in JSON format +- `--no-wait` - Wait for the brigded funds to be available in L2, +- `--interval ` - The polling interval in seconds for the bridged +- `-h --help` - display help for command -Lists the example contracts available to deploy from @aztec/noir-contracts.js -Options: - -h, --help display help for command +#### Subcommands -``` +#### aztec bridge-fee-juice amount -### aztec execute-governance-proposal +*This command help is currently unavailable due to a technical issue.* -``` -Usage: aztec execute-governance-proposal [options] -Executes a governance proposal. +#### aztec bridge-fee-juice recipient -Options: - -p, --proposal-id The ID of the proposal - -r, --registry-address The address of the registry contract - --wait Whether to wait until the proposal is - executable - --l1-rpc-urls 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 Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - -pk, --private-key The private key to use to vote - -m, --mnemonic The mnemonic to use to vote (default: "test - test test test test test test test test test - test junk") - -i, --mnemonic-index The index of the mnemonic to use to vote - (default: 0) - -h, --help display help for command +*This command help is currently unavailable due to a technical issue.* -``` -### aztec fast-forward-epochs +### aztec cancel-tx *Help for this command is currently unavailable due to a technical issue with option serialization.* -### aztec generate-bls-keypair - -``` -Usage: aztec generate-bls-keypair [options] - -Generate a BLS keypair with convenience flags - -Options: - --mnemonic Mnemonic for BLS derivation - --ikm Initial keying material for BLS (alternative to - mnemonic) - --bls-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 Write output to file - -h, --help display help for command - -``` - -### aztec generate-bootnode-enr - -``` -Usage: aztec generate-bootnode-enr [options] - -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 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. +### aztec codegen -Options: - --json Output the private key in JSON format - -h, --help display help for command +Validates and generates an Aztec Contract ABI from Noir ABI. +**Usage:** +```bash +aztec codegen [options] ``` -### aztec generate-p2p-private-key +**Available Commands:** -``` -Usage: aztec generate-p2p-private-key [options] +- `noir-abi-path` - Path to the Noir ABI or project dir. -Generates a private key that can be used for running a node on a LibP2P -network. +**Options:** -Options: - -h, --help display help for command +- `-o --outdir ` - Output folder for the generated code. +- `-f --force` - Force code generation even when the contract has not +- `-h --help` - display help for command -``` -### aztec generate-secret-and-hash +#### Subcommands -``` -Usage: aztec generate-secret-and-hash [options] +#### aztec codegen noir-abi-path -Generates an arbitrary secret (Fr), and its hash (using aztec-nr defaults) +*This command help is currently unavailable due to a technical issue.* -Options: - -h, --help display help for command -``` +### aztec compute-selector -### aztec get-account +Given a function signature, it computes a selector +**Usage:** +```bash +aztec compute-selector [options] ``` -Usage: aztec get-account [options]
- -Gets an account given its Aztec address. -Arguments: - address The Aztec address to get account for - -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command +**Available Commands:** -``` +- `functionSignature` - Function signature to compute selector for e.g. foo(Field) -### aztec get-accounts - -``` -Usage: aztec get-accounts [options] +**Options:** -Gets all the Aztec accounts stored in the PXE. +- `-h --help` - display help for command -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - --json Emit output as json - -h, --help display help for command -``` +#### Subcommands -### aztec get-block +#### aztec compute-selector functionSignature -``` -Usage: aztec get-block [options] [blockNumber] +*This command help is currently unavailable due to a technical issue.* -Gets info for a given block or latest. -Arguments: - blockNumber Block height +### aztec create-account -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command +Creates an aztec account that can be used for sending transactions. Registers +**Usage:** +```bash +aztec create-account [options] ``` -### aztec get-canonical-sponsored-fpc-address +**Options:** -``` -Usage: aztec get-canonical-sponsored-fpc-address [options] +- `--skip-initialization` - Skip initializing the account contract. Useful for publicly deploying an existing account. +- `--public-deploy` - Publishes the account contract instance (and the class, if needed). Needed if the contract contains public functions. +- `-p --public-key ` - Public key that identifies a private signing key stored outside of the wallet. Used for ECDSA SSH accounts over the secp256r1 curve. +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `-sk --secret-key ` - Secret key for account. Uses random by default. (env: SECRET_KEY) +- `-t --type ` - Type of account to create (choices: "schnorr", "ecdsasecp256r1", "ecdsasecp256r1ssh", "ecdsasecp256k1", default: "schnorr") +- `--register-only` - Just register the account on the PXE. Do not deploy or initialize the account contract. +- `--json` - Emit output as json +- `--no-wait` - Skip waiting for the contract to be deployed. Print the hash of deployment transaction +- `-v --verbose` - Provide timings on all executed operations (synching, simulating, proving) (default: false) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -Gets the canonical SponsoredFPC address for this any testnet running on the -same version as this CLI +### aztec create-authwit -Options: - -h, --help display help for command +Creates an authorization witness that can be privately sent to a caller so they +**Usage:** +```bash +aztec create-authwit [options] ``` -### aztec get-contract-data +**Available Commands:** -``` -Usage: aztec get-contract-data [options] +- `functionName` - Name of function to authorize +- `caller` - Account to be authorized to perform the action -Gets information about the Aztec contract deployed at the specified address. +**Options:** -Arguments: - contractAddress Aztec address of the contract. +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Function arguments (default: []) +- `-ca --contract-address
` - Aztec address of the contract. +- `-c --contract-artifact ` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `-h --help` - display help for command -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: - PXE_URL) - -b, --include-bytecode Include the contract's public function - bytecode, if any. (default: false) - -h, --help display help for command -``` +#### Subcommands -### aztec get-current-base-fee +#### aztec create-authwit functionName -``` -Usage: aztec get-current-base-fee [options] +*This command help is currently unavailable due to a technical issue.* -Gets the current base fee. -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command +#### aztec create-authwit caller -``` +*This command help is currently unavailable due to a technical issue.* -### aztec get-l1-addresses -``` -Usage: aztec get-l1-addresses [options] - -Gets the addresses of the L1 contracts. +### aztec debug-rollup -Options: - -r, --registry-address The address of the registry contract - --l1-rpc-urls 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 The version of the rollup - -c, --l1-chain-id 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 +Debugs the rollup contract. +**Usage:** +```bash +aztec debug-rollup [options] ``` -### aztec get-l1-balance +**Options:** -``` -Usage: aztec get-l1-balance [options] +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--rollup
` - ethereum address of the rollup contract +- `-h --help` - display help for command -Gets the balance of an ERC token in L1 for the given Ethereum address. +### aztec decode-enr -Arguments: - who Ethereum address to check. - -Options: - --l1-rpc-urls 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 The address of the token to check the balance of - -c, --l1-chain-id 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 +Decodes and ENR record +**Usage:** +```bash +aztec decode-enr [options] ``` -### aztec get-l1-to-l2-message-witness +**Available Commands:** -``` -Usage: aztec get-l1-to-l2-message-witness [options] +- `enr` - The encoded ENR string -Gets a L1 to L2 message witness. +**Options:** -Options: - -ca, --contract-address
Aztec address of the contract. - --message-hash The L1 to L2 message hash. - --secret The secret used to claim the L1 to L2 - message - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: - PXE_URL) - -h, --help display help for command +- `-h --help` - display help for command -``` -### aztec get-logs +#### Subcommands -``` -Usage: aztec get-logs [options] +#### aztec decode-enr enr -Gets all the public logs from an intersection of all the filter params. +*This command help is currently unavailable due to a technical issue.* -Options: - -tx, --tx-hash A transaction hash to get the receipt for. - -fb, --from-block Initial block number for getting logs - (defaults to 1). - -tb, --to-block Up to which block to fetch logs (defaults - to latest). - -al --after-log ID of a log after which to fetch the logs. - -ca, --contract-address
Contract address to filter logs by. - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: - PXE_URL) - --follow If set, will keep polling for new logs - until interrupted. - -h, --help display help for command -``` +### aztec deploy -### aztec get-node-info +Deploys a compiled Aztec.nr contract to Aztec. +**Usage:** +```bash +aztec deploy [options] [artifact] ``` -Usage: aztec get-node-info [options] - -Gets the information of an Aztec node from a PXE or directly from an Aztec -node. -Options: - --node-url URL of the node. - --json Emit output as json - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command - -``` +**Available Commands:** -### aztec get-pxe-info +- `artifact` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract -``` -Usage: aztec get-pxe-info [options] +**Options:** -Gets the information of a PXE at a URL. +- `--init ` - The contract initializer function to call (default: "constructor") +- `--no-init` - Leave the contract uninitialized +- `-k --public-key ` - Optional encryption public key for this address. Set this value only if this contract is expected to receive private notes, which will be encrypted using this public key. +- `-s --salt ` - Optional deployment salt as a hex string for generating the deployment address. +- `--universal` - Do not mix the sender address into the deployment. +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Constructor arguments (default: []) +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `--json` - Emit output as json +- `--no-wait` - Skip waiting for the contract to be deployed. Print the hash of deployment transaction +- `--no-class-registration` - Don't register this contract class +- `--no-public-deployment` - Don't emit this contract's public bytecode +- `--timeout ` - The amount of time in seconds to wait for the deployment to post to L2 +- `-v --verbose` - Provide timings on all executed operations (synching, simulating, proving) (default: false) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command -``` +#### Subcommands -### aztec get-tx +#### aztec deploy artifact -``` -Usage: aztec get-tx [options] [txHash] +*This command help is currently unavailable due to a technical issue.* -Gets the status of the recent txs, or a detailed view if a specific transaction -hash is provided -Arguments: - txHash A transaction hash to get the receipt for. +### aztec deploy-account -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -p, --page The page number to display (default: 1) - -s, --page-size The number of transactions to display per page - (default: 10) - -h, --help display help for command +Deploys an already registered aztec account that can be used for sending +**Usage:** +```bash +aztec deploy-account [options] ``` -### aztec import-test-accounts +**Options:** -``` -Usage: aztec import-test-accounts [options] +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--json` - Emit output as json +- `--no-wait` - Skip waiting for the contract to be deployed. Print the hash of deployment transaction +- `--register-class` - Register the contract class (useful for when the contract class has not been deployed yet). +- `--public-deploy` - Publishes the account contract instance (and the class, if needed). Needed if the contract contains public functions. +- `-v --verbose` - Provide timings on all executed operations (synching, simulating, proving) (default: false) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -Import test accounts from pxe. +### aztec deploy-l1-contracts -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - --json Emit output as json - -h, --help display help for command +Deploys all necessary Ethereum contracts for Aztec. +**Usage:** +```bash +aztec deploy-l1-contracts [options] ``` -### aztec inspect-contract - -``` -Usage: aztec inspect-contract [options] +**Options:** -Shows list of external callable functions for a contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-pk --private-key ` - The private key to use for deployment +- `--validators ` - Comma separated list of validators +- `-m --mnemonic ` - The mnemonic to use in deployment +- `-i --mnemonic-index ` - The index of the mnemonic to use in +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `--salt ` - The optional salt to use in deployment +- `--json` - Output the contract addresses in JSON +- `--test-accounts` - Populate genesis state with initial fee +- `--sponsored-fpc` - Populate genesis state with a testing +- `--accelerated-test-deployments` - Fire and forget deployment transactions, +- `--real-verifier` - Deploy the real verifier (default: false) +- `--existing-token
` - Use an existing ERC20 for both fee and +- `--create-verification-json` - [path] Create JSON file for etherscan contract +- `-h --help` - display help for command -Arguments: - contractArtifactFile A compiled Noir contract's artifact in JSON format or - name of a contract artifact exported by - @aztec/noir-contracts.js +### aztec deploy-new-rollup -Options: - -h, --help display help for command +Deploys a new rollup contract and adds it to the registry (if you are the +**Usage:** +```bash +aztec deploy-new-rollup [options] ``` -### aztec parse-parameter-struct - -``` -Usage: aztec parse-parameter-struct [options] +**Options:** -Helper for parsing an encoded string into a contract's parameter struct. +- `-r --registry-address ` - The address of the registry contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-pk --private-key ` - The private key to use for deployment +- `--validators ` - Comma separated list of validators +- `-m --mnemonic ` - The mnemonic to use in deployment +- `-i --mnemonic-index ` - The index of the mnemonic to use in +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `--salt ` - The optional salt to use in deployment +- `--json` - Output the contract addresses in JSON +- `--test-accounts` - Populate genesis state with initial fee +- `--sponsored-fpc` - Populate genesis state with a testing +- `--real-verifier` - Deploy the real verifier (default: false) +- `--create-verification-json` - [path] Create JSON file for etherscan contract +- `-h --help` - display help for command -Arguments: - encodedString The encoded hex string +### aztec deposit-governance-tokens -Options: - -c, --contract-artifact A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js - -p, --parameter The name of the struct parameter to decode into - -h, --help display help for command +Deposits governance tokens to the governance contract. +**Usage:** +```bash +aztec deposit-governance-tokens [options] ``` -### aztec preload-crs +**Options:** -``` -Usage: aztec preload-crs [options] +- `-r --registry-address ` - The address of the registry contract +- `--recipient ` - The recipient of the tokens +- `-a --amount ` - The amount of tokens to deposit +- `--mint` - Mint the tokens on L1 (default: false) +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `-p --private-key ` - The private key to use to deposit +- `-m --mnemonic ` - The mnemonic to use to deposit (default: +- `-i --mnemonic-index ` - The index of the mnemonic to use to deposit +- `-h --help` - display help for command -Preload the points data needed for proving and verifying +### aztec example-contracts -Options: - -h, --help display help for command +Lists the example contracts available to deploy from @aztec/noir-contracts.js +**Usage:** +```bash +aztec example-contracts [options] ``` -### aztec profile - -``` -Usage: aztec profile [options] +**Options:** -Profiles a private function by counting the unconditional operations in its -execution steps - -Arguments: - functionName Name of function to simulate - -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Function arguments (default: []) - -ca, --contract-address
Aztec address of the contract. - -c, --contract-artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - --debug-execution-steps-dir
Directory to write execution step artifacts for bb profiling/debugging. - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,asset=address,fpc=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command +- `-h --help` - display help for command -``` +### aztec execute-governance-proposal -### aztec propose-with-lock +Executes a governance proposal. +**Usage:** +```bash +aztec execute-governance-proposal [options] ``` -Usage: aztec propose-with-lock [options] - -Makes a proposal to governance with a lock - -Options: - -r, --registry-address The address of the registry contract - -p, --payload-address The address of the payload contract - --l1-rpc-urls 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 Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - -pk, --private-key The private key to use to propose - -m, --mnemonic The mnemonic to use to propose (default: - "test test test test test test test test - test test test junk") - -i, --mnemonic-index 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 -``` +**Options:** -### aztec prune-rollup +- `-p --proposal-id ` - The ID of the proposal +- `-r --registry-address ` - The address of the registry contract +- `--wait ` - Whether to wait until the proposal is +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `-pk --private-key ` - The private key to use to vote +- `-m --mnemonic ` - The mnemonic to use to vote (default: "test +- `-i --mnemonic-index ` - The index of the mnemonic to use to vote +- `-h --help` - display help for command -``` -Usage: aztec prune-rollup [options] +### aztec fast-forward-epochs -Prunes the pending chain on the rollup contract. +*Help for this command is currently unavailable due to a technical issue with option serialization.* -Options: - --l1-rpc-urls 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 The private key to use for deployment - -m, --mnemonic The mnemonic to use in deployment (default: - "test test test test test test test test test - test test junk") - -c, --l1-chain-id Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - --rollup
ethereum address of the rollup contract - -h, --help display help for command -``` +### aztec generate-bls-keypair -### aztec register-contract +Generate a BLS keypair with convenience flags +**Usage:** +```bash +aztec generate-bls-keypair [options] ``` -Usage: aztec register-contract [options] [address] [artifact] -Registers a contract in this wallet's PXE +**Options:** -Arguments: - address The address of the contract to register - artifact Path to a compiled Aztec contract's artifact in - JSON format. If executed inside a nargo workspace, - a package and contract name can be specified as - package@contract - -Options: - --init The contract initializer function to call - (default: "constructor") - -k, --public-key Optional encryption public key for this address. - Set this value only if this contract is expected - to receive private notes, which will be encrypted - using this public key. - -s, --salt Optional deployment salt as a hex string for - generating the deployment address. - --deployer The address of the account that deployed the - contract - --args [args...] Constructor arguments (default: []) - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command +- `--mnemonic ` - Mnemonic for BLS derivation +- `--ikm ` - Initial keying material for BLS (alternative to +- `--bls-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 ` - Write output to file +- `-h --help` - display help for command -``` +### aztec generate-bootnode-enr -### aztec register-sender +Generates the encoded ENR record for a bootnode. +**Usage:** +```bash +aztec generate-bootnode-enr [options] ``` -Usage: aztec register-sender [options] [address] - -Registers a sender's address in the wallet, so the note synching process will -look for notes sent by them -Arguments: - address The address of the sender to register +**Available Commands:** -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command +- `privateKey` - The peer id private key of the bootnode +- `p2pIp` - The bootnode P2P IP address +- `p2pPort` - The bootnode P2P port -``` +**Options:** -### aztec remove-l1-validator +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `-h --help` - display help for command -``` -Usage: aztec remove-l1-validator [options] -Removes a validator to the L1 rollup contract. +#### Subcommands -Options: - --l1-rpc-urls 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 The private key to use for deployment - -m, --mnemonic The mnemonic to use in deployment (default: - "test test test test test test test test test - test test junk") - -c, --l1-chain-id Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - --validator
ethereum address of the validator - --rollup
ethereum address of the rollup contract - -h, --help display help for command +#### aztec generate-bootnode-enr privateKey -``` +*This command help is currently unavailable due to a technical issue.* -### aztec send -``` -Usage: aztec send [options] +#### aztec generate-bootnode-enr p2pIp -Calls a function on an Aztec contract. +*This command help is currently unavailable due to a technical issue.* -Arguments: - functionName Name of function to execute - -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Function arguments (default: []) - -c, --contract-artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - -ca, --contract-address
Aztec address of the contract. - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - --no-wait Print transaction hash without waiting for it to be mined - --no-cancel Do not allow the transaction to be cancelled. This makes for cheaper transactions. - -v, --verbose Provide timings on all executed operations (synching, simulating, proving) (default: false) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,asset=address,fpc=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command -``` +#### aztec generate-bootnode-enr p2pPort -### aztec sequencers +*This command help is currently unavailable due to a technical issue.* -``` -Usage: aztec sequencers [options] [who] -Manages or queries registered sequencers on the L1 rollup contract. +### aztec generate-keys -Arguments: - command Command to run: list, add, remove, who-next - who Who to add/remove - -Options: - --l1-rpc-urls List of Ethereum host URLs. Chain identifiers - localhost and testnet can be used (comma - separated) (default: - ["http://host.docker.internal:8545"]) - -m, --mnemonic The mnemonic for the sender of the tx (default: - "test test test test test test test test test - test test junk") - --block-number Block number to query next sequencer for - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -c, --l1-chain-id Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - -h, --help display help for command +Generates and encryption and signing private key pair. +**Usage:** +```bash +aztec generate-keys [options] ``` -### aztec setup-protocol-contracts +**Options:** -``` -Usage: aztec setup-protocol-contracts [options] +- `--json` - Output the keys in JSON format +- `-h --help` - display help for command -Bootstrap the blockchain by initializing all the protocol contracts +### aztec generate-l1-account -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - --testAccounts Deploy funded test accounts. - --sponsoredFPC Deploy a sponsored FPC. - --json Output the contract addresses in JSON format - --skipProofWait Don't wait for proofs to land. - -h, --help display help for command +Generates a new private key for an account on L1. +**Usage:** +```bash +aztec generate-l1-account [options] ``` -### aztec simulate +**Options:** -``` -Usage: aztec simulate [options] +- `--json` - Output the private key in JSON format +- `-h --help` - display help for command -Simulates the execution of a function on an Aztec contract. +### aztec generate-p2p-private-key -Arguments: - functionName Name of function to simulate - -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Function arguments (default: []) - -ca, --contract-address
Aztec address of the contract. - -c, --contract-artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - -v, --verbose Provide timings on all executed operations (synching, simulating, proving) (default: false) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,asset=address,fpc=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command +Generates a private key that can be used for running a node on a LibP2P +**Usage:** +```bash +aztec generate-p2p-private-key [options] ``` -### aztec start - -**MISC** - -- `--network ` - Network to run Aztec on - *Environment: `$NETWORK`* - -- `--auto-update ` (default: `disabled`) - The auto update mode for this node - *Environment: `$AUTO_UPDATE`* +**Options:** -- `--auto-update-url ` - Base URL to check for updates - *Environment: `$AUTO_UPDATE_URL`* +- `-h --help` - display help for command -- `--sync-mode ` (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`* +### aztec generate-secret-and-hash -- `--snapshots-urls ` - Base URLs for snapshots index, comma-separated. - *Environment: `$SYNC_SNAPSHOTS_URLS`* +Generates an arbitrary secret (Fr), and its hash (using aztec-nr defaults) -- `--fisherman-mode` - Whether to run in fisherman mode. - *Environment: `$FISHERMAN_MODE`* +**Usage:** +```bash +aztec generate-secret-and-hash [options] +``` -**SANDBOX** +**Options:** -- `--sandbox` - Starts Aztec Sandbox +- `-h --help` - display help for command -- `--sandbox.noPXE` - Do not expose PXE service on sandbox start - *Environment: `$NO_PXE`* +### aztec get-account -- `--sandbox.l1Mnemonic ` (default: `test test test test test test test test test test test junk`) - Mnemonic for L1 accounts. Will be used - *Environment: `$MNEMONIC`* +Gets an account given its Aztec address. -- `--sandbox.deployAztecContractsSalt ` - Numeric salt for deploying L1 Aztec contracts before starting the sandbox. Needs mnemonic or private key to be set. - *Environment: `$DEPLOY_AZTEC_CONTRACTS_SALT`* +**Usage:** +```bash +aztec get-account [options]
+``` -**API** +**Available Commands:** -- `--port ` (default: `8080`) - Port to run the Aztec Services on - *Environment: `$AZTEC_PORT`* +- `address` - The Aztec address to get account for -- `--admin-port ` (default: `8880`) - Port to run admin APIs of Aztec Services on on - *Environment: `$AZTEC_ADMIN_PORT`* +**Options:** -- `--api-prefix ` - Prefix for API routes on any service that is started - *Environment: `$API_PREFIX`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -**ETHEREUM** -- `--l1-chain-id ` - The chain ID of the ethereum host. - *Environment: `$L1_CHAIN_ID`* +#### Subcommands -- `--l1-rpc-urls ` - The RPC Url of the ethereum host. - *Environment: `$ETHEREUM_HOSTS`* +#### aztec get-account address -- `--l1-consensus-host-urls ` - List of URLS for L1 consensus clients - *Environment: `$L1_CONSENSUS_HOST_URLS`* +*This command help is currently unavailable due to a technical issue.* -- `--l1-consensus-host-api-keys ` - 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 ` - 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`* +### aztec get-accounts -- `--registry-address ` - The deployed L1 registry contract address. - *Environment: `$REGISTRY_CONTRACT_ADDRESS`* +Gets all the Aztec accounts stored in the PXE. -- `--rollup-version ` - The version of the rollup. - *Environment: `$ROLLUP_VERSION`* +**Usage:** +```bash +aztec get-accounts [options] +``` -**STORAGE** +**Options:** -- `--data-directory ` - Optional dir to store data. If omitted will store in memory. - *Environment: `$DATA_DIRECTORY`* +- `-u --rpc-url ` - URL of the PXE (default: +- `--json` - Emit output as json +- `-h --help` - display help for command -- `--data-store-map-size-kb ` (default: `134217728`) - DB mapping size to be applied to all key/value stores - *Environment: `$DATA_STORE_MAP_SIZE_KB`* +### aztec get-block -**WORLD STATE** +Gets info for a given block or latest. -- `--world-state-data-directory ` - Optional directory for the world state database - *Environment: `$WS_DATA_DIRECTORY`* +**Usage:** +```bash +aztec get-block [options] [blockNumber] +``` -- `--world-state-db-map-size-kb ` - The maximum possible size of the world state DB in KB. Overwrites the general dataStoreMapSizeKb. - *Environment: `$WS_DB_MAP_SIZE_KB`* +**Available Commands:** -- `--world-state-block-history ` (default: `64`) - The number of historic blocks to maintain. Values less than 1 mean all history is maintained - *Environment: `$WS_NUM_HISTORIC_BLOCKS`* +- `blockNumber` - Block height -**AZTEC NODE** +**Options:** -- `--node` - Starts Aztec Node with options +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -**ARCHIVER** -- `--archiver` - Starts Aztec Archiver with options +#### Subcommands -- `--archiver.blobSinkUrl ` - The URL of the blob sink - *Environment: `$BLOB_SINK_URL`* +#### aztec get-block blockNumber -- `--archiver.blobSinkMapSizeKb ` - The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKb. - *Environment: `$BLOB_SINK_MAP_SIZE_KB`* +*This command help is currently unavailable due to a technical issue.* -- `--archiver.blobAllowEmptySources ` - Whether to allow having no blob sources configured during startup - *Environment: `$BLOB_ALLOW_EMPTY_SOURCES`* -- `--archiver.archiveApiUrl ` - The URL of the archive API - *Environment: `$BLOB_SINK_ARCHIVE_API_URL`* +### aztec get-canonical-sponsored-fpc-address -- `--archiver.archiverPollingIntervalMS ` (default: `500`) - The polling interval in ms for retrieving new L2 blocks and encrypted logs. - *Environment: `$ARCHIVER_POLLING_INTERVAL_MS`* +Gets the canonical SponsoredFPC address for this any testnet running on the -- `--archiver.archiverBatchSize ` (default: `100`) - The number of L2 blocks the archiver will attempt to download at a time. - *Environment: `$ARCHIVER_BATCH_SIZE`* +**Usage:** +```bash +aztec get-canonical-sponsored-fpc-address [options] +``` -- `--archiver.maxLogs ` (default: `1000`) - The max number of logs that can be obtained in 1 "getPublicLogs" call. - *Environment: `$ARCHIVER_MAX_LOGS`* +**Options:** -- `--archiver.archiverStoreMapSizeKb ` - The maximum possible size of the archiver DB in KB. Overwrites the general dataStoreMapSizeKb. - *Environment: `$ARCHIVER_STORE_MAP_SIZE_KB`* +- `-h --help` - display help for command -- `--archiver.skipValidateBlockAttestations ` - Whether to skip validating block attestations (use only for testing). +### aztec get-contract-data -- `--archiver.maxAllowedEthClientDriftSeconds ` (default: `300`) - Maximum allowed drift in seconds between the Ethereum client and current time. - *Environment: `$MAX_ALLOWED_ETH_CLIENT_DRIFT_SECONDS`* +Gets information about the Aztec contract deployed at the specified address. -- `--archiver.ethereumAllowNoDebugHosts ` (default: `true`) - Whether to allow starting the archiver without debug/trace method support on Ethereum hosts - *Environment: `$ETHEREUM_ALLOW_NO_DEBUG_HOSTS`* +**Usage:** +```bash +aztec get-contract-data [options] +``` -**SEQUENCER** +**Available Commands:** -- `--sequencer` - Starts Aztec Sequencer with options +- `contractAddress` - Aztec address of the contract. -- `--sequencer.validatorPrivateKeys ` (default: `[Redacted]`) - List of private keys of the validators participating in attestation duties - *Environment: `$VALIDATOR_PRIVATE_KEYS`* +**Options:** -- `--sequencer.validatorAddresses ` - List of addresses of the validators to use with remote signers - *Environment: `$VALIDATOR_ADDRESSES`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-b --include-bytecode ` - Include the contract's public function +- `-h --help` - display help for command -- `--sequencer.disableValidator ` - Do not run the validator - *Environment: `$VALIDATOR_DISABLED`* -- `--sequencer.disabledValidators ` - Temporarily disable these specific validator addresses +#### Subcommands -- `--sequencer.attestationPollingIntervalMs ` (default: `200`) - Interval between polling for new attestations - *Environment: `$VALIDATOR_ATTESTATIONS_POLLING_INTERVAL_MS`* +#### aztec get-contract-data contractAddress -- `--sequencer.validatorReexecute ` (default: `true`) - Re-execute transactions before attesting - *Environment: `$VALIDATOR_REEXECUTE`* +*This command help is currently unavailable due to a technical issue.* -- `--sequencer.validatorReexecuteDeadlineMs ` (default: `6000`) - Will re-execute until this many milliseconds are left in the slot - *Environment: `$VALIDATOR_REEXECUTE_DEADLINE_MS`* -- `--sequencer.alwaysReexecuteBlockProposals ` - Whether to always reexecute block proposals, even for non-validator nodes (useful for monitoring network status). - *Environment: `$ALWAYS_REEXECUTE_BLOCK_PROPOSALS`* +### aztec get-current-base-fee -- `--sequencer.transactionPollingIntervalMS ` (default: `500`) - The number of ms to wait between polling for pending txs. - *Environment: `$SEQ_TX_POLLING_INTERVAL_MS`* +Gets the current base fee. -- `--sequencer.maxTxsPerBlock ` (default: `32`) - The maximum number of txs to include in a block. - *Environment: `$SEQ_MAX_TX_PER_BLOCK`* +**Usage:** +```bash +aztec get-current-base-fee [options] +``` -- `--sequencer.minTxsPerBlock ` (default: `1`) - The minimum number of txs to include in a block. - *Environment: `$SEQ_MIN_TX_PER_BLOCK`* +**Options:** -- `--sequencer.publishTxsWithProposals ` - Whether to publish txs with proposals. - *Environment: `$SEQ_PUBLISH_TXS_WITH_PROPOSALS`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--sequencer.maxL2BlockGas ` (default: `10000000000`) - The maximum L2 block gas. - *Environment: `$SEQ_MAX_L2_BLOCK_GAS`* +### aztec get-l1-addresses -- `--sequencer.maxDABlockGas ` (default: `10000000000`) - The maximum DA block gas. - *Environment: `$SEQ_MAX_DA_BLOCK_GAS`* +Gets the addresses of the L1 contracts. -- `--sequencer.coinbase ` - Recipient of block reward. - *Environment: `$COINBASE`* +**Usage:** +```bash +aztec get-l1-addresses [options] +``` -- `--sequencer.feeRecipient ` - Address to receive fees. - *Environment: `$FEE_RECIPIENT`* +**Options:** -- `--sequencer.acvmWorkingDirectory ` - The working directory to use for simulation/proving - *Environment: `$ACVM_WORKING_DIRECTORY`* +- `-r --registry-address ` - The address of the registry contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-v --rollup-version ` - The version of the rollup +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `--json` - Output the addresses in JSON format +- `-h --help` - display help for command -- `--sequencer.acvmBinaryPath ` - The path to the ACVM binary - *Environment: `$ACVM_BINARY_PATH`* +### aztec get-l1-balance -- `--sequencer.maxBlockSizeInBytes ` (default: `1048576`) - Max block size - *Environment: `$SEQ_MAX_BLOCK_SIZE_IN_BYTES`* +Gets the balance of an ERC token in L1 for the given Ethereum address. -- `--sequencer.enforceTimeTable ` (default: `true`) - Whether to enforce the time table when building blocks - *Environment: `$SEQ_ENFORCE_TIME_TABLE`* +**Usage:** +```bash +aztec get-l1-balance [options] +``` -- `--sequencer.governanceProposerPayload ` (default: `0x0000000000000000000000000000000000000000`) - The address of the payload for the governanceProposer - *Environment: `$GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS`* +**Available Commands:** -- `--sequencer.maxL1TxInclusionTimeIntoSlot ` - 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`* +- `who` - Ethereum address to check. -- `--sequencer.attestationPropagationTime ` (default: `2`) - How many seconds it takes for proposals and attestations to travel across the p2p layer (one-way) - *Environment: `$SEQ_ATTESTATION_PROPAGATION_TIME`* +**Options:** -- `--sequencer.secondsBeforeInvalidatingBlockAsCommitteeMember ` (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`* +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-t --token ` - The address of the token to check the balance of +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--json` - Output the balance in JSON format +- `-h --help` - display help for command -- `--sequencer.secondsBeforeInvalidatingBlockAsNonCommitteeMember ` (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.injectFakeAttestation ` - Inject a fake attestation (for testing only) +#### Subcommands -- `--sequencer.shuffleAttestationOrdering ` - Shuffle attestation ordering to create invalid ordering (for testing only) +#### aztec get-l1-balance who -- `--sequencer.txPublicSetupAllowList ` - The list of functions calls allowed to run in setup - *Environment: `$TX_PUBLIC_SETUP_ALLOWLIST`* +*This command help is currently unavailable due to a technical issue.* -- `--sequencer.keyStoreDirectory ` - Location of key store directory - *Environment: `$KEY_STORE_DIRECTORY`* -- `--sequencer.publisherPrivateKeys ` - The private keys to be used by the publisher. - *Environment: `$SEQ_PUBLISHER_PRIVATE_KEYS`* +### aztec get-l1-to-l2-message-witness -- `--sequencer.publisherAddresses ` - The addresses of the publishers to use with remote signers - *Environment: `$SEQ_PUBLISHER_ADDRESSES`* +Gets a L1 to L2 message witness. -- `--sequencer.publisherAllowInvalidStates ` (default: `true`) - True to use publishers in invalid states (timed out, cancelled, etc) if no other is available - *Environment: `$SEQ_PUBLISHER_ALLOW_INVALID_STATES`* +**Usage:** +```bash +aztec get-l1-to-l2-message-witness [options] +``` -- `--sequencer.publisherForwarderAddress ` - Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only) - *Environment: `$SEQ_PUBLISHER_FORWARDER_ADDRESS`* +**Options:** -- `--sequencer.blobSinkUrl ` - The URL of the blob sink - *Environment: `$BLOB_SINK_URL`* +- `-ca --contract-address
` - Aztec address of the contract. +- `--message-hash ` - The L1 to L2 message hash. +- `--secret ` - The secret used to claim the L1 to L2 +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--sequencer.blobAllowEmptySources ` - Whether to allow having no blob sources configured during startup - *Environment: `$BLOB_ALLOW_EMPTY_SOURCES`* +### aztec get-logs -- `--sequencer.archiveApiUrl ` - The URL of the archive API - *Environment: `$BLOB_SINK_ARCHIVE_API_URL`* +Gets all the public logs from an intersection of all the filter params. -**BLOB SINK** +**Usage:** +```bash +aztec get-logs [options] +``` -- `--blob-sink` - Starts Aztec Blob Sink with options +**Options:** -- `--blobSink.port ` - The port to run the blob sink server on - *Environment: `$BLOB_SINK_PORT`* +- `-tx --tx-hash ` - A transaction hash to get the receipt for. +- `-fb --from-block ` - Initial block number for getting logs +- `-tb --to-block ` - Up to which block to fetch logs (defaults +- `-ca --contract-address
` - Contract address to filter logs by. +- `-u --rpc-url ` - URL of the PXE (default: +- `--follow` - If set, will keep polling for new logs +- `-h --help` - display help for command -- `--blobSink.blobSinkMapSizeKb ` - The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKb. - *Environment: `$BLOB_SINK_MAP_SIZE_KB`* +### aztec get-node-info -- `--blobSink.blobAllowEmptySources ` - Whether to allow having no blob sources configured during startup - *Environment: `$BLOB_ALLOW_EMPTY_SOURCES`* +Gets the information of an Aztec node from a PXE or directly from an Aztec -- `--blobSink.archiveApiUrl ` - The URL of the archive API - *Environment: `$BLOB_SINK_ARCHIVE_API_URL`* +**Usage:** +```bash +aztec get-node-info [options] +``` -**PROVER NODE** +**Options:** -- `--prover-node` - Starts Aztec Prover Node with options +- `--node-url ` - URL of the node. +- `--json` - Emit output as json +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--proverNode.keyStoreDirectory ` - Location of key store directory - *Environment: `$KEY_STORE_DIRECTORY`* +### aztec get-pxe-info -- `--proverNode.acvmWorkingDirectory ` - The working directory to use for simulation/proving - *Environment: `$ACVM_WORKING_DIRECTORY`* +Gets the information of a PXE at a URL. -- `--proverNode.acvmBinaryPath ` - The path to the ACVM binary - *Environment: `$ACVM_BINARY_PATH`* +**Usage:** +```bash +aztec get-pxe-info [options] +``` -- `--proverNode.bbWorkingDirectory ` - The working directory to use for proving - *Environment: `$BB_WORKING_DIRECTORY`* +**Options:** -- `--proverNode.bbBinaryPath ` - The path to the bb binary - *Environment: `$BB_BINARY_PATH`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--proverNode.bbSkipCleanup ` - Whether to skip cleanup of bb temporary files - *Environment: `$BB_SKIP_CLEANUP`* +### aztec get-tx -- `--proverNode.numConcurrentIVCVerifiers ` (default: `8`) - Max number of client IVC verifiers to run concurrently - *Environment: `$BB_NUM_IVC_VERIFIERS`* +Gets the status of the recent txs, or a detailed view if a specific transaction -- `--proverNode.bbIVCConcurrency ` (default: `1`) - Number of threads to use for IVC verification - *Environment: `$BB_IVC_CONCURRENCY`* +**Usage:** +```bash +aztec get-tx [options] [txHash] +``` -- `--proverNode.nodeUrl ` - The URL to the Aztec node to take proving jobs from - *Environment: `$AZTEC_NODE_URL`* +**Available Commands:** -- `--proverNode.proverId ` - Hex value that identifies the prover. Defaults to the address used for submitting proofs if not set. - *Environment: `$PROVER_ID`* +- `txHash` - A transaction hash to get the receipt for. -- `--proverNode.failedProofStore ` - 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`* +**Options:** -- `--proverNode.publisherAllowInvalidStates ` (default: `true`) - True to use publishers in invalid states (timed out, cancelled, etc) if no other is available - *Environment: `$PROVER_PUBLISHER_ALLOW_INVALID_STATES`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-p --page ` - The page number to display (default: 1) +- `-s --page-size ` - The number of transactions to display per page +- `-h --help` - display help for command -- `--proverNode.publisherForwarderAddress ` - Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only) - *Environment: `$PROVER_PUBLISHER_FORWARDER_ADDRESS`* -- `--proverNode.publisherPrivateKeys ` - The private keys to be used by the publisher. - *Environment: `$PROVER_PUBLISHER_PRIVATE_KEYS`* +#### Subcommands -- `--proverNode.publisherAddresses ` - The addresses of the publishers to use with remote signers - *Environment: `$PROVER_PUBLISHER_ADDRESSES`* +#### aztec get-tx txHash -- `--proverNode.proverNodeMaxPendingJobs ` (default: `10`) - The maximum number of pending jobs for the prover node - *Environment: `$PROVER_NODE_MAX_PENDING_JOBS`* +*This command help is currently unavailable due to a technical issue.* -- `--proverNode.proverNodePollingIntervalMs ` (default: `1000`) - The interval in milliseconds to poll for new jobs - *Environment: `$PROVER_NODE_POLLING_INTERVAL_MS`* -- `--proverNode.proverNodeMaxParallelBlocksPerEpoch ` (default: `32`) - The Maximum number of blocks to process in parallel while proving an epoch - *Environment: `$PROVER_NODE_MAX_PARALLEL_BLOCKS_PER_EPOCH`* +### aztec import-test-accounts -- `--proverNode.proverNodeFailedEpochStore ` - File store where to upload node state when an epoch fails to be proven - *Environment: `$PROVER_NODE_FAILED_EPOCH_STORE`* +Import test accounts from pxe. -- `--proverNode.proverNodeEpochProvingDelayMs ` - Optional delay in milliseconds to wait before proving a new epoch +**Usage:** +```bash +aztec import-test-accounts [options] +``` -- `--proverNode.txGatheringIntervalMs ` (default: `1000`) - How often to check that tx data is available - *Environment: `$PROVER_NODE_TX_GATHERING_INTERVAL_MS`* +**Options:** -- `--proverNode.txGatheringBatchSize ` (default: `10`) - How many transactions to gather from a node in a single request - *Environment: `$PROVER_NODE_TX_GATHERING_BATCH_SIZE`* +- `-u --rpc-url ` - URL of the PXE (default: +- `--json` - Emit output as json +- `-h --help` - display help for command -- `--proverNode.txGatheringMaxParallelRequestsPerNode ` (default: `100`) - How many tx requests to make in parallel to each node - *Environment: `$PROVER_NODE_TX_GATHERING_MAX_PARALLEL_REQUESTS_PER_NODE`* +### aztec inspect-contract -- `--proverNode.txGatheringTimeoutMs ` (default: `120000`) - How long to wait for tx data to be available before giving up - *Environment: `$PROVER_NODE_TX_GATHERING_TIMEOUT_MS`* +Shows list of external callable functions for a contract -- `--proverNode.proverNodeDisableProofPublish ` - Whether the prover node skips publishing proofs to L1 - *Environment: `$PROVER_NODE_DISABLE_PROOF_PUBLISH`* +**Usage:** +```bash +aztec inspect-contract [options] +``` -**PROVER BROKER** +**Available Commands:** -- `--prover-broker` - Starts Aztec proving job broker +- `contractArtifactFile` - A compiled Noir contract's artifact in JSON format or -- `--proverBroker.proverBrokerJobTimeoutMs ` (default: `30000`) - Jobs are retried if not kept alive for this long - *Environment: `$PROVER_BROKER_JOB_TIMEOUT_MS`* +**Options:** -- `--proverBroker.proverBrokerPollIntervalMs ` (default: `1000`) - The interval to check job health status - *Environment: `$PROVER_BROKER_POLL_INTERVAL_MS`* +- `-h --help` - display help for command -- `--proverBroker.proverBrokerJobMaxRetries ` (default: `3`) - If starting a prover broker locally, the max number of retries per proving job - *Environment: `$PROVER_BROKER_JOB_MAX_RETRIES`* -- `--proverBroker.proverBrokerBatchSize ` (default: `100`) - The prover broker writes jobs to disk in batches - *Environment: `$PROVER_BROKER_BATCH_SIZE`* +#### Subcommands -- `--proverBroker.proverBrokerBatchIntervalMs ` (default: `50`) - How often to flush batches to disk - *Environment: `$PROVER_BROKER_BATCH_INTERVAL_MS`* +#### aztec inspect-contract contractArtifactFile -- `--proverBroker.proverBrokerMaxEpochsToKeepResultsFor ` (default: `1`) - The maximum number of epochs to keep results for - *Environment: `$PROVER_BROKER_MAX_EPOCHS_TO_KEEP_RESULTS_FOR`* +*This command help is currently unavailable due to a technical issue.* -- `--proverBroker.proverBrokerStoreMapSizeKb ` - The size of the prover broker's database. Will override the dataStoreMapSizeKb if set. - *Environment: `$PROVER_BROKER_STORE_MAP_SIZE_KB`* -**PROVER AGENT** +### aztec parse-parameter-struct -- `--prover-agent` - Starts Aztec Prover Agent with options +Helper for parsing an encoded string into a contract's parameter struct. -- `--proverAgent.proverAgentCount ` (default: `1`) - Whether this prover has a local prover agent - *Environment: `$PROVER_AGENT_COUNT`* +**Usage:** +```bash +aztec parse-parameter-struct [options] +``` -- `--proverAgent.proverAgentPollIntervalMs ` (default: `1000`) - The interval agents poll for jobs at - *Environment: `$PROVER_AGENT_POLL_INTERVAL_MS`* +**Available Commands:** -- `--proverAgent.proverAgentProofTypes ` - The types of proofs the prover agent can generate - *Environment: `$PROVER_AGENT_PROOF_TYPES`* +- `encodedString` - The encoded hex string -- `--proverAgent.proverBrokerUrl ` - The URL where this agent takes jobs from - *Environment: `$PROVER_BROKER_HOST`* +**Options:** -- `--proverAgent.realProofs ` (default: `true`) - Whether to construct real proofs - *Environment: `$PROVER_REAL_PROOFS`* +- `-c --contract-artifact ` - A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js +- `-p --parameter ` - The name of the struct parameter to decode into +- `-h --help` - display help for command -- `--proverAgent.proverTestDelayType ` (default: `fixed`) - The type of artificial delay to introduce - *Environment: `$PROVER_TEST_DELAY_TYPE`* -- `--proverAgent.proverTestDelayMs ` - Artificial delay to introduce to all operations to the test prover. - *Environment: `$PROVER_TEST_DELAY_MS`* +#### Subcommands -- `--proverAgent.proverTestDelayFactor ` (default: `1`) - If using realistic delays, what percentage of realistic times to apply. - *Environment: `$PROVER_TEST_DELAY_FACTOR`* +#### aztec parse-parameter-struct encodedString -- `--p2p-enabled [value]` - Enable P2P subsystem - *Environment: `$P2P_ENABLED`* +*This command help is currently unavailable due to a technical issue.* -- `--p2p.p2pDiscoveryDisabled ` - A flag dictating whether the P2P discovery system should be disabled. - *Environment: `$P2P_DISCOVERY_DISABLED`* -- `--p2p.blockCheckIntervalMS ` (default: `100`) - The frequency in which to check for new L2 blocks. - *Environment: `$P2P_BLOCK_CHECK_INTERVAL_MS`* +### aztec preload-crs -- `--p2p.debugDisableColocationPenalty ` - DEBUG: Disable colocation penalty - NEVER set to true in production - *Environment: `$DEBUG_P2P_DISABLE_COLOCATION_PENALTY`* +Preload the points data needed for proving and verifying -- `--p2p.peerCheckIntervalMS ` (default: `30000`) - The frequency in which to check for new peers. - *Environment: `$P2P_PEER_CHECK_INTERVAL_MS`* +**Usage:** +```bash +aztec preload-crs [options] +``` -- `--p2p.l2QueueSize ` (default: `1000`) - Size of queue of L2 blocks to store. - *Environment: `$P2P_L2_QUEUE_SIZE`* +**Options:** -- `--p2p.listenAddress ` (default: `0.0.0.0`) - The listen address. ipv4 address. - *Environment: `$P2P_LISTEN_ADDR`* +- `-h --help` - display help for command -- `--p2p.p2pPort ` (default: `40400`) - The port for the P2P service. Defaults to 40400 - *Environment: `$P2P_PORT`* +### aztec profile -- `--p2p.p2pBroadcastPort ` - The port to broadcast the P2P service on (included in the node's ENR). Defaults to P2P_PORT. - *Environment: `$P2P_BROADCAST_PORT`* +Profiles a private function by counting the unconditional operations in its -- `--p2p.p2pIp ` - The IP address for the P2P service. ipv4 address. - *Environment: `$P2P_IP`* +**Usage:** +```bash +aztec profile [options] +``` -- `--p2p.peerIdPrivateKey ` - An optional peer id private key. If blank, will generate a random key. - *Environment: `$PEER_ID_PRIVATE_KEY`* +**Available Commands:** -- `--p2p.peerIdPrivateKeyPath ` - 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`* +- `functionName` - Name of function to simulate -- `--p2p.bootstrapNodes ` - A list of bootstrap peer ENRs to connect to. Separated by commas. - *Environment: `$BOOTSTRAP_NODES`* +**Options:** -- `--p2p.bootstrapNodeEnrVersionCheck ` - Whether to check the version of the bootstrap node ENR. - *Environment: `$P2P_BOOTSTRAP_NODE_ENR_VERSION_CHECK`* +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Function arguments (default: []) +- `-ca --contract-address
` - Aztec address of the contract. +- `-c --contract-artifact ` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract +- `--debug-execution-steps-dir
` - Directory to write execution step artifacts for bb profiling/debugging. +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -- `--p2p.bootstrapNodesAsFullPeers ` - Whether to consider our configured bootnodes as full peers - *Environment: `$P2P_BOOTSTRAP_NODES_AS_FULL_PEERS`* -- `--p2p.maxPeerCount ` (default: `100`) - The maximum number of peers to connect to. - *Environment: `$P2P_MAX_PEERS`* +#### Subcommands -- `--p2p.queryForIp ` - If announceUdpAddress or announceTcpAddress are not provided, query for the IP address of the machine. Default is false. - *Environment: `$P2P_QUERY_FOR_IP`* +#### aztec profile functionName -- `--p2p.gossipsubInterval ` (default: `700`) - The interval of the gossipsub heartbeat to perform maintenance tasks. - *Environment: `$P2P_GOSSIPSUB_INTERVAL_MS`* +*This command help is currently unavailable due to a technical issue.* -- `--p2p.gossipsubD ` (default: `8`) - The D parameter for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_D`* -- `--p2p.gossipsubDlo ` (default: `4`) - The Dlo parameter for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_DLO`* +### aztec propose-with-lock -- `--p2p.gossipsubDhi ` (default: `12`) - The Dhi parameter for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_DHI`* +Makes a proposal to governance with a lock -- `--p2p.gossipsubDLazy ` (default: `8`) - The Dlazy parameter for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_DLAZY`* +**Usage:** +```bash +aztec propose-with-lock [options] +``` -- `--p2p.gossipsubFloodPublish ` - Whether to flood publish messages. - For testing purposes only - *Environment: `$P2P_GOSSIPSUB_FLOOD_PUBLISH`* +**Options:** -- `--p2p.gossipsubMcacheLength ` (default: `6`) - The number of gossipsub interval message cache windows to keep. - *Environment: `$P2P_GOSSIPSUB_MCACHE_LENGTH`* +- `-r --registry-address ` - The address of the registry contract +- `-p --payload-address ` - The address of the payload contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `-pk --private-key ` - The private key to use to propose +- `-m --mnemonic ` - The mnemonic to use to propose (default: +- `-i --mnemonic-index ` - The index of the mnemonic to use to propose +- `--json` - Output the proposal ID in JSON format +- `-h --help` - display help for command -- `--p2p.gossipsubMcacheGossip ` (default: `3`) - How many message cache windows to include when gossiping with other peers. - *Environment: `$P2P_GOSSIPSUB_MCACHE_GOSSIP`* +### aztec prune-rollup -- `--p2p.gossipsubSeenTTL ` (default: `1200000`) - How long to keep message IDs in the seen cache. - *Environment: `$P2P_GOSSIPSUB_SEEN_TTL`* +Prunes the pending chain on the rollup contract. -- `--p2p.gossipsubTxTopicWeight ` (default: `1`) - The weight of the tx topic for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_TX_TOPIC_WEIGHT`* +**Usage:** +```bash +aztec prune-rollup [options] +``` -- `--p2p.gossipsubTxInvalidMessageDeliveriesWeight ` (default: `-20`) - The weight of the tx invalid message deliveries for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_TX_INVALID_MESSAGE_DELIVERIES_WEIGHT`* +**Options:** -- `--p2p.gossipsubTxInvalidMessageDeliveriesDecay ` (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`* +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-pk --private-key ` - The private key to use for deployment +- `-m --mnemonic ` - The mnemonic to use in deployment (default: +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--rollup
` - ethereum address of the rollup contract +- `-h --help` - display help for command -- `--p2p.peerPenaltyValues ` (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`* +### aztec register-contract -- `--p2p.doubleSpendSeverePeerPenaltyWindow ` (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`* +Registers a contract in this wallet's PXE -- `--p2p.blockRequestBatchSize ` (default: `20`) - The number of blocks to fetch in a single batch. - *Environment: `$P2P_BLOCK_REQUEST_BATCH_SIZE`* +**Usage:** +```bash +aztec register-contract [options] [address] [artifact] +``` -- `--p2p.archivedTxLimit ` - 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`* +**Available Commands:** -- `--p2p.trustedPeers ` - A list of trusted peer ENRs that will always be persisted. Separated by commas. - *Environment: `$P2P_TRUSTED_PEERS`* +- `address` - The address of the contract to register +- `artifact` - Path to a compiled Aztec contract's artifact in -- `--p2p.privatePeers ` - A list of private peer ENRs that will always be persisted and not be used for discovery. Separated by commas. - *Environment: `$P2P_PRIVATE_PEERS`* +**Options:** -- `--p2p.preferredPeers ` - A list of preferred peer ENRs that will always be persisted and not be used for discovery. Separated by commas. - *Environment: `$P2P_PREFERRED_PEERS`* +- `--init ` - The contract initializer function to call +- `-k --public-key ` - Optional encryption public key for this address. +- `-s --salt ` - Optional deployment salt as a hex string for +- `--deployer ` - The address of the account that deployed the +- `--args` - [args...] Constructor arguments (default: []) +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--p2p.p2pStoreMapSizeKb ` - The maximum possible size of the P2P DB in KB. Overwrites the general dataStoreMapSizeKb. - *Environment: `$P2P_STORE_MAP_SIZE_KB`* -- `--p2p.txPublicSetupAllowList ` - The list of functions calls allowed to run in setup - *Environment: `$TX_PUBLIC_SETUP_ALLOWLIST`* +#### Subcommands -- `--p2p.maxTxPoolSize ` (default: `100000000`) - The maximum cumulative tx size of pending txs (in bytes) before evicting lower priority txs. - *Environment: `$P2P_MAX_TX_POOL_SIZE`* +#### aztec register-contract address -- `--p2p.txPoolOverflowFactor ` (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`* +*This command help is currently unavailable due to a technical issue.* -- `--p2p.seenMessageCacheSize ` (default: `100000`) - The number of messages to keep in the seen message cache - *Environment: `$P2P_SEEN_MSG_CACHE_SIZE`* -- `--p2p.p2pDisableStatusHandshake ` - True to disable the status handshake on peer connected. - *Environment: `$P2P_DISABLE_STATUS_HANDSHAKE`* +#### aztec register-contract artifact -- `--p2p.p2pAllowOnlyValidators ` - True to only permit validators to connect. - *Environment: `$P2P_ALLOW_ONLY_VALIDATORS`* +*This command help is currently unavailable due to a technical issue.* -- `--p2p.p2pMaxFailedAuthAttemptsAllowed ` (default: `3`) - Number of auth attempts to allow before peer is banned. Number is inclusive - *Environment: `$P2P_MAX_AUTH_FAILED_ATTEMPTS_ALLOWED`* -- `--p2p.dropTransactions ` - True to simulate discarding transactions. - For testing purposes only - *Environment: `$P2P_DROP_TX`* +### aztec register-sender -- `--p2p.dropTransactionsProbability ` - The probability that a transaction is discarded. - For testing purposes only - *Environment: `$P2P_DROP_TX_CHANCE`* +Registers a sender's address in the wallet, so the note synching process will -- `--p2p.disableTransactions ` - Whether transactions are disabled for this node. This means transactions will be rejected at the RPC and P2P layers. - *Environment: `$TRANSACTIONS_DISABLED`* +**Usage:** +```bash +aztec register-sender [options] [address] +``` -- `--p2p.txPoolDeleteTxsAfterReorg ` - 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`* +**Available Commands:** -- `--p2p.overallRequestTimeoutMs ` (default: `10000`) - The overall timeout for a request response operation. - *Environment: `$P2P_REQRESP_OVERALL_REQUEST_TIMEOUT_MS`* +- `address` - The address of the sender to register -- `--p2p.individualRequestTimeoutMs ` (default: `10000`) - The timeout for an individual request response peer interaction. - *Environment: `$P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS`* +**Options:** -- `--p2p.dialTimeoutMs ` (default: `5000`) - How long to wait for the dial protocol to establish a connection - *Environment: `$P2P_REQRESP_DIAL_TIMEOUT_MS`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--p2p.p2pOptimisticNegotiation ` - Whether to use optimistic protocol negotiation when dialing to another peer (opposite of `negotiateFully`). - *Environment: `$P2P_REQRESP_OPTIMISTIC_NEGOTIATION`* -- `--p2p.txCollectionFastNodesTimeoutBeforeReqRespMs ` (default: `200`) - How long to wait before starting reqresp for fast collection - *Environment: `$TX_COLLECTION_FAST_NODES_TIMEOUT_BEFORE_REQ_RESP_MS`* +#### Subcommands -- `--p2p.txCollectionSlowNodesIntervalMs ` (default: `12000`) - How often to collect from configured nodes in the slow collection loop - *Environment: `$TX_COLLECTION_SLOW_NODES_INTERVAL_MS`* +#### aztec register-sender address -- `--p2p.txCollectionSlowReqRespIntervalMs ` (default: `12000`) - How often to collect from peers via reqresp in the slow collection loop - *Environment: `$TX_COLLECTION_SLOW_REQ_RESP_INTERVAL_MS`* +*This command help is currently unavailable due to a technical issue.* -- `--p2p.txCollectionSlowReqRespTimeoutMs ` (default: `20000`) - How long to wait for a reqresp response during slow collection - *Environment: `$TX_COLLECTION_SLOW_REQ_RESP_TIMEOUT_MS`* -- `--p2p.txCollectionReconcileIntervalMs ` (default: `60000`) - How often to reconcile found txs from the tx pool - *Environment: `$TX_COLLECTION_RECONCILE_INTERVAL_MS`* +### aztec remove-l1-validator -- `--p2p.txCollectionDisableSlowDuringFastRequests ` (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`* +Removes a validator to the L1 rollup contract. -- `--p2p.txCollectionFastNodeIntervalMs ` (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`* +**Usage:** +```bash +aztec remove-l1-validator [options] +``` -- `--p2p.txCollectionNodeRpcUrls ` - A comma-separated list of Aztec node RPC URLs to use for tx collection - *Environment: `$TX_COLLECTION_NODE_RPC_URLS`* +**Options:** -- `--p2p.txCollectionFastMaxParallelRequestsPerNode ` (default: `4`) - Maximum number of parallel requests to make to a node during fast collection - *Environment: `$TX_COLLECTION_FAST_MAX_PARALLEL_REQUESTS_PER_NODE`* +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-pk --private-key ` - The private key to use for deployment +- `-m --mnemonic ` - The mnemonic to use in deployment (default: +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--validator
` - ethereum address of the validator +- `--rollup
` - ethereum address of the rollup contract +- `-h --help` - display help for command -- `--p2p.txCollectionNodeRpcMaxBatchSize ` (default: `50`) - Maximum number of transactions to request from a node in a single batch - *Environment: `$TX_COLLECTION_NODE_RPC_MAX_BATCH_SIZE`* +### aztec send -- `--p2p-bootstrap` - Starts Aztec P2P Bootstrap with options +Calls a function on an Aztec contract. -- `--p2pBootstrap.p2pBroadcastPort ` - The port to broadcast the P2P service on (included in the node's ENR). Defaults to P2P_PORT. - *Environment: `$P2P_BROADCAST_PORT`* +**Usage:** +```bash +aztec send [options] +``` -- `--p2pBootstrap.peerIdPrivateKeyPath ` - 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`* +**Available Commands:** -- `--p2pBootstrap.queryForIp ` - If announceUdpAddress or announceTcpAddress are not provided, query for the IP address of the machine. Default is false. - *Environment: `$P2P_QUERY_FOR_IP`* +- `functionName` - Name of function to execute -**TELEMETRY** +**Options:** -- `--tel.metricsCollectorUrl ` - The URL of the telemetry collector for metrics - *Environment: `$OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`* +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Function arguments (default: []) +- `-c --contract-artifact ` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract +- `-ca --contract-address
` - Aztec address of the contract. +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `--no-wait` - Print transaction hash without waiting for it to be mined +- `--no-cancel` - Do not allow the transaction to be cancelled. This makes for cheaper transactions. +- `-v --verbose` - Provide timings on all executed operations (synching, simulating, proving) (default: false) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -- `--tel.tracesCollectorUrl ` - The URL of the telemetry collector for traces - *Environment: `$OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`* -- `--tel.logsCollectorUrl ` - The URL of the telemetry collector for logs - *Environment: `$OTEL_EXPORTER_OTLP_LOGS_ENDPOINT`* +#### Subcommands -- `--tel.otelCollectIntervalMs ` (default: `60000`) - The interval at which to collect metrics - *Environment: `$OTEL_COLLECT_INTERVAL_MS`* +#### aztec send functionName -- `--tel.otelExportTimeoutMs ` (default: `30000`) - The timeout for exporting metrics - *Environment: `$OTEL_EXPORT_TIMEOUT_MS`* +*This command help is currently unavailable due to a technical issue.* -- `--tel.otelExcludeMetrics ` - A list of metric prefixes to exclude from export - *Environment: `$OTEL_EXCLUDE_METRICS`* -- `--tel.publicMetricsCollectorUrl ` - A URL to publish a subset of metrics for public consumption - *Environment: `$PUBLIC_OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`* +### aztec sequencers -- `--tel.publicMetricsCollectFrom ` - The role types to collect metrics from - *Environment: `$PUBLIC_OTEL_COLLECT_FROM`* +Manages or queries registered sequencers on the L1 rollup contract. -- `--tel.publicIncludeMetrics ` - A list of metric prefixes to publicly export - *Environment: `$PUBLIC_OTEL_INCLUDE_METRICS`* +**Usage:** +```bash +aztec sequencers [options] [who] +``` -- `--tel.publicMetricsOptOut ` (default: `true`) - Whether to opt out of sharing optional telemetry - *Environment: `$PUBLIC_OTEL_OPT_OUT`* +**Available Commands:** -**BOT** +- `command` - Command to run: list, add, remove, who-next +- `who` - Who to add/remove -- `--bot` - Starts Aztec Bot with options +**Options:** -- `--bot.nodeUrl ` - The URL to the Aztec node to check for tx pool status. - *Environment: `$AZTEC_NODE_URL`* +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-m --mnemonic ` - The mnemonic for the sender of the tx (default: +- `--block-number ` - Block number to query next sequencer for +- `-u --rpc-url ` - URL of the PXE (default: +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `-h --help` - display help for command -- `--bot.nodeAdminUrl ` - The URL to the Aztec node admin API to force-flush txs if configured. - *Environment: `$AZTEC_NODE_ADMIN_URL`* -- `--bot.pxeUrl ` - URL to the PXE for sending txs, or undefined if an in-proc PXE is used. - *Environment: `$BOT_PXE_URL`* +#### Subcommands -- `--bot.l1Mnemonic ` - The mnemonic for the account to bridge fee juice from L1. - *Environment: `$BOT_L1_MNEMONIC`* +#### aztec sequencers command -- `--bot.l1PrivateKey ` - The private key for the account to bridge fee juice from L1. - *Environment: `$BOT_L1_PRIVATE_KEY`* +*This command help is currently unavailable due to a technical issue.* -- `--bot.l1ToL2MessageTimeoutSeconds ` (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 ` - Signing private key for the sender account. - *Environment: `$BOT_PRIVATE_KEY`* +#### aztec sequencers who -- `--bot.senderSalt ` - The salt to use to deploys the sender account. - *Environment: `$BOT_ACCOUNT_SALT`* +*This command help is currently unavailable due to a technical issue.* -- `--bot.recipientEncryptionSecret ` (default: `0x00000000000000000000000000000000000000000000000000000000cafecafe`) - Encryption secret for a recipient account. - *Environment: `$BOT_RECIPIENT_ENCRYPTION_SECRET`* -- `--bot.tokenSalt ` (default: `0x0000000000000000000000000000000000000000000000000000000000000001`) - Salt for the token contract deployment. - *Environment: `$BOT_TOKEN_SALT`* +### aztec setup-protocol-contracts -- `--bot.txIntervalSeconds ` (default: `60`) - Every how many seconds should a new tx be sent. - *Environment: `$BOT_TX_INTERVAL_SECONDS`* +Bootstrap the blockchain by initializing all the protocol contracts -- `--bot.privateTransfersPerTx ` (default: `1`) - How many private token transfers are executed per tx. - *Environment: `$BOT_PRIVATE_TRANSFERS_PER_TX`* +**Usage:** +```bash +aztec setup-protocol-contracts [options] +``` -- `--bot.publicTransfersPerTx ` (default: `1`) - How many public token transfers are executed per tx. - *Environment: `$BOT_PUBLIC_TRANSFERS_PER_TX`* +**Options:** -- `--bot.feePaymentMethod ` (default: `fee_juice`) - How to handle fee payments. (Options: fee_juice) - *Environment: `$BOT_FEE_PAYMENT_METHOD`* +- `-u --rpc-url ` - URL of the PXE (default: +- `--testAccounts` - Deploy funded test accounts. +- `--sponsoredFPC` - Deploy a sponsored FPC. +- `--json` - Output the contract addresses in JSON format +- `--skipProofWait` - Don't wait for proofs to land. +- `-h --help` - display help for command -- `--bot.noStart ` - True to not automatically setup or start the bot on initialization. - *Environment: `$BOT_NO_START`* +### aztec simulate -- `--bot.txMinedWaitSeconds ` (default: `180`) - How long to wait for a tx to be mined before reporting an error. - *Environment: `$BOT_TX_MINED_WAIT_SECONDS`* +Simulates the execution of a function on an Aztec contract. -- `--bot.followChain ` (default: `NONE`) - Which chain the bot follows - *Environment: `$BOT_FOLLOW_CHAIN`* +**Usage:** +```bash +aztec simulate [options] +``` -- `--bot.maxPendingTxs ` (default: `128`) - Do not send a tx if the node's tx pool already has this many pending txs. - *Environment: `$BOT_MAX_PENDING_TXS`* +**Available Commands:** -- `--bot.flushSetupTransactions ` - Make a request for the sequencer to build a block after each setup transaction. - *Environment: `$BOT_FLUSH_SETUP_TRANSACTIONS`* +- `functionName` - Name of function to simulate -- `--bot.l2GasLimit ` - L2 gas limit for the tx (empty to have the bot trigger an estimate gas). - *Environment: `$BOT_L2_GAS_LIMIT`* +**Options:** -- `--bot.daGasLimit ` - DA gas limit for the tx (empty to have the bot trigger an estimate gas). - *Environment: `$BOT_DA_GAS_LIMIT`* +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Function arguments (default: []) +- `-ca --contract-address
` - Aztec address of the contract. +- `-c --contract-artifact ` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `-v --verbose` - Provide timings on all executed operations (synching, simulating, proving) (default: false) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -- `--bot.contract ` (default: `TokenContract`) - Token contract to use - *Environment: `$BOT_TOKEN_CONTRACT`* -- `--bot.maxConsecutiveErrors ` - The maximum number of consecutive errors before the bot shuts down - *Environment: `$BOT_MAX_CONSECUTIVE_ERRORS`* +#### Subcommands -- `--bot.stopWhenUnhealthy ` - Stops the bot if service becomes unhealthy - *Environment: `$BOT_STOP_WHEN_UNHEALTHY`* +#### aztec simulate functionName -- `--bot.ammTxs ` - Deploy an AMM and send swaps to it - *Environment: `$BOT_AMM_TXS`* +*This command help is currently unavailable due to a technical issue.* -**PXE** -- `--pxe` - Starts Aztec PXE with options +### aztec start -- `--pxe.l2BlockBatchSize ` (default: `50`) - Maximum amount of blocks to pull from the stream in one request when synchronizing - *Environment: `$PXE_L2_BLOCK_BATCH_SIZE`* +**Options:** -- `--pxe.bbBinaryPath ` - Path to the BB binary - *Environment: `$BB_BINARY_PATH`* +- `--bot.noStart ` - ($BOT_NO_START) +- `--bot.txMinedWaitSeconds ` - (default: 180) ($BOT_TX_MINED_WAIT_SECONDS) +- `--bot.followChain ` - (default: NONE) ($BOT_FOLLOW_CHAIN) +- `--bot.maxPendingTxs ` - (default: 128) ($BOT_MAX_PENDING_TXS) +- `--bot.flushSetupTransactions ` - ($BOT_FLUSH_SETUP_TRANSACTIONS) +- `--bot.l2GasLimit ` - ($BOT_L2_GAS_LIMIT) +- `--bot.daGasLimit ` - ($BOT_DA_GAS_LIMIT) +- `--bot.contract ` - (default: TokenContract) ($BOT_TOKEN_CONTRACT) +- `--bot.maxConsecutiveErrors ` - ($BOT_MAX_CONSECUTIVE_ERRORS) +- `--bot.stopWhenUnhealthy ` - ($BOT_STOP_WHEN_UNHEALTHY) +- `--bot.ammTxs ` - ($BOT_AMM_TXS) +- `--pxe` - +- `--pxe.l2BlockBatchSize ` - (default: 50) ($PXE_L2_BLOCK_BATCH_SIZE) +- `--pxe.bbBinaryPath ` - ($BB_BINARY_PATH) +- `--pxe.bbWorkingDirectory ` - ($BB_WORKING_DIRECTORY) +- `--pxe.bbSkipCleanup ` - ($BB_SKIP_CLEANUP) +- `--pxe.proverEnabled ` - (default: true) ($PXE_PROVER_ENABLED) +- `--pxe.nodeUrl ` - ($AZTEC_NODE_URL) +- `--txe` - -- `--pxe.bbWorkingDirectory ` - Working directory for the BB binary - *Environment: `$BB_WORKING_DIRECTORY`* +### aztec trigger-seed-snapshot -- `--pxe.bbSkipCleanup ` - True to skip cleanup of temporary files for debugging purposes - *Environment: `$BB_SKIP_CLEANUP`* +Triggers a seed snapshot for the next epoch. -- `--pxe.proverEnabled ` (default: `true`) - Enable real proofs - *Environment: `$PXE_PROVER_ENABLED`* +**Usage:** +```bash +aztec trigger-seed-snapshot [options] +``` -- `--pxe.nodeUrl ` - Custom Aztec Node URL to connect to - *Environment: `$AZTEC_NODE_URL`* +**Options:** -**TXE** +- `-pk --private-key ` - The private key to use for deployment +- `-m --mnemonic ` - The mnemonic to use in deployment (default: +- `--rollup
` - ethereum address of the rollup contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `-h --help` - display help for command -- `--txe` - Starts Aztec TXE with options +### aztec update -### aztec trigger-seed-snapshot +Updates Nodejs and Noir dependencies +**Usage:** +```bash +aztec update [options] [projectPath] ``` -Usage: aztec trigger-seed-snapshot [options] -Triggers a seed snapshot for the next epoch. +**Available Commands:** -Options: - -pk, --private-key The private key to use for deployment - -m, --mnemonic The mnemonic to use in deployment (default: - "test test test test test test test test test - test test junk") - --rollup
ethereum address of the rollup contract - --l1-rpc-urls 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 Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - -h, --help display help for command +- `projectPath` - Path to the project directory (default: -``` +**Options:** -### aztec update +- `--contract` - [paths...] Paths to contracts to update dependencies (default: +- `--aztec-version ` - The version to update Aztec packages to. Defaults +- `-h --help` - display help for command -``` -Usage: aztec update [options] [projectPath] -Updates Nodejs and Noir dependencies +#### Subcommands -Arguments: - projectPath Path to the project directory +#### aztec update projectPath -Options: - --contract [paths...] Paths to contracts to update dependencies (default: - []) - --aztec-version The version to update Aztec packages to. Defaults - to latest (default: "latest") - -h, --help display help for command +*This command help is currently unavailable due to a technical issue.* -``` ### aztec validator-keys|valKeys @@ -2383,32 +1544,23 @@ Options: ### aztec vote-on-governance-proposal -``` -Usage: aztec vote-on-governance-proposal [options] - Votes on a governance proposal. -Options: - -p, --proposal-id The ID of the proposal - -a, --vote-amount The amount of tokens to vote - --in-favor Whether to vote in favor of the proposal. - Use "yea" for true, any other value for - false. - --wait Whether to wait until the proposal is active - -r, --registry-address The address of the registry contract - --l1-rpc-urls 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 Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - -pk, --private-key The private key to use to vote - -m, --mnemonic The mnemonic to use to vote (default: "test - test test test test test test test test test - test junk") - -i, --mnemonic-index The index of the mnemonic to use to vote - (default: 0) - -h, --help display help for command - +**Usage:** +```bash +aztec vote-on-governance-proposal [options] ``` + +**Options:** + +- `-p --proposal-id ` - The ID of the proposal +- `-a --vote-amount ` - The amount of tokens to vote +- `--in-favor ` - Whether to vote in favor of the proposal. +- `--wait ` - Whether to wait until the proposal is active +- `-r --registry-address ` - The address of the registry contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `-pk --private-key ` - The private key to use to vote +- `-m --mnemonic ` - The mnemonic to use to vote (default: "test +- `-i --mnemonic-index ` - The index of the mnemonic to use to vote +- `-h --help` - display help for command diff --git a/docs/developer_versioned_docs/version-v3.0.0-nightly.20260101/docs/cli/bb_cli_reference.md b/docs/developer_versioned_docs/version-v3.0.0-nightly.20260101/docs/cli/bb_cli_reference.md index 71a1c1f82725..28d09719da63 100644 --- a/docs/developer_versioned_docs/version-v3.0.0-nightly.20260101/docs/cli/bb_cli_reference.md +++ b/docs/developer_versioned_docs/version-v3.0.0-nightly.20260101/docs/cli/bb_cli_reference.md @@ -1,6 +1,6 @@ --- title: Barretenberg CLI Reference -description: Comprehensive auto-generated reference for the Barretenberg CLI Reference command-line interface with all commands and options. +description: Comprehensive auto-generated reference for the Barretenberg CLI command-line interface with all commands and options. tags: [cli, reference, autogenerated, barretenberg, proving] sidebar_position: 3 --- @@ -10,7 +10,7 @@ sidebar_position: 3 *This documentation is auto-generated from the `bb` CLI help output.* -*Generated: Thu 01 Jan 2026 09:56:44 UTC* +*Generated: Thu 01 Jan 2026 11:17:23 UTC* *Command: `bb`* diff --git a/docs/docs-developers/docs/cli/aztec_cli_reference.md b/docs/docs-developers/docs/cli/aztec_cli_reference.md index 6c6461a82b1d..da407481e10a 100644 --- a/docs/docs-developers/docs/cli/aztec_cli_reference.md +++ b/docs/docs-developers/docs/cli/aztec_cli_reference.md @@ -1,6 +1,6 @@ --- title: Aztec CLI Reference -description: Comprehensive auto-generated reference for the Aztec CLI Reference command-line interface with all commands and options. +description: Comprehensive auto-generated reference for the Aztec CLI command-line interface with all commands and options. tags: [cli, reference, autogenerated] sidebar_position: 1 --- @@ -10,7 +10,7 @@ sidebar_position: 1 *This documentation is auto-generated from the `aztec` CLI help output.* -*Generated: Wed 24 Dec 2025 17:46:59 UTC* +*Generated: Thu 01 Jan 2026 11:01:00 UTC* *Command: `aztec`* @@ -21,17 +21,29 @@ sidebar_position: 1 - [aztec add-l1-validator](#aztec-add-l1-validator) - [aztec advance-epoch](#aztec-advance-epoch) - [aztec authorize-action](#aztec-authorize-action) + - [aztec authorize-action functionName](#aztec-authorize-action-functionname) + - [aztec authorize-action caller](#aztec-authorize-action-caller) - [aztec block-number](#aztec-block-number) - [aztec bridge-erc20](#aztec-bridge-erc20) + - [aztec bridge-erc20 amount](#aztec-bridge-erc20-amount) + - [aztec bridge-erc20 recipient](#aztec-bridge-erc20-recipient) - [aztec bridge-fee-juice](#aztec-bridge-fee-juice) + - [aztec bridge-fee-juice amount](#aztec-bridge-fee-juice-amount) + - [aztec bridge-fee-juice recipient](#aztec-bridge-fee-juice-recipient) - [aztec cancel-tx](#aztec-cancel-tx) - [aztec codegen](#aztec-codegen) + - [aztec codegen noir-abi-path](#aztec-codegen-noir-abi-path) - [aztec compute-selector](#aztec-compute-selector) + - [aztec compute-selector functionSignature](#aztec-compute-selector-functionsignature) - [aztec create-account](#aztec-create-account) - [aztec create-authwit](#aztec-create-authwit) + - [aztec create-authwit functionName](#aztec-create-authwit-functionname) + - [aztec create-authwit caller](#aztec-create-authwit-caller) - [aztec debug-rollup](#aztec-debug-rollup) - [aztec decode-enr](#aztec-decode-enr) + - [aztec decode-enr enr](#aztec-decode-enr-enr) - [aztec deploy](#aztec-deploy) + - [aztec deploy artifact](#aztec-deploy-artifact) - [aztec deploy-account](#aztec-deploy-account) - [aztec deploy-l1-contracts](#aztec-deploy-l1-contracts) - [aztec deploy-new-rollup](#aztec-deploy-new-rollup) @@ -41,40 +53,59 @@ sidebar_position: 1 - [aztec fast-forward-epochs](#aztec-fast-forward-epochs) - [aztec generate-bls-keypair](#aztec-generate-bls-keypair) - [aztec generate-bootnode-enr](#aztec-generate-bootnode-enr) + - [aztec generate-bootnode-enr privateKey](#aztec-generate-bootnode-enr-privatekey) + - [aztec generate-bootnode-enr p2pIp](#aztec-generate-bootnode-enr-p2pip) + - [aztec generate-bootnode-enr p2pPort](#aztec-generate-bootnode-enr-p2pport) - [aztec generate-keys](#aztec-generate-keys) - [aztec generate-l1-account](#aztec-generate-l1-account) - [aztec generate-p2p-private-key](#aztec-generate-p2p-private-key) - [aztec generate-secret-and-hash](#aztec-generate-secret-and-hash) - [aztec get-account](#aztec-get-account) + - [aztec get-account address](#aztec-get-account-address) - [aztec get-accounts](#aztec-get-accounts) - [aztec get-block](#aztec-get-block) + - [aztec get-block blockNumber](#aztec-get-block-blocknumber) - [aztec get-canonical-sponsored-fpc-address](#aztec-get-canonical-sponsored-fpc-address) - [aztec get-contract-data](#aztec-get-contract-data) + - [aztec get-contract-data contractAddress](#aztec-get-contract-data-contractaddress) - [aztec get-current-base-fee](#aztec-get-current-base-fee) - [aztec get-l1-addresses](#aztec-get-l1-addresses) - [aztec get-l1-balance](#aztec-get-l1-balance) + - [aztec get-l1-balance who](#aztec-get-l1-balance-who) - [aztec get-l1-to-l2-message-witness](#aztec-get-l1-to-l2-message-witness) - [aztec get-logs](#aztec-get-logs) - [aztec get-node-info](#aztec-get-node-info) - [aztec get-pxe-info](#aztec-get-pxe-info) - [aztec get-tx](#aztec-get-tx) + - [aztec get-tx txHash](#aztec-get-tx-txhash) - [aztec import-test-accounts](#aztec-import-test-accounts) - [aztec inspect-contract](#aztec-inspect-contract) + - [aztec inspect-contract contractArtifactFile](#aztec-inspect-contract-contractartifactfile) - [aztec parse-parameter-struct](#aztec-parse-parameter-struct) + - [aztec parse-parameter-struct encodedString](#aztec-parse-parameter-struct-encodedstring) - [aztec preload-crs](#aztec-preload-crs) - [aztec profile](#aztec-profile) + - [aztec profile functionName](#aztec-profile-functionname) - [aztec propose-with-lock](#aztec-propose-with-lock) - [aztec prune-rollup](#aztec-prune-rollup) - [aztec register-contract](#aztec-register-contract) + - [aztec register-contract address](#aztec-register-contract-address) + - [aztec register-contract artifact](#aztec-register-contract-artifact) - [aztec register-sender](#aztec-register-sender) + - [aztec register-sender address](#aztec-register-sender-address) - [aztec remove-l1-validator](#aztec-remove-l1-validator) - [aztec send](#aztec-send) + - [aztec send functionName](#aztec-send-functionname) - [aztec sequencers](#aztec-sequencers) + - [aztec sequencers command](#aztec-sequencers-command) + - [aztec sequencers who](#aztec-sequencers-who) - [aztec setup-protocol-contracts](#aztec-setup-protocol-contracts) - [aztec simulate](#aztec-simulate) + - [aztec simulate functionName](#aztec-simulate-functionname) - [aztec start](#aztec-start) - [aztec trigger-seed-snapshot](#aztec-trigger-seed-snapshot) - [aztec update](#aztec-update) + - [aztec update projectPath](#aztec-update-projectpath) - [aztec validator-keys|valKeys](#aztec-validator-keys|valkeys) - [aztec vote-on-governance-proposal](#aztec-vote-on-governance-proposal) ## aztec @@ -160,2221 +191,1351 @@ aztec [options] [command] ### aztec add-contract -``` -Usage: aztec add-contract [options] - Adds an existing contract to the PXE. This is useful if you have deployed a -contract outside of the PXE and want to use it with the PXE. - -Options: - -c, --contract-artifact A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js - -ca, --contract-address
Aztec address of the contract. - --init-hash Initialization hash - --salt Optional deployment salt - -p, --public-key Optional public key for this contract - --portal-address
Optional address to a portal contract on L1 - --deployer-address
Optional address of the contract deployer - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command - -``` - -### 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 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 Network to execute against (env: NETWORK) - -pk, --private-key The private key to use sending the transaction - -m, --mnemonic The mnemonic to use sending the transaction - (default: "test test test test test test test - test test test test junk") - -c, --l1-chain-id Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - --attester
ethereum address of the attester - --withdrawer
ethereum address of the withdrawer - --bls-secret-key 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 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 List of Ethereum host URLs. Chain identifiers - localhost and testnet can be used (comma separated) - (default: ["http://host.docker.internal:8545"], env: - ETHEREUM_HOSTS) - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command - -``` - -### aztec authorize-action - -``` -Usage: aztec authorize-action [options] - -Authorizes a public call on the caller, so they can perform an action on behalf -of the provided account - -Arguments: - functionName Name of function to authorize - caller Account to be authorized to perform the action - -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Function arguments (default: []) - -ca, --contract-address
Aztec address of the contract. - -c, --contract-artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - -h, --help display help for command - -``` - -### aztec block-number - -``` -Usage: aztec block-number [options] - -Gets the current Aztec L2 block number. - -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command - -``` - -### aztec bridge-erc20 - -``` -Usage: aztec bridge-erc20 [options] - -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 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 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 Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - -t, --token The address of the token to bridge - -p, --portal The address of the portal contract - -f, --faucet The address of the faucet contract (only used if - minting) - --l1-private-key The private key to use for deployment - --json Output the claim in JSON format - -h, --help display help for command - -``` - -### aztec bridge-fee-juice - -``` -Usage: aztec bridge-fee-juice [options] - -Mints L1 Fee Juice and pushes them to L2. - -Arguments: - amount The amount of Fee Juice to mint and bridge. - recipient Aztec address of the recipient. - -Options: - --l1-rpc-urls List of Ethereum host URLs. Chain identifiers - localhost and testnet can be used (comma - separated) (default: - ["http://host.docker.internal:8545"]) - -m, --mnemonic 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) - --l1-private-key The private key to the eth account bridging - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -c, --l1-chain-id Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - --json Output the claim in JSON format - --no-wait Wait for the bridged funds to be available in L2, - polling every 60 seconds - --interval The polling interval in seconds for the bridged - funds (default: "60") - -h, --help display help for command +**Usage:** +```bash +aztec add-contract [options] ``` -### aztec cancel-tx - -*Help for this command is currently unavailable due to a technical issue with option serialization.* - - -### aztec codegen - -``` -Usage: aztec codegen [options] +**Options:** -Validates and generates an Aztec Contract ABI from Noir ABI. +- `-c --contract-artifact ` - A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js +- `-ca --contract-address
` - Aztec address of the contract. +- `--init-hash ` - Initialization hash +- `--salt ` - Optional deployment salt +- `-p --public-key ` - Optional public key for this contract +- `--portal-address
` - Optional address to a portal contract on L1 +- `--deployer-address
` - Optional address of the contract deployer +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `-h --help` - display help for command -Arguments: - noir-abi-path Path to the Noir ABI or project dir. +### aztec add-l1-validator -Options: - -o, --outdir Output folder for the generated code. - -f, --force Force code generation even when the contract has not - changed. - -h, --help display help for command +Adds a validator to the L1 rollup contract via a direct deposit. +**Usage:** +```bash +aztec add-l1-validator [options] ``` -### aztec compute-selector - -``` -Usage: aztec compute-selector [options] +**Options:** -Given a function signature, it computes a selector +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `--network ` - Network to execute against (env: NETWORK) +- `-pk --private-key ` - The private key to use sending the transaction +- `-m --mnemonic ` - The mnemonic to use sending the transaction +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--attester
` - ethereum address of the attester +- `--withdrawer
` - ethereum address of the withdrawer +- `--bls-secret-key ` - The BN254 scalar field element used as a secret +- `--move-with-latest-rollup` - Whether to move with the latest rollup (default: +- `--rollup ` - Rollup contract address +- `-h --help` - display help for command -Arguments: - functionSignature Function signature to compute selector for e.g. foo(Field) +### aztec advance-epoch -Options: - -h, --help display help for command +Use L1 cheat codes to warp time until the next epoch. +**Usage:** +```bash +aztec advance-epoch [options] ``` -### aztec create-account - -``` -Usage: aztec create-account [options] +**Options:** -Creates an aztec account that can be used for sending transactions. Registers -the account on the PXE and deploys an account contract. Uses a Schnorr -single-key account which uses the same key for encryption and authentication -(not secure for production usage). - -Options: - --skip-initialization Skip initializing the account contract. Useful for publicly deploying an existing account. - --public-deploy Publishes the account contract instance (and the class, if needed). Needed if the contract contains public functions. - -p, --public-key Public key that identifies a private signing key stored outside of the wallet. Used for ECDSA SSH accounts over the secp256r1 curve. - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - -sk, --secret-key Secret key for account. Uses random by default. (env: SECRET_KEY) - -t, --type Type of account to create (choices: "schnorr", "ecdsasecp256r1", "ecdsasecp256r1ssh", "ecdsasecp256k1", default: "schnorr") - --register-only Just register the account on the PXE. Do not deploy or initialize the account contract. - --json Emit output as json - --no-wait Skip waiting for the contract to be deployed. Print the hash of deployment transaction - -v, --verbose Provide timings on all executed operations (synching, simulating, proving) (default: false) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - feePayer The account paying the fee. - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,feePayer=address,asset=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -``` +### aztec authorize-action -### aztec create-authwit +Authorizes a public call on the caller, so they can perform an action on behalf +**Usage:** +```bash +aztec authorize-action [options] ``` -Usage: aztec create-authwit [options] -Creates an authorization witness that can be privately sent to a caller so they -can perform an action on behalf of the provided account +**Available Commands:** -Arguments: - functionName Name of function to authorize - caller Account to be authorized to perform the action +- `functionName` - Name of function to authorize +- `caller` - Account to be authorized to perform the action -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Function arguments (default: []) - -ca, --contract-address
Aztec address of the contract. - -c, --contract-artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - -h, --help display help for command +**Options:** -``` +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Function arguments (default: []) +- `-ca --contract-address
` - Aztec address of the contract. +- `-c --contract-artifact ` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `-h --help` - display help for command -### aztec debug-rollup -``` -Usage: aztec debug-rollup [options] +#### Subcommands -Debugs the rollup contract. +#### aztec authorize-action functionName -Options: - --l1-rpc-urls 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 Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - --rollup
ethereum address of the rollup contract - -h, --help display help for command +*This command help is currently unavailable due to a technical issue.* -``` -### aztec decode-enr +#### aztec authorize-action caller -``` -Usage: aztec decode-enr [options] +*This command help is currently unavailable due to a technical issue.* -Decodes and ENR record -Arguments: - enr The encoded ENR string +### aztec block-number -Options: - -h, --help display help for command +Gets the current Aztec L2 block number. +**Usage:** +```bash +aztec block-number [options] ``` -### aztec deploy +**Options:** -``` -Usage: aztec deploy [options] [artifact] +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -Deploys a compiled Aztec.nr contract to Aztec. +### aztec bridge-erc20 -Arguments: - artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - -Options: - --init The contract initializer function to call (default: "constructor") - --no-init Leave the contract uninitialized - -k, --public-key Optional encryption public key for this address. Set this value only if this contract is expected to receive private notes, which will be encrypted using this public key. - -s, --salt Optional deployment salt as a hex string for generating the deployment address. - --universal Do not mix the sender address into the deployment. - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Constructor arguments (default: []) - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - --json Emit output as json - --no-wait Skip waiting for the contract to be deployed. Print the hash of deployment transaction - --no-class-registration Don't register this contract class - --no-public-deployment Don't emit this contract's public bytecode - --timeout The amount of time in seconds to wait for the deployment to post to L2 - -v, --verbose Provide timings on all executed operations (synching, simulating, proving) (default: false) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,asset=address,fpc=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command +Bridges ERC20 tokens to L2. +**Usage:** +```bash +aztec bridge-erc20 [options] ``` -### aztec deploy-account +**Available Commands:** -``` -Usage: aztec deploy-account [options] +- `amount` - The amount of Fee Juice to mint and bridge. +- `recipient` - Aztec address of the recipient. -Deploys an already registered aztec account that can be used for sending -transactions. - -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --json Emit output as json - --no-wait Skip waiting for the contract to be deployed. Print the hash of deployment transaction - --register-class Register the contract class (useful for when the contract class has not been deployed yet). - --public-deploy Publishes the account contract instance (and the class, if needed). Needed if the contract contains public functions. - -v, --verbose Provide timings on all executed operations (synching, simulating, proving) (default: false) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - feePayer The account paying the fee. - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,feePayer=address,asset=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command +**Options:** -``` +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-m --mnemonic ` - The mnemonic to use for deriving the Ethereum +- `--mint` - Mint the tokens on L1 (default: false) +- `--private` - If the bridge should use the private flow +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `-t --token ` - The address of the token to bridge +- `-p --portal ` - The address of the portal contract +- `-f --faucet ` - The address of the faucet contract (only used if +- `--l1-private-key ` - The private key to use for deployment +- `--json` - Output the claim in JSON format +- `-h --help` - display help for command -### aztec deploy-l1-contracts -``` -Usage: aztec deploy-l1-contracts [options] +#### Subcommands -Deploys all necessary Ethereum contracts for Aztec. +#### aztec bridge-erc20 amount -Options: - --l1-rpc-urls 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 The private key to use for deployment - --validators Comma separated list of validators - -m, --mnemonic The mnemonic to use in deployment - (default: "test test test test test test - test test test test test junk") - -i, --mnemonic-index The index of the mnemonic to use in - deployment (default: 0) - -c, --l1-chain-id Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - --salt 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
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 +*This command help is currently unavailable due to a technical issue.* -``` -### aztec deploy-new-rollup +#### aztec bridge-erc20 recipient -``` -Usage: aztec deploy-new-rollup [options] +*This command help is currently unavailable due to a technical issue.* -Deploys a new rollup contract and adds it to the registry (if you are the -owner). - -Options: - -r, --registry-address The address of the registry contract - --l1-rpc-urls 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 The private key to use for deployment - --validators Comma separated list of validators - -m, --mnemonic The mnemonic to use in deployment - (default: "test test test test test test - test test test test test junk") - -i, --mnemonic-index The index of the mnemonic to use in - deployment (default: 0) - -c, --l1-chain-id Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - --salt 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 bridge-fee-juice -### aztec deposit-governance-tokens +Mints L1 Fee Juice and pushes them to L2. +**Usage:** +```bash +aztec bridge-fee-juice [options] ``` -Usage: aztec deposit-governance-tokens [options] -Deposits governance tokens to the governance contract. - -Options: - -r, --registry-address The address of the registry contract - --recipient The recipient of the tokens - -a, --amount The amount of tokens to deposit - --mint Mint the tokens on L1 (default: false) - --l1-rpc-urls 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 Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - -p, --private-key The private key to use to deposit - -m, --mnemonic The mnemonic to use to deposit (default: - "test test test test test test test test - test test test junk") - -i, --mnemonic-index The index of the mnemonic to use to deposit - (default: 0) - -h, --help display help for command +**Available Commands:** -``` +- `amount` - The amount of Fee Juice to mint and bridge. +- `recipient` - Aztec address of the recipient. -### aztec example-contracts +**Options:** -``` -Usage: aztec example-contracts [options] +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-m --mnemonic ` - The mnemonic to use for deriving the Ethereum +- `--mint` - Mint the tokens on L1 (default: false) +- `--l1-private-key ` - The private key to the eth account bridging +- `-u --rpc-url ` - URL of the PXE (default: +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--json` - Output the claim in JSON format +- `--no-wait` - Wait for the brigded funds to be available in L2, +- `--interval ` - The polling interval in seconds for the bridged +- `-h --help` - display help for command -Lists the example contracts available to deploy from @aztec/noir-contracts.js -Options: - -h, --help display help for command +#### Subcommands -``` +#### aztec bridge-fee-juice amount -### aztec execute-governance-proposal +*This command help is currently unavailable due to a technical issue.* -``` -Usage: aztec execute-governance-proposal [options] -Executes a governance proposal. +#### aztec bridge-fee-juice recipient -Options: - -p, --proposal-id The ID of the proposal - -r, --registry-address The address of the registry contract - --wait Whether to wait until the proposal is - executable - --l1-rpc-urls 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 Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - -pk, --private-key The private key to use to vote - -m, --mnemonic The mnemonic to use to vote (default: "test - test test test test test test test test test - test junk") - -i, --mnemonic-index The index of the mnemonic to use to vote - (default: 0) - -h, --help display help for command +*This command help is currently unavailable due to a technical issue.* -``` -### aztec fast-forward-epochs +### aztec cancel-tx *Help for this command is currently unavailable due to a technical issue with option serialization.* -### aztec generate-bls-keypair - -``` -Usage: aztec generate-bls-keypair [options] - -Generate a BLS keypair with convenience flags - -Options: - --mnemonic Mnemonic for BLS derivation - --ikm Initial keying material for BLS (alternative to - mnemonic) - --bls-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 Write output to file - -h, --help display help for command - -``` - -### aztec generate-bootnode-enr - -``` -Usage: aztec generate-bootnode-enr [options] - -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 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. +### aztec codegen -Options: - --json Output the private key in JSON format - -h, --help display help for command +Validates and generates an Aztec Contract ABI from Noir ABI. +**Usage:** +```bash +aztec codegen [options] ``` -### aztec generate-p2p-private-key +**Available Commands:** -``` -Usage: aztec generate-p2p-private-key [options] +- `noir-abi-path` - Path to the Noir ABI or project dir. -Generates a private key that can be used for running a node on a LibP2P -network. +**Options:** -Options: - -h, --help display help for command +- `-o --outdir ` - Output folder for the generated code. +- `-f --force` - Force code generation even when the contract has not +- `-h --help` - display help for command -``` -### aztec generate-secret-and-hash +#### Subcommands -``` -Usage: aztec generate-secret-and-hash [options] +#### aztec codegen noir-abi-path -Generates an arbitrary secret (Fr), and its hash (using aztec-nr defaults) +*This command help is currently unavailable due to a technical issue.* -Options: - -h, --help display help for command -``` +### aztec compute-selector -### aztec get-account +Given a function signature, it computes a selector +**Usage:** +```bash +aztec compute-selector [options] ``` -Usage: aztec get-account [options]
- -Gets an account given its Aztec address. -Arguments: - address The Aztec address to get account for - -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command +**Available Commands:** -``` +- `functionSignature` - Function signature to compute selector for e.g. foo(Field) -### aztec get-accounts - -``` -Usage: aztec get-accounts [options] +**Options:** -Gets all the Aztec accounts stored in the PXE. +- `-h --help` - display help for command -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - --json Emit output as json - -h, --help display help for command -``` +#### Subcommands -### aztec get-block +#### aztec compute-selector functionSignature -``` -Usage: aztec get-block [options] [blockNumber] +*This command help is currently unavailable due to a technical issue.* -Gets info for a given block or latest. -Arguments: - blockNumber Block height +### aztec create-account -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command +Creates an aztec account that can be used for sending transactions. Registers +**Usage:** +```bash +aztec create-account [options] ``` -### aztec get-canonical-sponsored-fpc-address +**Options:** -``` -Usage: aztec get-canonical-sponsored-fpc-address [options] +- `--skip-initialization` - Skip initializing the account contract. Useful for publicly deploying an existing account. +- `--public-deploy` - Publishes the account contract instance (and the class, if needed). Needed if the contract contains public functions. +- `-p --public-key ` - Public key that identifies a private signing key stored outside of the wallet. Used for ECDSA SSH accounts over the secp256r1 curve. +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `-sk --secret-key ` - Secret key for account. Uses random by default. (env: SECRET_KEY) +- `-t --type ` - Type of account to create (choices: "schnorr", "ecdsasecp256r1", "ecdsasecp256r1ssh", "ecdsasecp256k1", default: "schnorr") +- `--register-only` - Just register the account on the PXE. Do not deploy or initialize the account contract. +- `--json` - Emit output as json +- `--no-wait` - Skip waiting for the contract to be deployed. Print the hash of deployment transaction +- `-v --verbose` - Provide timings on all executed operations (synching, simulating, proving) (default: false) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -Gets the canonical SponsoredFPC address for this any testnet running on the -same version as this CLI +### aztec create-authwit -Options: - -h, --help display help for command +Creates an authorization witness that can be privately sent to a caller so they +**Usage:** +```bash +aztec create-authwit [options] ``` -### aztec get-contract-data +**Available Commands:** -``` -Usage: aztec get-contract-data [options] +- `functionName` - Name of function to authorize +- `caller` - Account to be authorized to perform the action -Gets information about the Aztec contract deployed at the specified address. +**Options:** -Arguments: - contractAddress Aztec address of the contract. +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Function arguments (default: []) +- `-ca --contract-address
` - Aztec address of the contract. +- `-c --contract-artifact ` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `-h --help` - display help for command -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: - PXE_URL) - -b, --include-bytecode Include the contract's public function - bytecode, if any. (default: false) - -h, --help display help for command -``` +#### Subcommands -### aztec get-current-base-fee +#### aztec create-authwit functionName -``` -Usage: aztec get-current-base-fee [options] +*This command help is currently unavailable due to a technical issue.* -Gets the current base fee. -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command +#### aztec create-authwit caller -``` +*This command help is currently unavailable due to a technical issue.* -### aztec get-l1-addresses -``` -Usage: aztec get-l1-addresses [options] - -Gets the addresses of the L1 contracts. +### aztec debug-rollup -Options: - -r, --registry-address The address of the registry contract - --l1-rpc-urls 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 The version of the rollup - -c, --l1-chain-id 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 +Debugs the rollup contract. +**Usage:** +```bash +aztec debug-rollup [options] ``` -### aztec get-l1-balance +**Options:** -``` -Usage: aztec get-l1-balance [options] +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--rollup
` - ethereum address of the rollup contract +- `-h --help` - display help for command -Gets the balance of an ERC token in L1 for the given Ethereum address. +### aztec decode-enr -Arguments: - who Ethereum address to check. - -Options: - --l1-rpc-urls 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 The address of the token to check the balance of - -c, --l1-chain-id 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 +Decodes and ENR record +**Usage:** +```bash +aztec decode-enr [options] ``` -### aztec get-l1-to-l2-message-witness +**Available Commands:** -``` -Usage: aztec get-l1-to-l2-message-witness [options] +- `enr` - The encoded ENR string -Gets a L1 to L2 message witness. +**Options:** -Options: - -ca, --contract-address
Aztec address of the contract. - --message-hash The L1 to L2 message hash. - --secret The secret used to claim the L1 to L2 - message - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: - PXE_URL) - -h, --help display help for command +- `-h --help` - display help for command -``` -### aztec get-logs +#### Subcommands -``` -Usage: aztec get-logs [options] +#### aztec decode-enr enr -Gets all the public logs from an intersection of all the filter params. +*This command help is currently unavailable due to a technical issue.* -Options: - -tx, --tx-hash A transaction hash to get the receipt for. - -fb, --from-block Initial block number for getting logs - (defaults to 1). - -tb, --to-block Up to which block to fetch logs (defaults - to latest). - -al --after-log ID of a log after which to fetch the logs. - -ca, --contract-address
Contract address to filter logs by. - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: - PXE_URL) - --follow If set, will keep polling for new logs - until interrupted. - -h, --help display help for command -``` +### aztec deploy -### aztec get-node-info +Deploys a compiled Aztec.nr contract to Aztec. +**Usage:** +```bash +aztec deploy [options] [artifact] ``` -Usage: aztec get-node-info [options] - -Gets the information of an Aztec node from a PXE or directly from an Aztec -node. -Options: - --node-url URL of the node. - --json Emit output as json - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command - -``` +**Available Commands:** -### aztec get-pxe-info +- `artifact` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract -``` -Usage: aztec get-pxe-info [options] +**Options:** -Gets the information of a PXE at a URL. +- `--init ` - The contract initializer function to call (default: "constructor") +- `--no-init` - Leave the contract uninitialized +- `-k --public-key ` - Optional encryption public key for this address. Set this value only if this contract is expected to receive private notes, which will be encrypted using this public key. +- `-s --salt ` - Optional deployment salt as a hex string for generating the deployment address. +- `--universal` - Do not mix the sender address into the deployment. +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Constructor arguments (default: []) +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `--json` - Emit output as json +- `--no-wait` - Skip waiting for the contract to be deployed. Print the hash of deployment transaction +- `--no-class-registration` - Don't register this contract class +- `--no-public-deployment` - Don't emit this contract's public bytecode +- `--timeout ` - The amount of time in seconds to wait for the deployment to post to L2 +- `-v --verbose` - Provide timings on all executed operations (synching, simulating, proving) (default: false) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command -``` +#### Subcommands -### aztec get-tx +#### aztec deploy artifact -``` -Usage: aztec get-tx [options] [txHash] +*This command help is currently unavailable due to a technical issue.* -Gets the status of the recent txs, or a detailed view if a specific transaction -hash is provided -Arguments: - txHash A transaction hash to get the receipt for. +### aztec deploy-account -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -p, --page The page number to display (default: 1) - -s, --page-size The number of transactions to display per page - (default: 10) - -h, --help display help for command +Deploys an already registered aztec account that can be used for sending +**Usage:** +```bash +aztec deploy-account [options] ``` -### aztec import-test-accounts +**Options:** -``` -Usage: aztec import-test-accounts [options] +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--json` - Emit output as json +- `--no-wait` - Skip waiting for the contract to be deployed. Print the hash of deployment transaction +- `--register-class` - Register the contract class (useful for when the contract class has not been deployed yet). +- `--public-deploy` - Publishes the account contract instance (and the class, if needed). Needed if the contract contains public functions. +- `-v --verbose` - Provide timings on all executed operations (synching, simulating, proving) (default: false) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -Import test accounts from pxe. +### aztec deploy-l1-contracts -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - --json Emit output as json - -h, --help display help for command +Deploys all necessary Ethereum contracts for Aztec. +**Usage:** +```bash +aztec deploy-l1-contracts [options] ``` -### aztec inspect-contract - -``` -Usage: aztec inspect-contract [options] +**Options:** -Shows list of external callable functions for a contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-pk --private-key ` - The private key to use for deployment +- `--validators ` - Comma separated list of validators +- `-m --mnemonic ` - The mnemonic to use in deployment +- `-i --mnemonic-index ` - The index of the mnemonic to use in +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `--salt ` - The optional salt to use in deployment +- `--json` - Output the contract addresses in JSON +- `--test-accounts` - Populate genesis state with initial fee +- `--sponsored-fpc` - Populate genesis state with a testing +- `--accelerated-test-deployments` - Fire and forget deployment transactions, +- `--real-verifier` - Deploy the real verifier (default: false) +- `--existing-token
` - Use an existing ERC20 for both fee and +- `--create-verification-json` - [path] Create JSON file for etherscan contract +- `-h --help` - display help for command -Arguments: - contractArtifactFile A compiled Noir contract's artifact in JSON format or - name of a contract artifact exported by - @aztec/noir-contracts.js +### aztec deploy-new-rollup -Options: - -h, --help display help for command +Deploys a new rollup contract and adds it to the registry (if you are the +**Usage:** +```bash +aztec deploy-new-rollup [options] ``` -### aztec parse-parameter-struct - -``` -Usage: aztec parse-parameter-struct [options] +**Options:** -Helper for parsing an encoded string into a contract's parameter struct. +- `-r --registry-address ` - The address of the registry contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-pk --private-key ` - The private key to use for deployment +- `--validators ` - Comma separated list of validators +- `-m --mnemonic ` - The mnemonic to use in deployment +- `-i --mnemonic-index ` - The index of the mnemonic to use in +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `--salt ` - The optional salt to use in deployment +- `--json` - Output the contract addresses in JSON +- `--test-accounts` - Populate genesis state with initial fee +- `--sponsored-fpc` - Populate genesis state with a testing +- `--real-verifier` - Deploy the real verifier (default: false) +- `--create-verification-json` - [path] Create JSON file for etherscan contract +- `-h --help` - display help for command -Arguments: - encodedString The encoded hex string +### aztec deposit-governance-tokens -Options: - -c, --contract-artifact A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js - -p, --parameter The name of the struct parameter to decode into - -h, --help display help for command +Deposits governance tokens to the governance contract. +**Usage:** +```bash +aztec deposit-governance-tokens [options] ``` -### aztec preload-crs +**Options:** -``` -Usage: aztec preload-crs [options] +- `-r --registry-address ` - The address of the registry contract +- `--recipient ` - The recipient of the tokens +- `-a --amount ` - The amount of tokens to deposit +- `--mint` - Mint the tokens on L1 (default: false) +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `-p --private-key ` - The private key to use to deposit +- `-m --mnemonic ` - The mnemonic to use to deposit (default: +- `-i --mnemonic-index ` - The index of the mnemonic to use to deposit +- `-h --help` - display help for command -Preload the points data needed for proving and verifying +### aztec example-contracts -Options: - -h, --help display help for command +Lists the example contracts available to deploy from @aztec/noir-contracts.js +**Usage:** +```bash +aztec example-contracts [options] ``` -### aztec profile - -``` -Usage: aztec profile [options] +**Options:** -Profiles a private function by counting the unconditional operations in its -execution steps - -Arguments: - functionName Name of function to simulate - -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Function arguments (default: []) - -ca, --contract-address
Aztec address of the contract. - -c, --contract-artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - --debug-execution-steps-dir
Directory to write execution step artifacts for bb profiling/debugging. - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,asset=address,fpc=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command +- `-h --help` - display help for command -``` +### aztec execute-governance-proposal -### aztec propose-with-lock +Executes a governance proposal. +**Usage:** +```bash +aztec execute-governance-proposal [options] ``` -Usage: aztec propose-with-lock [options] - -Makes a proposal to governance with a lock - -Options: - -r, --registry-address The address of the registry contract - -p, --payload-address The address of the payload contract - --l1-rpc-urls 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 Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - -pk, --private-key The private key to use to propose - -m, --mnemonic The mnemonic to use to propose (default: - "test test test test test test test test - test test test junk") - -i, --mnemonic-index 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 -``` +**Options:** -### aztec prune-rollup +- `-p --proposal-id ` - The ID of the proposal +- `-r --registry-address ` - The address of the registry contract +- `--wait ` - Whether to wait until the proposal is +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `-pk --private-key ` - The private key to use to vote +- `-m --mnemonic ` - The mnemonic to use to vote (default: "test +- `-i --mnemonic-index ` - The index of the mnemonic to use to vote +- `-h --help` - display help for command -``` -Usage: aztec prune-rollup [options] +### aztec fast-forward-epochs -Prunes the pending chain on the rollup contract. +*Help for this command is currently unavailable due to a technical issue with option serialization.* -Options: - --l1-rpc-urls 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 The private key to use for deployment - -m, --mnemonic The mnemonic to use in deployment (default: - "test test test test test test test test test - test test junk") - -c, --l1-chain-id Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - --rollup
ethereum address of the rollup contract - -h, --help display help for command -``` +### aztec generate-bls-keypair -### aztec register-contract +Generate a BLS keypair with convenience flags +**Usage:** +```bash +aztec generate-bls-keypair [options] ``` -Usage: aztec register-contract [options] [address] [artifact] -Registers a contract in this wallet's PXE +**Options:** -Arguments: - address The address of the contract to register - artifact Path to a compiled Aztec contract's artifact in - JSON format. If executed inside a nargo workspace, - a package and contract name can be specified as - package@contract - -Options: - --init The contract initializer function to call - (default: "constructor") - -k, --public-key Optional encryption public key for this address. - Set this value only if this contract is expected - to receive private notes, which will be encrypted - using this public key. - -s, --salt Optional deployment salt as a hex string for - generating the deployment address. - --deployer The address of the account that deployed the - contract - --args [args...] Constructor arguments (default: []) - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command +- `--mnemonic ` - Mnemonic for BLS derivation +- `--ikm ` - Initial keying material for BLS (alternative to +- `--bls-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 ` - Write output to file +- `-h --help` - display help for command -``` +### aztec generate-bootnode-enr -### aztec register-sender +Generates the encoded ENR record for a bootnode. +**Usage:** +```bash +aztec generate-bootnode-enr [options] ``` -Usage: aztec register-sender [options] [address] - -Registers a sender's address in the wallet, so the note synching process will -look for notes sent by them -Arguments: - address The address of the sender to register +**Available Commands:** -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -h, --help display help for command +- `privateKey` - The peer id private key of the bootnode +- `p2pIp` - The bootnode P2P IP address +- `p2pPort` - The bootnode P2P port -``` +**Options:** -### aztec remove-l1-validator +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `-h --help` - display help for command -``` -Usage: aztec remove-l1-validator [options] -Removes a validator to the L1 rollup contract. +#### Subcommands -Options: - --l1-rpc-urls 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 The private key to use for deployment - -m, --mnemonic The mnemonic to use in deployment (default: - "test test test test test test test test test - test test junk") - -c, --l1-chain-id Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - --validator
ethereum address of the validator - --rollup
ethereum address of the rollup contract - -h, --help display help for command +#### aztec generate-bootnode-enr privateKey -``` +*This command help is currently unavailable due to a technical issue.* -### aztec send -``` -Usage: aztec send [options] +#### aztec generate-bootnode-enr p2pIp -Calls a function on an Aztec contract. +*This command help is currently unavailable due to a technical issue.* -Arguments: - functionName Name of function to execute - -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Function arguments (default: []) - -c, --contract-artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - -ca, --contract-address
Aztec address of the contract. - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - --no-wait Print transaction hash without waiting for it to be mined - --no-cancel Do not allow the transaction to be cancelled. This makes for cheaper transactions. - -v, --verbose Provide timings on all executed operations (synching, simulating, proving) (default: false) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,asset=address,fpc=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command -``` +#### aztec generate-bootnode-enr p2pPort -### aztec sequencers +*This command help is currently unavailable due to a technical issue.* -``` -Usage: aztec sequencers [options] [who] -Manages or queries registered sequencers on the L1 rollup contract. +### aztec generate-keys -Arguments: - command Command to run: list, add, remove, who-next - who Who to add/remove - -Options: - --l1-rpc-urls List of Ethereum host URLs. Chain identifiers - localhost and testnet can be used (comma - separated) (default: - ["http://host.docker.internal:8545"]) - -m, --mnemonic The mnemonic for the sender of the tx (default: - "test test test test test test test test test - test test junk") - --block-number Block number to query next sequencer for - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - -c, --l1-chain-id Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - -h, --help display help for command +Generates and encryption and signing private key pair. +**Usage:** +```bash +aztec generate-keys [options] ``` -### aztec setup-protocol-contracts +**Options:** -``` -Usage: aztec setup-protocol-contracts [options] +- `--json` - Output the keys in JSON format +- `-h --help` - display help for command -Bootstrap the blockchain by initializing all the protocol contracts +### aztec generate-l1-account -Options: - -u, --rpc-url URL of the PXE (default: - "http://host.docker.internal:8080", env: PXE_URL) - --testAccounts Deploy funded test accounts. - --sponsoredFPC Deploy a sponsored FPC. - --json Output the contract addresses in JSON format - --skipProofWait Don't wait for proofs to land. - -h, --help display help for command +Generates a new private key for an account on L1. +**Usage:** +```bash +aztec generate-l1-account [options] ``` -### aztec simulate +**Options:** -``` -Usage: aztec simulate [options] +- `--json` - Output the private key in JSON format +- `-h --help` - display help for command -Simulates the execution of a function on an Aztec contract. +### aztec generate-p2p-private-key -Arguments: - functionName Name of function to simulate - -Options: - -u, --rpc-url URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) - --args [args...] Function arguments (default: []) - -ca, --contract-address
Aztec address of the contract. - -c, --contract-artifact Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract - -sk, --secret-key The sender's secret key (env: SECRET_KEY) - -v, --verbose Provide timings on all executed operations (synching, simulating, proving) (default: false) - --payment Fee payment method and arguments. - Parameters: - method Valid values: "fee_juice", "fpc-public", "fpc-private", "fpc-sponsored" Default: fee_juice - asset The asset used for fee payment. Required for "fpc-public" and "fpc-private". - fpc The FPC contract that pays in fee juice. Not required for the "fee_juice" method. - claim Whether to use a previously stored claim to bridge fee juice. - claimSecret The secret to claim fee juice on L1. - claimAmount The amount of fee juice to be claimed. - messageLeafIndex The index of the claim in the l1toL2Message tree. - feeRecipient Recipient of the fee. - Format: --payment method=name,asset=address,fpc=address ... - --gas-limits Gas limits for the tx. - --max-fees-per-gas Maximum fees per gas unit for DA and L2 computation. - --max-priority-fees-per-gas Maximum priority fees per gas unit for DA and L2 computation. - --estimate-gas Whether to automatically estimate gas limits for the tx. - --estimate-gas-only Only report gas estimation for the tx, do not send it. - -h, --help display help for command +Generates a private key that can be used for running a node on a LibP2P +**Usage:** +```bash +aztec generate-p2p-private-key [options] ``` -### aztec start - -**MISC** - -- `--network ` - Network to run Aztec on - *Environment: `$NETWORK`* - -- `--auto-update ` (default: `disabled`) - The auto update mode for this node - *Environment: `$AUTO_UPDATE`* +**Options:** -- `--auto-update-url ` - Base URL to check for updates - *Environment: `$AUTO_UPDATE_URL`* +- `-h --help` - display help for command -- `--sync-mode ` (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`* +### aztec generate-secret-and-hash -- `--snapshots-urls ` - Base URLs for snapshots index, comma-separated. - *Environment: `$SYNC_SNAPSHOTS_URLS`* +Generates an arbitrary secret (Fr), and its hash (using aztec-nr defaults) -- `--fisherman-mode` - Whether to run in fisherman mode. - *Environment: `$FISHERMAN_MODE`* +**Usage:** +```bash +aztec generate-secret-and-hash [options] +``` -**SANDBOX** +**Options:** -- `--sandbox` - Starts Aztec Sandbox +- `-h --help` - display help for command -- `--sandbox.noPXE` - Do not expose PXE service on sandbox start - *Environment: `$NO_PXE`* +### aztec get-account -- `--sandbox.l1Mnemonic ` (default: `test test test test test test test test test test test junk`) - Mnemonic for L1 accounts. Will be used - *Environment: `$MNEMONIC`* +Gets an account given its Aztec address. -- `--sandbox.deployAztecContractsSalt ` - Numeric salt for deploying L1 Aztec contracts before starting the sandbox. Needs mnemonic or private key to be set. - *Environment: `$DEPLOY_AZTEC_CONTRACTS_SALT`* +**Usage:** +```bash +aztec get-account [options]
+``` -**API** +**Available Commands:** -- `--port ` (default: `8080`) - Port to run the Aztec Services on - *Environment: `$AZTEC_PORT`* +- `address` - The Aztec address to get account for -- `--admin-port ` (default: `8880`) - Port to run admin APIs of Aztec Services on on - *Environment: `$AZTEC_ADMIN_PORT`* +**Options:** -- `--api-prefix ` - Prefix for API routes on any service that is started - *Environment: `$API_PREFIX`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -**ETHEREUM** -- `--l1-chain-id ` - The chain ID of the ethereum host. - *Environment: `$L1_CHAIN_ID`* +#### Subcommands -- `--l1-rpc-urls ` - The RPC Url of the ethereum host. - *Environment: `$ETHEREUM_HOSTS`* +#### aztec get-account address -- `--l1-consensus-host-urls ` - List of URLS for L1 consensus clients - *Environment: `$L1_CONSENSUS_HOST_URLS`* +*This command help is currently unavailable due to a technical issue.* -- `--l1-consensus-host-api-keys ` - 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 ` - 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`* +### aztec get-accounts -- `--registry-address ` - The deployed L1 registry contract address. - *Environment: `$REGISTRY_CONTRACT_ADDRESS`* +Gets all the Aztec accounts stored in the PXE. -- `--rollup-version ` - The version of the rollup. - *Environment: `$ROLLUP_VERSION`* +**Usage:** +```bash +aztec get-accounts [options] +``` -**STORAGE** +**Options:** -- `--data-directory ` - Optional dir to store data. If omitted will store in memory. - *Environment: `$DATA_DIRECTORY`* +- `-u --rpc-url ` - URL of the PXE (default: +- `--json` - Emit output as json +- `-h --help` - display help for command -- `--data-store-map-size-kb ` (default: `134217728`) - DB mapping size to be applied to all key/value stores - *Environment: `$DATA_STORE_MAP_SIZE_KB`* +### aztec get-block -**WORLD STATE** +Gets info for a given block or latest. -- `--world-state-data-directory ` - Optional directory for the world state database - *Environment: `$WS_DATA_DIRECTORY`* +**Usage:** +```bash +aztec get-block [options] [blockNumber] +``` -- `--world-state-db-map-size-kb ` - The maximum possible size of the world state DB in KB. Overwrites the general dataStoreMapSizeKb. - *Environment: `$WS_DB_MAP_SIZE_KB`* +**Available Commands:** -- `--world-state-block-history ` (default: `64`) - The number of historic blocks to maintain. Values less than 1 mean all history is maintained - *Environment: `$WS_NUM_HISTORIC_BLOCKS`* +- `blockNumber` - Block height -**AZTEC NODE** +**Options:** -- `--node` - Starts Aztec Node with options +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -**ARCHIVER** -- `--archiver` - Starts Aztec Archiver with options +#### Subcommands -- `--archiver.blobSinkUrl ` - The URL of the blob sink - *Environment: `$BLOB_SINK_URL`* +#### aztec get-block blockNumber -- `--archiver.blobSinkMapSizeKb ` - The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKb. - *Environment: `$BLOB_SINK_MAP_SIZE_KB`* +*This command help is currently unavailable due to a technical issue.* -- `--archiver.blobAllowEmptySources ` - Whether to allow having no blob sources configured during startup - *Environment: `$BLOB_ALLOW_EMPTY_SOURCES`* -- `--archiver.archiveApiUrl ` - The URL of the archive API - *Environment: `$BLOB_SINK_ARCHIVE_API_URL`* +### aztec get-canonical-sponsored-fpc-address -- `--archiver.archiverPollingIntervalMS ` (default: `500`) - The polling interval in ms for retrieving new L2 blocks and encrypted logs. - *Environment: `$ARCHIVER_POLLING_INTERVAL_MS`* +Gets the canonical SponsoredFPC address for this any testnet running on the -- `--archiver.archiverBatchSize ` (default: `100`) - The number of L2 blocks the archiver will attempt to download at a time. - *Environment: `$ARCHIVER_BATCH_SIZE`* +**Usage:** +```bash +aztec get-canonical-sponsored-fpc-address [options] +``` -- `--archiver.maxLogs ` (default: `1000`) - The max number of logs that can be obtained in 1 "getPublicLogs" call. - *Environment: `$ARCHIVER_MAX_LOGS`* +**Options:** -- `--archiver.archiverStoreMapSizeKb ` - The maximum possible size of the archiver DB in KB. Overwrites the general dataStoreMapSizeKb. - *Environment: `$ARCHIVER_STORE_MAP_SIZE_KB`* +- `-h --help` - display help for command -- `--archiver.skipValidateBlockAttestations ` - Whether to skip validating block attestations (use only for testing). +### aztec get-contract-data -- `--archiver.maxAllowedEthClientDriftSeconds ` (default: `300`) - Maximum allowed drift in seconds between the Ethereum client and current time. - *Environment: `$MAX_ALLOWED_ETH_CLIENT_DRIFT_SECONDS`* +Gets information about the Aztec contract deployed at the specified address. -- `--archiver.ethereumAllowNoDebugHosts ` (default: `true`) - Whether to allow starting the archiver without debug/trace method support on Ethereum hosts - *Environment: `$ETHEREUM_ALLOW_NO_DEBUG_HOSTS`* +**Usage:** +```bash +aztec get-contract-data [options] +``` -**SEQUENCER** +**Available Commands:** -- `--sequencer` - Starts Aztec Sequencer with options +- `contractAddress` - Aztec address of the contract. -- `--sequencer.validatorPrivateKeys ` (default: `[Redacted]`) - List of private keys of the validators participating in attestation duties - *Environment: `$VALIDATOR_PRIVATE_KEYS`* +**Options:** -- `--sequencer.validatorAddresses ` - List of addresses of the validators to use with remote signers - *Environment: `$VALIDATOR_ADDRESSES`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-b --include-bytecode ` - Include the contract's public function +- `-h --help` - display help for command -- `--sequencer.disableValidator ` - Do not run the validator - *Environment: `$VALIDATOR_DISABLED`* -- `--sequencer.disabledValidators ` - Temporarily disable these specific validator addresses +#### Subcommands -- `--sequencer.attestationPollingIntervalMs ` (default: `200`) - Interval between polling for new attestations - *Environment: `$VALIDATOR_ATTESTATIONS_POLLING_INTERVAL_MS`* +#### aztec get-contract-data contractAddress -- `--sequencer.validatorReexecute ` (default: `true`) - Re-execute transactions before attesting - *Environment: `$VALIDATOR_REEXECUTE`* +*This command help is currently unavailable due to a technical issue.* -- `--sequencer.validatorReexecuteDeadlineMs ` (default: `6000`) - Will re-execute until this many milliseconds are left in the slot - *Environment: `$VALIDATOR_REEXECUTE_DEADLINE_MS`* -- `--sequencer.alwaysReexecuteBlockProposals ` - Whether to always reexecute block proposals, even for non-validator nodes (useful for monitoring network status). - *Environment: `$ALWAYS_REEXECUTE_BLOCK_PROPOSALS`* +### aztec get-current-base-fee -- `--sequencer.transactionPollingIntervalMS ` (default: `500`) - The number of ms to wait between polling for pending txs. - *Environment: `$SEQ_TX_POLLING_INTERVAL_MS`* +Gets the current base fee. -- `--sequencer.maxTxsPerBlock ` (default: `32`) - The maximum number of txs to include in a block. - *Environment: `$SEQ_MAX_TX_PER_BLOCK`* +**Usage:** +```bash +aztec get-current-base-fee [options] +``` -- `--sequencer.minTxsPerBlock ` (default: `1`) - The minimum number of txs to include in a block. - *Environment: `$SEQ_MIN_TX_PER_BLOCK`* +**Options:** -- `--sequencer.publishTxsWithProposals ` - Whether to publish txs with proposals. - *Environment: `$SEQ_PUBLISH_TXS_WITH_PROPOSALS`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--sequencer.maxL2BlockGas ` (default: `10000000000`) - The maximum L2 block gas. - *Environment: `$SEQ_MAX_L2_BLOCK_GAS`* +### aztec get-l1-addresses -- `--sequencer.maxDABlockGas ` (default: `10000000000`) - The maximum DA block gas. - *Environment: `$SEQ_MAX_DA_BLOCK_GAS`* +Gets the addresses of the L1 contracts. -- `--sequencer.coinbase ` - Recipient of block reward. - *Environment: `$COINBASE`* +**Usage:** +```bash +aztec get-l1-addresses [options] +``` -- `--sequencer.feeRecipient ` - Address to receive fees. - *Environment: `$FEE_RECIPIENT`* +**Options:** -- `--sequencer.acvmWorkingDirectory ` - The working directory to use for simulation/proving - *Environment: `$ACVM_WORKING_DIRECTORY`* +- `-r --registry-address ` - The address of the registry contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-v --rollup-version ` - The version of the rollup +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `--json` - Output the addresses in JSON format +- `-h --help` - display help for command -- `--sequencer.acvmBinaryPath ` - The path to the ACVM binary - *Environment: `$ACVM_BINARY_PATH`* +### aztec get-l1-balance -- `--sequencer.maxBlockSizeInBytes ` (default: `1048576`) - Max block size - *Environment: `$SEQ_MAX_BLOCK_SIZE_IN_BYTES`* +Gets the balance of an ERC token in L1 for the given Ethereum address. -- `--sequencer.enforceTimeTable ` (default: `true`) - Whether to enforce the time table when building blocks - *Environment: `$SEQ_ENFORCE_TIME_TABLE`* +**Usage:** +```bash +aztec get-l1-balance [options] +``` -- `--sequencer.governanceProposerPayload ` (default: `0x0000000000000000000000000000000000000000`) - The address of the payload for the governanceProposer - *Environment: `$GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS`* +**Available Commands:** -- `--sequencer.maxL1TxInclusionTimeIntoSlot ` - 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`* +- `who` - Ethereum address to check. -- `--sequencer.attestationPropagationTime ` (default: `2`) - How many seconds it takes for proposals and attestations to travel across the p2p layer (one-way) - *Environment: `$SEQ_ATTESTATION_PROPAGATION_TIME`* +**Options:** -- `--sequencer.secondsBeforeInvalidatingBlockAsCommitteeMember ` (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`* +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-t --token ` - The address of the token to check the balance of +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--json` - Output the balance in JSON format +- `-h --help` - display help for command -- `--sequencer.secondsBeforeInvalidatingBlockAsNonCommitteeMember ` (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.injectFakeAttestation ` - Inject a fake attestation (for testing only) +#### Subcommands -- `--sequencer.shuffleAttestationOrdering ` - Shuffle attestation ordering to create invalid ordering (for testing only) +#### aztec get-l1-balance who -- `--sequencer.txPublicSetupAllowList ` - The list of functions calls allowed to run in setup - *Environment: `$TX_PUBLIC_SETUP_ALLOWLIST`* +*This command help is currently unavailable due to a technical issue.* -- `--sequencer.keyStoreDirectory ` - Location of key store directory - *Environment: `$KEY_STORE_DIRECTORY`* -- `--sequencer.publisherPrivateKeys ` - The private keys to be used by the publisher. - *Environment: `$SEQ_PUBLISHER_PRIVATE_KEYS`* +### aztec get-l1-to-l2-message-witness -- `--sequencer.publisherAddresses ` - The addresses of the publishers to use with remote signers - *Environment: `$SEQ_PUBLISHER_ADDRESSES`* +Gets a L1 to L2 message witness. -- `--sequencer.publisherAllowInvalidStates ` (default: `true`) - True to use publishers in invalid states (timed out, cancelled, etc) if no other is available - *Environment: `$SEQ_PUBLISHER_ALLOW_INVALID_STATES`* +**Usage:** +```bash +aztec get-l1-to-l2-message-witness [options] +``` -- `--sequencer.publisherForwarderAddress ` - Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only) - *Environment: `$SEQ_PUBLISHER_FORWARDER_ADDRESS`* +**Options:** -- `--sequencer.blobSinkUrl ` - The URL of the blob sink - *Environment: `$BLOB_SINK_URL`* +- `-ca --contract-address
` - Aztec address of the contract. +- `--message-hash ` - The L1 to L2 message hash. +- `--secret ` - The secret used to claim the L1 to L2 +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--sequencer.blobAllowEmptySources ` - Whether to allow having no blob sources configured during startup - *Environment: `$BLOB_ALLOW_EMPTY_SOURCES`* +### aztec get-logs -- `--sequencer.archiveApiUrl ` - The URL of the archive API - *Environment: `$BLOB_SINK_ARCHIVE_API_URL`* +Gets all the public logs from an intersection of all the filter params. -**BLOB SINK** +**Usage:** +```bash +aztec get-logs [options] +``` -- `--blob-sink` - Starts Aztec Blob Sink with options +**Options:** -- `--blobSink.port ` - The port to run the blob sink server on - *Environment: `$BLOB_SINK_PORT`* +- `-tx --tx-hash ` - A transaction hash to get the receipt for. +- `-fb --from-block ` - Initial block number for getting logs +- `-tb --to-block ` - Up to which block to fetch logs (defaults +- `-ca --contract-address
` - Contract address to filter logs by. +- `-u --rpc-url ` - URL of the PXE (default: +- `--follow` - If set, will keep polling for new logs +- `-h --help` - display help for command -- `--blobSink.blobSinkMapSizeKb ` - The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKb. - *Environment: `$BLOB_SINK_MAP_SIZE_KB`* +### aztec get-node-info -- `--blobSink.blobAllowEmptySources ` - Whether to allow having no blob sources configured during startup - *Environment: `$BLOB_ALLOW_EMPTY_SOURCES`* +Gets the information of an Aztec node from a PXE or directly from an Aztec -- `--blobSink.archiveApiUrl ` - The URL of the archive API - *Environment: `$BLOB_SINK_ARCHIVE_API_URL`* +**Usage:** +```bash +aztec get-node-info [options] +``` -**PROVER NODE** +**Options:** -- `--prover-node` - Starts Aztec Prover Node with options +- `--node-url ` - URL of the node. +- `--json` - Emit output as json +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--proverNode.keyStoreDirectory ` - Location of key store directory - *Environment: `$KEY_STORE_DIRECTORY`* +### aztec get-pxe-info -- `--proverNode.acvmWorkingDirectory ` - The working directory to use for simulation/proving - *Environment: `$ACVM_WORKING_DIRECTORY`* +Gets the information of a PXE at a URL. -- `--proverNode.acvmBinaryPath ` - The path to the ACVM binary - *Environment: `$ACVM_BINARY_PATH`* +**Usage:** +```bash +aztec get-pxe-info [options] +``` -- `--proverNode.bbWorkingDirectory ` - The working directory to use for proving - *Environment: `$BB_WORKING_DIRECTORY`* +**Options:** -- `--proverNode.bbBinaryPath ` - The path to the bb binary - *Environment: `$BB_BINARY_PATH`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--proverNode.bbSkipCleanup ` - Whether to skip cleanup of bb temporary files - *Environment: `$BB_SKIP_CLEANUP`* +### aztec get-tx -- `--proverNode.numConcurrentIVCVerifiers ` (default: `8`) - Max number of client IVC verifiers to run concurrently - *Environment: `$BB_NUM_IVC_VERIFIERS`* +Gets the status of the recent txs, or a detailed view if a specific transaction -- `--proverNode.bbIVCConcurrency ` (default: `1`) - Number of threads to use for IVC verification - *Environment: `$BB_IVC_CONCURRENCY`* +**Usage:** +```bash +aztec get-tx [options] [txHash] +``` -- `--proverNode.nodeUrl ` - The URL to the Aztec node to take proving jobs from - *Environment: `$AZTEC_NODE_URL`* +**Available Commands:** -- `--proverNode.proverId ` - Hex value that identifies the prover. Defaults to the address used for submitting proofs if not set. - *Environment: `$PROVER_ID`* +- `txHash` - A transaction hash to get the receipt for. -- `--proverNode.failedProofStore ` - 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`* +**Options:** -- `--proverNode.publisherAllowInvalidStates ` (default: `true`) - True to use publishers in invalid states (timed out, cancelled, etc) if no other is available - *Environment: `$PROVER_PUBLISHER_ALLOW_INVALID_STATES`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-p --page ` - The page number to display (default: 1) +- `-s --page-size ` - The number of transactions to display per page +- `-h --help` - display help for command -- `--proverNode.publisherForwarderAddress ` - Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only) - *Environment: `$PROVER_PUBLISHER_FORWARDER_ADDRESS`* -- `--proverNode.publisherPrivateKeys ` - The private keys to be used by the publisher. - *Environment: `$PROVER_PUBLISHER_PRIVATE_KEYS`* +#### Subcommands -- `--proverNode.publisherAddresses ` - The addresses of the publishers to use with remote signers - *Environment: `$PROVER_PUBLISHER_ADDRESSES`* +#### aztec get-tx txHash -- `--proverNode.proverNodeMaxPendingJobs ` (default: `10`) - The maximum number of pending jobs for the prover node - *Environment: `$PROVER_NODE_MAX_PENDING_JOBS`* +*This command help is currently unavailable due to a technical issue.* -- `--proverNode.proverNodePollingIntervalMs ` (default: `1000`) - The interval in milliseconds to poll for new jobs - *Environment: `$PROVER_NODE_POLLING_INTERVAL_MS`* -- `--proverNode.proverNodeMaxParallelBlocksPerEpoch ` (default: `32`) - The Maximum number of blocks to process in parallel while proving an epoch - *Environment: `$PROVER_NODE_MAX_PARALLEL_BLOCKS_PER_EPOCH`* +### aztec import-test-accounts -- `--proverNode.proverNodeFailedEpochStore ` - File store where to upload node state when an epoch fails to be proven - *Environment: `$PROVER_NODE_FAILED_EPOCH_STORE`* +Import test accounts from pxe. -- `--proverNode.proverNodeEpochProvingDelayMs ` - Optional delay in milliseconds to wait before proving a new epoch +**Usage:** +```bash +aztec import-test-accounts [options] +``` -- `--proverNode.txGatheringIntervalMs ` (default: `1000`) - How often to check that tx data is available - *Environment: `$PROVER_NODE_TX_GATHERING_INTERVAL_MS`* +**Options:** -- `--proverNode.txGatheringBatchSize ` (default: `10`) - How many transactions to gather from a node in a single request - *Environment: `$PROVER_NODE_TX_GATHERING_BATCH_SIZE`* +- `-u --rpc-url ` - URL of the PXE (default: +- `--json` - Emit output as json +- `-h --help` - display help for command -- `--proverNode.txGatheringMaxParallelRequestsPerNode ` (default: `100`) - How many tx requests to make in parallel to each node - *Environment: `$PROVER_NODE_TX_GATHERING_MAX_PARALLEL_REQUESTS_PER_NODE`* +### aztec inspect-contract -- `--proverNode.txGatheringTimeoutMs ` (default: `120000`) - How long to wait for tx data to be available before giving up - *Environment: `$PROVER_NODE_TX_GATHERING_TIMEOUT_MS`* +Shows list of external callable functions for a contract -- `--proverNode.proverNodeDisableProofPublish ` - Whether the prover node skips publishing proofs to L1 - *Environment: `$PROVER_NODE_DISABLE_PROOF_PUBLISH`* +**Usage:** +```bash +aztec inspect-contract [options] +``` -**PROVER BROKER** +**Available Commands:** -- `--prover-broker` - Starts Aztec proving job broker +- `contractArtifactFile` - A compiled Noir contract's artifact in JSON format or -- `--proverBroker.proverBrokerJobTimeoutMs ` (default: `30000`) - Jobs are retried if not kept alive for this long - *Environment: `$PROVER_BROKER_JOB_TIMEOUT_MS`* +**Options:** -- `--proverBroker.proverBrokerPollIntervalMs ` (default: `1000`) - The interval to check job health status - *Environment: `$PROVER_BROKER_POLL_INTERVAL_MS`* +- `-h --help` - display help for command -- `--proverBroker.proverBrokerJobMaxRetries ` (default: `3`) - If starting a prover broker locally, the max number of retries per proving job - *Environment: `$PROVER_BROKER_JOB_MAX_RETRIES`* -- `--proverBroker.proverBrokerBatchSize ` (default: `100`) - The prover broker writes jobs to disk in batches - *Environment: `$PROVER_BROKER_BATCH_SIZE`* +#### Subcommands -- `--proverBroker.proverBrokerBatchIntervalMs ` (default: `50`) - How often to flush batches to disk - *Environment: `$PROVER_BROKER_BATCH_INTERVAL_MS`* +#### aztec inspect-contract contractArtifactFile -- `--proverBroker.proverBrokerMaxEpochsToKeepResultsFor ` (default: `1`) - The maximum number of epochs to keep results for - *Environment: `$PROVER_BROKER_MAX_EPOCHS_TO_KEEP_RESULTS_FOR`* +*This command help is currently unavailable due to a technical issue.* -- `--proverBroker.proverBrokerStoreMapSizeKb ` - The size of the prover broker's database. Will override the dataStoreMapSizeKb if set. - *Environment: `$PROVER_BROKER_STORE_MAP_SIZE_KB`* -**PROVER AGENT** +### aztec parse-parameter-struct -- `--prover-agent` - Starts Aztec Prover Agent with options +Helper for parsing an encoded string into a contract's parameter struct. -- `--proverAgent.proverAgentCount ` (default: `1`) - Whether this prover has a local prover agent - *Environment: `$PROVER_AGENT_COUNT`* +**Usage:** +```bash +aztec parse-parameter-struct [options] +``` -- `--proverAgent.proverAgentPollIntervalMs ` (default: `1000`) - The interval agents poll for jobs at - *Environment: `$PROVER_AGENT_POLL_INTERVAL_MS`* +**Available Commands:** -- `--proverAgent.proverAgentProofTypes ` - The types of proofs the prover agent can generate - *Environment: `$PROVER_AGENT_PROOF_TYPES`* +- `encodedString` - The encoded hex string -- `--proverAgent.proverBrokerUrl ` - The URL where this agent takes jobs from - *Environment: `$PROVER_BROKER_HOST`* +**Options:** -- `--proverAgent.realProofs ` (default: `true`) - Whether to construct real proofs - *Environment: `$PROVER_REAL_PROOFS`* +- `-c --contract-artifact ` - A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js +- `-p --parameter ` - The name of the struct parameter to decode into +- `-h --help` - display help for command -- `--proverAgent.proverTestDelayType ` (default: `fixed`) - The type of artificial delay to introduce - *Environment: `$PROVER_TEST_DELAY_TYPE`* -- `--proverAgent.proverTestDelayMs ` - Artificial delay to introduce to all operations to the test prover. - *Environment: `$PROVER_TEST_DELAY_MS`* +#### Subcommands -- `--proverAgent.proverTestDelayFactor ` (default: `1`) - If using realistic delays, what percentage of realistic times to apply. - *Environment: `$PROVER_TEST_DELAY_FACTOR`* +#### aztec parse-parameter-struct encodedString -- `--p2p-enabled [value]` - Enable P2P subsystem - *Environment: `$P2P_ENABLED`* +*This command help is currently unavailable due to a technical issue.* -- `--p2p.p2pDiscoveryDisabled ` - A flag dictating whether the P2P discovery system should be disabled. - *Environment: `$P2P_DISCOVERY_DISABLED`* -- `--p2p.blockCheckIntervalMS ` (default: `100`) - The frequency in which to check for new L2 blocks. - *Environment: `$P2P_BLOCK_CHECK_INTERVAL_MS`* +### aztec preload-crs -- `--p2p.debugDisableColocationPenalty ` - DEBUG: Disable colocation penalty - NEVER set to true in production - *Environment: `$DEBUG_P2P_DISABLE_COLOCATION_PENALTY`* +Preload the points data needed for proving and verifying -- `--p2p.peerCheckIntervalMS ` (default: `30000`) - The frequency in which to check for new peers. - *Environment: `$P2P_PEER_CHECK_INTERVAL_MS`* +**Usage:** +```bash +aztec preload-crs [options] +``` -- `--p2p.l2QueueSize ` (default: `1000`) - Size of queue of L2 blocks to store. - *Environment: `$P2P_L2_QUEUE_SIZE`* +**Options:** -- `--p2p.listenAddress ` (default: `0.0.0.0`) - The listen address. ipv4 address. - *Environment: `$P2P_LISTEN_ADDR`* +- `-h --help` - display help for command -- `--p2p.p2pPort ` (default: `40400`) - The port for the P2P service. Defaults to 40400 - *Environment: `$P2P_PORT`* +### aztec profile -- `--p2p.p2pBroadcastPort ` - The port to broadcast the P2P service on (included in the node's ENR). Defaults to P2P_PORT. - *Environment: `$P2P_BROADCAST_PORT`* +Profiles a private function by counting the unconditional operations in its -- `--p2p.p2pIp ` - The IP address for the P2P service. ipv4 address. - *Environment: `$P2P_IP`* +**Usage:** +```bash +aztec profile [options] +``` -- `--p2p.peerIdPrivateKey ` - An optional peer id private key. If blank, will generate a random key. - *Environment: `$PEER_ID_PRIVATE_KEY`* +**Available Commands:** -- `--p2p.peerIdPrivateKeyPath ` - 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`* +- `functionName` - Name of function to simulate -- `--p2p.bootstrapNodes ` - A list of bootstrap peer ENRs to connect to. Separated by commas. - *Environment: `$BOOTSTRAP_NODES`* +**Options:** -- `--p2p.bootstrapNodeEnrVersionCheck ` - Whether to check the version of the bootstrap node ENR. - *Environment: `$P2P_BOOTSTRAP_NODE_ENR_VERSION_CHECK`* +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Function arguments (default: []) +- `-ca --contract-address
` - Aztec address of the contract. +- `-c --contract-artifact ` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract +- `--debug-execution-steps-dir
` - Directory to write execution step artifacts for bb profiling/debugging. +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -- `--p2p.bootstrapNodesAsFullPeers ` - Whether to consider our configured bootnodes as full peers - *Environment: `$P2P_BOOTSTRAP_NODES_AS_FULL_PEERS`* -- `--p2p.maxPeerCount ` (default: `100`) - The maximum number of peers to connect to. - *Environment: `$P2P_MAX_PEERS`* +#### Subcommands -- `--p2p.queryForIp ` - If announceUdpAddress or announceTcpAddress are not provided, query for the IP address of the machine. Default is false. - *Environment: `$P2P_QUERY_FOR_IP`* +#### aztec profile functionName -- `--p2p.gossipsubInterval ` (default: `700`) - The interval of the gossipsub heartbeat to perform maintenance tasks. - *Environment: `$P2P_GOSSIPSUB_INTERVAL_MS`* +*This command help is currently unavailable due to a technical issue.* -- `--p2p.gossipsubD ` (default: `8`) - The D parameter for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_D`* -- `--p2p.gossipsubDlo ` (default: `4`) - The Dlo parameter for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_DLO`* +### aztec propose-with-lock -- `--p2p.gossipsubDhi ` (default: `12`) - The Dhi parameter for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_DHI`* +Makes a proposal to governance with a lock -- `--p2p.gossipsubDLazy ` (default: `8`) - The Dlazy parameter for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_DLAZY`* +**Usage:** +```bash +aztec propose-with-lock [options] +``` -- `--p2p.gossipsubFloodPublish ` - Whether to flood publish messages. - For testing purposes only - *Environment: `$P2P_GOSSIPSUB_FLOOD_PUBLISH`* +**Options:** -- `--p2p.gossipsubMcacheLength ` (default: `6`) - The number of gossipsub interval message cache windows to keep. - *Environment: `$P2P_GOSSIPSUB_MCACHE_LENGTH`* +- `-r --registry-address ` - The address of the registry contract +- `-p --payload-address ` - The address of the payload contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `-pk --private-key ` - The private key to use to propose +- `-m --mnemonic ` - The mnemonic to use to propose (default: +- `-i --mnemonic-index ` - The index of the mnemonic to use to propose +- `--json` - Output the proposal ID in JSON format +- `-h --help` - display help for command -- `--p2p.gossipsubMcacheGossip ` (default: `3`) - How many message cache windows to include when gossiping with other peers. - *Environment: `$P2P_GOSSIPSUB_MCACHE_GOSSIP`* +### aztec prune-rollup -- `--p2p.gossipsubSeenTTL ` (default: `1200000`) - How long to keep message IDs in the seen cache. - *Environment: `$P2P_GOSSIPSUB_SEEN_TTL`* +Prunes the pending chain on the rollup contract. -- `--p2p.gossipsubTxTopicWeight ` (default: `1`) - The weight of the tx topic for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_TX_TOPIC_WEIGHT`* +**Usage:** +```bash +aztec prune-rollup [options] +``` -- `--p2p.gossipsubTxInvalidMessageDeliveriesWeight ` (default: `-20`) - The weight of the tx invalid message deliveries for the gossipsub protocol. - *Environment: `$P2P_GOSSIPSUB_TX_INVALID_MESSAGE_DELIVERIES_WEIGHT`* +**Options:** -- `--p2p.gossipsubTxInvalidMessageDeliveriesDecay ` (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`* +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-pk --private-key ` - The private key to use for deployment +- `-m --mnemonic ` - The mnemonic to use in deployment (default: +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--rollup
` - ethereum address of the rollup contract +- `-h --help` - display help for command -- `--p2p.peerPenaltyValues ` (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`* +### aztec register-contract -- `--p2p.doubleSpendSeverePeerPenaltyWindow ` (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`* +Registers a contract in this wallet's PXE -- `--p2p.blockRequestBatchSize ` (default: `20`) - The number of blocks to fetch in a single batch. - *Environment: `$P2P_BLOCK_REQUEST_BATCH_SIZE`* +**Usage:** +```bash +aztec register-contract [options] [address] [artifact] +``` -- `--p2p.archivedTxLimit ` - 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`* +**Available Commands:** -- `--p2p.trustedPeers ` - A list of trusted peer ENRs that will always be persisted. Separated by commas. - *Environment: `$P2P_TRUSTED_PEERS`* +- `address` - The address of the contract to register +- `artifact` - Path to a compiled Aztec contract's artifact in -- `--p2p.privatePeers ` - A list of private peer ENRs that will always be persisted and not be used for discovery. Separated by commas. - *Environment: `$P2P_PRIVATE_PEERS`* +**Options:** -- `--p2p.preferredPeers ` - A list of preferred peer ENRs that will always be persisted and not be used for discovery. Separated by commas. - *Environment: `$P2P_PREFERRED_PEERS`* +- `--init ` - The contract initializer function to call +- `-k --public-key ` - Optional encryption public key for this address. +- `-s --salt ` - Optional deployment salt as a hex string for +- `--deployer ` - The address of the account that deployed the +- `--args` - [args...] Constructor arguments (default: []) +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--p2p.p2pStoreMapSizeKb ` - The maximum possible size of the P2P DB in KB. Overwrites the general dataStoreMapSizeKb. - *Environment: `$P2P_STORE_MAP_SIZE_KB`* -- `--p2p.txPublicSetupAllowList ` - The list of functions calls allowed to run in setup - *Environment: `$TX_PUBLIC_SETUP_ALLOWLIST`* +#### Subcommands -- `--p2p.maxTxPoolSize ` (default: `100000000`) - The maximum cumulative tx size of pending txs (in bytes) before evicting lower priority txs. - *Environment: `$P2P_MAX_TX_POOL_SIZE`* +#### aztec register-contract address -- `--p2p.txPoolOverflowFactor ` (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`* +*This command help is currently unavailable due to a technical issue.* -- `--p2p.seenMessageCacheSize ` (default: `100000`) - The number of messages to keep in the seen message cache - *Environment: `$P2P_SEEN_MSG_CACHE_SIZE`* -- `--p2p.p2pDisableStatusHandshake ` - True to disable the status handshake on peer connected. - *Environment: `$P2P_DISABLE_STATUS_HANDSHAKE`* +#### aztec register-contract artifact -- `--p2p.p2pAllowOnlyValidators ` - True to only permit validators to connect. - *Environment: `$P2P_ALLOW_ONLY_VALIDATORS`* +*This command help is currently unavailable due to a technical issue.* -- `--p2p.p2pMaxFailedAuthAttemptsAllowed ` (default: `3`) - Number of auth attempts to allow before peer is banned. Number is inclusive - *Environment: `$P2P_MAX_AUTH_FAILED_ATTEMPTS_ALLOWED`* -- `--p2p.dropTransactions ` - True to simulate discarding transactions. - For testing purposes only - *Environment: `$P2P_DROP_TX`* +### aztec register-sender -- `--p2p.dropTransactionsProbability ` - The probability that a transaction is discarded. - For testing purposes only - *Environment: `$P2P_DROP_TX_CHANCE`* +Registers a sender's address in the wallet, so the note synching process will -- `--p2p.disableTransactions ` - Whether transactions are disabled for this node. This means transactions will be rejected at the RPC and P2P layers. - *Environment: `$TRANSACTIONS_DISABLED`* +**Usage:** +```bash +aztec register-sender [options] [address] +``` -- `--p2p.txPoolDeleteTxsAfterReorg ` - 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`* +**Available Commands:** -- `--p2p.overallRequestTimeoutMs ` (default: `10000`) - The overall timeout for a request response operation. - *Environment: `$P2P_REQRESP_OVERALL_REQUEST_TIMEOUT_MS`* +- `address` - The address of the sender to register -- `--p2p.individualRequestTimeoutMs ` (default: `10000`) - The timeout for an individual request response peer interaction. - *Environment: `$P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS`* +**Options:** -- `--p2p.dialTimeoutMs ` (default: `5000`) - How long to wait for the dial protocol to establish a connection - *Environment: `$P2P_REQRESP_DIAL_TIMEOUT_MS`* +- `-u --rpc-url ` - URL of the PXE (default: +- `-h --help` - display help for command -- `--p2p.p2pOptimisticNegotiation ` - Whether to use optimistic protocol negotiation when dialing to another peer (opposite of `negotiateFully`). - *Environment: `$P2P_REQRESP_OPTIMISTIC_NEGOTIATION`* -- `--p2p.txCollectionFastNodesTimeoutBeforeReqRespMs ` (default: `200`) - How long to wait before starting reqresp for fast collection - *Environment: `$TX_COLLECTION_FAST_NODES_TIMEOUT_BEFORE_REQ_RESP_MS`* +#### Subcommands -- `--p2p.txCollectionSlowNodesIntervalMs ` (default: `12000`) - How often to collect from configured nodes in the slow collection loop - *Environment: `$TX_COLLECTION_SLOW_NODES_INTERVAL_MS`* +#### aztec register-sender address -- `--p2p.txCollectionSlowReqRespIntervalMs ` (default: `12000`) - How often to collect from peers via reqresp in the slow collection loop - *Environment: `$TX_COLLECTION_SLOW_REQ_RESP_INTERVAL_MS`* +*This command help is currently unavailable due to a technical issue.* -- `--p2p.txCollectionSlowReqRespTimeoutMs ` (default: `20000`) - How long to wait for a reqresp response during slow collection - *Environment: `$TX_COLLECTION_SLOW_REQ_RESP_TIMEOUT_MS`* -- `--p2p.txCollectionReconcileIntervalMs ` (default: `60000`) - How often to reconcile found txs from the tx pool - *Environment: `$TX_COLLECTION_RECONCILE_INTERVAL_MS`* +### aztec remove-l1-validator -- `--p2p.txCollectionDisableSlowDuringFastRequests ` (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`* +Removes a validator to the L1 rollup contract. -- `--p2p.txCollectionFastNodeIntervalMs ` (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`* +**Usage:** +```bash +aztec remove-l1-validator [options] +``` -- `--p2p.txCollectionNodeRpcUrls ` - A comma-separated list of Aztec node RPC URLs to use for tx collection - *Environment: `$TX_COLLECTION_NODE_RPC_URLS`* +**Options:** -- `--p2p.txCollectionFastMaxParallelRequestsPerNode ` (default: `4`) - Maximum number of parallel requests to make to a node during fast collection - *Environment: `$TX_COLLECTION_FAST_MAX_PARALLEL_REQUESTS_PER_NODE`* +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-pk --private-key ` - The private key to use for deployment +- `-m --mnemonic ` - The mnemonic to use in deployment (default: +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `--validator
` - ethereum address of the validator +- `--rollup
` - ethereum address of the rollup contract +- `-h --help` - display help for command -- `--p2p.txCollectionNodeRpcMaxBatchSize ` (default: `50`) - Maximum number of transactions to request from a node in a single batch - *Environment: `$TX_COLLECTION_NODE_RPC_MAX_BATCH_SIZE`* +### aztec send -- `--p2p-bootstrap` - Starts Aztec P2P Bootstrap with options +Calls a function on an Aztec contract. -- `--p2pBootstrap.p2pBroadcastPort ` - The port to broadcast the P2P service on (included in the node's ENR). Defaults to P2P_PORT. - *Environment: `$P2P_BROADCAST_PORT`* +**Usage:** +```bash +aztec send [options] +``` -- `--p2pBootstrap.peerIdPrivateKeyPath ` - 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`* +**Available Commands:** -- `--p2pBootstrap.queryForIp ` - If announceUdpAddress or announceTcpAddress are not provided, query for the IP address of the machine. Default is false. - *Environment: `$P2P_QUERY_FOR_IP`* +- `functionName` - Name of function to execute -**TELEMETRY** +**Options:** -- `--tel.metricsCollectorUrl ` - The URL of the telemetry collector for metrics - *Environment: `$OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`* +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Function arguments (default: []) +- `-c --contract-artifact ` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract +- `-ca --contract-address
` - Aztec address of the contract. +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `--no-wait` - Print transaction hash without waiting for it to be mined +- `--no-cancel` - Do not allow the transaction to be cancelled. This makes for cheaper transactions. +- `-v --verbose` - Provide timings on all executed operations (synching, simulating, proving) (default: false) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -- `--tel.tracesCollectorUrl ` - The URL of the telemetry collector for traces - *Environment: `$OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`* -- `--tel.logsCollectorUrl ` - The URL of the telemetry collector for logs - *Environment: `$OTEL_EXPORTER_OTLP_LOGS_ENDPOINT`* +#### Subcommands -- `--tel.otelCollectIntervalMs ` (default: `60000`) - The interval at which to collect metrics - *Environment: `$OTEL_COLLECT_INTERVAL_MS`* +#### aztec send functionName -- `--tel.otelExportTimeoutMs ` (default: `30000`) - The timeout for exporting metrics - *Environment: `$OTEL_EXPORT_TIMEOUT_MS`* +*This command help is currently unavailable due to a technical issue.* -- `--tel.otelExcludeMetrics ` - A list of metric prefixes to exclude from export - *Environment: `$OTEL_EXCLUDE_METRICS`* -- `--tel.publicMetricsCollectorUrl ` - A URL to publish a subset of metrics for public consumption - *Environment: `$PUBLIC_OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`* +### aztec sequencers -- `--tel.publicMetricsCollectFrom ` - The role types to collect metrics from - *Environment: `$PUBLIC_OTEL_COLLECT_FROM`* +Manages or queries registered sequencers on the L1 rollup contract. -- `--tel.publicIncludeMetrics ` - A list of metric prefixes to publicly export - *Environment: `$PUBLIC_OTEL_INCLUDE_METRICS`* +**Usage:** +```bash +aztec sequencers [options] [who] +``` -- `--tel.publicMetricsOptOut ` (default: `true`) - Whether to opt out of sharing optional telemetry - *Environment: `$PUBLIC_OTEL_OPT_OUT`* +**Available Commands:** -**BOT** +- `command` - Command to run: list, add, remove, who-next +- `who` - Who to add/remove -- `--bot` - Starts Aztec Bot with options +**Options:** -- `--bot.nodeUrl ` - The URL to the Aztec node to check for tx pool status. - *Environment: `$AZTEC_NODE_URL`* +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-m --mnemonic ` - The mnemonic for the sender of the tx (default: +- `--block-number ` - Block number to query next sequencer for +- `-u --rpc-url ` - URL of the PXE (default: +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `-h --help` - display help for command -- `--bot.nodeAdminUrl ` - The URL to the Aztec node admin API to force-flush txs if configured. - *Environment: `$AZTEC_NODE_ADMIN_URL`* -- `--bot.pxeUrl ` - URL to the PXE for sending txs, or undefined if an in-proc PXE is used. - *Environment: `$BOT_PXE_URL`* +#### Subcommands -- `--bot.l1Mnemonic ` - The mnemonic for the account to bridge fee juice from L1. - *Environment: `$BOT_L1_MNEMONIC`* +#### aztec sequencers command -- `--bot.l1PrivateKey ` - The private key for the account to bridge fee juice from L1. - *Environment: `$BOT_L1_PRIVATE_KEY`* +*This command help is currently unavailable due to a technical issue.* -- `--bot.l1ToL2MessageTimeoutSeconds ` (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 ` - Signing private key for the sender account. - *Environment: `$BOT_PRIVATE_KEY`* +#### aztec sequencers who -- `--bot.senderSalt ` - The salt to use to deploys the sender account. - *Environment: `$BOT_ACCOUNT_SALT`* +*This command help is currently unavailable due to a technical issue.* -- `--bot.recipientEncryptionSecret ` (default: `0x00000000000000000000000000000000000000000000000000000000cafecafe`) - Encryption secret for a recipient account. - *Environment: `$BOT_RECIPIENT_ENCRYPTION_SECRET`* -- `--bot.tokenSalt ` (default: `0x0000000000000000000000000000000000000000000000000000000000000001`) - Salt for the token contract deployment. - *Environment: `$BOT_TOKEN_SALT`* +### aztec setup-protocol-contracts -- `--bot.txIntervalSeconds ` (default: `60`) - Every how many seconds should a new tx be sent. - *Environment: `$BOT_TX_INTERVAL_SECONDS`* +Bootstrap the blockchain by initializing all the protocol contracts -- `--bot.privateTransfersPerTx ` (default: `1`) - How many private token transfers are executed per tx. - *Environment: `$BOT_PRIVATE_TRANSFERS_PER_TX`* +**Usage:** +```bash +aztec setup-protocol-contracts [options] +``` -- `--bot.publicTransfersPerTx ` (default: `1`) - How many public token transfers are executed per tx. - *Environment: `$BOT_PUBLIC_TRANSFERS_PER_TX`* +**Options:** -- `--bot.feePaymentMethod ` (default: `fee_juice`) - How to handle fee payments. (Options: fee_juice) - *Environment: `$BOT_FEE_PAYMENT_METHOD`* +- `-u --rpc-url ` - URL of the PXE (default: +- `--testAccounts` - Deploy funded test accounts. +- `--sponsoredFPC` - Deploy a sponsored FPC. +- `--json` - Output the contract addresses in JSON format +- `--skipProofWait` - Don't wait for proofs to land. +- `-h --help` - display help for command -- `--bot.noStart ` - True to not automatically setup or start the bot on initialization. - *Environment: `$BOT_NO_START`* +### aztec simulate -- `--bot.txMinedWaitSeconds ` (default: `180`) - How long to wait for a tx to be mined before reporting an error. - *Environment: `$BOT_TX_MINED_WAIT_SECONDS`* +Simulates the execution of a function on an Aztec contract. -- `--bot.followChain ` (default: `NONE`) - Which chain the bot follows - *Environment: `$BOT_FOLLOW_CHAIN`* +**Usage:** +```bash +aztec simulate [options] +``` -- `--bot.maxPendingTxs ` (default: `128`) - Do not send a tx if the node's tx pool already has this many pending txs. - *Environment: `$BOT_MAX_PENDING_TXS`* +**Available Commands:** -- `--bot.flushSetupTransactions ` - Make a request for the sequencer to build a block after each setup transaction. - *Environment: `$BOT_FLUSH_SETUP_TRANSACTIONS`* +- `functionName` - Name of function to simulate -- `--bot.l2GasLimit ` - L2 gas limit for the tx (empty to have the bot trigger an estimate gas). - *Environment: `$BOT_L2_GAS_LIMIT`* +**Options:** -- `--bot.daGasLimit ` - DA gas limit for the tx (empty to have the bot trigger an estimate gas). - *Environment: `$BOT_DA_GAS_LIMIT`* +- `-u --rpc-url ` - URL of the PXE (default: "http://host.docker.internal:8080", env: PXE_URL) +- `--args` - [args...] Function arguments (default: []) +- `-ca --contract-address
` - Aztec address of the contract. +- `-c --contract-artifact ` - Path to a compiled Aztec contract's artifact in JSON format. If executed inside a nargo workspace, a package and contract name can be specified as package@contract +- `-sk --secret-key ` - The sender's secret key (env: SECRET_KEY) +- `-v --verbose` - Provide timings on all executed operations (synching, simulating, proving) (default: false) +- `--payment ` - Fee payment method and arguments. +- `--gas-limits ` - Gas limits for the tx. +- `--max-fees-per-gas ` - Maximum fees per gas unit for DA and L2 computation. +- `--max-priority-fees-per-gas ` - Maximum priority fees per gas unit for DA and L2 computation. +- `--estimate-gas` - Whether to automatically estimate gas limits for the tx. +- `--estimate-gas-only` - Only report gas estimation for the tx, do not send it. +- `-h --help` - display help for command -- `--bot.contract ` (default: `TokenContract`) - Token contract to use - *Environment: `$BOT_TOKEN_CONTRACT`* -- `--bot.maxConsecutiveErrors ` - The maximum number of consecutive errors before the bot shuts down - *Environment: `$BOT_MAX_CONSECUTIVE_ERRORS`* +#### Subcommands -- `--bot.stopWhenUnhealthy ` - Stops the bot if service becomes unhealthy - *Environment: `$BOT_STOP_WHEN_UNHEALTHY`* +#### aztec simulate functionName -- `--bot.ammTxs ` - Deploy an AMM and send swaps to it - *Environment: `$BOT_AMM_TXS`* +*This command help is currently unavailable due to a technical issue.* -**PXE** -- `--pxe` - Starts Aztec PXE with options +### aztec start -- `--pxe.l2BlockBatchSize ` (default: `50`) - Maximum amount of blocks to pull from the stream in one request when synchronizing - *Environment: `$PXE_L2_BLOCK_BATCH_SIZE`* +**Options:** -- `--pxe.bbBinaryPath ` - Path to the BB binary - *Environment: `$BB_BINARY_PATH`* +- `--bot.noStart ` - ($BOT_NO_START) +- `--bot.txMinedWaitSeconds ` - (default: 180) ($BOT_TX_MINED_WAIT_SECONDS) +- `--bot.followChain ` - (default: NONE) ($BOT_FOLLOW_CHAIN) +- `--bot.maxPendingTxs ` - (default: 128) ($BOT_MAX_PENDING_TXS) +- `--bot.flushSetupTransactions ` - ($BOT_FLUSH_SETUP_TRANSACTIONS) +- `--bot.l2GasLimit ` - ($BOT_L2_GAS_LIMIT) +- `--bot.daGasLimit ` - ($BOT_DA_GAS_LIMIT) +- `--bot.contract ` - (default: TokenContract) ($BOT_TOKEN_CONTRACT) +- `--bot.maxConsecutiveErrors ` - ($BOT_MAX_CONSECUTIVE_ERRORS) +- `--bot.stopWhenUnhealthy ` - ($BOT_STOP_WHEN_UNHEALTHY) +- `--bot.ammTxs ` - ($BOT_AMM_TXS) +- `--pxe` - +- `--pxe.l2BlockBatchSize ` - (default: 50) ($PXE_L2_BLOCK_BATCH_SIZE) +- `--pxe.bbBinaryPath ` - ($BB_BINARY_PATH) +- `--pxe.bbWorkingDirectory ` - ($BB_WORKING_DIRECTORY) +- `--pxe.bbSkipCleanup ` - ($BB_SKIP_CLEANUP) +- `--pxe.proverEnabled ` - (default: true) ($PXE_PROVER_ENABLED) +- `--pxe.nodeUrl ` - ($AZTEC_NODE_URL) +- `--txe` - -- `--pxe.bbWorkingDirectory ` - Working directory for the BB binary - *Environment: `$BB_WORKING_DIRECTORY`* +### aztec trigger-seed-snapshot -- `--pxe.bbSkipCleanup ` - True to skip cleanup of temporary files for debugging purposes - *Environment: `$BB_SKIP_CLEANUP`* +Triggers a seed snapshot for the next epoch. -- `--pxe.proverEnabled ` (default: `true`) - Enable real proofs - *Environment: `$PXE_PROVER_ENABLED`* +**Usage:** +```bash +aztec trigger-seed-snapshot [options] +``` -- `--pxe.nodeUrl ` - Custom Aztec Node URL to connect to - *Environment: `$AZTEC_NODE_URL`* +**Options:** -**TXE** +- `-pk --private-key ` - The private key to use for deployment +- `-m --mnemonic ` - The mnemonic to use in deployment (default: +- `--rollup
` - ethereum address of the rollup contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain identifiers +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: 31337, +- `-h --help` - display help for command -- `--txe` - Starts Aztec TXE with options +### aztec update -### aztec trigger-seed-snapshot +Updates Nodejs and Noir dependencies +**Usage:** +```bash +aztec update [options] [projectPath] ``` -Usage: aztec trigger-seed-snapshot [options] -Triggers a seed snapshot for the next epoch. +**Available Commands:** -Options: - -pk, --private-key The private key to use for deployment - -m, --mnemonic The mnemonic to use in deployment (default: - "test test test test test test test test test - test test junk") - --rollup
ethereum address of the rollup contract - --l1-rpc-urls 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 Chain ID of the ethereum host (default: 31337, - env: L1_CHAIN_ID) - -h, --help display help for command +- `projectPath` - Path to the project directory (default: -``` +**Options:** -### aztec update +- `--contract` - [paths...] Paths to contracts to update dependencies (default: +- `--aztec-version ` - The version to update Aztec packages to. Defaults +- `-h --help` - display help for command -``` -Usage: aztec update [options] [projectPath] -Updates Nodejs and Noir dependencies +#### Subcommands -Arguments: - projectPath Path to the project directory +#### aztec update projectPath -Options: - --contract [paths...] Paths to contracts to update dependencies (default: - []) - --aztec-version The version to update Aztec packages to. Defaults - to latest (default: "latest") - -h, --help display help for command +*This command help is currently unavailable due to a technical issue.* -``` ### aztec validator-keys|valKeys @@ -2383,32 +1544,23 @@ Options: ### aztec vote-on-governance-proposal -``` -Usage: aztec vote-on-governance-proposal [options] - Votes on a governance proposal. -Options: - -p, --proposal-id The ID of the proposal - -a, --vote-amount The amount of tokens to vote - --in-favor Whether to vote in favor of the proposal. - Use "yea" for true, any other value for - false. - --wait Whether to wait until the proposal is active - -r, --registry-address The address of the registry contract - --l1-rpc-urls 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 Chain ID of the ethereum host (default: - 31337, env: L1_CHAIN_ID) - -pk, --private-key The private key to use to vote - -m, --mnemonic The mnemonic to use to vote (default: "test - test test test test test test test test test - test junk") - -i, --mnemonic-index The index of the mnemonic to use to vote - (default: 0) - -h, --help display help for command - +**Usage:** +```bash +aztec vote-on-governance-proposal [options] ``` + +**Options:** + +- `-p --proposal-id ` - The ID of the proposal +- `-a --vote-amount ` - The amount of tokens to vote +- `--in-favor ` - Whether to vote in favor of the proposal. +- `--wait ` - Whether to wait until the proposal is active +- `-r --registry-address ` - The address of the registry contract +- `--l1-rpc-urls ` - List of Ethereum host URLs. Chain +- `-c --l1-chain-id ` - Chain ID of the ethereum host (default: +- `-pk --private-key ` - The private key to use to vote +- `-m --mnemonic ` - The mnemonic to use to vote (default: "test +- `-i --mnemonic-index ` - The index of the mnemonic to use to vote +- `-h --help` - display help for command diff --git a/docs/docs-developers/docs/cli/bb_cli_reference.md b/docs/docs-developers/docs/cli/bb_cli_reference.md index d9d35c31ded1..28d09719da63 100644 --- a/docs/docs-developers/docs/cli/bb_cli_reference.md +++ b/docs/docs-developers/docs/cli/bb_cli_reference.md @@ -1,6 +1,6 @@ --- title: Barretenberg CLI Reference -description: Comprehensive auto-generated reference for the Barretenberg CLI Reference command-line interface with all commands and options. +description: Comprehensive auto-generated reference for the Barretenberg CLI command-line interface with all commands and options. tags: [cli, reference, autogenerated, barretenberg, proving] sidebar_position: 3 --- @@ -10,7 +10,7 @@ sidebar_position: 3 *This documentation is auto-generated from the `bb` CLI help output.* -*Generated: Thu 01 Jan 2026 10:01:35 UTC* +*Generated: Thu 01 Jan 2026 11:17:23 UTC* *Command: `bb`* diff --git a/docs/scripts/cli_reference_generation/cli_config.sh b/docs/scripts/cli_reference_generation/cli_config.sh index 8f4a0a712ad9..980c20d9cb74 100755 --- a/docs/scripts/cli_reference_generation/cli_config.sh +++ b/docs/scripts/cli_reference_generation/cli_config.sh @@ -1,62 +1,69 @@ #!/bin/bash # Shared CLI configuration for documentation generation scripts -# Source this file to get CLI configuration variables +# Reads configuration from cli_docs_config.json (single source of truth) # # Usage: # source "$(dirname "${BASH_SOURCE[0]}")/cli_config.sh" # get_cli_config "aztec" # echo "$CLI_DISPLAY_NAME" # "Aztec CLI" +# +# Requires: jq + +# Path to JSON config file (source of truth) +CLI_CONFIG_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +CLI_CONFIG_JSON="$CLI_CONFIG_DIR/cli_docs_config.json" + +# Check for jq dependency +if ! command -v jq &> /dev/null; then + echo "Error: jq is required but not installed" >&2 + echo " Install with: brew install jq (macOS) or apt install jq (Linux)" >&2 + return 1 2>/dev/null || exit 1 +fi + +# Check config file exists +if [[ ! -f "$CLI_CONFIG_JSON" ]]; then + echo "Error: Config file not found: $CLI_CONFIG_JSON" >&2 + return 1 2>/dev/null || exit 1 +fi -# Valid CLI names -readonly VALID_CLIS=("aztec" "aztec-wallet" "bb") +# Read valid CLI names from JSON config +# Note: Using process substitution to avoid subshell issues with arrays +VALID_CLIS=() +while IFS= read -r cli; do + VALID_CLIS+=("$cli") +done < <(jq -r '.clis | keys[]' "$CLI_CONFIG_JSON") +readonly VALID_CLIS -# Get configuration for a CLI +# Get configuration for a CLI from JSON # Sets: CLI_DISPLAY_NAME, CLI_TITLE, CLI_COMMAND, CLI_FORMAT, -# CLI_OUTPUT_FILE, CLI_SIDEBAR_POSITION, CLI_TAGS +# CLI_OUTPUT_FILE, CLI_SIDEBAR_POSITION, CLI_TAGS, CLI_DESCRIPTION # -# CLI_SIDEBAR_POSITION controls the order in Docusaurus sidebar: -# 1 = aztec (primary CLI, listed first) -# 2 = aztec-wallet (secondary CLI) -# 3 = bb (Barretenberg proving backend) +# CLI_SIDEBAR_POSITION controls the order in Docusaurus sidebar get_cli_config() { local cli_name="$1" - case "$cli_name" in - aztec) - CLI_DISPLAY_NAME="Aztec CLI" - CLI_TITLE="Aztec CLI Reference" - CLI_COMMAND="aztec" - CLI_FORMAT="commander" - CLI_OUTPUT_FILE="aztec_cli_reference.md" - CLI_SIDEBAR_POSITION="1" - CLI_TAGS="[cli, reference, autogenerated]" - ;; - aztec-wallet) - CLI_DISPLAY_NAME="Aztec Wallet CLI" - CLI_TITLE="Aztec Wallet CLI Reference" - CLI_COMMAND="aztec-wallet" - CLI_FORMAT="commander" - CLI_OUTPUT_FILE="aztec_wallet_cli_reference.md" - CLI_SIDEBAR_POSITION="2" - CLI_TAGS="[cli, reference, autogenerated, wallet]" - ;; - bb) - CLI_DISPLAY_NAME="Barretenberg CLI" - CLI_TITLE="Barretenberg CLI Reference" - CLI_COMMAND="bb" - CLI_FORMAT="cli11" - CLI_OUTPUT_FILE="bb_cli_reference.md" - CLI_SIDEBAR_POSITION="3" - CLI_TAGS="[cli, reference, autogenerated, barretenberg, proving]" - ;; - *) - echo "Error: Unknown CLI '$cli_name'. Valid options: ${VALID_CLIS[*]}" >&2 - return 1 - ;; - esac + # Check if CLI exists in config + local cli_config + cli_config=$(jq -r ".clis[\"$cli_name\"] // empty" "$CLI_CONFIG_JSON") + + if [[ -z "$cli_config" ]]; then + echo "Error: Unknown CLI '$cli_name'. Valid options: ${VALID_CLIS[*]}" >&2 + return 1 + fi + + # Extract values from JSON + CLI_DISPLAY_NAME=$(echo "$cli_config" | jq -r '.display_name') + CLI_TITLE=$(echo "$cli_config" | jq -r '.title') + CLI_COMMAND=$(echo "$cli_config" | jq -r '.command') + CLI_FORMAT=$(echo "$cli_config" | jq -r '.format') + CLI_OUTPUT_FILE=$(echo "$cli_config" | jq -r '.output_file') + CLI_SIDEBAR_POSITION=$(echo "$cli_config" | jq -r '.sidebar_position') + CLI_DESCRIPTION=$(echo "$cli_config" | jq -r '.description') + # Format tags as bracket-enclosed comma-separated list for YAML front-matter + CLI_TAGS=$(echo "$cli_config" | jq -r '.tags | "[" + join(", ") + "]"') } -# Validate CLI name +# Validate CLI name against JSON config validate_cli_name() { local cli_name="$1" for valid in "${VALID_CLIS[@]}"; do @@ -80,4 +87,3 @@ get_cli_install_instructions() { ;; esac } - diff --git a/docs/scripts/cli_reference_generation/cli_docs_config.json b/docs/scripts/cli_reference_generation/cli_docs_config.json new file mode 100644 index 000000000000..c3ed73d27b01 --- /dev/null +++ b/docs/scripts/cli_reference_generation/cli_docs_config.json @@ -0,0 +1,51 @@ +{ + "description": "Configuration for auto-generated CLI documentation", + "clis": { + "aztec": { + "command": "aztec", + "format": "commander", + "display_name": "Aztec CLI", + "title": "Aztec CLI Reference", + "output_file": "aztec_cli_reference.md", + "sidebar_position": 1, + "tags": ["cli", "reference", "autogenerated"], + "description": "Comprehensive auto-generated reference for the Aztec CLI command-line interface with all commands and options.", + "docs_path": "docs/cli", + "enabled": true + }, + "aztec-wallet": { + "command": "aztec-wallet", + "format": "commander", + "display_name": "Aztec Wallet CLI", + "title": "Aztec Wallet CLI Reference", + "output_file": "aztec_wallet_cli_reference.md", + "sidebar_position": 2, + "tags": ["cli", "reference", "autogenerated", "wallet"], + "description": "Comprehensive auto-generated reference for the Aztec Wallet CLI command-line interface with all commands and options.", + "docs_path": "docs/cli", + "enabled": true + }, + "bb": { + "command": "bb", + "format": "cli11", + "display_name": "Barretenberg CLI", + "title": "Barretenberg CLI Reference", + "output_file": "bb_cli_reference.md", + "sidebar_position": 3, + "tags": ["cli", "reference", "autogenerated", "barretenberg", "proving"], + "description": "Comprehensive auto-generated reference for the Barretenberg CLI command-line interface with all commands and options.", + "docs_path": "docs/cli", + "enabled": true + } + }, + "output": { + "current_docs_base": "docs-developers", + "versioned_docs_base": "developer_versioned_docs", + "versions_file": "developer_versions.json" + }, + "generation": { + "skip_version_check": false, + "timeout_seconds": 60, + "max_recursion_depth": 5 + } +} diff --git a/docs/scripts/cli_reference_generation/generate_all_cli_docs.sh b/docs/scripts/cli_reference_generation/generate_all_cli_docs.sh new file mode 100755 index 000000000000..6f506e876bca --- /dev/null +++ b/docs/scripts/cli_reference_generation/generate_all_cli_docs.sh @@ -0,0 +1,314 @@ +#!/bin/bash +# Generate CLI documentation for all configured CLIs +# This script reads from cli_docs_config.json and generates docs for each enabled CLI +# +# Usage: +# ./generate_all_cli_docs.sh [options] +# +# Options: +# --version Target version (e.g., v3.0.0, v3.0.0-nightly.20260101) +# --output-dir Output directory (default: auto-detect from config) +# --skip-version-check Skip CLI version verification +# --cli Generate docs for specific CLI only (can be repeated) +# --dry-run Show what would be done without executing +# +# Examples: +# ./generate_all_cli_docs.sh # Generate for current docs +# ./generate_all_cli_docs.sh --version v3.0.0 # Generate for specific version +# ./generate_all_cli_docs.sh --cli bb --cli aztec # Generate for specific CLIs +# ./generate_all_cli_docs.sh --skip-version-check # Skip version checks (for CI) + +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +DOCS_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)" +CONFIG_FILE="$SCRIPT_DIR/cli_docs_config.json" + +# Default values +TARGET_VERSION="" +OUTPUT_DIR="" +SKIP_VERSION_CHECK=false +SPECIFIC_CLIS=() +DRY_RUN=false + +# Parse arguments +while [[ $# -gt 0 ]]; do + case $1 in + --version) + TARGET_VERSION="$2" + shift 2 + ;; + --output-dir) + OUTPUT_DIR="$2" + shift 2 + ;; + --skip-version-check) + SKIP_VERSION_CHECK=true + shift + ;; + --cli) + SPECIFIC_CLIS+=("$2") + shift 2 + ;; + --dry-run) + DRY_RUN=true + shift + ;; + -h|--help) + cat << 'EOF' +Generate CLI documentation for all configured CLIs. +Reads from cli_docs_config.json and generates docs for each enabled CLI. + +Usage: + ./generate_all_cli_docs.sh [options] + +Options: + --version Target version (e.g., v3.0.0, v3.0.0-nightly.20260101) + --output-dir Output directory (default: auto-detect from config) + --skip-version-check Skip CLI version verification + --cli Generate docs for specific CLI only (can be repeated) + --dry-run Show what would be done without executing + -h, --help Show this help message + +Examples: + ./generate_all_cli_docs.sh # Generate for current docs + ./generate_all_cli_docs.sh --version v3.0.0 # Generate for specific version + ./generate_all_cli_docs.sh --cli bb --cli aztec # Generate for specific CLIs + ./generate_all_cli_docs.sh --skip-version-check # Skip version checks (for CI) +EOF + exit 0 + ;; + *) + echo "Unknown option: $1" + exit 1 + ;; + esac +done + +# Validate config file exists +if [[ ! -f "$CONFIG_FILE" ]]; then + echo "Error: Config file not found: $CONFIG_FILE" + exit 1 +fi + +# Check for jq +if ! command -v jq &> /dev/null; then + echo "Error: jq is required but not installed" + exit 1 +fi + +echo "==============================================" +echo "CLI Documentation Generator" +echo "==============================================" +echo "" +echo "Config file: $CONFIG_FILE" +echo "Docs root: $DOCS_ROOT" +[[ -n "$TARGET_VERSION" ]] && echo "Target version: $TARGET_VERSION" +[[ "$SKIP_VERSION_CHECK" == "true" ]] && echo "Version check: SKIPPED" +[[ "$DRY_RUN" == "true" ]] && echo "Mode: DRY RUN" +echo "" + +# Read configuration +CURRENT_DOCS_BASE=$(jq -r '.output.current_docs_base' "$CONFIG_FILE") +VERSIONED_DOCS_BASE=$(jq -r '.output.versioned_docs_base' "$CONFIG_FILE") + +# Get list of CLIs to process +if [[ ${#SPECIFIC_CLIS[@]} -gt 0 ]]; then + CLI_NAMES=("${SPECIFIC_CLIS[@]}") +else + # Read all enabled CLIs from config (compatible with bash 3.2+) + CLI_NAMES=() + while IFS= read -r cli; do + CLI_NAMES+=("$cli") + done < <(jq -r '.clis | to_entries[] | select(.value.enabled == true) | .key' "$CONFIG_FILE") +fi + +echo "CLIs to process: ${CLI_NAMES[*]}" +echo "" + +# Track results +SUCCESSFUL=() +FAILED=() +SKIPPED=() + +# Create temp directory (shared across all CLI processing) +TEMP_DIR=$(mktemp -d) +trap 'rm -rf "$TEMP_DIR"' EXIT + +# Process each CLI +for cli_name in "${CLI_NAMES[@]}"; do + echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" + echo "Processing: $cli_name" + echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" + + # Read CLI config + CLI_CONFIG=$(jq -r ".clis[\"$cli_name\"]" "$CONFIG_FILE") + + if [[ "$CLI_CONFIG" == "null" ]]; then + echo " ⚠️ CLI '$cli_name' not found in config, skipping" + SKIPPED+=("$cli_name") + continue + fi + + ENABLED=$(echo "$CLI_CONFIG" | jq -r '.enabled') + if [[ "$ENABLED" != "true" ]]; then + echo " ⚠️ CLI '$cli_name' is disabled in config, skipping" + SKIPPED+=("$cli_name") + continue + fi + + COMMAND=$(echo "$CLI_CONFIG" | jq -r '.command') + FORMAT=$(echo "$CLI_CONFIG" | jq -r '.format') + DISPLAY_NAME=$(echo "$CLI_CONFIG" | jq -r '.display_name') + TITLE=$(echo "$CLI_CONFIG" | jq -r '.title') + OUTPUT_FILE=$(echo "$CLI_CONFIG" | jq -r '.output_file') + SIDEBAR_POSITION=$(echo "$CLI_CONFIG" | jq -r '.sidebar_position') + DOCS_PATH=$(echo "$CLI_CONFIG" | jq -r '.docs_path') + DESCRIPTION=$(echo "$CLI_CONFIG" | jq -r '.description') + + # Read tags as comma-separated string + TAGS=$(echo "$CLI_CONFIG" | jq -r '.tags | join(", ")') + + echo " Command: $COMMAND" + echo " Format: $FORMAT" + echo " Output: $OUTPUT_FILE" + + # Check if command exists + if ! command -v "$COMMAND" &> /dev/null; then + echo " ⚠️ Command '$COMMAND' not found, skipping" + SKIPPED+=("$cli_name") + continue + fi + + if [[ "$DRY_RUN" == "true" ]]; then + echo " [DRY RUN] Would generate docs for $cli_name" + SUCCESSFUL+=("$cli_name") + continue + fi + + # Temp file paths (using shared temp directory) + TEMP_JSON="$TEMP_DIR/cli_docs.json" + TEMP_MD="$TEMP_DIR/cli_auto.md" + TEMP_FINAL="$TEMP_DIR/cli_final.md" + + # Step 1: Scan CLI + echo " Scanning CLI..." + if ! python3 "$SCRIPT_DIR/scan_cli.py" \ + --command "$COMMAND" \ + --cli-format "$FORMAT" \ + --output "$TEMP_JSON" 2>&1; then + echo " ❌ Failed to scan CLI" + FAILED+=("$cli_name") + continue + fi + + # Step 2: Generate markdown + echo " Generating markdown..." + if ! python3 "$SCRIPT_DIR/transform_to_markdown.py" \ + --input "$TEMP_JSON" \ + --output "$TEMP_MD" \ + --title "$TITLE" 2>&1; then + echo " ❌ Failed to generate markdown" + FAILED+=("$cli_name") + continue + fi + + # Step 3: Add front-matter + cat > "$TEMP_FINAL" << EOF +--- +title: ${TITLE} +description: ${DESCRIPTION} +tags: [${TAGS}] +sidebar_position: ${SIDEBAR_POSITION} +--- + +# ${TITLE} + +*This documentation is auto-generated from the \`${COMMAND}\` CLI help output.* + +EOF + + # Append markdown content (skip first line which is duplicate title) + tail -n +2 "$TEMP_MD" >> "$TEMP_FINAL" + + # Step 4: Deploy to target locations + deploy_to_version() { + local version=$1 + local target_dir="" + + if [[ "$version" == "current" ]]; then + target_dir="$DOCS_ROOT/$CURRENT_DOCS_BASE/$DOCS_PATH" + else + target_dir="$DOCS_ROOT/$VERSIONED_DOCS_BASE/version-${version}/$DOCS_PATH" + fi + + if [[ ! -d "$target_dir" ]]; then + echo " ⚠️ Directory not found: $target_dir" + return 1 + fi + + cp "$TEMP_FINAL" "$target_dir/$OUTPUT_FILE" + echo " ✓ Deployed to $version" + return 0 + } + + echo " Deploying..." + + if [[ -n "$TARGET_VERSION" ]]; then + # Deploy to specific version only + deploy_to_version "$TARGET_VERSION" || true + else + # Deploy to current docs + deploy_to_version "current" || true + + # Deploy to all versioned docs + VERSIONS_FILE="$DOCS_ROOT/$(jq -r '.output.versions_file' "$CONFIG_FILE")" + if [[ -f "$VERSIONS_FILE" ]]; then + # Validate JSON and check for versions + if ! jq -e '.[]' "$VERSIONS_FILE" &>/dev/null; then + echo " ⚠️ Versions file is empty or invalid JSON: $VERSIONS_FILE" + else + while IFS= read -r version; do + deploy_to_version "$version" || true + done < <(jq -r '.[]' "$VERSIONS_FILE") + fi + else + echo " ⚠️ Versions file not found: $VERSIONS_FILE" + fi + fi + + SUCCESSFUL+=("$cli_name") + echo " ✅ Completed" + echo "" +done + +# Summary +echo "" +echo "==============================================" +echo "Summary" +echo "==============================================" +echo "" +echo "Successful: ${#SUCCESSFUL[@]}" +for cli in "${SUCCESSFUL[@]}"; do + echo " ✅ $cli" +done + +if [[ ${#SKIPPED[@]} -gt 0 ]]; then + echo "" + echo "Skipped: ${#SKIPPED[@]}" + for cli in "${SKIPPED[@]}"; do + echo " ⚠️ $cli" + done +fi + +if [[ ${#FAILED[@]} -gt 0 ]]; then + echo "" + echo "Failed: ${#FAILED[@]}" + for cli in "${FAILED[@]}"; do + echo " ❌ $cli" + done + exit 1 +fi + +echo "" +echo "✅ CLI documentation generation complete!" diff --git a/docs/scripts/cli_reference_generation/update_cli_docs.sh b/docs/scripts/cli_reference_generation/update_cli_docs.sh index db097d2de886..a17faeb8474d 100755 --- a/docs/scripts/cli_reference_generation/update_cli_docs.sh +++ b/docs/scripts/cli_reference_generation/update_cli_docs.sh @@ -126,7 +126,7 @@ python3 "$SCRIPT_DIR/transform_to_markdown.py" \ cat > "$TEMP_WITH_FRONTMATTER" << EOF --- title: ${CLI_TITLE} -description: Comprehensive auto-generated reference for the ${CLI_DISPLAY_NAME} command-line interface with all commands and options. +description: ${CLI_DESCRIPTION} tags: ${CLI_TAGS} sidebar_position: ${CLI_SIDEBAR_POSITION} ---