Skip to main content
Version: Devnet (v3.0.0-devnet.4)

Aztec Wallet CLI Reference

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

info

This is an auto-generated reference. For a more curated guide with examples and best practices, see the manual Aztec Wallet CLI reference.

Generated: Thu Nov 6 02:38:33 HKT 2025

Command: aztec-wallet

Table of Contents​

aztec-wallet​

Aztec wallet

Usage:

wallet [options] [command]

Available Commands:

  • import-test-accounts [options] - Import test accounts from pxe.
  • create-account [options] - Creates an aztec account that can be used for sending transactions.
  • deploy-account [options] <address> - Deploys an already registered aztec account that can be used for sending transactions.
  • deploy [options] [artifact] - Deploys a compiled Aztec.nr contract to Aztec.
  • send [options] <functionName> - Calls a function on an Aztec contract.
  • simulate [options] <functionName> - Simulates the execution of a function on an Aztec contract.
  • profile [options] <functionName> - Profiles a private function by counting the unconditional operations in its execution steps
  • bridge-fee-juice [options] <amount> <recipient> - Mints L1 Fee Juice and pushes them to L2.
  • create-authwit [options] <functionName> <caller> - Creates an authorization witness that can be privately sent to a caller so they can perform an action on behalf of the provided account
  • authorize-action [options] <functionName> <caller> - Authorizes a public call on the caller, so they can perform an action on behalf of the provided account
  • get-tx [options] [txHash] - Gets the status of the recent txs, or a detailed view if a specific transaction hash is provided
  • register-sender [options] [address] - Registers a sender's address in the wallet, so the note synching process will look for notes sent by them
  • register-contract [options] [address] [artifact] - Registers a contract in this wallet's PXE
  • alias <type> <key> <value> - Aliases information for easy reference.
  • get-alias [alias] - Shows stored aliases
  • create-secret [options] - Creates an aliased secret to use in other commands
  • help [command] - display help for command

Options:

  • -V --version - output the version number
  • -d --data-dir <string> - Storage directory for wallet data (default: "/Users/aztec/.aztec/wallet")
  • -p --prover <string> - The type of prover the wallet uses (choices: "wasm", "native", "none", default: "native", env: PXE_PROVER)
  • -n --node-url <string> - URL of the Aztec node to connect to (default: "http://host.docker.internal:8080", env: AZTEC_NODE_URL)
  • -h --help - display help for command

Subcommands​

aztec-wallet import-test-accounts​

Usage: wallet import-test-accounts [options]

Import test accounts from pxe.

Options:
  --json      Emit output as json
  -h, --help  display help for command
2025/11/06 02:38:35 socat[72638] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet create-account​

