General Options
options for configuring the node instance and chain.config
The path to the configuration file to use.- Syntax
--config <FILE>chain
The chain this node is running. Possible values are either a built-in chain or the path to a chain specification file. Built-in chains:optimism, optimism_sepolia, base, base_sepolia, dev, etc.
- Syntax
- Default
--chain <CHAIN_OR_PATH>instance
Add a new instance of a node. Configures the ports of the node to avoid conflicts with the defaults.- Syntax
--instance <INSTANCE>with-unused-ports
Sets all ports to unused, allowing the OS to choose random unused ports when sockets are bound. Mutually exclusive with--instance.
- Syntax
--with-unused-portsMetrics
Options for Prometheus metrics.metrics
Enable Prometheus metrics. The metrics will be served at the given interface and port.- Syntax
--metrics <PROMETHEUS>metrics.prometheus.push.url
URL for pushing Prometheus metrics to a push gateway.- Syntax
--metrics.prometheus.push.url <PUSH_GATEWAY_URL>metrics.prometheus.push.interval
Interval in seconds for pushing metrics to push gateway.- Syntax
- Default
--metrics.prometheus.push.interval <SECONDS>Datadir
Options for data storage.datadir
The path to the data dir for all reth files and subdirectories. Defaults to the OS-specific data directory:- Linux:
$XDG_DATA_HOME/reth/or$HOME/.local/share/reth/ - Windows:
{FOLDERID_RoamingAppData}/reth/ - macOS:
$HOME/Library/Application Support/reth/
- Syntax
- Default
--datadir <DATA_DIR>datadir.static-files
The absolute path to store static files in.- Syntax
--datadir.static-files <PATH>datadir.rocksdb
The absolute path to storeRocksDB database in.
- Syntax
--datadir.rocksdb <PATH>datadir.pprof-dumps
The absolute path to store pprof dumps in.- Syntax
--datadir.pprof-dumps <PATH>Networking
Options for P2P networking and discovery.disable-discovery
Disable the discovery service.- Syntax
--disable-discoverydisable-dns-discovery
Disable the DNS discovery.- Syntax
--disable-dns-discoverydisable-discv4-discovery
Disable Discv4 discovery.- Syntax
--disable-discv4-discoveryenable-discv5-discovery
Enable Discv5 discovery.- Syntax
--enable-discv5-discoverydisable-nat
Disable NAT discovery.- Syntax
--disable-natdiscovery.addr
The UDP address to use for devp2p peer discovery version 4.- Syntax
- Default
--discovery.addr <DISCOVERY_ADDR>discovery.port
The UDP port to use for devp2p peer discovery version 4.- Syntax
- Default
--discovery.port <DISCOVERY_PORT>discovery.v5.addr
The UDP IPv4 address to use for devp2p peer discovery version 5.- Syntax
--discovery.v5.addr <DISCOVERY_V5_ADDR>discovery.v5.addr.ipv6
The UDP IPv6 address to use for devp2p peer discovery version 5.- Syntax
--discovery.v5.addr.ipv6 <DISCOVERY_V5_ADDR_IPV6>discovery.v5.port
The UDP IPv4 port to use for devp2p peer discovery version 5.- Syntax
- Default
--discovery.v5.port <DISCOVERY_V5_PORT>discovery.v5.port.ipv6
The UDP IPv6 port to use for devp2p peer discovery version 5.- Syntax
- Default
--discovery.v5.port.ipv6 <DISCOVERY_V5_PORT_IPV6>discovery.v5.lookup-interval
The interval in seconds at which to carry out periodic lookup queries, for the whole run of the program- Syntax
- Default
--discovery.v5.lookup-interval <DISCOVERY_V5_LOOKUP_INTERVAL>discovery.v5.bootstrap.lookup-interval
The interval in seconds at which to carry out boost lookup queries, for a fixed number of times, at bootstrap- Syntax
- Default
--discovery.v5.bootstrap.lookup-interval <DISCOVERY_V5_BOOTSTRAP_LOOKUP_INTERVAL>discovery.v5.bootstrap.lookup-countdown
The number of times to carry out boost lookup queries at bootstrap- Syntax
- Default
--discovery.v5.bootstrap.lookup-countdown <DISCOVERY_V5_BOOTSTRAP_LOOKUP_COUNTDOWN>trusted-peers
Comma separated enode URLs of trusted peers for P2P connections.- Syntax
--trusted-peers <TRUSTED_PEERS>trusted-only
Connect to or accept from trusted peers only.- Syntax
--trusted-onlybootnodes
Comma separated enode URLs for P2P discovery bootstrap.- Syntax
--bootnodes <BOOTNODES>dns-retries
Amount of DNS resolution requests retries to perform when peering- Syntax
- Default
--dns-retries <DNS_RETRIES>peers-file
The path to the known peers file. Connected peers are dumped to this file on nodes shutdown, and read on startup. Cannot be used with--no-persist-peers.
- Syntax
--peers-file <FILE>identity
Custom node identity.- Syntax
- Default
--identity <IDENTITY>p2p-secret-key
Secret key to use for this node.- Syntax
--p2p-secret-key <PATH>p2p-secret-key-hex
Hex encoded secret key to use for this node. This will also deterministically set the peer ID. Cannot be used together with--p2p-secret-key.
- Syntax
--p2p-secret-key-hex <HEX>no-persist-peers
Do not persist peers.- Syntax
--no-persist-peersnat
NAT resolution method (any|none|upnp|publicip|extip:<IP>)- Syntax
- Default
--nat <NAT>addr
Network listening address.- Syntax
- Default
--addr <ADDR>port
Network listening port.- Syntax
- Default
--port <PORT>max-outbound-peers
Maximum number of outbound peers.- Syntax
- Default
--max-outbound-peers <MAX_OUTBOUND_PEERS>max-inbound-peers
Maximum number of inbound peers. default: 30- Syntax
- Default
--max-inbound-peers <MAX_INBOUND_PEERS>max-peers
Maximum number of total peers (inbound + outbound).- Syntax
--max-peers <COUNT>max-tx-reqs
Max concurrentGetPooledTransactions requests.
- Syntax
- Default
--max-tx-reqs <COUNT>max-tx-reqs-peer
Max concurrentGetPooledTransactions requests per peer.
- Syntax
- Default
--max-tx-reqs-peer <COUNT>max-seen-tx-history
Max number of seen transactions to remember per peer.- Syntax
- Default
--max-seen-tx-history <COUNT>max-pending-imports
Max number of transactions to import concurrently.- Syntax
- Default
--max-pending-imports <COUNT>pooled-tx-response-soft-limit
Experimental, for usage in research. Sets the max accumulated byte size of transactions to pack in one response.- Syntax
- Default
--pooled-tx-response-soft-limit <BYTES>pooled-tx-pack-soft-limit
Experimental, for usage in research. Sets the max accumulated byte size of transactions to request in one request.- Syntax
- Default
--pooled-tx-pack-soft-limit <BYTES>max-tx-pending-fetch
Max capacity of cache of hashes for transactions pending fetch.- Syntax
- Default
--max-tx-pending-fetch <COUNT>net-if.experimental
Name of network interface used to communicate with peers.- Syntax
- Default
--net-if.experimental <IF_NAME>tx-propagation-policy
Transaction Propagation Policy The policy determines which peers transactions are gossiped to.- Syntax
- Default
--tx-propagation-policy <TX_PROPAGATION_POLICY>tx-ingress-policy
Transaction ingress policy Determines which peers’ transactions are accepted over P2P.- Syntax
- Default
--tx-ingress-policy <TX_INGRESS_POLICY>disable-tx-gossip
Disable transaction pool gossip.- Syntax
--disable-tx-gossiptx-propagation-mode
Sets the transaction propagation mode by determining how new pending transactions are propagated to other peers in full.- Syntax
- Default
--tx-propagation-mode <PROPAGATION_MODE>required-block-hashes
Comma separated list of required block hashes or block number=hash pairs. Peers that don’t have these blocks will be filtered out.- Syntax
--required-block-hashes <REQUIRED_BLOCK_HASHES>network-id
Optional network ID to override the chain specification’s network ID for P2P connections.- Syntax
--network-id <NETWORK_ID>netrestrict
Restrict network communication to the given IP networks (CIDR masks). Comma separated list of CIDR network specifications. Only peers with IP addresses within these ranges will be allowed to connect.- Syntax
--netrestrict <NETRESTRICT>RPC
Options for HTTP, WebSocket, and IPC RPC servers.http
Enable the HTTP-RPC server.- Syntax
--httphttp.addr
Http server address to listen on.- Syntax
- Default
--http.addr <HTTP_ADDR>http.port
Http server port to listen on.- Syntax
- Default
--http.port <HTTP_PORT>http.disable-compression
Disable compression for HTTP responses- Syntax
--http.disable-compressionhttp.api
Rpc Modules to be configured for the HTTP server.- Syntax
- Possible Values
--http.api <HTTP_API>http.corsdomain
Http Corsdomain to allow request from.- Syntax
--http.corsdomain <HTTP_CORSDOMAIN>ws
Enable the WS-RPC server.- Syntax
--wsws.addr
Ws server address to listen on.- Syntax
- Default
--ws.addr <WS_ADDR>ws.port
Ws server port to listen on.- Syntax
- Default
--ws.port <WS_PORT>ws.origins
Origins from which to acceptWebSocket requests
- Syntax
--ws.origins <ws.origins>ws.api
Rpc Modules to be configured for the WS server.- Syntax
--ws.api <WS_API>ipcdisable
Disable the IPC-RPC server- Syntax
--ipcdisableipcpath
Filename for IPC socket/pipe within the datadir- Syntax
- Default
--ipcpath <IPCPATH>ipc.permissions
Set the permissions for the IPC socket file, in octal format. If not specified, the permissions will be set by the system’s umask.- Syntax
--ipc.permissions <IPC_SOCKET_PERMISSIONS>authrpc.addr
Auth server address to listen on.- Syntax
- Default
--authrpc.addr <AUTH_ADDR>authrpc.port
Auth server port to listen on.- Syntax
- Default
--authrpc.port <AUTH_PORT>authrpc.jwtsecret
Path to a JWT secret to use for the authenticated engine-API RPC server.- Syntax
--authrpc.jwtsecret <PATH>auth-ipc
Enable auth engine API over IPC.- Syntax
—auth-ipc
auth-ipc.path
Filename for auth IPC socket/pipe within the datadir.- Syntax
- Default
--auth-ipc.path <AUTH_IPC_PATH>disable-auth-server
Disable the auth/engine API server. This will prevent the authenticated engine-API server from starting. Use this if you’re running a node that doesn’t need to serve engine API requests.- Syntax
--disable-auth-serverrpc.jwtsecret
Hex encoded JWT secret to authenticate the regular RPC server(s), see —http.api and —ws.api. This is not used for the authenticated engine-API RPC server (see —authrpc.jwtsecret).- Syntax
--rpc.jwtsecret <HEX>rpc.max-request-size
Set the maximum RPC request payload size for both HTTP and WS in megabytes.- Syntax
- Default
--rpc.max-request-size <RPC_MAX_REQUEST_SIZE>rpc.max-response-size
Set the maximum RPC response payload size for both HTTP and WS in megabytes. Alias:--rpc.returndata.limit
- Syntax
- Default
--rpc.max-response-size <RPC_MAX_RESPONSE_SIZE>rpc.max-subscriptions-per-connection
Set the maximum concurrent subscriptions per connection.- Syntax
- Default
--rpc.max-subscriptions-per-connection <RPC_MAX_SUBSCRIPTIONS_PER_CONNECTION>rpc.max-connections
Maximum number of RPC server connections.- Syntax
- Default
--rpc.max-connections <COUNT>rpc.max-tracing-requests
Maximum number of concurrent tracing requests. By default this chooses a sensible value based on the number of available cores. Tracing requests are generally CPU bound. Choosing a value that is higher than the available CPU cores can have a negative impact on the performance of the node and affect the node’s ability to maintain sync.- Syntax
- Default
--rpc.max-tracing-requests <COUNT>rpc.max-blocking-io-requests
Maximum number of concurrent blocking IO requests. Blocking IO requests include eth_call, eth_estimateGas, and similar methods that require EVM execution. These are spawned as blocking tasks to avoid blocking the async runtime.- Syntax
- Default
--rpc.max-blocking-io-requests <COUNT>rpc.max-trace-filter-blocks
Maximum number of blocks for trace_filter requests.- Syntax
- Default
--rpc.max-trace-filter-blocks <COUNT>rpc.max-blocks-per-filter
Maximum number of blocks that could be scanned per filter request. (0 = entire chain)- Syntax
- Default
--rpc.max-blocks-per-filter <COUNT>rpc.max-logs-per-response
Maximum number of logs that can be returned in a single response. (0 = no limit)- Syntax
- Default
--rpc.max-logs-per-response <COUNT>rpc.gascap
Maximum gas limit for eth_call and call tracing RPC methods.- Syntax
- Default
--rpc.gascap <GAS_CAP>rpc.evm-memory-limit
Maximum memory the EVM can allocate per RPC request.- Syntax
- Default
--rpc.evm-memory-limit <MEMORY_LIMIT>rpc.txfeecap
Maximum eth transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap).- Syntax
- Default
--rpc.txfeecap <TX_FEE_CAP>rpc.max-simulate-blocks
Maximum number of blocks for eth_simulateV1 call.- Syntax
- Default
--rpc.max-simulate-blocks <BLOCKS_COUNT>rpc.eth-proof-window
The maximum proof window for historical proof generation. This value allows for generating historical proofs up to configured number of blocks from current tip (up to tip - window).- Syntax
- Default
--rpc.eth-proof-window <RPC_ETH_PROOF_WINDOW>rpc.proof-permits
Maximum number of concurrent getproof requests.- Syntax
- Default
--rpc.proof-permits <COUNT>rpc.pending-block
Configures the pending block behavior for RPC responses. Options: full (include all transactions), empty (header only), none (disable pending blocks).- Syntax
- Default
--rpc.pending-block <KIND>rpc.forwarder
Endpoint to forward transactions to.- Syntax
--rpc.forwarder <FORWARDER>Builder
Options for the payload builder.builder.disallow
Path to file containing disallowed addresses, json-encoded list of strings. Block validation API will reject blocks containing transactions from these addresses.- Syntax
--builder.disallow <PATH>builder.extradata
Block extra data set by the payload builder.- Syntax
- Default
--builder.extradata <EXTRA_DATA>builder.gaslimit
Target gas limit for built blocks.- Syntax
--builder.gaslimit <GAS_LIMIT>builder.interval
The interval at which the job should build a new payload after the last. Interval is specified in seconds or in milliseconds if the value ends withms.
- Syntax
- Default
--builder.interval <DURATION>builder.deadline
The deadline for when the payload builder job should resolve.- Syntax
- Default
--builder.deadline <SECONDS>builder.max-tasks
Maximum number of tasks to spawn for building a payload.- Syntax
- Default
--builder.max-tasks <MAX_PAYLOAD_TASKS>builder.max-blobs
Maximum number of blobs to include per block.- Syntax
--builder.max-blobs <COUNT>RPC State Cache
Options for the RPC state cache.rpc-cache.max-blocks
Max number of blocks in cache.- Syntax
- Default
--rpc-cache.max-blocks <MAX_BLOCKS>rpc-cache.max-receipts
Max number receipts in cache.- Syntax
- Default
--rpc-cache.max-receipts <MAX_RECEIPTS>rpc-cache.max-headers
Max number of headers in cache.- Syntax
- Default
--rpc-cache.max-headers <MAX_HEADERS>rpc-cache.max-concurrent-db-requests
Max number of concurrent database requests.- Syntax
- Default
--rpc-cache.max-concurrent-db-requests <MAX_CONCURRENT_DB_REQUESTS>Gas Price Oracle
Options for the Gas Price Oracle.gpo.blocks
Number of recent blocks to check for gas price.- Syntax
- Default
--gpo.blocks <BLOCKS>gpo.ignoreprice
Gas Price below which gpo will ignore transactions.- Syntax
- Default
--gpo.ignoreprice <IGNORE_PRICE>gpo.maxprice
Maximum transaction priority fee (or gasprice before London Fork) to be recommended by gpo.- Syntax
- Default
--gpo.maxprice <MAX_PRICE>gpo.percentile
The percentile of gas prices to use for the estimate.- Syntax
- Default
--gpo.percentile <PERCENTILE>gpo.default-suggested-fee
The default gas price to use if there are no blocks to use for estimation.- Syntax
--gpo.default-suggested-fee <DEFAULT_SUGGESTED_FEE>rpc.send-raw-transaction-sync-timeout
Timeout for the send_raw_transaction_sync RPC method.- Syntax
- Default
--rpc.send-raw-transaction-sync-timeout <SECONDS>testing.skip-invalid-transactions
Skip invalid transactions intesting_buildBlockV1 instead of failing.
When enabled, transactions that fail execution will be skipped, and all subsequent transactions from the same sender will also be skipped.
- Syntax
--testing.skip-invalid-transactionsTxPool
Options for the Transaction Pool.txpool.pending-max-count
Max number of transaction in the pending sub-pool.- Syntax
- Default
--txpool.pending-max-count <PENDING_MAX_COUNT>txpool.pending-max-size
Max size of the pending sub-pool in megabytes.- Syntax
- Default
--txpool.pending-max-size <PENDING_MAX_SIZE>txpool.basefee-max-count
Max number of transaction in the basefee sub-pool.- Syntax
- Default
--txpool.basefee-max-count <BASEFEE_MAX_COUNT>txpool.basefee-max-size
Max size of the basefee sub-pool in megabytes.- Syntax
- Default
--txpool.basefee-max-size <BASEFEE_MAX_SIZE>- Syntax
- Default
--txpool.basefee-max-count <BASEFEE_MAX_COUNT>txpool.queued-max-count
Max number of transaction in the queued sub-pool.- Syntax
- Default
--txpool.queued-max-count <QUEUED_MAX_COUNT>txpool.queued-max-size
Max size of the queued sub-pool in megabytes.- Syntax
- Default
--txpool.queued-max-size <QUEUED_MAX_SIZE>txpool.blobpool-max-count
Max number of transactions in the blobpool.- Syntax
- Default
--txpool.blobpool-max-count <BLOBPOOL_MAX_COUNT>txpool.blobpool-max-size
Max size of the blobpool in megabytes.- Syntax
- Default
--txpool.blobpool-max-size <BLOBPOOL_MAX_SIZE>txpool.blob-cache-size
Max number of entries for the in-memory cache of the blob store.- Syntax
--txpool.blob-cache-size <BLOB_CACHE_SIZE>txpool.disable-blobs-support
Disable EIP-4844 blob transaction support.- Syntax
—txpool.disable-blobs-support
txpool.max-account-slots
Max number of executable transaction slots guaranteed per account.- Syntax
- Default
--txpool.max-account-slots <MAX_ACCOUNT_SLOTS>txpool.pricebump
Price bump (in %) for the transaction pool underpriced check.- Syntax
- Default
--txpool.pricebump <PRICE_BUMP>txpool.minimal-protocol-fee
Minimum base fee required by the protocol.- Syntax
- Default
--txpool.minimal-protocol-fee <MINIMAL_PROTOCOL_BASEFEE>txpool.minimum-priority-fee
Minimum priority fee required for transaction acceptance into the pool. Transactions with a priority fee below this value will be rejected.- Syntax
--txpool.minimum-priority-fee <MINIMUM_PRIORITY_FEE>txpool.gas-limit
The default enforced gas limit for transactions entering the pool.- Syntax
- Default
--txpool.gas-limit <ENFORCED_GAS_LIMIT>txpool.max-tx-gas
Maximum gas limit for individual transactions. Transactions exceeding this limit will be rejected.- Syntax
--txpool.max-tx-gas <MAX_TX_GAS_LIMIT>blobpool.pricebump
Price bump percentage to replace an already existing blob transaction.- Syntax
--blobpool.pricebump <BLOB_TRANSACTION_PRICE_BUMP>'</Tab> <Tab title="Default">100`txpool.max-tx-input-bytes
Max size in bytes of a single transaction allowed to enter the pool.- Syntax
- Default
--txpool.max-tx-input-bytes <MAX_TX_INPUT_BYTES>txpool.max-cached-entries
The maximum number of blobs to keep in the in-memory blob cache.- Syntax
- Default
--txpool.max-cached-entries <MAX_CACHED_ENTRIES>txpool.nolocals
Flag to disable local transaction exemptions.- Syntax
--txpool.nolocalstxpool.locals
Flag to allow certain addresses as local.- Syntax
--txpool.locals <LOCALS>txpool.no-local-transactions-propagation
Flag to toggle local transaction propagation.- Syntax
--txpool.no-local-transactions-propagationtxpool.additional-validation-tasks
Number of additional transaction validation tasks to spawn.- Syntax
- Default
--txpool.additional-validation-tasks <ADDITIONAL_VALIDATION_TASKS>txpool.max-pending-txns
Maximum number of pending transactions from the network to buffer.- Syntax
- Default
--txpool.max-pending-txns <PENDING_TX_LISTENER_BUFFER_SIZE>txpool.max-new-txns
Maximum number of new transactions to buffer.- Syntax
- Default
--txpool.max-new-txns <NEW_TX_LISTENER_BUFFER_SIZE>txpool.max-new-pending-txs-notifications
How many new pending transactions to buffer and send to in-progress pending transaction iterators.- Syntax
- Default
--txpool.max-new-pending-txs-notifications <MAX_NEW_PENDING_TXS_NOTIFICATIONS>txpool.lifetime
Maximum amount of time (in seconds) non-executable transactions are queued.- Syntax
- Default
--txpool.lifetime <DURATION>txpool.transactions-backup
Path to store the local transaction backup at, to survive node restarts.- Syntax
--txpool.transactions-backup <PATH>txpool.disable-transactions-backup
Disables transaction backup to disk on node shutdown.- Syntax
--txpool.disable-transactions-backuptxpool.max-batch-size
Max batch size for transaction pool insertions.- Syntax
- Default
--txpool.max-batch-size <MAX_BATCH_SIZE>Debug
Options for debugging.debug.terminate
Flag indicating whether the node should be terminated after the pipeline sync.- Syntax
--debug.terminatedebug.tip
Set the chain tip manually for testing purposes. NOTE: This is a temporary flag.- Syntax
--debug.tip <TIP>debug.max-block
Runs the sync only up to the specified block.- Syntax
--debug.max-block <MAX_BLOCK>debug.etherscan
Runs a fake consensus client that advances the chain using recent block hashes on Etherscan. If specified, requires anETHERSCAN_API_KEY environment variable.
- Syntax
--debug.etherscan [<ETHERSCAN_API_URL>]debug.rpc-consensus-url
Runs a fake consensus client using blocks fetched from an RPC endpoint. Supports both HTTP andWebSocket endpoints.
- Syntax
--debug.rpc-consensus-url <RPC_URL>debug.skip-fcu
If provided, the engine will skipn consecutive FCUs.
- Syntax
--debug.skip-fcu <SKIP_FCU>debug.skip-new-payload
If provided, the engine will skipn consecutive new payloads.
- Syntax
--debug.skip-new-payload <SKIP_NEW_PAYLOAD>debug.reorg-frequency
If provided, the chain will be reorged at specified frequency.- Syntax
--debug.reorg-frequency <REORG_FREQUENCY>debug.reorg-depth
The reorg depth for chain reorgs.- Syntax
--debug.reorg-depth <REORG_DEPTH>debug.engine-api-store
The path to store engine API messages at. If specified, all of the intercepted engine API messages will be written to specified location.- Syntax
--debug.engine-api-store <PATH>debug.invalid-block-hook
Determines which type of invalid block hook to install. Possible values:witness, pre-state, opcode.
- Syntax
- Default
--debug.invalid-block-hook <INVALID_BLOCK_HOOK>debug.healthy-node-rpc-url
The RPC URL of a healthy node to use for comparing invalid block hook results against.- Syntax
--debug.healthy-node-rpc-url <URL>ethstats
The URL of the ethstats server to connect to. Example:nodename:secret@host:port.
- Syntax
--ethstats <ETHSTATS>debug.startup-sync-state-idle
Set the node to idle state when the backfill is not running. This makes theeth_syncing RPC return “Idle” when the node has just started or finished the backfill, but did not yet receive any new blocks.
- Syntax
--debug.startup-sync-state-idleDatabase
Options for the database.db.log-level
Database logging level. Levels higher than “notice” require a debug build. Possible values:fatal, error, warn, notice, verbose, debug, trace, extra.
- Syntax
--db.log-level <LOG_LEVEL>db.exclusive
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume.- Syntax
--db.exclusive <EXCLUSIVE>db.max-size
Maximum database size (e.g., 4TB, 8TB). This sets the “map size” of the database. If the database grows beyond this limit, the node will stop with an “environment map size limit reached” error.- Syntax
- Default
--db.max-size <MAX_SIZE>db.page-size
Database page size (e.g., 4KB, 8KB, 16KB). Specifies the page size used by the MDBX database. The page size determines the maximum database size. MDBX supports up to 2^31 pages, so with the default 4KB page size, the maximum database size is 8TB. To allow larger databases, increase this value to 8KB or higher. WARNING: This setting is only configurable at database creation; changing it later requires re-syncing.- Syntax
--db.page-size <PAGE_SIZE>db.growth-step
Database growth step (e.g., 4GB, 4KB).- Syntax
--db.growth-step <GROWTH_STEP>db.read-transaction-timeout
Read transaction timeout in seconds, 0 means no timeout.- Syntax
--db.read-transaction-timeout <READ_TRANSACTION_TIMEOUT>db.max-readers
Maximum number of readers allowed to access the database concurrently.- Syntax
--db.max-readers <MAX_READERS>db.sync-mode
Controls how aggressively the database synchronizes data to disk.- Syntax
--db.sync-mode <SYNC_MODE>Dev testnet
Options for running a local development testnet.dev
Start the node in dev mode. This mode uses a local proof-of-authority consensus engine with either fixed block times or automatically mined blocks. Disables network discovery and enables local http server. Prefunds 20 accounts derived by mnemonic “test test test test test test test test test test test junk” with 10 000 ETH each.- Syntax
--devdev.block-max-transactions
How many transactions to mine per block.- Syntax
--dev.block-max-transactions <BLOCK_MAX_TRANSACTIONS>dev.block-time
Interval between blocks. Parses strings usinghumantime::parse_duration.
Example: --dev.block-time 12s
- Syntax
--dev.block-time <BLOCK_TIME>dev.mnemonic
Derive dev accounts from a fixed mnemonic instead of random ones.- Syntax
- Default
--dev.mnemonic <MNEMONIC>Pruning
Options for data pruning.full
Run full node. Only the most recentMINIMUM_PRUNING_DISTANCE block states are stored.
- Syntax
--fullminimal
Run minimal storage mode with maximum pruning and smaller static files. This mode configures the node to use minimal disk space by:- Fully pruning sender recovery, transaction lookup, receipts
- Leaving 10,064 blocks for account, storage history and block bodies
- Using 10,000 blocks per static file segment
- Syntax
--minimalprune.block-interval
Minimum pruning interval measured in blocks.- Syntax
--prune.block-interval <BLOCK_INTERVAL>prune.sender-recovery.full
Prunes all sender recovery data.- Syntax
--prune.sender-recovery.fullprune.sender-recovery.distance
Prune sender recovery data before the head-N block number. In other words, keep the last blocks.- Syntax
--prune.sender-recovery.distance <BLOCKS>prune.sender-recovery.before
Prune sender recovery data before the specified block number. The specified block number is not pruned.- Syntax
--prune.sender-recovery.before <BLOCK_NUMBER>prune.transaction-lookup.full
Prunes all transaction lookup data.- Syntax
--prune.transaction-lookup.fullprune.transaction-lookup.distance
Prune transaction lookup data before the head-N block number. In other words, keep the last blocks.- Syntax
--prune.transaction-lookup.distance <BLOCKS>prune.transaction-lookup.before
Prune transaction lookup data before the specified block number. The specified block number is not pruned.- Syntax
--prune.transaction-lookup.before <BLOCK_NUMBER>prune.receipts.full
Prunes all receipt data.- Syntax
--prune.receipts.fullprune.receipts.pre-merge
Prune receipts before the merge block.- Syntax
--prune.receipts.pre-mergeprune.receipts.distance
Prune receipts before the head-N block number. In other words, keep the last blocks.- Syntax
--prune.receipts.distance <BLOCKS>prune.receipts.before
Prune receipts before the specified block number. The specified block number is not pruned.- Syntax
--prune.receipts.before <BLOCK_NUMBER>prune.receiptslogfilter
Configure receipts log filter. Format:<address>:<prune_mode>... where <prune_mode> can be full, distance:<blocks>, or before:<block_number>.
- Syntax
--prune.receiptslogfilter <FILTER_CONFIG>prune.account-history.full
Prunes all account history.- Syntax
--prune.account-history.fullprune.account-history.distance
Prune account history before the head-N block number. In other words, keep the last blocks.- Syntax
--prune.account-history.distance <BLOCKS>prune.account-history.before
Prune account history before the specified block number. The specified block number is not pruned.- Syntax
--prune.account-history.before <BLOCK_NUMBER>prune.storage-history.full
Prunes all storage history data.- Syntax
--prune.storage-history.fullprune.storage-history.distance
Prune storage history before the head-N block number. In other words, keep the last blocks.- Syntax
--prune.storage-history.distance <BLOCKS>prune.storage-history.before
Prune storage history before the specified block number. The specified block number is not pruned.- Syntax
--prune.storage-history.before <BLOCK_NUMBER>prune.bodies.pre-merge
Prune bodies before the merge block.- Syntax
--prune.bodies.pre-mergeprune.bodies.distance
Prune bodies before the head-N block number. In other words, keep the last blocks.- Syntax
--prune.bodies.distance <BLOCKS>prune.bodies.before
Prune body history before the specified block number. The specified block number is not pruned.- Syntax
--prune.bodies.before <BLOCK_NUMBER>Engine
Engine API options.engine.persistence-threshold
Configure persistence threshold for the engine. This determines how many canonical blocks must be in-memory, ahead of the last persisted block, before flushing canonical blocks to disk again. To persist blocks as fast as the node receives them, set this value to zero. This will cause more frequent DB writes.- Syntax
- Default
--engine.persistence-threshold <PERSISTENCE_THRESHOLD>engine.memory-block-buffer-target
Configure the target number of blocks to keep in memory.- Syntax
- Default
--engine.memory-block-buffer-target <MEMORY_BLOCK_BUFFER_TARGET>engine.legacy-state-root
Enable legacy state root calculation.- Syntax
--engine.legacy-state-rootengine.disable-state-cache
Disable the state cache.- Syntax
--engine.disable-state-cacheengine.disable-prewarming
Disable parallel prewarming of the state.- Syntax
--engine.disable-prewarmingengine.disable-parallel-sparse-trie
Disable the parallel sparse trie in the engine.- Syntax
--engine.disable-parallel-sparse-trieengine.state-provider-metrics
Enable state provider latency metrics. This allows the engine to collect and report stats about how long state provider calls took during execution, but introduces slight overhead.- Syntax
--engine.state-provider-metricsengine.cross-block-cache-size
Configure the size of the cross-block cache in megabytes.- Syntax
- Default
--engine.cross-block-cache-size <CROSS_BLOCK_CACHE_SIZE>engine.state-root-task-compare-updates
Enable comparing trie updates from the state root task to the trie updates from the regular state root calculation.- Syntax
--engine.state-root-task-compare-updatesengine.accept-execution-requests-hash
Enables accepting a requests hash instead of an array of requests in engine_newPayloadV4.- Syntax
--engine.accept-execution-requests-hashengine.multiproof-chunking
Whether the multiproof task should chunk proof targets.- Syntax
--engine.multiproof-chunkingengine.multiproof-chunk-size
Multiproof task chunk size for proof targets.- Syntax
- Default
--engine.multiproof-chunk-size <MULTIPROOF_CHUNK_SIZE>engine.reserved-cpu-cores
Configure the number of reserved CPU cores for non-reth processes.- Syntax
- Default
--engine.reserved-cpu-cores <RESERVED_CPU_CORES>engine.disable-precompile-cache
Disable the precompile cache.- Syntax
--engine.disable-precompile-cacheengine.state-root-fallback
Enable state root fallback. Primarily used for testing purposes.- Syntax
--engine.state-root-fallbackengine.always-process-payload-attributes-on-canonical-head
Always process payload attributes and begin a payload build process even ifforkchoiceState.headBlockHash is already the canonical head or an ancestor. See TreeConfig::always_process_payload_attributes_on_canonical_head for more details.
Note: This is a no-op on OP Stack.
- Syntax
--engine.always-process-payload-attributes-on-canonical-headengine.allow-unwind-canonical-header
Allow unwinding canonical header to ancestor during forkchoice updates. SeeTreeConfig::unwind_canonical_header for more details.
- Syntax
--engine.allow-unwind-canonical-headerengine.storage-worker-count
Configure the number of storage proof workers in the Tokio blocking pool. If not specified, defaults to 2x available parallelism, clamped between 2 and 64.- Syntax
--engine.storage-worker-count <STORAGE_WORKER_COUNT>engine.account-worker-count
Configure the number of account proof workers in the Tokio blocking pool. If not specified, defaults to the same count as storage workers.- Syntax
--engine.account-worker-count <ACCOUNT_WORKER_COUNT>engine.enable-proof-v2
Enable V2 storage proofs for state root calculations.- Syntax
--engine.enable-proof-v2ERA
Options for ERA1 file import.era.enable
Enable import from ERA1 files.- Syntax
--era.enableera.path
The path to a directory for import. The ERA1 files are read from the local directory parsing headers and bodies.- Syntax
--era.path <ERA_PATH>era.url
The URL to a remote host where the ERA1 files are hosted. The ERA1 files are read from the remote host using HTTP GET requests parsing headers and bodies.- Syntax
--era.url <ERA_URL>Static Files
Options for static file storage configuration.static-files.blocks-per-file.headers
Number of blocks per file for the headers segment.- Syntax
--static-files.blocks-per-file.headers <BLOCKS_PER_FILE_HEADERS>static-files.blocks-per-file.transactions
Number of blocks per file for the transactions segment.- Syntax
--static-files.blocks-per-file.transactions <BLOCKS_PER_FILE_TRANSACTIONS>static-files.blocks-per-file.receipts
Number of blocks per file for the receipts segment.- Syntax
--static-files.blocks-per-file.receipts <BLOCKS_PER_FILE_RECEIPTS>static-files.blocks-per-file.transaction-senders
Number of blocks per file for the transaction senders segment.- Syntax
--static-files.blocks-per-file.transaction-senders <BLOCKS_PER_FILE_TRANSACTION_SENDERS>static-files.blocks-per-file.account-change-sets
Number of blocks per file for the account changesets segment.- Syntax
--static-files.blocks-per-file.account-change-sets <BLOCKS_PER_FILE_ACCOUNT_CHANGE_SETS>static-files.receipts
Store receipts in static files instead of the database. When enabled, receipts will be written to static files on disk instead of the database. Note: This setting can only be configured at genesis initialization. Once the node has been initialized, changing this flag requires re-syncing from scratch.- Syntax
--static-files.receiptsstatic-files.transaction-senders
Store transaction senders in static files instead of the database. When enabled, transaction senders will be written to static files on disk instead of the database. Note: This setting can only be configured at genesis initialization. Once the node has been initialized, changing this flag requires re-syncing from scratch.- Syntax
--static-files.transaction-sendersstatic-files.account-change-sets
Store account changesets in static files. When enabled, account changesets will be written to static files on disk instead of the database. Note: This setting can only be configured at genesis initialization. Once the node has been initialized, changing this flag requires re-syncing from scratch.- Syntax
--static-files.account-change-setsRollup
Options for Rollup configuration.rollup.sequencer
Endpoint for the sequencer mempool (can be both HTTP and WS). Aliases:--rollup.sequencer-http, --rollup.sequencer-ws
- Syntax
--rollup.sequencer <SEQUENCER>rollup.disable-tx-pool-gossip
Disable transaction pool gossip.- Syntax
--rollup.disable-tx-pool-gossiprollup.compute-pending-block
By default the pending block equals the latest block to save resources and not leak txs from the tx-pool, this flag enables computing of the pending block from the tx-pool instead. Ifcompute_pending_block is not enabled, the payload builder will use the payload attributes from the latest block. Note that this flag is not yet functional.
- Syntax
--rollup.compute-pending-blockrollup.discovery.v4
Enables discovery v4 if provided.- Syntax
--rollup.discovery.v4rollup.enable-tx-conditional
Enable transaction conditional support on sequencer.- Syntax
--rollup.enable-tx-conditionalrollup.supervisor-http
HTTP endpoint for the supervisor.- Syntax
- Default
--rollup.supervisor-http <SUPERVISOR_HTTP_URL>rollup.supervisor-safety-level
Safety level for the supervisor.- Syntax
- Default
--rollup.supervisor-safety-level <SUPERVISOR_SAFETY_LEVEL>rollup.sequencer-headers
Optional headers to use when connecting to the sequencer.- Syntax
--rollup.sequencer-headers <SEQUENCER_HEADERS>rollup.historicalrpc
RPC endpoint for historical data.- Syntax
--rollup.historicalrpc <HISTORICAL_HTTP_URL>min-suggested-priority-fee
Minimum suggested priority fee (tip) in wei.- Syntax
- Default
--min-suggested-priority-fee <MIN_SUGGESTED_PRIORITY_FEE>flashblocks-url
A URL pointing to a secure websocket subscription that streams out flashblocks. If given, the flashblocks are received to build pending block. All request with “pending” block tag will use the pending state based on flashblocks.- Syntax
--flashblocks-url <FLASHBLOCKS_URL>flashblock-consensus
Enable flashblock consensus client to drive the chain forward. When enabled, the flashblock consensus client will process flashblock sequences and submit them to the engine API to advance the chain. Requiresflashblocks_url to be set.
- Syntax
--flashblock-consensusLogging
Options for logging.log.stdout.format
The format to use for logs written to stdout. Possible values:json, log-fmt, terminal.
- Syntax
- Default
--log.stdout.format <FORMAT>log.stdout.filter
The filter to use for logs written to stdout.- Syntax
--log.stdout.filter <FILTER>log.file.format
The format to use for logs written to the log file. Possible values:json, log-fmt, terminal.
- Syntax
- Default
--log.file.format <FORMAT>log.file.filter
The filter to use for logs written to the log file.- Syntax
- Default
--log.file.filter <FILTER>log.file.directory
The path to put log files in.- Syntax
- Default
--log.file.directory <PATH>log.file.name
The prefix name of the log files.- Syntax
- Default
--log.file.name <NAME>log.file.max-size
The maximum size (in MB) of one log file.- Syntax
- Default
--log.file.max-size <SIZE>log.file.max-files
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled.- Syntax
- Default
--log.file.max-files <COUNT>log.journald
Write logs to journald.- Syntax
--log.journaldlog.journald.filter
The filter to use for logs written to journald.- Syntax
- Default
--log.journald.filter <FILTER>color
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting. Possible values:always, auto, never.
- Syntax
- Default
--color <COLOR>logs-otlp
EnableOpentelemetry logs export to an OTLP endpoint.
If no value provided, defaults based on protocol:
- HTTP:
http://localhost:4318/v1/logs - gRPC:
http://localhost:4317
- Syntax
- Environment Variable
--logs-otlp[=<URL>]logs-otlp.filter
Set a filter directive for the OTLP logs exporter. This controls the verbosity of logs sent to the OTLP endpoint. It follows the same syntax as theRUST_LOG environment variable.
Defaults to INFO if not specified.
- Syntax
- Default
--logs-otlp.filter <FILTER>Display
Options for display and verbosity.verbosity
Set the minimum log level.-v: Errors-vv: Warnings-vvv: Info-vvvv: Debug-vvvvv: Traces (warning: very verbose!)
- Syntax
- Default
-v, --verbosityquiet
Silence all log output.- Syntax
-q, --quietTracing
Options for OpenTelemetry tracing.tracing-otlp
EnableOpentelemetry tracing export to an OTLP endpoint.
If no value provided, defaults based on protocol:
- HTTP:
http://localhost:4318/v1/traces - gRPC:
http://localhost:4317
- Syntax
- Environment Variable
--tracing-otlp[=<URL>]tracing-otlp-protocol
OTLP transport protocol to use for exporting traces and logs.http: expects endpoint path to end with/v1/tracesor/v1/logsgrpc: expects endpoint without a path Defaults to HTTP if not specified.
http: HTTP/Protobuf transport, port 4318, requires/v1/tracespathgrpc: gRPC transport, port 4317
- Syntax
- Default
- Environment Variable
--tracing-otlp-protocol <PROTOCOL>tracing-otlp.filter
Set a filter directive for the OTLP tracer. This controls the verbosity of spans and events sent to the OTLP endpoint. It follows the same syntax as theRUST_LOG environment variable.
Example: --tracing-otlp.filter=info,reth=debug,hyper_util=off
Defaults to TRACE if not specified.
- Syntax
- Default
--tracing-otlp.filter <FILTER>tracing-otlp.sample-ratio
Trace sampling ratio to control the percentage of traces to export. Valid range: 0.0 to 1.0 (1.0 = Sample all, 0.0 = Disable).1.0, default: Sample all traces0.01: Sample 1% of traces0.0: Disable sampling
--tracing-otlp.sample-ratio=0.0.
- Syntax
- Environment Variable
--tracing-otlp.sample-ratio <RATIO>