diff --git a/docs/docs/the_aztec_network/guides/run_nodes/cli_reference.md b/docs/docs/the_aztec_network/guides/run_nodes/cli_reference.md index 06336e8452d7..3efa5a9226b7 100644 --- a/docs/docs/the_aztec_network/guides/run_nodes/cli_reference.md +++ b/docs/docs/the_aztec_network/guides/run_nodes/cli_reference.md @@ -29,11 +29,25 @@ If two subsystems can contain the same configuration option, only one needs to b ::: ```bash - NETWORK + MISC - --network ($NETWORK) + --network ($NETWORK) Network to run Aztec on + --auto-update (default: disabled) ($AUTO_UPDATE) + Configure auto updates + + --auto-update-url ($AUTO_UPDATE_URL) + Configure where to get updates from + + SANDBOX + + --sandbox + Starts Aztec Sandbox + + --sandbox.noPXE [value] ($NO_PXE) + Do not expose PXE service on sandbox start + API --port (default: 8080) ($AZTEC_PORT) @@ -67,33 +81,33 @@ If two subsystems can contain the same configuration option, only one needs to b STORAGE - --data-directory ($DATA_DIRECTORY) + --data-directory ($DATA_DIRECTORY) Where to store data for services. If not set, will store temporarily - --data-store-map-size-kb ($DATA_STORE_MAP_SIZE_KB) + --data-store-map-size-kb ($DATA_STORE_MAP_SIZE_KB) The maximum possible size of the data store DB in KB. Can be overridden by component-specific options. L1 CONTRACT ADDRESSES - --rollup-address ($ROLLUP_CONTRACT_ADDRESS) + --rollup-address ($ROLLUP_CONTRACT_ADDRESS) The deployed L1 rollup contract address - --registry-address ($REGISTRY_CONTRACT_ADDRESS) + --registry-address ($REGISTRY_CONTRACT_ADDRESS) The deployed L1 registry contract address - --inbox-address ($INBOX_CONTRACT_ADDRESS) + --inbox-address ($INBOX_CONTRACT_ADDRESS) The deployed L1 -> L2 inbox contract address - --outbox-address ($OUTBOX_CONTRACT_ADDRESS) + --outbox-address ($OUTBOX_CONTRACT_ADDRESS) The deployed L2 -> L1 outbox contract address - --fee-juice-address ($FEE_JUICE_CONTRACT_ADDRESS) + --fee-juice-address ($FEE_JUICE_CONTRACT_ADDRESS) The deployed L1 Fee Juice contract address - --staking-asset-address ($STAKING_ASSET_CONTRACT_ADDRESS) + --staking-asset-address ($STAKING_ASSET_CONTRACT_ADDRESS) The deployed L1 Staking Asset contract address - --fee-juice-portal-address ($FEE_JUICE_PORTAL_CONTRACT_ADDRESS) + --fee-juice-portal-address ($FEE_JUICE_PORTAL_CONTRACT_ADDRESS) The deployed L1 Fee Juice portal contract address AZTEC NODE @@ -101,19 +115,19 @@ If two subsystems can contain the same configuration option, only one needs to b --node Starts Aztec Node with options - --node.archiverUrl ($ARCHIVER_URL) + --node.archiverUrl ($ARCHIVER_URL) URL for an archiver service - --node.deployAztecContracts ($DEPLOY_AZTEC_CONTRACTS) + --node.deployAztecContracts ($DEPLOY_AZTEC_CONTRACTS) Deploys L1 Aztec contracts before starting the node. Needs mnemonic or private key to be set. - --node.deployAztecContractsSalt ($DEPLOY_AZTEC_CONTRACTS_SALT) + --node.deployAztecContractsSalt ($DEPLOY_AZTEC_CONTRACTS_SALT) Numeric salt for deploying L1 Aztec contracts before starting the node. Needs mnemonic or private key to be set. Implies --node.deployAztecContracts. - --node.assumeProvenThroughBlockNumber ($ASSUME_PROVEN_THROUGH_BLOCK_NUMBER) + --node.assumeProvenThroughBlockNumber ($ASSUME_PROVEN_THROUGH_BLOCK_NUMBER) Cheats the rollup contract into assuming every block until this one is proven. Useful for speeding up bootstraps. - --node.publisherPrivateKey ($L1_PRIVATE_KEY) + --node.publisherPrivateKey ($L1_PRIVATE_KEY) Private key of account for publishing L1 contracts --node.worldStateBlockCheckIntervalMS (default: 100) ($WS_BLOCK_CHECK_INTERVAL_MS) @@ -122,18 +136,18 @@ If two subsystems can contain the same configuration option, only one needs to b --node.syncMode (default: snapshot) ($SYNC_MODE) 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. - --node.snapshotsUrl ($SYNC_SNAPSHOTS_URL) + --node.snapshotsUrl ($SYNC_SNAPSHOTS_URL) Base URL for downloading snapshots for snapshot sync. P2P SUBSYSTEM - --p2p-enabled [value] ($P2P_ENABLED) + --p2p-enabled [value] ($P2P_ENABLED) Enable P2P subsystem --p2p.blockCheckIntervalMS (default: 100) ($P2P_BLOCK_CHECK_INTERVAL_MS) The frequency in which to check for new L2 blocks. - --p2p.debugDisableColocationPenalty ($DEBUG_P2P_DISABLE_COLOCATION_PENALTY) + --p2p.debugDisableColocationPenalty ($DEBUG_P2P_DISABLE_COLOCATION_PENALTY) DEBUG: Disable colocation penalty - NEVER set to true in production --p2p.peerCheckIntervalMS (default: 30000) ($P2P_PEER_CHECK_INTERVAL_MS) @@ -146,35 +160,35 @@ If two subsystems can contain the same configuration option, only one needs to b The listen address. ipv4 address. --p2p.p2pPort (default: 40400) ($P2P_PORT) - The port for the P2P service. + The port for the P2P service. Defaults to 40400 - --p2p.p2pIp ($P2P_IP) + --p2p.p2pBroadcastPort ($P2P_BROADCAST_PORT) + The port to broadcast the P2P service on (included in the node's ENR). Defaults to P2P_PORT. + + --p2p.p2pIp ($P2P_IP) The IP address for the P2P service. ipv4 address. - --p2p.peerIdPrivateKey ($PEER_ID_PRIVATE_KEY) + --p2p.peerIdPrivateKey ($PEER_ID_PRIVATE_KEY) An optional peer id private key. If blank, will generate a random key. + --p2p.peerIdPrivateKeyPath ($PEER_ID_PRIVATE_KEY_PATH) + 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. + --p2p.bootstrapNodes (default: ) ($BOOTSTRAP_NODES) A list of bootstrap peer ENRs to connect to. Separated by commas. - --p2p.bootstrapNodeEnrVersionCheck ($P2P_BOOTSTRAP_NODE_ENR_VERSION_CHECK) + --p2p.bootstrapNodeEnrVersionCheck ($P2P_BOOTSTRAP_NODE_ENR_VERSION_CHECK) Whether to check the version of the bootstrap node ENR. - --p2p.bootstrapNodesAsFullPeers ($P2P_BOOTSTRAP_NODES_AS_FULL_PEERS) + --p2p.bootstrapNodesAsFullPeers ($P2P_BOOTSTRAP_NODES_AS_FULL_PEERS) Whether to consider our configured bootnodes as full peers --p2p.maxPeerCount (default: 100) ($P2P_MAX_PEERS) The maximum number of peers to connect to. - --p2p.queryForIp ($P2P_QUERY_FOR_IP) + --p2p.queryForIp ($P2P_QUERY_FOR_IP) If announceUdpAddress or announceTcpAddress are not provided, query for the IP address of the machine. Default is false. - --p2p.keepProvenTxsInPoolFor ($P2P_TX_POOL_KEEP_PROVEN_FOR) - How many blocks have to pass after a block is proven before its txs are deleted (zero to delete immediately once proven) - - --p2p.keepAttestationsInPoolFor (default: 96) ($P2P_ATTESTATION_POOL_KEEP_FOR) - How many slots to keep attestations for. - --p2p.gossipsubInterval (default: 700) ($P2P_GOSSIPSUB_INTERVAL_MS) The interval of the gossipsub heartbeat to perform maintenance tasks. @@ -197,7 +211,10 @@ If two subsystems can contain the same configuration option, only one needs to b The number of gossipsub interval message cache windows to keep. --p2p.gossipsubMcacheGossip (default: 3) ($P2P_GOSSIPSUB_MCACHE_GOSSIP) - How many message cache windows to include when gossiping with other pears. + How many message cache windows to include when gossiping with other peers. + + --p2p.gossipsubSeenTTL (default: 1200000) ($P2P_GOSSIPSUB_SEEN_TTL) + How long to keep message IDs in the seen cache. --p2p.gossipsubTxTopicWeight (default: 1) ($P2P_GOSSIPSUB_TX_TOPIC_WEIGHT) The weight of the tx topic for the gossipsub protocol. @@ -217,16 +234,19 @@ If two subsystems can contain the same configuration option, only one needs to b --p2p.blockRequestBatchSize (default: 20) ($P2P_BLOCK_REQUEST_BATCH_SIZE) The number of blocks to fetch in a single batch. - --p2p.archivedTxLimit ($P2P_ARCHIVED_TX_LIMIT) + --p2p.archivedTxLimit ($P2P_ARCHIVED_TX_LIMIT) The number of transactions that will be archived. If the limit is set to 0 then archiving will be disabled. --p2p.trustedPeers (default: ) ($P2P_TRUSTED_PEERS) - A list of trusted peers ENRs. Separated by commas. + A list of trusted peer ENRs that will always be persisted. Separated by commas. + + --p2p.privatePeers (default: ) ($P2P_PRIVATE_PEERS) + A list of private peer ENRs that will always be persisted and not be used for discovery. Separated by commas. - --p2p.p2pStoreMapSizeKb ($P2P_STORE_MAP_SIZE_KB) + --p2p.p2pStoreMapSizeKb ($P2P_STORE_MAP_SIZE_KB) The maximum possible size of the P2P DB in KB. Overwrites the general dataStoreMapSizeKB. - --p2p.txPublicSetupAllowList ($TX_PUBLIC_SETUP_ALLOWLIST) + --p2p.txPublicSetupAllowList ($TX_PUBLIC_SETUP_ALLOWLIST) The list of functions calls allowed to run in setup --p2p.maxTxPoolSize (default: 100000000) ($P2P_MAX_TX_POOL_SIZE) @@ -238,18 +258,18 @@ If two subsystems can contain the same configuration option, only one needs to b --p2p.individualRequestTimeoutMs (default: 2000) ($P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS) The timeout for an individual request response peer interaction. - --p2p.rollupVersion ($ROLLUP_VERSION) + --p2p.rollupVersion ($ROLLUP_VERSION) The version of the rollup. TELEMETRY - --tel.metricsCollectorUrl ($OTEL_EXPORTER_OTLP_METRICS_ENDPOINT) + --tel.metricsCollectorUrl ($OTEL_EXPORTER_OTLP_METRICS_ENDPOINT) The URL of the telemetry collector for metrics - --tel.tracesCollectorUrl ($OTEL_EXPORTER_OTLP_TRACES_ENDPOINT) + --tel.tracesCollectorUrl ($OTEL_EXPORTER_OTLP_TRACES_ENDPOINT) The URL of the telemetry collector for traces - --tel.logsCollectorUrl ($OTEL_EXPORTER_OTLP_LOGS_ENDPOINT) + --tel.logsCollectorUrl ($OTEL_EXPORTER_OTLP_LOGS_ENDPOINT) The URL of the telemetry collector for logs --tel.otelCollectIntervalMs (default: 60000) ($OTEL_COLLECT_INTERVAL_MS) @@ -269,34 +289,31 @@ If two subsystems can contain the same configuration option, only one needs to b --pxe.dataStoreMapSizeKB (default: 134217728) ($DATA_STORE_MAP_SIZE_KB) DB mapping size to be applied to all key/value stores - --pxe.rollupVersion ($ROLLUP_VERSION) + --pxe.rollupVersion ($ROLLUP_VERSION) The version of the rollup. - --pxe.l2StartingBlock (default: 1) ($PXE_L2_STARTING_BLOCK) - L2 block to start scanning from for new accounts - --pxe.l2BlockBatchSize (default: 200) ($PXE_L2_BLOCK_BATCH_SIZE) Maximum amount of blocks to pull from the stream in one request when synchronizing - --pxe.bbBinaryPath ($BB_BINARY_PATH) + --pxe.bbBinaryPath ($BB_BINARY_PATH) Path to the BB binary - --pxe.bbWorkingDirectory ($BB_WORKING_DIRECTORY) + --pxe.bbWorkingDirectory ($BB_WORKING_DIRECTORY) Working directory for the BB binary - --pxe.bbSkipCleanup ($BB_SKIP_CLEANUP) + --pxe.bbSkipCleanup ($BB_SKIP_CLEANUP) True to skip cleanup of temporary files for debugging purposes --pxe.proverEnabled (default: true) ($PXE_PROVER_ENABLED) Enable real proofs - --pxe.network ($NETWORK) + --pxe.network ($NETWORK) External Aztec network to connect to. e.g. devnet - --pxe.apiKey ($API_KEY) + --pxe.apiKey ($API_KEY) API Key required by the external network's node - --pxe.nodeUrl ($AZTEC_NODE_URL) + --pxe.nodeUrl ($AZTEC_NODE_URL) Custom Aztec Node URL to connect to ARCHIVER @@ -304,10 +321,13 @@ If two subsystems can contain the same configuration option, only one needs to b --archiver Starts Aztec Archiver with options - --archiver.blobSinkUrl ($BLOB_SINK_URL) + --archiver.blobSinkUrl ($BLOB_SINK_URL) The URL of the blob sink - --archiver.archiveApiUrl ($BLOB_SINK_ARCHIVE_API_URL) + --archiver.blobSinkMapSizeKb ($BLOB_SINK_MAP_SIZE_KB) + The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKB. + + --archiver.archiveApiUrl ($BLOB_SINK_ARCHIVE_API_URL) The URL of the archive API --archiver.archiverPollingIntervalMS (default: 500) ($ARCHIVER_POLLING_INTERVAL_MS) @@ -319,10 +339,10 @@ If two subsystems can contain the same configuration option, only one needs to b --archiver.maxLogs (default: 1000) ($ARCHIVER_MAX_LOGS) The max number of logs that can be obtained in 1 "getPublicLogs" call. - --archiver.archiverStoreMapSizeKb ($ARCHIVER_STORE_MAP_SIZE_KB) + --archiver.archiverStoreMapSizeKb ($ARCHIVER_STORE_MAP_SIZE_KB) The maximum possible size of the archiver DB in KB. Overwrites the general dataStoreMapSizeKB. - --archiver.rollupVersion ($ROLLUP_VERSION) + --archiver.rollupVersion ($ROLLUP_VERSION) The version of the rollup. --archiver.viemPollingIntervalMS (default: 1000) ($ARCHIVER_VIEM_POLLING_INTERVAL_MS) @@ -379,7 +399,7 @@ If two subsystems can contain the same configuration option, only one needs to b --archiver.priorityFeeRetryBumpPercentage (default: 50) ($L1_PRIORITY_FEE_RETRY_BUMP_PERCENTAGE) How much to increase priority fee by each retry attempt (percentage) - --archiver.fixedPriorityFeePerGas ($L1_FIXED_PRIORITY_FEE_PER_GAS) + --archiver.fixedPriorityFeePerGas ($L1_FIXED_PRIORITY_FEE_PER_GAS) Fixed priority fee per gas in Gwei. Overrides any priority fee bump percentage --archiver.maxAttempts (default: 3) ($L1_TX_MONITOR_MAX_ATTEMPTS) @@ -402,10 +422,10 @@ If two subsystems can contain the same configuration option, only one needs to b --sequencer Starts Aztec Sequencer with options - --sequencer.validatorPrivateKey ($VALIDATOR_PRIVATE_KEY) + --sequencer.validatorPrivateKey ($VALIDATOR_PRIVATE_KEY) The private key of the validator participating in attestation duties - --sequencer.disableValidator ($VALIDATOR_DISABLED) + --sequencer.disableValidator ($VALIDATOR_DISABLED) Do not run the validator --sequencer.attestationPollingIntervalMs (default: 200) ($VALIDATOR_ATTESTATIONS_POLLING_INTERVAL_MS) @@ -423,22 +443,25 @@ If two subsystems can contain the same configuration option, only one needs to b --sequencer.minTxsPerBlock (default: 1) ($SEQ_MIN_TX_PER_BLOCK) The minimum number of txs to include in a block. + --sequencer.publishTxsWithProposals ($SEQ_PUBLISH_TXS_WITH_PROPOSALS) + Whether to publish txs with proposals. + --sequencer.maxL2BlockGas (default: 10000000000) ($SEQ_MAX_L2_BLOCK_GAS) The maximum L2 block gas. --sequencer.maxDABlockGas (default: 10000000000) ($SEQ_MAX_DA_BLOCK_GAS) The maximum DA block gas. - --sequencer.coinbase ($COINBASE) + --sequencer.coinbase ($COINBASE) Recipient of block reward. - --sequencer.feeRecipient ($FEE_RECIPIENT) + --sequencer.feeRecipient ($FEE_RECIPIENT) Address to receive fees. - --sequencer.acvmWorkingDirectory ($ACVM_WORKING_DIRECTORY) + --sequencer.acvmWorkingDirectory ($ACVM_WORKING_DIRECTORY) The working directory to use for simulation/proving - --sequencer.acvmBinaryPath ($ACVM_BINARY_PATH) + --sequencer.acvmBinaryPath ($ACVM_BINARY_PATH) The path to the ACVM binary --sequencer.maxBlockSizeInBytes (default: 1048576) ($SEQ_MAX_BLOCK_SIZE_IN_BYTES) @@ -450,10 +473,10 @@ If two subsystems can contain the same configuration option, only one needs to b --sequencer.governanceProposerPayload (default: 0x0000000000000000000000000000000000000000) ($GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS) The address of the payload for the governanceProposer - --sequencer.maxL1TxInclusionTimeIntoSlot ($SEQ_MAX_L1_TX_INCLUSION_TIME_INTO_SLOT) + --sequencer.maxL1TxInclusionTimeIntoSlot ($SEQ_MAX_L1_TX_INCLUSION_TIME_INTO_SLOT) How many seconds into an L1 slot we can still send a tx and get it mined. - --sequencer.txPublicSetupAllowList ($TX_PUBLIC_SETUP_ALLOWLIST) + --sequencer.txPublicSetupAllowList ($TX_PUBLIC_SETUP_ALLOWLIST) The list of functions calls allowed to run in setup --sequencer.viemPollingIntervalMS (default: 1000) ($L1_READER_VIEM_POLLING_INTERVAL_MS) @@ -483,7 +506,7 @@ If two subsystems can contain the same configuration option, only one needs to b --sequencer.priorityFeeRetryBumpPercentage (default: 50) ($L1_PRIORITY_FEE_RETRY_BUMP_PERCENTAGE) How much to increase priority fee by each retry attempt (percentage) - --sequencer.fixedPriorityFeePerGas ($L1_FIXED_PRIORITY_FEE_PER_GAS) + --sequencer.fixedPriorityFeePerGas ($L1_FIXED_PRIORITY_FEE_PER_GAS) Fixed priority fee per gas in Gwei. Overrides any priority fee bump percentage --sequencer.maxAttempts (default: 3) ($L1_TX_MONITOR_MAX_ATTEMPTS) @@ -504,6 +527,9 @@ If two subsystems can contain the same configuration option, only one needs to b --sequencer.blobSinkUrl ($BLOB_SINK_URL) The URL of the blob sink + --sequencer.blobSinkMapSizeKb ($BLOB_SINK_MAP_SIZE_KB) + The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKB. + --sequencer.archiveApiUrl ($BLOB_SINK_ARCHIVE_API_URL) The URL of the archive API @@ -530,6 +556,12 @@ If two subsystems can contain the same configuration option, only one needs to b --blobSink.port ($BLOB_SINK_PORT) The port to run the blob sink server on + --blobSink.blobSinkUrl ($BLOB_SINK_URL) + The URL of the blob sink + + --blobSink.blobSinkMapSizeKb ($BLOB_SINK_MAP_SIZE_KB) + The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKB. + --blobSink.archiveApiUrl ($BLOB_SINK_ARCHIVE_API_URL) The URL of the archive API @@ -586,6 +618,21 @@ If two subsystems can contain the same configuration option, only one needs to b --proverNode.worldStateDbMapSizeKb ($WS_DB_MAP_SIZE_KB) The maximum possible size of the world state DB in KB. Overwrites the general dataStoreMapSizeKB. + --proverNode.archiveTreeMapSizeKb ($ARCHIVE_TREE_MAP_SIZE_KB) + The maximum possible size of the world state archive tree in KB. Overwrites the general worldStateDbMapSizeKb. + + --proverNode.nullifierTreeMapSizeKb ($NULLIFIER_TREE_MAP_SIZE_KB) + The maximum possible size of the world state nullifier tree in KB. Overwrites the general worldStateDbMapSizeKb. + + --proverNode.noteHashTreeMapSizeKb ($NOTE_HASH_TREE_MAP_SIZE_KB) + The maximum possible size of the world state note hash tree in KB. Overwrites the general worldStateDbMapSizeKb. + + --proverNode.messageTreeMapSizeKb ($MESSAGE_TREE_MAP_SIZE_KB) + The maximum possible size of the world state message tree in KB. Overwrites the general worldStateDbMapSizeKb. + + --proverNode.publicDataTreeMapSizeKb ($PUBLIC_DATA_TREE_MAP_SIZE_KB) + The maximum possible size of the world state public data tree in KB. Overwrites the general worldStateDbMapSizeKb. + --proverNode.worldStateDataDirectory ($WS_DATA_DIRECTORY) Optional directory for the world state database @@ -601,8 +648,8 @@ If two subsystems can contain the same configuration option, only one needs to b --proverNode.publisherPrivateKey (default: 0x0000000000000000000000000000000000000000000000000000000000000000)($PROVER_PUBLISHER_PRIVATE_KEY) The private key to be used by the publisher. - --proverNode.proverCoordinationNodeUrl ($PROVER_COORDINATION_NODE_URL) - The URL of the tx provider node + --proverNode.proverCoordinationNodeUrls (default: ) ($PROVER_COORDINATION_NODE_URLS) + The URLs of the tx provider nodes --proverNode.proverNodeMaxPendingJobs (default: 10) ($PROVER_NODE_MAX_PENDING_JOBS) The maximum number of pending jobs for the prover node @@ -613,14 +660,17 @@ If two subsystems can contain the same configuration option, only one needs to b --proverNode.proverNodeMaxParallelBlocksPerEpoch (default: 32) ($PROVER_NODE_MAX_PARALLEL_BLOCKS_PER_EPOCH) The Maximum number of blocks to process in parallel while proving an epoch - --proverNode.txGatheringTimeoutMs (default: 60000) ($PROVER_NODE_TX_GATHERING_TIMEOUT_MS) - The maximum amount of time to wait for tx data to be available + --proverNode.proverNodeFailedEpochStore ($PROVER_NODE_FAILED_EPOCH_STORE) + File store where to upload node state when an epoch fails to be proven --proverNode.txGatheringIntervalMs (default: 1000) ($PROVER_NODE_TX_GATHERING_INTERVAL_MS) How often to check that tx data is available - --proverNode.txGatheringMaxParallelRequests (default: 100) ($PROVER_NODE_TX_GATHERING_MAX_PARALLEL_REQUESTS) - How many txs to load up a time + --proverNode.txGatheringBatchSize (default: 10) ($PROVER_NODE_TX_GATHERING_BATCH_SIZE) + How many transactions to gather from a node in a single request + + --proverNode.txGatheringMaxParallelRequestsPerNode (default: 100) ($PROVER_NODE_TX_GATHERING_MAX_PARALLEL_REQUESTS_PER_NODE) + How many tx requests to make in parallel to each node --proverNode.testAccounts ($TEST_ACCOUNTS) Whether to populate the genesis state with initial fee juice for the test accounts. @@ -634,6 +684,12 @@ If two subsystems can contain the same configuration option, only one needs to b --proverNode.snapshotsUrl ($SYNC_SNAPSHOTS_URL) Base URL for snapshots index. + --proverNode.autoUpdate (default: disabled) ($AUTO_UPDATE) + The auto update mode for this node + + --proverNode.autoUpdateUrl ($AUTO_UPDATE_URL) + Base URL to check for updates + PROVER BROKER --prover-broker @@ -703,7 +759,123 @@ If two subsystems can contain the same configuration option, only one needs to b --p2p-bootstrap Starts Aztec P2P Bootstrap with options + --p2pBootstrap.p2pBroadcastPort ($P2P_BROADCAST_PORT) + The port to broadcast the P2P service on (included in the node's ENR). Defaults to P2P_PORT. + + --p2pBootstrap.peerIdPrivateKeyPath ($PEER_ID_PRIVATE_KEY_PATH) + 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. + --p2pBootstrap.dataStoreMapSizeKB (default: 134217728) ($DATA_STORE_MAP_SIZE_KB) DB mapping size to be applied to all key/value stores + BOT + + --bot + Starts Aztec Bot with options + + --bot.nodeUrl ($AZTEC_NODE_URL) + The URL to the Aztec node to check for tx pool status. + + --bot.nodeAdminUrl ($AZTEC_NODE_ADMIN_URL) + The URL to the Aztec node admin API to force-flush txs if configured. + + --bot.pxeUrl ($BOT_PXE_URL) + URL to the PXE for sending txs, or undefined if an in-proc PXE is used. + + --bot.l1Mnemonic ($BOT_L1_MNEMONIC) + The mnemonic for the account to bridge fee juice from L1. + + --bot.l1PrivateKey ($BOT_L1_PRIVATE_KEY) + The private key for the account to bridge fee juice from L1. + + --bot.senderPrivateKey ($BOT_PRIVATE_KEY) + Signing private key for the sender account. + + --bot.senderSalt ($BOT_ACCOUNT_SALT) + The salt to use to deploys the sender account. + + --bot.recipientEncryptionSecret (default: 0x00000000000000000000000000000000000000000000000000000000cafecafe)($BOT_RECIPIENT_ENCRYPTION_SECRET) + Encryption secret for a recipient account. + + --bot.tokenSalt (default: 0x0000000000000000000000000000000000000000000000000000000000000001)($BOT_TOKEN_SALT) + Salt for the token contract deployment. + + --bot.txIntervalSeconds (default: 60) ($BOT_TX_INTERVAL_SECONDS) + Every how many seconds should a new tx be sent. + + --bot.privateTransfersPerTx (default: 1) ($BOT_PRIVATE_TRANSFERS_PER_TX) + How many private token transfers are executed per tx. + + --bot.publicTransfersPerTx (default: 1) ($BOT_PUBLIC_TRANSFERS_PER_TX) + How many public token transfers are executed per tx. + + --bot.feePaymentMethod (default: fee_juice) ($BOT_FEE_PAYMENT_METHOD) + How to handle fee payments. (Options: fee_juice) + + --bot.noStart ($BOT_NO_START) + True to not automatically setup or start the bot on initialization. + + --bot.txMinedWaitSeconds (default: 180) ($BOT_TX_MINED_WAIT_SECONDS) + How long to wait for a tx to be mined before reporting an error. + + --bot.followChain (default: NONE) ($BOT_FOLLOW_CHAIN) + Which chain the bot follows + + --bot.maxPendingTxs (default: 128) ($BOT_MAX_PENDING_TXS) + Do not send a tx if the node's tx pool already has this many pending txs. + + --bot.flushSetupTransactions ($BOT_FLUSH_SETUP_TRANSACTIONS) + Make a request for the sequencer to build a block after each setup transaction. + + --bot.l2GasLimit ($BOT_L2_GAS_LIMIT) + L2 gas limit for the tx (empty to have the bot trigger an estimate gas). + + --bot.daGasLimit ($BOT_DA_GAS_LIMIT) + DA gas limit for the tx (empty to have the bot trigger an estimate gas). + + --bot.contract (default: TokenContract) ($BOT_TOKEN_CONTRACT) + Token contract to use + + --bot.maxConsecutiveErrors ($BOT_MAX_CONSECUTIVE_ERRORS) + The maximum number of consecutive errors before the bot shuts down + + --bot.stopWhenUnhealthy ($BOT_STOP_WHEN_UNHEALTHY) + Stops the bot if service becomes unhealthy + + --bot.ammTxs ($BOT_AMM_TXS) + Deploy an AMM and send swaps to it + + TXE + + --txe + Starts Aztec TXE with options + + FAUCET + + --faucet + Starts the Aztec faucet + + --faucet.apiServer (default: true) + Starts a simple HTTP server to access the faucet + + --faucet.apiServerPort (default: 8080) + The port on which to start the api server on + + --faucet.viemPollingIntervalMS (default: 1000) ($L1_READER_VIEM_POLLING_INTERVAL_MS) + The polling interval viem uses in ms + + --faucet.l1Mnemonic ($MNEMONIC) + The mnemonic for the faucet account + + --faucet.mnemonicAccountIndex ($FAUCET_MNEMONIC_ACCOUNT_INDEX) + The account to use + + --faucet.interval (default: 3600000) ($FAUCET_INTERVAL_MS) + How often the faucet can be dripped + + --faucet.ethAmount (default: 1.0) ($FAUCET_ETH_AMOUNT) + How much eth the faucet should drip per call + + --faucet.l1Assets ($FAUCET_L1_ASSETS) + Which other L1 assets the faucet is able to drip ``` diff --git a/docs/versioned_docs/version-Latest/the_aztec_network/guides/run_nodes/cli_reference.md b/docs/versioned_docs/version-Latest/the_aztec_network/guides/run_nodes/cli_reference.md index 06336e8452d7..3efa5a9226b7 100644 --- a/docs/versioned_docs/version-Latest/the_aztec_network/guides/run_nodes/cli_reference.md +++ b/docs/versioned_docs/version-Latest/the_aztec_network/guides/run_nodes/cli_reference.md @@ -29,11 +29,25 @@ If two subsystems can contain the same configuration option, only one needs to b ::: ```bash - NETWORK + MISC - --network ($NETWORK) + --network ($NETWORK) Network to run Aztec on + --auto-update (default: disabled) ($AUTO_UPDATE) + Configure auto updates + + --auto-update-url ($AUTO_UPDATE_URL) + Configure where to get updates from + + SANDBOX + + --sandbox + Starts Aztec Sandbox + + --sandbox.noPXE [value] ($NO_PXE) + Do not expose PXE service on sandbox start + API --port (default: 8080) ($AZTEC_PORT) @@ -67,33 +81,33 @@ If two subsystems can contain the same configuration option, only one needs to b STORAGE - --data-directory ($DATA_DIRECTORY) + --data-directory ($DATA_DIRECTORY) Where to store data for services. If not set, will store temporarily - --data-store-map-size-kb ($DATA_STORE_MAP_SIZE_KB) + --data-store-map-size-kb ($DATA_STORE_MAP_SIZE_KB) The maximum possible size of the data store DB in KB. Can be overridden by component-specific options. L1 CONTRACT ADDRESSES - --rollup-address ($ROLLUP_CONTRACT_ADDRESS) + --rollup-address ($ROLLUP_CONTRACT_ADDRESS) The deployed L1 rollup contract address - --registry-address ($REGISTRY_CONTRACT_ADDRESS) + --registry-address ($REGISTRY_CONTRACT_ADDRESS) The deployed L1 registry contract address - --inbox-address ($INBOX_CONTRACT_ADDRESS) + --inbox-address ($INBOX_CONTRACT_ADDRESS) The deployed L1 -> L2 inbox contract address - --outbox-address ($OUTBOX_CONTRACT_ADDRESS) + --outbox-address ($OUTBOX_CONTRACT_ADDRESS) The deployed L2 -> L1 outbox contract address - --fee-juice-address ($FEE_JUICE_CONTRACT_ADDRESS) + --fee-juice-address ($FEE_JUICE_CONTRACT_ADDRESS) The deployed L1 Fee Juice contract address - --staking-asset-address ($STAKING_ASSET_CONTRACT_ADDRESS) + --staking-asset-address ($STAKING_ASSET_CONTRACT_ADDRESS) The deployed L1 Staking Asset contract address - --fee-juice-portal-address ($FEE_JUICE_PORTAL_CONTRACT_ADDRESS) + --fee-juice-portal-address ($FEE_JUICE_PORTAL_CONTRACT_ADDRESS) The deployed L1 Fee Juice portal contract address AZTEC NODE @@ -101,19 +115,19 @@ If two subsystems can contain the same configuration option, only one needs to b --node Starts Aztec Node with options - --node.archiverUrl ($ARCHIVER_URL) + --node.archiverUrl ($ARCHIVER_URL) URL for an archiver service - --node.deployAztecContracts ($DEPLOY_AZTEC_CONTRACTS) + --node.deployAztecContracts ($DEPLOY_AZTEC_CONTRACTS) Deploys L1 Aztec contracts before starting the node. Needs mnemonic or private key to be set. - --node.deployAztecContractsSalt ($DEPLOY_AZTEC_CONTRACTS_SALT) + --node.deployAztecContractsSalt ($DEPLOY_AZTEC_CONTRACTS_SALT) Numeric salt for deploying L1 Aztec contracts before starting the node. Needs mnemonic or private key to be set. Implies --node.deployAztecContracts. - --node.assumeProvenThroughBlockNumber ($ASSUME_PROVEN_THROUGH_BLOCK_NUMBER) + --node.assumeProvenThroughBlockNumber ($ASSUME_PROVEN_THROUGH_BLOCK_NUMBER) Cheats the rollup contract into assuming every block until this one is proven. Useful for speeding up bootstraps. - --node.publisherPrivateKey ($L1_PRIVATE_KEY) + --node.publisherPrivateKey ($L1_PRIVATE_KEY) Private key of account for publishing L1 contracts --node.worldStateBlockCheckIntervalMS (default: 100) ($WS_BLOCK_CHECK_INTERVAL_MS) @@ -122,18 +136,18 @@ If two subsystems can contain the same configuration option, only one needs to b --node.syncMode (default: snapshot) ($SYNC_MODE) 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. - --node.snapshotsUrl ($SYNC_SNAPSHOTS_URL) + --node.snapshotsUrl ($SYNC_SNAPSHOTS_URL) Base URL for downloading snapshots for snapshot sync. P2P SUBSYSTEM - --p2p-enabled [value] ($P2P_ENABLED) + --p2p-enabled [value] ($P2P_ENABLED) Enable P2P subsystem --p2p.blockCheckIntervalMS (default: 100) ($P2P_BLOCK_CHECK_INTERVAL_MS) The frequency in which to check for new L2 blocks. - --p2p.debugDisableColocationPenalty ($DEBUG_P2P_DISABLE_COLOCATION_PENALTY) + --p2p.debugDisableColocationPenalty ($DEBUG_P2P_DISABLE_COLOCATION_PENALTY) DEBUG: Disable colocation penalty - NEVER set to true in production --p2p.peerCheckIntervalMS (default: 30000) ($P2P_PEER_CHECK_INTERVAL_MS) @@ -146,35 +160,35 @@ If two subsystems can contain the same configuration option, only one needs to b The listen address. ipv4 address. --p2p.p2pPort (default: 40400) ($P2P_PORT) - The port for the P2P service. + The port for the P2P service. Defaults to 40400 - --p2p.p2pIp ($P2P_IP) + --p2p.p2pBroadcastPort ($P2P_BROADCAST_PORT) + The port to broadcast the P2P service on (included in the node's ENR). Defaults to P2P_PORT. + + --p2p.p2pIp ($P2P_IP) The IP address for the P2P service. ipv4 address. - --p2p.peerIdPrivateKey ($PEER_ID_PRIVATE_KEY) + --p2p.peerIdPrivateKey ($PEER_ID_PRIVATE_KEY) An optional peer id private key. If blank, will generate a random key. + --p2p.peerIdPrivateKeyPath ($PEER_ID_PRIVATE_KEY_PATH) + 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. + --p2p.bootstrapNodes (default: ) ($BOOTSTRAP_NODES) A list of bootstrap peer ENRs to connect to. Separated by commas. - --p2p.bootstrapNodeEnrVersionCheck ($P2P_BOOTSTRAP_NODE_ENR_VERSION_CHECK) + --p2p.bootstrapNodeEnrVersionCheck ($P2P_BOOTSTRAP_NODE_ENR_VERSION_CHECK) Whether to check the version of the bootstrap node ENR. - --p2p.bootstrapNodesAsFullPeers ($P2P_BOOTSTRAP_NODES_AS_FULL_PEERS) + --p2p.bootstrapNodesAsFullPeers ($P2P_BOOTSTRAP_NODES_AS_FULL_PEERS) Whether to consider our configured bootnodes as full peers --p2p.maxPeerCount (default: 100) ($P2P_MAX_PEERS) The maximum number of peers to connect to. - --p2p.queryForIp ($P2P_QUERY_FOR_IP) + --p2p.queryForIp ($P2P_QUERY_FOR_IP) If announceUdpAddress or announceTcpAddress are not provided, query for the IP address of the machine. Default is false. - --p2p.keepProvenTxsInPoolFor ($P2P_TX_POOL_KEEP_PROVEN_FOR) - How many blocks have to pass after a block is proven before its txs are deleted (zero to delete immediately once proven) - - --p2p.keepAttestationsInPoolFor (default: 96) ($P2P_ATTESTATION_POOL_KEEP_FOR) - How many slots to keep attestations for. - --p2p.gossipsubInterval (default: 700) ($P2P_GOSSIPSUB_INTERVAL_MS) The interval of the gossipsub heartbeat to perform maintenance tasks. @@ -197,7 +211,10 @@ If two subsystems can contain the same configuration option, only one needs to b The number of gossipsub interval message cache windows to keep. --p2p.gossipsubMcacheGossip (default: 3) ($P2P_GOSSIPSUB_MCACHE_GOSSIP) - How many message cache windows to include when gossiping with other pears. + How many message cache windows to include when gossiping with other peers. + + --p2p.gossipsubSeenTTL (default: 1200000) ($P2P_GOSSIPSUB_SEEN_TTL) + How long to keep message IDs in the seen cache. --p2p.gossipsubTxTopicWeight (default: 1) ($P2P_GOSSIPSUB_TX_TOPIC_WEIGHT) The weight of the tx topic for the gossipsub protocol. @@ -217,16 +234,19 @@ If two subsystems can contain the same configuration option, only one needs to b --p2p.blockRequestBatchSize (default: 20) ($P2P_BLOCK_REQUEST_BATCH_SIZE) The number of blocks to fetch in a single batch. - --p2p.archivedTxLimit ($P2P_ARCHIVED_TX_LIMIT) + --p2p.archivedTxLimit ($P2P_ARCHIVED_TX_LIMIT) The number of transactions that will be archived. If the limit is set to 0 then archiving will be disabled. --p2p.trustedPeers (default: ) ($P2P_TRUSTED_PEERS) - A list of trusted peers ENRs. Separated by commas. + A list of trusted peer ENRs that will always be persisted. Separated by commas. + + --p2p.privatePeers (default: ) ($P2P_PRIVATE_PEERS) + A list of private peer ENRs that will always be persisted and not be used for discovery. Separated by commas. - --p2p.p2pStoreMapSizeKb ($P2P_STORE_MAP_SIZE_KB) + --p2p.p2pStoreMapSizeKb ($P2P_STORE_MAP_SIZE_KB) The maximum possible size of the P2P DB in KB. Overwrites the general dataStoreMapSizeKB. - --p2p.txPublicSetupAllowList ($TX_PUBLIC_SETUP_ALLOWLIST) + --p2p.txPublicSetupAllowList ($TX_PUBLIC_SETUP_ALLOWLIST) The list of functions calls allowed to run in setup --p2p.maxTxPoolSize (default: 100000000) ($P2P_MAX_TX_POOL_SIZE) @@ -238,18 +258,18 @@ If two subsystems can contain the same configuration option, only one needs to b --p2p.individualRequestTimeoutMs (default: 2000) ($P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS) The timeout for an individual request response peer interaction. - --p2p.rollupVersion ($ROLLUP_VERSION) + --p2p.rollupVersion ($ROLLUP_VERSION) The version of the rollup. TELEMETRY - --tel.metricsCollectorUrl ($OTEL_EXPORTER_OTLP_METRICS_ENDPOINT) + --tel.metricsCollectorUrl ($OTEL_EXPORTER_OTLP_METRICS_ENDPOINT) The URL of the telemetry collector for metrics - --tel.tracesCollectorUrl ($OTEL_EXPORTER_OTLP_TRACES_ENDPOINT) + --tel.tracesCollectorUrl ($OTEL_EXPORTER_OTLP_TRACES_ENDPOINT) The URL of the telemetry collector for traces - --tel.logsCollectorUrl ($OTEL_EXPORTER_OTLP_LOGS_ENDPOINT) + --tel.logsCollectorUrl ($OTEL_EXPORTER_OTLP_LOGS_ENDPOINT) The URL of the telemetry collector for logs --tel.otelCollectIntervalMs (default: 60000) ($OTEL_COLLECT_INTERVAL_MS) @@ -269,34 +289,31 @@ If two subsystems can contain the same configuration option, only one needs to b --pxe.dataStoreMapSizeKB (default: 134217728) ($DATA_STORE_MAP_SIZE_KB) DB mapping size to be applied to all key/value stores - --pxe.rollupVersion ($ROLLUP_VERSION) + --pxe.rollupVersion ($ROLLUP_VERSION) The version of the rollup. - --pxe.l2StartingBlock (default: 1) ($PXE_L2_STARTING_BLOCK) - L2 block to start scanning from for new accounts - --pxe.l2BlockBatchSize (default: 200) ($PXE_L2_BLOCK_BATCH_SIZE) Maximum amount of blocks to pull from the stream in one request when synchronizing - --pxe.bbBinaryPath ($BB_BINARY_PATH) + --pxe.bbBinaryPath ($BB_BINARY_PATH) Path to the BB binary - --pxe.bbWorkingDirectory ($BB_WORKING_DIRECTORY) + --pxe.bbWorkingDirectory ($BB_WORKING_DIRECTORY) Working directory for the BB binary - --pxe.bbSkipCleanup ($BB_SKIP_CLEANUP) + --pxe.bbSkipCleanup ($BB_SKIP_CLEANUP) True to skip cleanup of temporary files for debugging purposes --pxe.proverEnabled (default: true) ($PXE_PROVER_ENABLED) Enable real proofs - --pxe.network ($NETWORK) + --pxe.network ($NETWORK) External Aztec network to connect to. e.g. devnet - --pxe.apiKey ($API_KEY) + --pxe.apiKey ($API_KEY) API Key required by the external network's node - --pxe.nodeUrl ($AZTEC_NODE_URL) + --pxe.nodeUrl ($AZTEC_NODE_URL) Custom Aztec Node URL to connect to ARCHIVER @@ -304,10 +321,13 @@ If two subsystems can contain the same configuration option, only one needs to b --archiver Starts Aztec Archiver with options - --archiver.blobSinkUrl ($BLOB_SINK_URL) + --archiver.blobSinkUrl ($BLOB_SINK_URL) The URL of the blob sink - --archiver.archiveApiUrl ($BLOB_SINK_ARCHIVE_API_URL) + --archiver.blobSinkMapSizeKb ($BLOB_SINK_MAP_SIZE_KB) + The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKB. + + --archiver.archiveApiUrl ($BLOB_SINK_ARCHIVE_API_URL) The URL of the archive API --archiver.archiverPollingIntervalMS (default: 500) ($ARCHIVER_POLLING_INTERVAL_MS) @@ -319,10 +339,10 @@ If two subsystems can contain the same configuration option, only one needs to b --archiver.maxLogs (default: 1000) ($ARCHIVER_MAX_LOGS) The max number of logs that can be obtained in 1 "getPublicLogs" call. - --archiver.archiverStoreMapSizeKb ($ARCHIVER_STORE_MAP_SIZE_KB) + --archiver.archiverStoreMapSizeKb ($ARCHIVER_STORE_MAP_SIZE_KB) The maximum possible size of the archiver DB in KB. Overwrites the general dataStoreMapSizeKB. - --archiver.rollupVersion ($ROLLUP_VERSION) + --archiver.rollupVersion ($ROLLUP_VERSION) The version of the rollup. --archiver.viemPollingIntervalMS (default: 1000) ($ARCHIVER_VIEM_POLLING_INTERVAL_MS) @@ -379,7 +399,7 @@ If two subsystems can contain the same configuration option, only one needs to b --archiver.priorityFeeRetryBumpPercentage (default: 50) ($L1_PRIORITY_FEE_RETRY_BUMP_PERCENTAGE) How much to increase priority fee by each retry attempt (percentage) - --archiver.fixedPriorityFeePerGas ($L1_FIXED_PRIORITY_FEE_PER_GAS) + --archiver.fixedPriorityFeePerGas ($L1_FIXED_PRIORITY_FEE_PER_GAS) Fixed priority fee per gas in Gwei. Overrides any priority fee bump percentage --archiver.maxAttempts (default: 3) ($L1_TX_MONITOR_MAX_ATTEMPTS) @@ -402,10 +422,10 @@ If two subsystems can contain the same configuration option, only one needs to b --sequencer Starts Aztec Sequencer with options - --sequencer.validatorPrivateKey ($VALIDATOR_PRIVATE_KEY) + --sequencer.validatorPrivateKey ($VALIDATOR_PRIVATE_KEY) The private key of the validator participating in attestation duties - --sequencer.disableValidator ($VALIDATOR_DISABLED) + --sequencer.disableValidator ($VALIDATOR_DISABLED) Do not run the validator --sequencer.attestationPollingIntervalMs (default: 200) ($VALIDATOR_ATTESTATIONS_POLLING_INTERVAL_MS) @@ -423,22 +443,25 @@ If two subsystems can contain the same configuration option, only one needs to b --sequencer.minTxsPerBlock (default: 1) ($SEQ_MIN_TX_PER_BLOCK) The minimum number of txs to include in a block. + --sequencer.publishTxsWithProposals ($SEQ_PUBLISH_TXS_WITH_PROPOSALS) + Whether to publish txs with proposals. + --sequencer.maxL2BlockGas (default: 10000000000) ($SEQ_MAX_L2_BLOCK_GAS) The maximum L2 block gas. --sequencer.maxDABlockGas (default: 10000000000) ($SEQ_MAX_DA_BLOCK_GAS) The maximum DA block gas. - --sequencer.coinbase ($COINBASE) + --sequencer.coinbase ($COINBASE) Recipient of block reward. - --sequencer.feeRecipient ($FEE_RECIPIENT) + --sequencer.feeRecipient ($FEE_RECIPIENT) Address to receive fees. - --sequencer.acvmWorkingDirectory ($ACVM_WORKING_DIRECTORY) + --sequencer.acvmWorkingDirectory ($ACVM_WORKING_DIRECTORY) The working directory to use for simulation/proving - --sequencer.acvmBinaryPath ($ACVM_BINARY_PATH) + --sequencer.acvmBinaryPath ($ACVM_BINARY_PATH) The path to the ACVM binary --sequencer.maxBlockSizeInBytes (default: 1048576) ($SEQ_MAX_BLOCK_SIZE_IN_BYTES) @@ -450,10 +473,10 @@ If two subsystems can contain the same configuration option, only one needs to b --sequencer.governanceProposerPayload (default: 0x0000000000000000000000000000000000000000) ($GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS) The address of the payload for the governanceProposer - --sequencer.maxL1TxInclusionTimeIntoSlot ($SEQ_MAX_L1_TX_INCLUSION_TIME_INTO_SLOT) + --sequencer.maxL1TxInclusionTimeIntoSlot ($SEQ_MAX_L1_TX_INCLUSION_TIME_INTO_SLOT) How many seconds into an L1 slot we can still send a tx and get it mined. - --sequencer.txPublicSetupAllowList ($TX_PUBLIC_SETUP_ALLOWLIST) + --sequencer.txPublicSetupAllowList ($TX_PUBLIC_SETUP_ALLOWLIST) The list of functions calls allowed to run in setup --sequencer.viemPollingIntervalMS (default: 1000) ($L1_READER_VIEM_POLLING_INTERVAL_MS) @@ -483,7 +506,7 @@ If two subsystems can contain the same configuration option, only one needs to b --sequencer.priorityFeeRetryBumpPercentage (default: 50) ($L1_PRIORITY_FEE_RETRY_BUMP_PERCENTAGE) How much to increase priority fee by each retry attempt (percentage) - --sequencer.fixedPriorityFeePerGas ($L1_FIXED_PRIORITY_FEE_PER_GAS) + --sequencer.fixedPriorityFeePerGas ($L1_FIXED_PRIORITY_FEE_PER_GAS) Fixed priority fee per gas in Gwei. Overrides any priority fee bump percentage --sequencer.maxAttempts (default: 3) ($L1_TX_MONITOR_MAX_ATTEMPTS) @@ -504,6 +527,9 @@ If two subsystems can contain the same configuration option, only one needs to b --sequencer.blobSinkUrl ($BLOB_SINK_URL) The URL of the blob sink + --sequencer.blobSinkMapSizeKb ($BLOB_SINK_MAP_SIZE_KB) + The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKB. + --sequencer.archiveApiUrl ($BLOB_SINK_ARCHIVE_API_URL) The URL of the archive API @@ -530,6 +556,12 @@ If two subsystems can contain the same configuration option, only one needs to b --blobSink.port ($BLOB_SINK_PORT) The port to run the blob sink server on + --blobSink.blobSinkUrl ($BLOB_SINK_URL) + The URL of the blob sink + + --blobSink.blobSinkMapSizeKb ($BLOB_SINK_MAP_SIZE_KB) + The maximum possible size of the blob sink DB in KB. Overwrites the general dataStoreMapSizeKB. + --blobSink.archiveApiUrl ($BLOB_SINK_ARCHIVE_API_URL) The URL of the archive API @@ -586,6 +618,21 @@ If two subsystems can contain the same configuration option, only one needs to b --proverNode.worldStateDbMapSizeKb ($WS_DB_MAP_SIZE_KB) The maximum possible size of the world state DB in KB. Overwrites the general dataStoreMapSizeKB. + --proverNode.archiveTreeMapSizeKb ($ARCHIVE_TREE_MAP_SIZE_KB) + The maximum possible size of the world state archive tree in KB. Overwrites the general worldStateDbMapSizeKb. + + --proverNode.nullifierTreeMapSizeKb ($NULLIFIER_TREE_MAP_SIZE_KB) + The maximum possible size of the world state nullifier tree in KB. Overwrites the general worldStateDbMapSizeKb. + + --proverNode.noteHashTreeMapSizeKb ($NOTE_HASH_TREE_MAP_SIZE_KB) + The maximum possible size of the world state note hash tree in KB. Overwrites the general worldStateDbMapSizeKb. + + --proverNode.messageTreeMapSizeKb ($MESSAGE_TREE_MAP_SIZE_KB) + The maximum possible size of the world state message tree in KB. Overwrites the general worldStateDbMapSizeKb. + + --proverNode.publicDataTreeMapSizeKb ($PUBLIC_DATA_TREE_MAP_SIZE_KB) + The maximum possible size of the world state public data tree in KB. Overwrites the general worldStateDbMapSizeKb. + --proverNode.worldStateDataDirectory ($WS_DATA_DIRECTORY) Optional directory for the world state database @@ -601,8 +648,8 @@ If two subsystems can contain the same configuration option, only one needs to b --proverNode.publisherPrivateKey (default: 0x0000000000000000000000000000000000000000000000000000000000000000)($PROVER_PUBLISHER_PRIVATE_KEY) The private key to be used by the publisher. - --proverNode.proverCoordinationNodeUrl ($PROVER_COORDINATION_NODE_URL) - The URL of the tx provider node + --proverNode.proverCoordinationNodeUrls (default: ) ($PROVER_COORDINATION_NODE_URLS) + The URLs of the tx provider nodes --proverNode.proverNodeMaxPendingJobs (default: 10) ($PROVER_NODE_MAX_PENDING_JOBS) The maximum number of pending jobs for the prover node @@ -613,14 +660,17 @@ If two subsystems can contain the same configuration option, only one needs to b --proverNode.proverNodeMaxParallelBlocksPerEpoch (default: 32) ($PROVER_NODE_MAX_PARALLEL_BLOCKS_PER_EPOCH) The Maximum number of blocks to process in parallel while proving an epoch - --proverNode.txGatheringTimeoutMs (default: 60000) ($PROVER_NODE_TX_GATHERING_TIMEOUT_MS) - The maximum amount of time to wait for tx data to be available + --proverNode.proverNodeFailedEpochStore ($PROVER_NODE_FAILED_EPOCH_STORE) + File store where to upload node state when an epoch fails to be proven --proverNode.txGatheringIntervalMs (default: 1000) ($PROVER_NODE_TX_GATHERING_INTERVAL_MS) How often to check that tx data is available - --proverNode.txGatheringMaxParallelRequests (default: 100) ($PROVER_NODE_TX_GATHERING_MAX_PARALLEL_REQUESTS) - How many txs to load up a time + --proverNode.txGatheringBatchSize (default: 10) ($PROVER_NODE_TX_GATHERING_BATCH_SIZE) + How many transactions to gather from a node in a single request + + --proverNode.txGatheringMaxParallelRequestsPerNode (default: 100) ($PROVER_NODE_TX_GATHERING_MAX_PARALLEL_REQUESTS_PER_NODE) + How many tx requests to make in parallel to each node --proverNode.testAccounts ($TEST_ACCOUNTS) Whether to populate the genesis state with initial fee juice for the test accounts. @@ -634,6 +684,12 @@ If two subsystems can contain the same configuration option, only one needs to b --proverNode.snapshotsUrl ($SYNC_SNAPSHOTS_URL) Base URL for snapshots index. + --proverNode.autoUpdate (default: disabled) ($AUTO_UPDATE) + The auto update mode for this node + + --proverNode.autoUpdateUrl ($AUTO_UPDATE_URL) + Base URL to check for updates + PROVER BROKER --prover-broker @@ -703,7 +759,123 @@ If two subsystems can contain the same configuration option, only one needs to b --p2p-bootstrap Starts Aztec P2P Bootstrap with options + --p2pBootstrap.p2pBroadcastPort ($P2P_BROADCAST_PORT) + The port to broadcast the P2P service on (included in the node's ENR). Defaults to P2P_PORT. + + --p2pBootstrap.peerIdPrivateKeyPath ($PEER_ID_PRIVATE_KEY_PATH) + 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. + --p2pBootstrap.dataStoreMapSizeKB (default: 134217728) ($DATA_STORE_MAP_SIZE_KB) DB mapping size to be applied to all key/value stores + BOT + + --bot + Starts Aztec Bot with options + + --bot.nodeUrl ($AZTEC_NODE_URL) + The URL to the Aztec node to check for tx pool status. + + --bot.nodeAdminUrl ($AZTEC_NODE_ADMIN_URL) + The URL to the Aztec node admin API to force-flush txs if configured. + + --bot.pxeUrl ($BOT_PXE_URL) + URL to the PXE for sending txs, or undefined if an in-proc PXE is used. + + --bot.l1Mnemonic ($BOT_L1_MNEMONIC) + The mnemonic for the account to bridge fee juice from L1. + + --bot.l1PrivateKey ($BOT_L1_PRIVATE_KEY) + The private key for the account to bridge fee juice from L1. + + --bot.senderPrivateKey ($BOT_PRIVATE_KEY) + Signing private key for the sender account. + + --bot.senderSalt ($BOT_ACCOUNT_SALT) + The salt to use to deploys the sender account. + + --bot.recipientEncryptionSecret (default: 0x00000000000000000000000000000000000000000000000000000000cafecafe)($BOT_RECIPIENT_ENCRYPTION_SECRET) + Encryption secret for a recipient account. + + --bot.tokenSalt (default: 0x0000000000000000000000000000000000000000000000000000000000000001)($BOT_TOKEN_SALT) + Salt for the token contract deployment. + + --bot.txIntervalSeconds (default: 60) ($BOT_TX_INTERVAL_SECONDS) + Every how many seconds should a new tx be sent. + + --bot.privateTransfersPerTx (default: 1) ($BOT_PRIVATE_TRANSFERS_PER_TX) + How many private token transfers are executed per tx. + + --bot.publicTransfersPerTx (default: 1) ($BOT_PUBLIC_TRANSFERS_PER_TX) + How many public token transfers are executed per tx. + + --bot.feePaymentMethod (default: fee_juice) ($BOT_FEE_PAYMENT_METHOD) + How to handle fee payments. (Options: fee_juice) + + --bot.noStart ($BOT_NO_START) + True to not automatically setup or start the bot on initialization. + + --bot.txMinedWaitSeconds (default: 180) ($BOT_TX_MINED_WAIT_SECONDS) + How long to wait for a tx to be mined before reporting an error. + + --bot.followChain (default: NONE) ($BOT_FOLLOW_CHAIN) + Which chain the bot follows + + --bot.maxPendingTxs (default: 128) ($BOT_MAX_PENDING_TXS) + Do not send a tx if the node's tx pool already has this many pending txs. + + --bot.flushSetupTransactions ($BOT_FLUSH_SETUP_TRANSACTIONS) + Make a request for the sequencer to build a block after each setup transaction. + + --bot.l2GasLimit ($BOT_L2_GAS_LIMIT) + L2 gas limit for the tx (empty to have the bot trigger an estimate gas). + + --bot.daGasLimit ($BOT_DA_GAS_LIMIT) + DA gas limit for the tx (empty to have the bot trigger an estimate gas). + + --bot.contract (default: TokenContract) ($BOT_TOKEN_CONTRACT) + Token contract to use + + --bot.maxConsecutiveErrors ($BOT_MAX_CONSECUTIVE_ERRORS) + The maximum number of consecutive errors before the bot shuts down + + --bot.stopWhenUnhealthy ($BOT_STOP_WHEN_UNHEALTHY) + Stops the bot if service becomes unhealthy + + --bot.ammTxs ($BOT_AMM_TXS) + Deploy an AMM and send swaps to it + + TXE + + --txe + Starts Aztec TXE with options + + FAUCET + + --faucet + Starts the Aztec faucet + + --faucet.apiServer (default: true) + Starts a simple HTTP server to access the faucet + + --faucet.apiServerPort (default: 8080) + The port on which to start the api server on + + --faucet.viemPollingIntervalMS (default: 1000) ($L1_READER_VIEM_POLLING_INTERVAL_MS) + The polling interval viem uses in ms + + --faucet.l1Mnemonic ($MNEMONIC) + The mnemonic for the faucet account + + --faucet.mnemonicAccountIndex ($FAUCET_MNEMONIC_ACCOUNT_INDEX) + The account to use + + --faucet.interval (default: 3600000) ($FAUCET_INTERVAL_MS) + How often the faucet can be dripped + + --faucet.ethAmount (default: 1.0) ($FAUCET_ETH_AMOUNT) + How much eth the faucet should drip per call + + --faucet.l1Assets ($FAUCET_L1_ASSETS) + Which other L1 assets the faucet is able to drip ```