Optimism Documentation

This page provides detailed documentation for all available op-geth configuration options, organized by functionality. The following options are from v1.101603.3-rc.3 Please note that the executable is still named geth to maintain a minimal diff. The following sections provide detailed documentation for all available op-geth configuration options, organized by functionality.

Account management

Options for managing accounts, keystores, and external signers.

keystore

Directory for the keystore. The default is inside the data directory.

Syntax
Example
Environment Variable

--keystore <value>

--keystore=/path/to/keystore

GETH_KEYSTORE=/path/to/keystore

lightkdf

Reduce key-derivation RAM & CPU usage at some expense of KDF strength. The default value is false.

Syntax
Example
Environment Variable

--lightkdf

--lightkdf=false

GETH_LIGHTKDF=false

password

Password file to use for non-interactive password input.

Syntax
Example
Environment Variable

--password <value>

--password=/path/to/passwordfile

GETH_PASSWORD=/path/to/passwordfile

pcscdpath

Path to the smartcard daemon (pcscd) socket file. The default value is "/run/pcscd/pcscd.comm".

Syntax
Example
Environment Variable

--pcscdpath <value>

--pcscdpath=/custom/path/to/pcscd.comm

GETH_PCSCDPATH=/custom/path/to/pcscd.comm

signer

External signer (url or path to ipc file).

Syntax
Example
Environment Variable

--signer <value>

--signer=/path/to/ipcfile

GETH_SIGNER=/path/to/ipcfile

usb

Enable monitoring and management of USB hardware wallets. The default value is false.

Syntax
Example
Environment Variable

--usb

--usb=false

GETH_USB=false

RPC and API configuration

Configure HTTP, WebSocket, authenticated RPC endpoints, and console access.

authrpc.addr

Listening address for authenticated APIs. The default value is "localhost".

Syntax
Example
Environment Variable

--authrpc.addr <value>

--authrpc.addr="localhost"

GETH_AUTHRPC_ADDR="localhost"

authrpc.jwtsecret

Path to a JWT secret to use for authenticated RPC endpoints.

Syntax
Example
Environment Variable

--authrpc.jwtsecret <value>

--authrpc.jwtsecret=/path/to/jwtsecret

GETH_AUTHRPC_JWTSECRET=/path/to/jwtsecret

authrpc.port

Listening port for authenticated APIs. The default value is 8551.

Syntax
Example
Environment Variable

--authrpc.port <value>

--authrpc.port=8551

GETH_AUTHRPC_PORT=8551

authrpc.vhosts

Comma separated list of virtual hostnames from which to accept requests (server enforced). The default value is "localhost". Accepts ’*’ wildcard.

Syntax
Example
Environment Variable

--authrpc.vhosts <value>

--authrpc.vhosts="localhost"

GETH_AUTHRPC_VHOSTS="localhost"

exec

Execute JavaScript statement.

Syntax
Example
Environment Variable

--exec <value>

--exec="console.log('Hello, World!')"

GETH_EXEC="console.log('Hello, World!')"

graphql

Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if an HTTP server is started as well. The default value is false.

Syntax
Example
Environment Variable

--graphql

--graphql=false

GETH_GRAPHQL=false

graphql.corsdomain

Comma separated list of domains from which to accept cross origin requests (browser enforced).

Syntax
Example
Environment Variable

--graphql.corsdomain <value>

--graphql.corsdomain="http://example.com"

GETH_GRAPHQL_CORSDOMAIN="http://example.com"

graphql.vhosts

Comma separated list of virtual hostnames from which to accept requests (server enforced). The default value is "localhost". Accepts ’*’ wildcard.

Syntax
Example
Environment Variable

--graphql.vhosts <value>

--graphql.vhosts="localhost"

GETH_GRAPHQL_VHOSTS="localhost"

Pass custom headers to the RPC server when using --remotedb or the geth attach console. This flag can be given multiple times.

Syntax
Example
Environment Variable

--header <value>, -H <value>

--header "X-Custom-Header: Value"

http

Enable the HTTP-RPC server. The default value is false.

Syntax
Example
Environment Variable

--http

--http=false

GETH_HTTP=false

http.addr

HTTP-RPC server listening interface. The default value is "localhost".

Syntax
Example
Environment Variable

--http.addr <value>

--http.addr="localhost"

GETH_HTTP_ADDR="localhost"

http.api

API’s offered over the HTTP-RPC interface.

Syntax
Example
Environment Variable

--http.api <value>

--http.api="eth,web3"

GETH_HTTP_API="eth,web3"

http.corsdomain

Comma separated list of domains from which to accept cross origin requests (browser enforced).

Syntax
Example
Environment Variable

--http.corsdomain <value>

--http.corsdomain="http://example.com"

GETH_HTTP_CORSDOMAIN="http://example.com"

http.port

HTTP-RPC server listening port. The default value is 8545.

Syntax
Example
Environment Variable

--http.port <value>

--http.port=8545

GETH_HTTP_PORT=8545