Usage: wallet create-account [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:
  -f, --from <string>                                       Alias or address of the account performing the deployment
  --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.
  --register-class                                          Register the contract class (useful for when the contract class has not been deployed yet).
  -p, --public-key <string>                                 Public key that identifies a private signing key stored outside of the wallet. Used for ECDSA SSH accounts over the secp256r1 curve.
  -sk, --secret-key <string>                                Secret key for account. Uses random by default. (env: SECRET_KEY)
  -a, --alias <string>                                      Alias for the account. Used for easy reference in subsequent commands.
  -t, --type <string>                                       Type of account to create (choices: "schnorr", "ecdsasecp256r1", "ecdsasecp256r1ssh", "ecdsasecp256k1", default: "schnorr")
  --register-only                                           Just register the account on the Wallet. 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 <options>                                       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. 
  Format: --payment method=name,asset=address,fpc=address ...
  --gas-limits <da=100,l2=100,teardownDA=10,teardownL2=10>  Gas limits for the tx.
  --max-fees-per-gas <da=100,l2=100>                        Maximum fees per gas unit for DA and L2 computation.
  --max-priority-fees-per-gas <da=0,l2=0>                   Maximum priority fees per gas unit for DA and L2 computation.
  --estimate-gas-only                                       Only report gas estimation for the tx, do not send it.
  -h, --help                                                display help for command
2025/11/06 02:38:37 socat[72822] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet deploy-account​

Usage: wallet deploy-account [options] <address>

Deploys an already registered aztec account that can be used for sending
transactions.

Arguments:
  address                                                   The address of the contract to register

Options:
  -f, --from <string>                                       Alias or address of the account performing the deployment
  --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.
  --skip-initialization                                     Skip initializing the account contract. Useful for publicly deploying an existing account.
  -v, --verbose                                             Provide timings on all executed operations (synching, simulating, proving) (default: false)
  --payment <options>                                       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. 
  Format: --payment method=name,asset=address,fpc=address ...
  --gas-limits <da=100,l2=100,teardownDA=10,teardownL2=10>  Gas limits for the tx.
  --max-fees-per-gas <da=100,l2=100>                        Maximum fees per gas unit for DA and L2 computation.
  --max-priority-fees-per-gas <da=0,l2=0>                   Maximum priority fees per gas unit for DA and L2 computation.
  --estimate-gas-only                                       Only report gas estimation for the tx, do not send it.
  -h, --help                                                display help for command
2025/11/06 02:38:39 socat[73008] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet deploy​

Usage: wallet deploy [options] [artifact]

Deploys a compiled Aztec.nr contract to Aztec.

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 <string>                                           The contract initializer function to call (default: "constructor")
  --no-init                                                 Leave the contract uninitialized
  -k, --public-key <string>                                 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 <hex string>                                   Optional deployment salt as a hex string for generating the deployment address.
  --universal                                               Do not mix the sender address into the deployment.
  --args [args...]                                          Constructor  arguments (default: [])
  -f, --from <string>                                       Alias or address of the account to deploy from
  -a, --alias <string>                                      Alias for the contract. Used for easy reference subsequent commands.
  --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 <number>                                        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 <options>                                       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. 
  Format: --payment method=name,asset=address,fpc=address ...
  --gas-limits <da=100,l2=100,teardownDA=10,teardownL2=10>  Gas limits for the tx.
  --max-fees-per-gas <da=100,l2=100>                        Maximum fees per gas unit for DA and L2 computation.
  --max-priority-fees-per-gas <da=0,l2=0>                   Maximum priority fees per gas unit for DA and L2 computation.
  --estimate-gas-only                                       Only report gas estimation for the tx, do not send it.
  -h, --help                                                display help for command
2025/11/06 02:38:40 socat[73175] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet send​

Usage: wallet send [options] <functionName>

Calls a function on an Aztec contract.

Arguments:
  functionName                                              Name of function to execute

Options:
  --args [args...]                                          Function  arguments (default: [])
  -c, --contract-artifact <fileLocation>                    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 <address>                         Aztec address of the contract.
  -a, --alias <string>                                      Alias for the transaction hash. Used for easy reference in subsequent commands.
  -aw, --auth-witness <string,...>                          Authorization witness to use for the transaction. If using multiple, pass a comma separated string
  -f, --from <string>                                       Alias or address of the account to send the transaction from
  --no-wait                                                 Print transaction hash without waiting for it to be mined
  -v, --verbose                                             Provide timings on all executed operations (synching, simulating, proving) (default: false)
  --payment <options>                                       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. 
  Format: --payment method=name,asset=address,fpc=address ...
  --gas-limits <da=100,l2=100,teardownDA=10,teardownL2=10>  Gas limits for the tx.
  --max-fees-per-gas <da=100,l2=100>                        Maximum fees per gas unit for DA and L2 computation.
  --max-priority-fees-per-gas <da=0,l2=0>                   Maximum priority fees per gas unit for DA and L2 computation.
  --estimate-gas-only                                       Only report gas estimation for the tx, do not send it.
  -h, --help                                                display help for command
2025/11/06 02:38:42 socat[73359] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet simulate​

Usage: wallet simulate [options] <functionName>

Simulates the execution of a function on an Aztec contract.

Arguments:
  functionName                                              Name of function to simulate

Options:
  --args [args...]                                          Function  arguments (default: [])
  -ca, --contract-address <address>                         Aztec address of the contract.
  -c, --contract-artifact <fileLocation>                    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 <string>                                The sender's secret key (env: SECRET_KEY)
  -aw, --auth-witness <string,...>                          Authorization witness to use for the simulation
  -f, --from <string>                                       Alias or address of the account to simulate from
  -v, --verbose                                             Provide timings on all executed operations (synching, simulating, proving) (default: false)
  --payment <options>                                       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. 
  Format: --payment method=name,asset=address,fpc=address ...
  --gas-limits <da=100,l2=100,teardownDA=10,teardownL2=10>  Gas limits for the tx.
  --max-fees-per-gas <da=100,l2=100>                        Maximum fees per gas unit for DA and L2 computation.
  --max-priority-fees-per-gas <da=0,l2=0>                   Maximum priority fees per gas unit for DA and L2 computation.
  --estimate-gas-only                                       Only report gas estimation for the tx, do not send it.
  -h, --help                                                display help for command
2025/11/06 02:38:44 socat[73475] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet profile​

Usage: wallet profile [options] <functionName>

Profiles a private function by counting the unconditional operations in its
execution steps

Arguments:
  functionName                                              Name of function to simulate

Options:
  --args [args...]                                          Function  arguments (default: [])
  -ca, --contract-address <address>                         Aztec address of the contract.
  -c, --contract-artifact <fileLocation>                    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 <address>                     Directory to write execution step artifacts for bb profiling/debugging.
  -aw, --auth-witness <string,...>                          Authorization witness to use for the simulation
  -f, --from <string>                                       Alias or address of the account to simulate from
  --payment <options>                                       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. 
  Format: --payment method=name,asset=address,fpc=address ...
  --gas-limits <da=100,l2=100,teardownDA=10,teardownL2=10>  Gas limits for the tx.
  --max-fees-per-gas <da=100,l2=100>                        Maximum fees per gas unit for DA and L2 computation.
  --max-priority-fees-per-gas <da=0,l2=0>                   Maximum priority fees per gas unit for DA and L2 computation.
  --estimate-gas-only                                       Only report gas estimation for the tx, do not send it.
  -h, --help                                                display help for command
2025/11/06 02:38:46 socat[73649] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet bridge-fee-juice​

Usage: wallet bridge-fee-juice [options] <amount> <recipient>

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 <string>      List of Ethereum host URLs. Chain identifiers
                              localhost and testnet can be used (comma
                              separated) (default:
                              ["http://host.docker.internal:8545"])
  -m, --mnemonic <string>     The mnemonic 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 <string>   The private key to the eth account bridging
  -c, --l1-chain-id <number>  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 <number>         The polling interval in seconds for the bridged
                              funds (default: "60")
  -h, --help                  display help for command
2025/11/06 02:38:48 socat[73882] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet create-authwit​

Usage: wallet create-authwit [options] <functionName> <caller>

Creates an authorization witness that can be privately sent to a 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:
  --args [args...]                        Function  arguments (default: [])
  -ca, --contract-address <address>       Aztec address of the contract.
  -c, --contract-artifact <fileLocation>  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
  -f, --from <string>                     Alias or address of the account to simulate from
  -a, --alias <string>                    Alias for the authorization witness. Used for easy reference in subsequent commands.
  -h, --help                              display help for command
2025/11/06 02:38:49 socat[74097] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet authorize-action​

Usage: wallet authorize-action [options] <functionName> <caller>

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:
  --args [args...]                        Function  arguments (default: [])
  -ca, --contract-address <address>       Aztec address of the contract.
  -c, --contract-artifact <fileLocation>  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
  -f, --from <string>                     Alias or address of the account to simulate from
  -h, --help                              display help for command
2025/11/06 02:38:51 socat[74325] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet get-tx​

Usage: wallet get-tx [options] [txHash]

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.

Options:
  -p, --page <number>       The page number to display (default: 1)
  -s, --page-size <number>  The number of transactions to display per page
                            (default: 10)
  -h, --help                display help for command
2025/11/06 02:38:53 socat[74531] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet register-sender​

Usage: wallet 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

Options:
  -a, --alias <string>  Alias for the sender. Used for easy reference in
                        subsequent commands.
  -h, --help            display help for command
2025/11/06 02:38:55 socat[74757] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet register-contract​

Usage: wallet register-contract [options] [address] [artifact]

Registers a contract in this wallet's PXE

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 <string>            The contract initializer function to call
                             (default: "constructor")
  -k, --public-key <string>  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 <hex string>    Optional deployment salt as a hex string for
                             generating the deployment address.
  --deployer <string>        The address of the account that deployed the
                             contract
  --args [args...]           Constructor  arguments (default: [])
  -a, --alias <string>       Alias for the contact. Used for easy reference in
                             subsequent commands.
  -h, --help                 display help for command
2025/11/06 02:38:57 socat[74814] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet alias​

Usage: wallet alias [options] <type> <key> <value>

Aliases information for easy reference.

Arguments:
  type        Type of alias to create (choices: "accounts", "contracts",
              "artifacts", "secrets", "transactions", "authwits")
  key         Key to alias.
  value       Value to assign to the alias.

Options:
  -h, --help  display help for command
2025/11/06 02:38:58 socat[74996] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet get-alias​

Usage: wallet get-alias [options] [alias]

Shows stored aliases

Arguments:
  alias       Alias to retrieve

Options:
  -h, --help  display help for command
2025/11/06 02:39:00 socat[75164] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use

aztec-wallet create-secret​

Usage: wallet create-secret [options]

Creates an aliased secret to use in other commands

Options:
  -a, --alias <string>  Key to alias the secret with
  -h, --help            display help for command
2025/11/06 02:39:02 socat[75350] E bind(5, {LEN=16 AF=2 0.0.0.0:12345}, 16): Address already in use