http.rpcprefix`\

HTTP path prefix on which JSON-RPC is served. Use ’/’ to serve on all paths.

Syntax
Example
Environment Variable

--http.rpcprefix <value>

--http.rpcprefix="/"

GETH_HTTP_RPCPREFIX="/"

http.vhosts

Comma separated list of virtual hostnames from which to accept requests (server enforced). The default value is "localhost". Accepts ’*’ wildcard.

Syntax
Example
Environment Variable

--http.vhosts <value>

--http.vhosts=localhost

GETH_HTTP_VHOSTS=localhost

ipcdisable

Disable the IPC-RPC server. The default value is false.

Syntax
Example
Environment Variable

--ipcdisable

--ipcdisable=false

GETH_IPCDISABLE=false

ipcpath

Filename for IPC socket/pipe within the datadir (explicit paths escape it).

Syntax
Example
Environment Variable

--ipcpath <value>

--ipcpath=/path/to/ipcfile

GETH_IPCPATH=/path/to/ipcfile

jspath

JavaScript root path for loadScript. The default value is . (current directory).

Syntax
Example
Environment Variable

--jspath <value>

--jspath=/path/to/scripts

GETH_JSPATH=/path/to/scripts

preload

Comma separated list of JavaScript files to preload into the console.

Syntax
Example
Environment Variable

--preload <value>

--preload="file1.js,file2.js"

GETH_PRELOAD="file1.js,file2.js"

rpc.allow-unprotected-txs

Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC. The default value is false.

Syntax
Example
Environment Variable

--rpc.allow-unprotected-txs

--rpc.allow-unprotected-txs=false

GETH_RPC_ALLOW_UNPROTECTED_TXS=false

rpc.batch-request-limit

Maximum number of requests in a batch. The default value is 1000.

Syntax
Example
Environment Variable

--rpc.batch-request-limit=<value>

--rpc.batch-request-limit=1000

GETH_RPC_BATCH_REQUEST_LIMIT=1000

rpc.batch-response-max-size

Maximum number of bytes returned from a batched call. The default value is 25000000.

Syntax
Example
Environment Variable

--rpc.batch-response-max-size=<value>

--rpc.batch-response-max-size=25000000

GETH_RPC_BATCH_RESPONSE_MAX_SIZE=25000000

rpc.evmtimeout

Sets a timeout used for eth_call (0=infinite). The default value is 5s.

Syntax
Example
Environment Variable

--rpc.evmtimeout <value>

--rpc.evmtimeout=5s

GETH_RPC_EVMTIMEOUT=5s

rpc.gascap

Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite). The default value is 50000000.

Syntax
Example
Environment Variable

--rpc.gascap=<value>

--rpc.gascap=50000000

GETH_RPC_GASCAP=50000000

rpc.txfeecap

Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap). The default value is 1.

Syntax
Example
Environment Variable

--rpc.txfeecap=<value>

--rpc.txfeecap=1

ws

Enable the WS-RPC server. The default value is false.

Syntax
Example
Environment Variable

--ws

--ws=false

GETH_WS=false

ws.addr

WS-RPC server listening interface. The default value is "localhost".

Syntax
Example
Environment Variable

--ws.addr=<value>

--ws.addr=localhost

GETH_WS_ADDR=localhost

ws.api

API’s offered over the WS-RPC interface.

Syntax
Example
Environment Variable

--ws.api=<value>

--ws.api="eth,web3"

GETH_WS_API="eth,web3"

ws.origins

Origins from which to accept websockets requests.

Syntax
Example
Environment Variable

--ws.origins=<value>

--ws.origins="http://example.com"

GETH_WS_ORIGINS="http://example.com"

ws.port

WS-RPC server listening port. The default value is 8546.

Syntax
Example
Environment Variable

--ws.port=<value>

--ws.port=8546

GETH_WS_PORT=8546

ws.rpcprefix

HTTP path prefix on which JSON-RPC is served over WS. Use ’/’ to serve on all paths.

Syntax
Example
Environment Variable

--ws.rpcprefix=<value>

--ws.rpcprefix="/"

GETH_WS_RPCPREFIX="/"

Development Chain

Options for running a local development chain with pre-funded accounts.

dev

Ephemeral proof-of-authority network with a pre-funded developer account, mining enabled. The default value is false.

Syntax
Example
Environment Variable

--dev

--dev=false

GETH_DEV=false

dev.gaslimit

Initial block gas limit. The default value is 11500000.

Syntax
Example
Environment Variable

--dev.gaslimit=<value>

--dev.gaslimit=11500000

GETH_DEV_GASLIMIT=11500000

dev.period

Block period to use in developer mode (0 = mine only if transaction pending). The default value is 0.

Syntax
Example
Environment Variable

--dev.period=<value>

--dev.period=0

GETH_DEV_PERIOD=0

Chain and network selection

Configure which network to connect to and manage blockchain data storage.

bloomfilter.size

Megabytes of memory allocated to bloom-filter for pruning. The default value is 2048.

Syntax
Example
Environment Variable

--bloomfilter.size=<value>

--bloomfilter.size=2048

GETH_BLOOMFILTER_SIZE=2048

config

TOML configuration file.

Syntax
Example
Environment Variable

--config=<value>

--config=/path/to/config.toml

GETH_CONFIG=/path/to/config.toml

datadir

Data directory for the databases and keystore. The default value is /home/<user>/.ethereum.

Syntax
Example
Environment Variable

--datadir=<value>

--datadir=/home/soyboy/.ethereum

GETH_DATADIR=/home/soyboy/.ethereum

datadir.ancient

Root directory for ancient data (default = inside chaindata).

Syntax
Example
Environment Variable

--datadir.ancient=<value>

GETH_DATADIR_ANCIENT=<value>

datadir.era

Root directory for era1 history (default = inside ancient/chain).

Syntax
Example
Environment Variable

--datadir.era=<value>

GETH_DATADIR_ERA=<value>

datadir.minfreedisk

Minimum free disk space in MB, once reached triggers auto shut down (default = —cache.gc converted to MB, 0 = disabled).

Syntax
Example
Environment Variable

--datadir.minfreedisk=<value>

--datadir.minfreedisk=0

GETH_DATADIR_MINFREEDISK=0

db.engine

Backing database implementation to use (‘pebble’ or ‘leveldb’).

Syntax
Example
Environment Variable

--db.engine=<value>

--db.engine=leveldb

GETH_DB_ENGINE=leveldb

eth.requiredblocks

Comma separated block number-to-hash mappings to require for peering (<number>=<hash>).

Syntax
Example
Environment Variable

--eth.requiredblocks=<value>

--eth.requiredblocks="12345=0xabcde12345..."

GETH_ETH_REQUIREDBLOCKS="12345=0xabcde12345..."

exitwhensynced

Exits after block synchronization completes. The default value is false.

Syntax
Example
Environment Variable

--exitwhensynced

--exitwhensynced=false

GETH_EXITWHENSYNCED=false

holesky

Holesky network: pre-configured proof-of-stake test network. The default value is false.

Syntax
Example
Environment Variable

--holesky

--holesky=false

GETH_HOLESKY=false

hoodi

Hoodi network: pre-configured proof-of-stake test network. The default value is false.

Syntax
Example
Environment Variable

--hoodi

--hoodi=false

GETH_HOODI=false

mainnet

Ethereum mainnet. The default value is false.

Syntax
Example
Environment Variable

--mainnet

--mainnet=false

GETH_MAINNET=false

networkid

Explicitly set network id (integer). The default value is 0. For testnets: use —sepolia, —holesky, —hoodi instead.

Syntax
Example
Environment Variable

--networkid <value>

--networkid=1

GETH_NETWORKID=1

op-network, beta.op-network

Select a pre-configured OP-Stack network (warning: op-mainnet and op-goerli require special sync, datadir is recommended), options: arena-z-mainnet, arena-z-sepolia, automata-mainnet, base-devnet-0-sepolia-dev-0, base-mainnet, base-sepolia, bob-mainnet, camp-sepolia, creator-chain-testnet-sepolia, cyber-mainnet, cyber-sepolia, ethernity-mainnet, ethernity-sepolia, fraxtal-mainnet, funki-mainnet, funki-sepolia, hashkeychain-mainnet, ink-mainnet, ink-sepolia, lisk-mainnet, lisk-sepolia, lyra-mainnet, metal-mainnet, metal-sepolia, mint-mainnet, mode-mainnet, mode-sepolia, op-mainnet, op-sepolia, oplabs-devnet-0-sepolia-dev-0, orderly-mainnet, ozean-sepolia, pivotal-sepolia, polynomial-mainnet, race-mainnet, race-sepolia, radius_testnet-sepolia, redstone-mainnet, rehearsal-0-bn-0-rehearsal-0-bn, rehearsal-0-bn-1-rehearsal-0-bn, settlus-mainnet-mainnet, settlus-sepolia-sepolia, shape-mainnet, shape-sepolia, silent-data-mainnet-mainnet, snax-mainnet, soneium-mainnet, soneium-minato-sepolia, sseed-mainnet, swan-mainnet, swell-mainnet, tbn-mainnet, tbn-sepolia, unichain-mainnet, unichain-sepolia, worldchain-mainnet, worldchain-sepolia, xterio-eth-mainnet, zora-mainnet, zora-sepolia

Syntax
Example
Environment Variable

--op-network=<value>

--op-network=base-mainnet

GETH_OP_NETWORK=base-mainnet

override.cancun

Manually specify the Cancun fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.cancun=<value>

--override.cancun=0

GETH_OVERRIDE_CANCUN=0

override.canyon

Manually specify the Optimism Canyon fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.canyon=<value>

--override.canyon=0

GETH_OVERRIDE_CANYON=0

override.ecotone

Manually specify the Optimism Ecotone fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.ecotone=<value>

--override.ecotone=0

GETH_OVERRIDE_ECOTONE=0

override.fjord

Manually specify the Optimism Fjord fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.fjord=<value>

--override.fjord=0

GETH_OVERRIDE_FJORD=0

override.granite

Manually specify the Optimism Granite fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.granite=<value>

--override.granite=0

GETH_OVERRIDE_GRANITE=0

override.holocene

Manually specify the Optimism Holocene fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.holocene=<value>

--override.holocene=0

GETH_OVERRIDE_HOLOCENE=0

`override.interop`

Manually specify the Optimism Interop feature-set fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.interop=<value>

--override.interop=0

GETH_OVERRIDE_INTEROP=0

override.isthmus

Manually specify the Optimism Isthmus fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.isthmus=<value>

--override.isthmus=0

GETH_OVERRIDE_ISTHMUS=0

override.jovian

Manually specify the Optimism Jovian fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.jovian=<value>

--override.jovian=0

GETH_OVERRIDE_JOVIAN=0

override.osaka

Manually specify the Osaka fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.osaka=<value>

--override.osaka=0

GETH_OVERRIDE_OSAKA=0

override.verkle

Manually specify the Verkle fork timestamp, overriding the bundled setting. The default value is 0.

Syntax
Example
Environment Variable

--override.verkle=<value>

--override.verkle=0

GETH_OVERRIDE_VERKLE=0

sepolia

Sepolia network: pre-configured proof-of-work test network. The default value is false.

Syntax
Example
Environment Variable

--sepolia

--sepolia=false

GETH_SEPOLIA=false

`snapshot`

Enables snapshot-database mode. The default value is true.

Syntax
Example
Environment Variable

--snapshot

--snapshot=true

GETH_SNAPSHOT=true

Gas price oracle

Configure how gas prices are estimated and suggested to users.

gpo.blocks

Number of recent blocks to check for gas prices. The default value is 20.

Syntax
Example
Environment Variable

--gpo.blocks=<value>

--gpo.blocks=20

GETH_GPO_BLOCKS=20

gpo.ignoreprice

Gas price below which GPO will ignore transactions. The default value is 2.

Syntax
Syntax
Syntax

--gpo.ignoreprice=<value>

--gpo.ignoreprice=2

GETH_GPO_IGNOREPRICE=2

gpo.maxprice

Maximum transaction priority fee (or gasprice before London fork) to be recommended by GPO. The default value is 500000000000.

Syntax
Syntax
Syntax

--gpo.maxprice=<value>

--gpo.maxprice=500000000000

GETH_GPO_MAXPRICE=500000000000

gpo.minsuggestedpriorityfee

Minimum transaction priority fee to suggest. Used on OP chains when blocks are not full. The default value is 1000000.

Syntax
Syntax
Syntax

--gpo.minsuggestedpriorityfee=<value>

--gpo.minsuggestedpriorityfee=1000000

GETH_GPO_MINSUGGESTEDPRIORITYFEE=1000000

gpo.percentile

Suggested gas price is the given percentile of a set of recent transaction gas prices. The default value is 60.

Syntax
Example
Environment Variable

--gpo.percentile=<value>

--gpo.percentile=60

GETH_GPO_PERCENTILE=60

Logging and debugging

Control log output, profiling, and debugging tools.

go-execution-trace

Write Go execution trace to the given file.

Syntax
Example
Environment Variable

--go-execution-trace <value>

--go-execution-trace=/path/to/trace.out

GETH_GO_EXECUTION_TRACE=/path/to/trace.out

log.compress

Compress the log files. The default value is false.

Syntax
Example
Environment Variable

--log.compress

--log.compress=false

GETH_LOG_COMPRESS=false

log.file

Write logs to a file.

Syntax
Example
Environment Variable

--log.file=<value>

--log.file=/path/to/logfile

GETH_LOG_FILE=/path/to/logfile

log.format

Log format to use (json|logfmt|terminal).

Syntax
Example
Environment Variable

--log.format=<value>

--log.format=logfmt

GETH_LOG_FORMAT=logfmt

log.maxage

Maximum number of days to retain a log file. The default value is 30.

Syntax
Example
Environment Variable

--log.maxage=<value>

--log.maxage=30

GETH_LOG_MAXAGE=30

log.maxbackups

Maximum number of log files to retain. The default value is 10.

Syntax
Example
Environment Variable

--log.maxbackups=<value>

--log.maxbackups=10

GETH_LOG_MAXBACKUPS=10

log.maxsize

Maximum size in MBs of a single log file. The default value is 100.

Syntax
Example
Environment Variable

--log.maxsize=<value>

--log.maxsize=100

GETH_LOG_MAXSIZE=100

`log.rotate`

Enables log file rotation. The default value is false.

Syntax
Example
Environment Variable

--log.rotate

--log.rotate=false

GETH_LOG_ROTATE=false

log.vmodule

Per-module verbosity: comma-separated list of <pattern>=<level> (e.g. eth/*=5,p2p=4).

Syntax
Example
Environment Variable

--log.vmodule=<value>

--log.vmodule="eth/*=5,p2p=4"

GETH_LOG_VMODULE="eth/*=5,p2p=4"

nocompaction

Disables database compaction after import. The default value is false.

Syntax
Example
Environment Variable

--nocompaction

--nocompaction=false

GETH_NOCOMPACTION=false

pprof

Enable the pprof HTTP server. The default value is false.

Syntax
Example
Environment Variable

--pprof

--pprof=false

GETH_PPROF=false

pprof.addr

pprof HTTP server listening interface. The default value is "127.0.0.1".

Syntax
Example
Environment Variable

--pprof.addr=<value>

--pprof.addr="127.0.0.1"

GETH_PPROF_ADDR="127.0.0.1"

pprof.blockprofilerate

Turn on block profiling with the given rate. The default value is 0.

Syntax
Example
Environment Variable

--pprof.blockprofilerate=<value>

--pprof.blockprofilerate=0

GETH_PPROF_BLOCKPROFILERATE=0

pprof.cpuprofile

Write CPU profile to the given file.

Syntax
Syntax

--pprof.cpuprofile=<value>

--pprof.cpuprofile=/path/to/cpu.profile

pprof.memprofilerate

Turn on memory profiling with the given rate. The default value is 524288.

Syntax
Example
Environment Variable

--pprof.memprofilerate=<value>

--pprof.memprofilerate=524288

GETH_PPROF_MEMPROFILERATE=524288

pprof.port

pprof HTTP server listening port. The default value is 6060.

Syntax
Example
Environment Variable

--pprof.port=<value>

--pprof.port=6060

GETH_PPROF_PORT=6060

remotedb

URL for remote database.

Syntax
Example
Environment Variable

--remotedb=<value>

--remotedb=http://example.com/db

GETH_REMOTEDB=http://example.com/db

verbosity

Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail. The default value is 3.

Syntax
Example
Environment Variable

--verbosity=<value>

--verbosity=3

GETH_VERBOSITY=3

Metrics and monitoring

Enable metrics collection and export to monitoring systems.

ethstats

Reporting URL of an ethstats service (nodename:secret@host:port).

Syntax
Example
Environment Variable

--ethstats=<value>

--ethstats="nodename:secret@host:port"

GETH_ETHSTATS="nodename:secret@host:port"

metrics

Enable metrics collection and reporting. The default value is false.

Syntax
Example
Environment Variable

--metrics

--metrics=false

GETH_METRICS=false

metrics.addr

Enable stand-alone metrics HTTP server listening interface.

Syntax
Example
Environment Variable

--metrics.addr=<value>

--metrics.addr="127.0.0.1:9090"

GETH_METRICS_ADDR="127.0.0.1:9090"

metrics.expensive

Enable expensive metrics collection and reporting. The default value is false.

Syntax
Example
Environment Variable

--metrics.expensive

--metrics.expensive=false

GETH_METRICS_EXPENSIVE=false

metrics.influxdb

Enable metrics export/push to an external InfluxDB database. The default value is false.

Syntax
Example
Environment Variable

--metrics.influxdb

--metrics.influxdb=false

GETH_METRICS_INFLUXDB=false

metrics.influxdb.bucket

InfluxDB bucket name to push reported metrics to (v2 only). The default value is "geth".

Syntax
Example
Environment Variable

--metrics.influxdb.bucket=<value>

--metrics.influxdb.bucket="geth"

GETH_METRICS_INFLUXDB_BUCKET="geth"

metrics.influxdb.database

InfluxDB database name to push reported metrics to. The default value is "geth".

Syntax
Example
Environment Variable

--metrics.influxdb.database=<value>

--metrics.influxdb.database="geth"

GETH_METRICS_INFLUXDB_DATABASE="geth"

metrics.influxdb.endpoint

InfluxDB API endpoint to report metrics to. The default value is "http://localhost:8086".

Syntax
Example
Environment Variable

--metrics.influxdb.endpoint=<value>

--metrics.influxdb.endpoint="http://localhost:8086"

GETH_METRICS_INFLUXDB_ENDPOINT="http://localhost:8086"

metrics.influxdb.organization

InfluxDB organization name (v2 only). The default value is "geth".

Syntax
Example
Environment Variable

--metrics.influxdb.organization=<value>

--metrics.influxdb.organization="geth"

GETH_METRICS_INFLUXDB_ORGANIZATION="geth"

metrics.influxdb.password

Password to authorize access to the database. The default value is "test".

Syntax
Example
Environment Variable

--metrics.influxdb.password=<value>

--metrics.influxdb.password="test"

GETH_METRICS_INFLUXDB_PASSWORD="test"

metrics.influxdb.tags

Comma-separated InfluxDB tags (key/values) attached to all measurements. The default value is "host=localhost".

Syntax
Example
Environment Variable

--metrics.influxdb.tags=<value>

--metrics.influxdb.tags="host=localhost"

GETH_METRICS_INFLUXDB_TAGS="host=localhost"

metrics.influxdb.token

Token to authorize access to the database (v2 only). The default value is "test".

Syntax
Example
Environment Variable

--metrics.influxdb.token=<value>

--metrics.influxdb.token="test"

GETH_METRICS_INFLUXDB_TOKEN="test"

metrics.influxdb.username

Username to authorize access to the database. The default value is "test".

Syntax
Example
Environment Variable

--metrics.influxdb.username=<value>

--metrics.influxdb.username="test"

GETH_METRICS_INFLUXDB_USERNAME="test"

metrics.influxdbv2

Enable metrics export/push to an external InfluxDB v2 database. The default value is false.

Syntax
Example
Environment Variable

--metrics.influxdbv2

--metrics.influxdbv2=false

GETH_METRICS_INFLUXDBV2=false

metrics.port

Metrics HTTP server listening port. The default value is 6060. Please note that --metrics.addr must be set to start the server.

Syntax
Example
Environment Variable

--metrics.port=<value>

--metrics.port=6060

GETH_METRICS_PORT=6060

General options

Help, version, and other general-purpose flags.

help

Show help. This is typically used to display command-line options and usage information.

Syntax
Syntax

--help or -h

--help

synctarget

Hash of the block to full sync to (dev testing feature).

Syntax
Example
Environment Variable

--synctarget=<value>

--synctarget="0x123...456"

GETH_SYNCTARGET="0x123...456"

version

Nodes built from source do not output the correct version numbers that are reported on the GitHub release page.

Print the version. This option is typically used to display the version of the software.

Syntax
Syntax

--version or -v

--version

Peer-to-peer networking

Configure P2P connections, peer discovery, and network settings.

bootnodes

Comma separated enode URLs for P2P discovery bootstrap.

Syntax
Example
Environment Variable

--bootnodes=<value>

--bootnodes=

GETH_BOOTNODES=

discovery.dns

Sets DNS discovery entry points (use "" to disable DNS).

Syntax
Example
Environment Variable

--discovery.dns=<value>

--discovery.dns=""

GETH_DISCOVERY_DNS=""

discovery.port

Use a custom UDP port for P2P discovery. The default value is 30303.

Syntax
Example
Environment Variable

--discovery.port=<value>

--discovery.port=30303

GETH_DISCOVERY_PORT=30303

discovery.v4

Enables the V4 discovery mechanism. The default value is false.

Syntax
Example
Environment Variable

--discovery.v4 or --discv4

--discovery.v4=false

GETH_DISCOVERY_V4=false

discovery.v5

Enables the V5 discovery mechanism. The default value is true.

Syntax
Example
Environment Variable

--discovery.v5 or --discv5

--discovery.v5=true

GETH_DISCOVERY_V5=true

identity

Custom node name.

Syntax
Example
Environment Variable

--identity=<value>

--identity="MyNode"

GETH_IDENTITY="MyNode"

maxpeers

Maximum number of network peers (network disabled if set to 0). The default value is 50.

Syntax
Example
Environment Variable

--maxpeers=<value>

--maxpeers=50

GETH_MAXPEERS=50

maxpendpeers

Maximum number of pending connection attempts (defaults used if set to 0). The default value is 0.

Syntax
Example
Environment Variable

--maxpendpeers=<value>

--maxpendpeers=0

GETH_MAXPENDPEERS=0

nat

Syntax
Example
Environment Variable

--nat=<value>

--nat="any"

GETH_NAT="any"

netrestrict

Restricts network communication to the given IP networks (CIDR masks).

Syntax
Example
Environment Variable

--netrestrict=<value>

--netrestrict="192.168.0.0/24"

GETH_NETRESTRICT="192.168.0.0/24"

nodekey

P2P node key file.

Syntax
Example
Environment Variable

--nodekey=<value>

--nodekey=/path/to/nodekey

GETH_NODEKEY=/path/to/nodekey

nodekeyhex

P2P node key as hex (for testing).

Syntax
Example
Environment Variable

--nodekeyhex=<value>

--nodekeyhex="abcdef..."

GETH_NODEKEYHEX="abcdef..."

nodiscover

Disables the peer discovery mechanism (manual peer addition). The default value is false.

Syntax
Example
Environment Variable

--nodiscover

--nodiscover=false

GETH_NODISCOVER=false

port

Network listening port. The default value is 30303.

Syntax
Example
Environment Variable

--port=<value>

--port=30303

GETH_PORT=30303

Performance and resource management

Tune memory usage, caching, and other performance-related settings.

`cache`

Megabytes of memory allocated to internal caching. The default is 4096 MB for mainnet full node and 128 MB for light mode.

Syntax
Example
Environment Variable

--cache=<value>

--cache=1024

GETH_CACHE=1024

cache.blocklogs

Size (in number of blocks) of the log cache for filtering. The default value is 32.

Syntax
Example
Environment Variable

--cache.blocklogs=<value>

--cache.blocklogs=32

GETH_CACHE_BLOCKLOGS=32

cache.database

Percentage of cache memory allowance to use for database I/O. The default value is 50.

Syntax
Example
Environment Variable

--cache.database=<value>

--cache.database=50

GETH_CACHE_DATABASE=50

cache.gc

Percentage of cache memory allowance to use for trie pruning. The default is 25% for full mode and 0% for archive mode.

Syntax
Example
Environment Variable

--cache.gc=<value>

--cache.gc=25

GETH_CACHE_GC=25

cache.noprefetch

Disable heuristic state prefetch during block import (less CPU and disk IO, more time waiting for data). The default value is false.

Syntax
Example
Environment Variable

--cache.noprefetch

--cache.noprefetch=false

GETH_CACHE_NOPREFETCH=false

cache.preimages

Enable recording the SHA3/keccak preimages of trie keys. The default value is false.

Syntax
Example
Environment Variable

--cache.preimages

--cache.preimages=false

GETH_CACHE_PREIMAGES=false

cache.snapshot

Percentage of cache memory allowance to use for snapshot caching. The default is 10% for full mode and 20% for archive mode.

Syntax
Example
Environment Variable

--cache.snapshot=<value>

--cache.snapshot=10

GETH_CACHE_SNAPSHOT=10

cache.trie

Percentage of cache memory allowance to use for trie caching. The default is 15% for full mode and 30% for archive mode.

Syntax
Example
Environment Variable

--cache.trie=<value>

--cache.trie=15%

GETH_CACHE_TRIE=15%

crypto.kzg

KZG library implementation to use; gokzg (recommended) or ckzg. The default value is "gokzg".

Syntax
Example
Environment Variable

--crypto.kzg=<value>

--crypto.kzg=gokzg

GETH_CRYPTO_KZG=gokzg

fdlimit

Raise the open file descriptor resource limit. The default is the system fd limit.

Syntax
Example
Environment Variable

--fdlimit=<value>

--fdlimit=0 (system default)

GETH_FDLIMIT=0

OP Stack specific options

Configuration options specific to OP Stack rollup functionality.

rollup.computependingblock

By default, the pending block equals the latest block to save resources and not leak transactions from the tx-pool. This flag enables computing of the pending block from the tx-pool instead. The default value is false.

Syntax
Example
Environment Variable

--rollup.computependingblock

--rollup.computependingblock=false

GETH_ROLLUP_COMPUTEPENDINGBLOCK=false

rollup.disabletxpoolgossip

Disable transaction pool gossip. The default value is false.

Syntax
Example
Environment Variable

--rollup.disabletxpoolgossip

--rollup.disabletxpoolgossip=false

GETH_ROLLUP_DISABLETXPOOLGOSSIP=false

rollup.enabletxpooladmission

Add RPC-submitted transactions to the txpool (on by default if —rollup.sequencerhttp is not set). The default value is false.

Syntax
Example
Environment Variable

--rollup.enabletxpooladmission

--rollup.enabletxpooladmission=false

GETH_ROLLUP_ENABLETXPOOLADMISSION=false

rollup.halt

Opt-in option to halt on incompatible protocol version requirements of the given level (major/minor/patch/none), as signaled through the Engine API by the rollup node.

Syntax
Example
Environment Variable

--rollup.halt=<value>

--rollup.halt="major"

GETH_ROLLUP_HALT="major"

rollup.historicalrpc

RPC endpoint for historical data.

Syntax
Example
Environment Variable

--rollup.historicalrpc <value>

--rollup.historicalrpc "http://example.com"

GETH_ROLLUP_HISTORICALRPC="http://example.com"

rollup.historicalrpctimeout

Timeout for historical RPC requests. The default value is 5s.

Syntax
Example
Environment Variable

--rollup.historicalrpctimeout=<value>

--rollup.historicalrpctimeout=5s

GETH_ROLLUP_HISTORICALRPCTIMEOUT=5s

rollup.interopmempoolfiltering

If using interop, transactions are checked for interop validity before being added to the mempool (experimental). The default value is false.

Syntax
Example
Environment Variable

--rollup.interopmempoolfiltering

--rollup.interopmempoolfiltering=false

GETH_ROLLUP_INTEROPMEMPOOLFILTERING=false

rollup.interoprpc

RPC endpoint for interop message verification (experimental).

Syntax
Example
Environment Variable

--rollup.interoprpc <value>

--rollup.interoprpc="http://example.com"

GETH_ROLLUP_INTEROPRPC="http://example.com"

rollup.sequencerhttp

HTTP endpoint for the sequencer mempool.

Syntax
Example
Environment Variable

--rollup.sequencerhttp=<value>

--rollup.sequencerhttp="http://example.com"

GETH_ROLLUP_SEQUENCERHTTP="http://example.com"

rollup.sequencertxconditionalcostratelimit

Maximum cost — storage lookups — allowed for conditional transactions in a given second. The default value is 5000.

Syntax
Example
Environment Variable

--rollup.sequencertxconditionalcostratelimit <value>

--rollup.sequencertxconditionalcostratelimit=5000

GETH_ROLLUP_SEQUENCERTXCONDITIONALCOSTRATELIMIT=5000

rollup.sequencertxconditionalenabled

Serve the eth_sendRawTransactionConditional endpoint and apply the conditional constraints on mempool inclusion & block building. The default value is false.

Syntax
Example
Environment Variable

--rollup.sequencertxconditionalenabled

--rollup.sequencertxconditionalenabled=false

GETH_ROLLUP_SEQUENCERTXCONDITIONALENABLED=false

rollup.superchain-upgrades

Apply superchain-registry config changes to the local chain-configuration. The default value is true.

Syntax
Example
Environment Variable

--rollup.superchain-upgrades or --beta.rollup.superchain-upgrades

--rollup.superchain-upgrades=true

GETH_ROLLUP_SUPERCHAIN_UPGRADES=true

State and history management

Control how much historical state and transaction data to retain.

gcmode

Blockchain garbage collection mode, only relevant in state.scheme=hash. Options are “full” and “archive”. The default value is "full".

Syntax
Example
Environment Variable

--gcmode=<value>

--gcmode="full"

GETH_GCMODE="full"

history.chain

Blockchain history retention (“all” or “postmerge”). The default value is "all".

Syntax
Example
Environment Variable

--history.chain=<value>

--history.chain="all"

GETH_HISTORY_CHAIN="all"

history.logs

Number of recent blocks to maintain log search index for. The default is about one year (2350000 blocks), with 0 representing the entire chain.

Syntax
Example
Environment Variable

--history.logs=<value>

--history.logs=2350000

GETH_HISTORY_LOGS=2350000

history.logs.disable

Do not maintain log search index. The default value is false.

Syntax
Example
Environment Variable

--history.logs.disable

--history.logs.disable=false

GETH_HISTORY_LOGS_DISABLE=false

history.logs.export

Export checkpoints to file in go source file format.

Syntax
Example
Environment Variable

--history.logs.export <value>

--history.logs.export="/path/to/export.go"

GETH_HISTORY_LOGS_EXPORT="/path/to/export.go"

history.state

Number of recent blocks to retain state history for, only relevant in state.scheme=path. The default is 90000 blocks, with 0 representing the entire chain.

Syntax
Example
Environment Variable

--history.state=<value>

--history.state=90000

GETH_HISTORY_STATE=90000

history.transactions

Number of recent blocks to maintain transactions index for. The default is about one year (2350000 blocks), with 0 representing the entire chain.

Syntax
Example
Environment Variable

--history.transactions=<value>

--history.transactions=2350000

GETH_HISTORY_TRANSACTIONS=2350000

state.scheme

Scheme to use for storing Ethereum state. Options are ‘hash’ or ‘path’.

Syntax
Example
Environment Variable

--state.scheme=<value>

--state.scheme="hash"

GETH_STATE_SCHEME="hash"

syncmode

Blockchain sync mode. Options are “snap”, or “full”. The default value is "snap".

Syntax
Example
Environment Variable

--syncmode=<value>

--syncmode="full"

GETH_SYNCMODE="full"

Transaction pool - Blob transactions

Configure the blob transaction pool (EIP-4844).

blobpool.datacap

Disk space to allocate for pending blob transactions (soft limit). The default value is 2684354560.

Syntax
Example
Environment Variable

--blobpool.datacap=<value>

--blobpool.datacap=2684354560

GETH_BLOBPOOL_DATACAP=2684354560

blobpool.datadir

Data directory to store blob transactions in. The default value is "blobpool".

Syntax
Example
Environment Variable

--blobpool.datadir=<value>

--blobpool.datadir="blobpool"

GETH_BLOBPOOL_DATADIR="blobpool"

blobpool.pricebump

Price bump percentage to replace an already existing blob transaction. The default value is 100.

Syntax
Example
Environment Variable

--blobpool.pricebump=<value>

--blobpool.pricebump=100

GETH_BLOBPOOL_PRICEBUMP=100

Transaction pool - Standard transactions

Configure the standard EVM transaction pool.

txpool.accountqueue

Maximum number of non-executable transaction slots permitted per account. The default value is 64.

Syntax
Example
Environment Variable

--txpool.accountqueue=<value>

--txpool.accountqueue=64

GETH_TXPOOL_ACCOUNTQUEUE=64

txpool.accountslots

Minimum number of executable transaction slots guaranteed per account. The default value is 16.

Syntax
Example
Environment Variable

--txpool.accountslots=<value>

--txpool.accountslots=16

GETH_TXPOOL_ACCOUNTSLOTS=16

txpool.globalqueue

Maximum number of non-executable transaction slots for all accounts. The default value is 1024.

Syntax
Example
Environment Variable

--txpool.globalqueue=<value>

--txpool.globalqueue=1024

GETH_TXPOOL_GLOBALQUEUE=1024

txpool.globalslots

Maximum number of executable transaction slots for all accounts. The default value is 5120.

Syntax
Example
Environment Variable

--txpool.globalslots=<value>

--txpool.globalslots=5120

GETH_TXPOOL_GLOBALSLOTS=5120

txpool.journal

Disk journal for local transactions to survive node restarts. The default value is "transactions.rlp".

Syntax
Example
Environment Variable

--txpool.journal=<value>

--txpool.journal="transactions.rlp"

GETH_TXPOOL_JOURNAL="transactions.rlp"

txpool.journalremotes

Includes remote transactions in the journal. The default value is false.

Syntax
Example
Environment Variable

--txpool.journalremotes

--txpool.journalremotes=false

GETH_TXPOOL_JOURNALREMOTES=false

txpool.lifetime

Maximum amount of time non-executable transactions are queued. The default value is 3h0m0s.

Syntax
Example
Environment Variable

--txpool.lifetime=<value>

--txpool.lifetime=3h0m0s

GETH_TXPOOL_LIFETIME=3h0m0s

txpool.locals

Comma-separated accounts to treat as locals (no flush, priority inclusion).

Syntax
Example
Environment Variable

--txpool.locals=<value>

--txpool.locals="0x123...,0x456..."

GETH_TXPOOL_LOCALS="0x123...,0x456..."

txpool.maxtxgas

Maximum gas limit for individual transactions (0 = no limit). Transactions exceeding this limit will be rejected by the transaction pool. The default value is 0.

Syntax
Example
Environment Variable

--txpool.maxtxgas=<value>

--txpool.maxtxgas=0

GETH_TXPOOL_MAXTXGAS=0

txpool.nolocals

Disables price exemptions for locally submitted transactions. The default value is false.

Syntax
Example
Environment Variable

--txpool.nolocals

--txpool.nolocals=false

GETH_TXPOOL_NOLOCALS=false

txpool.pricebump

Price bump percentage to replace an already existing transaction. The default value is 10.

Syntax
Example
Environment Variable

--txpool.pricebump=<value>

--txpool.pricebump=10

GETH_TXPOOL_PRICEBUMP=10

txpool.pricelimit

Minimum gas price tip to enforce for acceptance into the pool. The default value is 1.

Syntax
Example
Environment Variable

--txpool.pricelimit=<value>

--txpool.pricelimit=1

GETH_TXPOOL_PRICELIMIT=1

txpool.rejournal

Time interval to regenerate the local transaction journal. The default value is 1h0m0s.

Syntax
Example
Environment Variable

--txpool.rejournal=<value>

--txpool.rejournal=1h0m0s

GETH_TXPOOL_REJOURNAL=1h0m0s

EVM configuration

Options for EVM debugging and instrumentation.

vmdebug

Record information useful for VM and contract debugging. The default value is false.

Syntax
Example
Environment Variable

--vmdebug

--vmdebug=false

GETH_VMDEBUG=false

vmtrace

Name of tracer which should record internal VM operations (costly).

Syntax
Example
Environment Variable

--vmtrace <value>

--vmtrace="callTracer"

GETH_VMTRACE="callTracer"

vmtrace.jsonconfig

Tracer configuration (JSON). The default value is "{}".

Syntax
Example
Environment Variable

--vmtrace.jsonconfig <value>

--vmtrace.jsonconfig="{}"

GETH_VMTRACE_JSONCONFIG="{}"

Getting Started

Guides

Tutorials

Reference

​Account management

​keystore

​lightkdf

​password

​pcscdpath

​signer

​usb

​RPC and API configuration

​authrpc.addr

​authrpc.jwtsecret

​authrpc.port

​authrpc.vhosts

​exec

​graphql

​graphql.corsdomain

​graphql.vhosts

​header

​http

​http.addr

​http.api

​http.corsdomain

​http.port

​http.rpcprefix`\

​http.vhosts

​ipcdisable

​ipcpath

​jspath

​preload

​rpc.allow-unprotected-txs

​rpc.batch-request-limit

​rpc.batch-response-max-size

​rpc.evmtimeout

​rpc.gascap

​rpc.txfeecap

​ws

​ws.addr

​ws.api

​ws.origins

​ws.port

​ws.rpcprefix

​Development Chain

​dev

​dev.gaslimit

​dev.period

​Chain and network selection

​bloomfilter.size

​config

​datadir

​datadir.ancient

​datadir.era

​datadir.minfreedisk

​db.engine

​eth.requiredblocks

​exitwhensynced

​holesky

​hoodi

​mainnet

​networkid

​op-network, beta.op-network

​override.cancun

​override.canyon

​override.ecotone

​override.fjord

​override.granite

​override.holocene

​override.interop

​override.isthmus

​override.jovian

​override.osaka

​override.verkle

​sepolia

​snapshot

​Gas price oracle

​gpo.blocks

​gpo.ignoreprice

​gpo.maxprice

Account management

keystore

lightkdf

password

pcscdpath

signer

usb

RPC and API configuration

authrpc.addr

authrpc.jwtsecret

authrpc.port

authrpc.vhosts

exec

graphql

graphql.corsdomain

graphql.vhosts

header

http

http.addr

http.api

http.corsdomain

http.port

http.rpcprefix`\

http.vhosts

ipcdisable

ipcpath

jspath

preload

rpc.allow-unprotected-txs

rpc.batch-request-limit

rpc.batch-response-max-size

rpc.evmtimeout

rpc.gascap

rpc.txfeecap

ws

ws.addr

ws.api

ws.origins

ws.port

ws.rpcprefix

Development Chain

dev

dev.gaslimit

dev.period

Chain and network selection

bloomfilter.size

config

datadir

datadir.ancient

datadir.era

datadir.minfreedisk

db.engine

eth.requiredblocks

exitwhensynced

holesky

hoodi

mainnet

networkid

op-network, beta.op-network

override.cancun

override.canyon

override.ecotone

override.fjord

override.granite

override.holocene

`override.interop`

override.isthmus

override.jovian

override.osaka

override.verkle

sepolia

`snapshot`

Gas price oracle

gpo.blocks

gpo.ignoreprice

gpo.maxprice

gpo.minsuggestedpriorityfee

gpo.percentile

Logging and debugging

go-execution-trace