forks/go-ethereum
1
0
Fork 1
mirror of https://github.com/ethereum/go-ethereum.git synced 2026-05-14 03:56:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update CLI args as well as custom network documentation (#28167)

Browse source 
* updating cli flags

* fix newline
This commit is contained in:
Parithosh Jayanthi 2023-09-20 18:29:26 +02:00 committed by GitHub
parent 7ebc5d15da
commit 41ce10d5cd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 266 additions and 199 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

460
docs/fundamentals/command-line-options.md
View file

@ -27,7 +27,7 @@ USAGE:
geth [global options] command [command options] [arguments...] geth [global options] command [command options] [arguments...]
VERSION: VERSION:
1.11.5-unstable-f86913bc-20230315 1.13.1-stable-3f40e65c
COMMANDS: COMMANDS:
account Manage accounts account Manage accounts
@ -54,68 +54,89 @@ COMMANDS:
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
GLOBAL OPTIONS: GLOBAL OPTIONS:
--log.rotate (default: false) ($GETH_LOG_ROTATE)
Enables log file rotation
ACCOUNT ACCOUNT
--allow-insecure-unlock (default: false)
--allow-insecure-unlock (default: false) ($GETH_ALLOW_INSECURE_UNLOCK)
Allow insecure account unlocking when account-related RPCs are exposed by http Allow insecure account unlocking when account-related RPCs are exposed by http
--keystore value --keystore value ($GETH_KEYSTORE)
Directory for the keystore (default = inside the datadir) Directory for the keystore (default = inside the datadir)
--lightkdf (default: false) --lightkdf (default: false) ($GETH_LIGHTKDF)
Reduce key-derivation RAM & CPU usage at some expense of KDF strength Reduce key-derivation RAM & CPU usage at some expense of KDF strength
--password value --password value ($GETH_PASSWORD)
Password file to use for non-interactive password input Password file to use for non-interactive password input
--pcscdpath value --pcscdpath value (default: "/run/pcscd/pcscd.comm") ($GETH_PCSCDPATH)
Path to the smartcard daemon (pcscd) socket file Path to the smartcard daemon (pcscd) socket file
--signer value --signer value ($GETH_SIGNER)
External signer (url or path to ipc file) External signer (url or path to ipc file)
--unlock value --unlock value ($GETH_UNLOCK)
Comma separated list of accounts to unlock Comma separated list of accounts to unlock
--usb (default: false) --usb (default: false) ($GETH_USB)
Enable monitoring and management of USB hardware wallets Enable monitoring and management of USB hardware wallets
ALIASED (deprecated) ALIASED (deprecated)
--nousb (default: false)
--cache.trie.journal value ($GETH_CACHE_TRIE_JOURNAL)
Disk journal directory for trie cache to survive node restarts
--cache.trie.rejournal value (default: 0s) ($GETH_CACHE_TRIE_REJOURNAL)
Time interval to regenerate the trie cache journal
--nousb (default: false) ($GETH_NOUSB)
Disables monitoring for and managing USB hardware wallets (deprecated) Disables monitoring for and managing USB hardware wallets (deprecated)
--whitelist value --txlookuplimit value (default: 2350000) ($GETH_TXLOOKUPLIMIT)
Number of recent blocks to maintain transactions index for (default = about one
year, 0 = entire chain) (deprecated, use history.transactions instead)
--v5disc (default: false) ($GETH_V5DISC)
Enables the experimental RLPx V5 (Topic Discovery) mechanism (deprecated, use
--discv5 instead)
--whitelist value ($GETH_WHITELIST)
Comma separated block number-to-hash mappings to enforce (<number>=<hash>) Comma separated block number-to-hash mappings to enforce (<number>=<hash>)
(deprecated in favor of --eth.requiredblocks) (deprecated in favor of --eth.requiredblocks)
API AND CONSOLE API AND CONSOLE
--authrpc.addr value (default: "localhost")
--authrpc.addr value (default: "localhost") ($GETH_AUTHRPC_ADDR)
Listening address for authenticated APIs Listening address for authenticated APIs
--authrpc.jwtsecret value --authrpc.jwtsecret value ($GETH_AUTHRPC_JWTSECRET)
Path to a JWT secret to use for authenticated RPC endpoints Path to a JWT secret to use for authenticated RPC endpoints
--authrpc.port value (default: 8551) --authrpc.port value (default: 8551) ($GETH_AUTHRPC_PORT)
Listening port for authenticated APIs Listening port for authenticated APIs
--authrpc.vhosts value (default: "localhost") --authrpc.vhosts value (default: "localhost") ($GETH_AUTHRPC_VHOSTS)
Comma separated list of virtual hostnames from which to accept requests (server Comma separated list of virtual hostnames from which to accept requests (server
enforced). Accepts '*' wildcard. enforced). Accepts '*' wildcard.
--exec value --exec value ($GETH_EXEC)
Execute JavaScript statement Execute JavaScript statement
--graphql (default: false) --graphql (default: false) ($GETH_GRAPHQL)
Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if Enable GraphQL on the HTTP-RPC server. Note that GraphQL can only be started if
an HTTP server is started as well. an HTTP server is started as well.
--graphql.corsdomain value --graphql.corsdomain value ($GETH_GRAPHQL_CORSDOMAIN)
Comma separated list of domains from which to accept cross origin requests Comma separated list of domains from which to accept cross origin requests
(browser enforced) (browser enforced)
--graphql.vhosts value (default: "localhost") --graphql.vhosts value (default: "localhost") ($GETH_GRAPHQL_VHOSTS)
Comma separated list of virtual hostnames from which to accept requests (server Comma separated list of virtual hostnames from which to accept requests (server
enforced). Accepts '*' wildcard. enforced). Accepts '*' wildcard.
@ -123,452 +144,493 @@ GLOBAL OPTIONS:
Pass custom headers to the RPC server when using --remotedb or the geth attach Pass custom headers to the RPC server when using --remotedb or the geth attach
console. This flag can be given multiple times. console. This flag can be given multiple times.
--http (default: false) --http (default: false) ($GETH_HTTP)
Enable the HTTP-RPC server Enable the HTTP-RPC server
--http.addr value (default: "localhost") --http.addr value (default: "localhost") ($GETH_HTTP_ADDR)
HTTP-RPC server listening interface HTTP-RPC server listening interface
--http.api value --http.api value ($GETH_HTTP_API)
API's offered over the HTTP-RPC interface API's offered over the HTTP-RPC interface
--http.corsdomain value --http.corsdomain value ($GETH_HTTP_CORSDOMAIN)
Comma separated list of domains from which to accept cross origin requests Comma separated list of domains from which to accept cross origin requests
(browser enforced) (browser enforced)
--http.port value (default: 8545) --http.port value (default: 8545) ($GETH_HTTP_PORT)
HTTP-RPC server listening port HTTP-RPC server listening port
--http.rpcprefix value --http.rpcprefix value ($GETH_HTTP_RPCPREFIX)
HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all HTTP path path prefix on which JSON-RPC is served. Use '/' to serve on all
paths. paths.
--http.vhosts value (default: "localhost") --http.vhosts value (default: "localhost") ($GETH_HTTP_VHOSTS)
Comma separated list of virtual hostnames from which to accept requests (server Comma separated list of virtual hostnames from which to accept requests (server
enforced). Accepts '*' wildcard. enforced). Accepts '*' wildcard.
--ipcdisable (default: false) --ipcdisable (default: false) ($GETH_IPCDISABLE)
Disable the IPC-RPC server Disable the IPC-RPC server
--ipcpath value --ipcpath value ($GETH_IPCPATH)
Filename for IPC socket/pipe within the datadir (explicit paths escape it) Filename for IPC socket/pipe within the datadir (explicit paths escape it)
--jspath value (default: .) --jspath value (default: .) ($GETH_JSPATH)
JavaScript root path for `loadScript` JavaScript root path for `loadScript`
--preload value --preload value ($GETH_PRELOAD)
Comma separated list of JavaScript files to preload into the console Comma separated list of JavaScript files to preload into the console
--rpc.allow-unprotected-txs (default: false) --rpc.allow-unprotected-txs (default: false) ($GETH_RPC_ALLOW_UNPROTECTED_TXS)
Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC Allow for unprotected (non EIP155 signed) transactions to be submitted via RPC
--rpc.enabledeprecatedpersonal (default: false) --rpc.batch-request-limit value (default: 1000) ($GETH_RPC_BATCH_REQUEST_LIMIT)
Maximum number of requests in a batch
--rpc.batch-response-max-size value (default: 25000000) ($GETH_RPC_BATCH_RESPONSE_MAX_SIZE)
Maximum number of bytes returned from a batched call
--rpc.enabledeprecatedpersonal (default: false) ($GETH_RPC_ENABLEDEPRECATEDPERSONAL)
Enables the (deprecated) personal namespace Enables the (deprecated) personal namespace
--rpc.evmtimeout value (default: 5s) --rpc.evmtimeout value (default: 5s) ($GETH_RPC_EVMTIMEOUT)
Sets a timeout used for eth_call (0=infinite) Sets a timeout used for eth_call (0=infinite)
--rpc.gascap value (default: 50000000) --rpc.gascap value (default: 50000000) ($GETH_RPC_GASCAP)
Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite) Sets a cap on gas that can be used in eth_call/estimateGas (0=infinite)
--rpc.txfeecap value (default: 1) --rpc.txfeecap value (default: 1)
Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 =
no cap) no cap)
--ws (default: false) --ws (default: false) ($GETH_WS)
Enable the WS-RPC server Enable the WS-RPC server
--ws.addr value (default: "localhost") --ws.addr value (default: "localhost") ($GETH_WS_ADDR)
WS-RPC server listening interface WS-RPC server listening interface
--ws.api value --ws.api value ($GETH_WS_API)
API's offered over the WS-RPC interface API's offered over the WS-RPC interface
--ws.origins value --ws.origins value ($GETH_WS_ORIGINS)
Origins from which to accept websockets requests Origins from which to accept websockets requests
--ws.port value (default: 8546) --ws.port value (default: 8546) ($GETH_WS_PORT)
WS-RPC server listening port WS-RPC server listening port
--ws.rpcprefix value --ws.rpcprefix value ($GETH_WS_RPCPREFIX)
HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths. HTTP path prefix on which JSON-RPC is served. Use '/' to serve on all paths.
DEVELOPER CHAIN DEVELOPER CHAIN
--dev (default: false)
--dev (default: false) ($GETH_DEV)
Ephemeral proof-of-authority network with a pre-funded developer account, mining Ephemeral proof-of-authority network with a pre-funded developer account, mining
enabled enabled
--dev.gaslimit value (default: 11500000) --dev.gaslimit value (default: 11500000) ($GETH_DEV_GASLIMIT)
Initial block gas limit Initial block gas limit
--dev.period value (default: 0) --dev.period value (default: 0) ($GETH_DEV_PERIOD)
Block period to use in developer mode (0 = mine only if transaction pending) Block period to use in developer mode (0 = mine only if transaction pending)
ETHEREUM ETHEREUM
--bloomfilter.size value (default: 2048)
--bloomfilter.size value (default: 2048) ($GETH_BLOOMFILTER_SIZE)
Megabytes of memory allocated to bloom-filter for pruning Megabytes of memory allocated to bloom-filter for pruning
--config value --config value ($GETH_CONFIG)
TOML configuration file TOML configuration file
--datadir value (default: /Users/fjl/Library/Ethereum) --datadir value (default: /root/.ethereum) ($GETH_DATADIR)
Data directory for the databases and keystore Data directory for the databases and keystore
--datadir.ancient value --datadir.ancient value ($GETH_DATADIR_ANCIENT)
Root directory for ancient data (default = inside chaindata) Root directory for ancient data (default = inside chaindata)
--datadir.minfreedisk value --datadir.minfreedisk value ($GETH_DATADIR_MINFREEDISK)
Minimum free disk space in MB, once reached triggers auto shut down (default = Minimum free disk space in MB, once reached triggers auto shut down (default =
--cache.gc converted to MB, 0 = disabled) --cache.gc converted to MB, 0 = disabled)
--db.engine value (default: "leveldb") --db.engine value ($GETH_DB_ENGINE)
Backing database implementation to use ('leveldb' or 'pebble') Backing database implementation to use ('pebble' or 'leveldb')
--eth.requiredblocks value --eth.requiredblocks value ($GETH_ETH_REQUIREDBLOCKS)
Comma separated block number-to-hash mappings to require for peering Comma separated block number-to-hash mappings to require for peering
(<number>=<hash>) (<number>=<hash>)
--exitwhensynced (default: false) --exitwhensynced (default: false) ($GETH_EXITWHENSYNCED)
Exits after block synchronisation completes Exits after block synchronisation completes
--gcmode value (default: "full") --goerli (default: false) ($GETH_GOERLI)
Blockchain garbage collection mode ("full", "archive")
--goerli (default: false)
Görli network: pre-configured proof-of-authority test network Görli network: pre-configured proof-of-authority test network
--mainnet (default: false) --holesky (default: false) ($GETH_HOLESKY)
Holesky network: pre-configured proof-of-stake test network
--mainnet (default: false) ($GETH_MAINNET)
Ethereum mainnet Ethereum mainnet
--networkid value (default: 1) --networkid value (default: 1) ($GETH_NETWORKID)
Explicitly set network id (integer)(For testnets: use --rinkeby, --goerli, Explicitly set network id (integer)(For testnets: use --goerli, --sepolia,
--sepolia instead) --holesky instead)
--override.shanghai value (default: 0) --override.cancun value (default: 0) ($GETH_OVERRIDE_CANCUN)
Manually specify the Shanghai fork timestamp, overriding the bundled setting Manually specify the Cancun fork timestamp, overriding the bundled setting
--rinkeby (default: false) --override.verkle value (default: 0) ($GETH_OVERRIDE_VERKLE)
Rinkeby network: pre-configured proof-of-authority test network Manually specify the Verkle fork timestamp, overriding the bundled setting
--sepolia (default: false) --sepolia (default: false) ($GETH_SEPOLIA)
Sepolia network: pre-configured proof-of-work test network Sepolia network: pre-configured proof-of-work test network
--snapshot (default: true) --snapshot (default: true) ($GETH_SNAPSHOT)
Enables snapshot-database mode (default = enable) Enables snapshot-database mode (default = enable)
--syncmode value (default: snap)
Blockchain sync mode ("snap", "full" or "light")
--txlookuplimit value (default: 2350000)
Number of recent blocks to maintain transactions index for (default = about one
year, 0 = entire chain)
GAS PRICE ORACLE GAS PRICE ORACLE
--gpo.blocks value (default: 20)
--gpo.blocks value (default: 20) ($GETH_GPO_BLOCKS)
Number of recent blocks to check for gas prices Number of recent blocks to check for gas prices
--gpo.ignoreprice value (default: 2) --gpo.ignoreprice value (default: 2)
Gas price below which gpo will ignore transactions Gas price below which gpo will ignore transactions
--gpo.maxprice value (default: 500000000000) --gpo.maxprice value (default: 500000000000)
Maximum transaction priority fee (or gasprice before London fork) to be Maximum transaction priority fee (or gasprice before London fork) to be
recommended by gpo recommended by gpo
--gpo.percentile value (default: 60) --gpo.percentile value (default: 60) ($GETH_GPO_PERCENTILE)
Suggested gas price is the given percentile of a set of recent transaction gas Suggested gas price is the given percentile of a set of recent transaction gas
prices prices
LIGHT CLIENT LIGHT CLIENT
--light.egress value (default: 0)
--light.egress value (default: 0) ($GETH_LIGHT_EGRESS)
Outgoing bandwidth limit for serving light clients (kilobytes/sec, 0 = Outgoing bandwidth limit for serving light clients (kilobytes/sec, 0 =
unlimited) unlimited)
--light.ingress value (default: 0) --light.ingress value (default: 0) ($GETH_LIGHT_INGRESS)
Incoming bandwidth limit for serving light clients (kilobytes/sec, 0 = Incoming bandwidth limit for serving light clients (kilobytes/sec, 0 =
unlimited) unlimited)
--light.maxpeers value (default: 100) --light.maxpeers value (default: 100) ($GETH_LIGHT_MAXPEERS)
Maximum number of light clients to serve, or light servers to attach to Maximum number of light clients to serve, or light servers to attach to
--light.nopruning (default: false) --light.nopruning (default: false) ($GETH_LIGHT_NOPRUNING)
Disable ancient light chain data pruning Disable ancient light chain data pruning
--light.nosyncserve (default: false) --light.nosyncserve (default: false) ($GETH_LIGHT_NOSYNCSERVE)
Enables serving light clients before syncing Enables serving light clients before syncing
--light.serve value (default: 0) --light.serve value (default: 0) ($GETH_LIGHT_SERVE)
Maximum percentage of time allowed for serving LES requests (multi-threaded Maximum percentage of time allowed for serving LES requests (multi-threaded
processing allows values over 100) processing allows values over 100)
--ulc.fraction value (default: 75)
Minimum % of trusted ultra-light servers required to announce a new head
--ulc.onlyannounce (default: false)
Ultra light server sends announcements only
--ulc.servers value
List of trusted ultra-light servers
LOGGING AND DEBUGGING LOGGING AND DEBUGGING
--fakepow (default: false)
Disables proof-of-work verification
--log.backtrace value --log.backtrace value ($GETH_LOG_BACKTRACE)
Request a stack trace at a specific logging statement (e.g. "block.go:271") Request a stack trace at a specific logging statement (e.g. "block.go:271")
--log.debug (default: false) --log.compress (default: false) ($GETH_LOG_COMPRESS)
Compress the log files
--log.debug (default: false) ($GETH_LOG_DEBUG)
Prepends log messages with call-site location (file and line number) Prepends log messages with call-site location (file and line number)
--log.file value --log.file value ($GETH_LOG_FILE)
Write logs to a file Write logs to a file
--log.json (default: false) --log.format value ($GETH_LOG_FORMAT)
Format logs with JSON Log format to use (json|logfmt|terminal)
--nocompaction (default: false) --log.maxage value (default: 30) ($GETH_LOG_MAXAGE)
Disables db compaction after import Maximum number of days to retain a log file
--pprof (default: false) --log.maxbackups value (default: 10) ($GETH_LOG_MAXBACKUPS)
Enable the pprof HTTP server Maximum number of log files to retain
--pprof.addr value (default: "127.0.0.1") --log.maxsize value (default: 100) ($GETH_LOG_MAXSIZE)
pprof HTTP server listening interface Maximum size in MBs of a single log file
--pprof.blockprofilerate value (default: 0) --log.vmodule value ($GETH_LOG_VMODULE)
Turn on block profiling with the given rate
--pprof.cpuprofile value
Write CPU profile to the given file
--pprof.memprofilerate value (default: 524288)
Turn on memory profiling with the given rate
--pprof.port value (default: 6060)
pprof HTTP server listening port
--remotedb value
URL for remote database
--trace value
Write execution trace to the given file
--verbosity value (default: 3)
Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail
--vmodule value
Per-module verbosity: comma-separated list of <pattern>=<level> (e.g. Per-module verbosity: comma-separated list of <pattern>=<level> (e.g.
eth/*=5,p2p=4) eth/*=5,p2p=4)
--nocompaction (default: false) ($GETH_NOCOMPACTION)
Disables db compaction after import
--pprof (default: false) ($GETH_PPROF)
Enable the pprof HTTP server
--pprof.addr value (default: "127.0.0.1") ($GETH_PPROF_ADDR)
pprof HTTP server listening interface
--pprof.blockprofilerate value (default: 0) ($GETH_PPROF_BLOCKPROFILERATE)
Turn on block profiling with the given rate
--pprof.cpuprofile value ($GETH_PPROF_CPUPROFILE)
Write CPU profile to the given file
--pprof.memprofilerate value (default: 524288) ($GETH_PPROF_MEMPROFILERATE)
Turn on memory profiling with the given rate
--pprof.port value (default: 6060) ($GETH_PPROF_PORT)
pprof HTTP server listening port
--remotedb value ($GETH_REMOTEDB)
URL for remote database
--trace value ($GETH_TRACE)
Write execution trace to the given file
--verbosity value (default: 3) ($GETH_VERBOSITY)
Logging verbosity: 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail
METRICS AND STATS METRICS AND STATS
--ethstats value
--ethstats value ($GETH_ETHSTATS)
Reporting URL of a ethstats service (nodename:secret@host:port) Reporting URL of a ethstats service (nodename:secret@host:port)
--metrics (default: false) --metrics (default: false) ($GETH_METRICS)
Enable metrics collection and reporting Enable metrics collection and reporting
--metrics.addr value --metrics.addr value ($GETH_METRICS_ADDR)
Enable stand-alone metrics HTTP server listening interface. Enable stand-alone metrics HTTP server listening interface.
--metrics.expensive (default: false) --metrics.expensive (default: false) ($GETH_METRICS_EXPENSIVE)
Enable expensive metrics collection and reporting Enable expensive metrics collection and reporting
--metrics.influxdb (default: false) --metrics.influxdb (default: false) ($GETH_METRICS_INFLUXDB)
Enable metrics export/push to an external InfluxDB database Enable metrics export/push to an external InfluxDB database
--metrics.influxdb.bucket value (default: "geth") --metrics.influxdb.bucket value (default: "geth") ($GETH_METRICS_INFLUXDB_BUCKET)
InfluxDB bucket name to push reported metrics to (v2 only) InfluxDB bucket name to push reported metrics to (v2 only)
--metrics.influxdb.database value (default: "geth") --metrics.influxdb.database value (default: "geth") ($GETH_METRICS_INFLUXDB_DATABASE)
InfluxDB database name to push reported metrics to InfluxDB database name to push reported metrics to
--metrics.influxdb.endpoint value (default: "http://localhost:8086") --metrics.influxdb.endpoint value (default: "http://localhost:8086") ($GETH_METRICS_INFLUXDB_ENDPOINT)
InfluxDB API endpoint to report metrics to InfluxDB API endpoint to report metrics to
--metrics.influxdb.organization value (default: "geth") --metrics.influxdb.organization value (default: "geth") ($GETH_METRICS_INFLUXDB_ORGANIZATION)
InfluxDB organization name (v2 only) InfluxDB organization name (v2 only)
--metrics.influxdb.password value (default: "test") --metrics.influxdb.password value (default: "test") ($GETH_METRICS_INFLUXDB_PASSWORD)
Password to authorize access to the database Password to authorize access to the database
--metrics.influxdb.tags value (default: "host=localhost") --metrics.influxdb.tags value (default: "host=localhost") ($GETH_METRICS_INFLUXDB_TAGS)
Comma-separated InfluxDB tags (key/values) attached to all measurements Comma-separated InfluxDB tags (key/values) attached to all measurements
--metrics.influxdb.token value (default: "test") --metrics.influxdb.token value (default: "test") ($GETH_METRICS_INFLUXDB_TOKEN)
Token to authorize access to the database (v2 only) Token to authorize access to the database (v2 only)
--metrics.influxdb.username value (default: "test") --metrics.influxdb.username value (default: "test") ($GETH_METRICS_INFLUXDB_USERNAME)
Username to authorize access to the database Username to authorize access to the database
--metrics.influxdbv2 (default: false) --metrics.influxdbv2 (default: false) ($GETH_METRICS_INFLUXDBV2)
Enable metrics export/push to an external InfluxDB v2 database Enable metrics export/push to an external InfluxDB v2 database
--metrics.port value (default: 6060) --metrics.port value (default: 6060) ($GETH_METRICS_PORT)
Metrics HTTP server listening port. Metrics HTTP server listening port.
Please note that --metrics.addr must be set Please note that --metrics.addr must be set
to start the server. to start the server.
MINER MINER
--mine (default: false)
--mine (default: false) ($GETH_MINE)
Enable mining Enable mining
--miner.etherbase value --miner.etherbase value ($GETH_MINER_ETHERBASE)
0x prefixed public address for block mining rewards 0x prefixed public address for block mining rewards
--miner.extradata value --miner.extradata value ($GETH_MINER_EXTRADATA)
Block extra data set by the miner (default = client version) Block extra data set by the miner (default = client version)
--miner.gaslimit value (default: 30000000) --miner.gaslimit value (default: 30000000) ($GETH_MINER_GASLIMIT)
Target gas ceiling for mined blocks Target gas ceiling for mined blocks
--miner.gasprice value (default: 0) --miner.gasprice value (default: 0) ($GETH_MINER_GASPRICE)
Minimum gas price for mining a transaction Minimum gas price for mining a transaction
--miner.newpayload-timeout value (default: 2s) --miner.newpayload-timeout value (default: 2s) ($GETH_MINER_NEWPAYLOAD_TIMEOUT)
Specify the maximum time allowance for creating a new payload Specify the maximum time allowance for creating a new payload
--miner.recommit value (default: 2s) ($GETH_MINER_RECOMMIT)
--miner.recommit value (default: 2s)
Time interval to recreate the block being mined Time interval to recreate the block being mined
MISC MISC
--help, -h (default: false)
--help, -h (default: false)
show help show help
--synctarget value --synctarget value ($GETH_SYNCTARGET)
File for containing the hex-encoded block-rlp as sync target(dev feature) File for containing the hex-encoded block-rlp as sync target(dev feature)
--version, -v (default: false) --version, -v (default: false)
print the version print the version
NETWORKING NETWORKING
--bootnodes value
--bootnodes value ($GETH_BOOTNODES)
Comma separated enode URLs for P2P discovery bootstrap Comma separated enode URLs for P2P discovery bootstrap
--discovery.dns value --discovery.dns value ($GETH_DISCOVERY_DNS)
Sets DNS discovery entry points (use "" to disable DNS) Sets DNS discovery entry points (use "" to disable DNS)
--discovery.port value (default: 30303) --discovery.port value (default: 30303) ($GETH_DISCOVERY_PORT)
Use a custom UDP port for P2P discovery Use a custom UDP port for P2P discovery
--identity value --discovery.v4, --discv4 (default: true) ($GETH_DISCOVERY_V4)
Enables the V4 discovery mechanism
--discovery.v5, --discv5 (default: false) ($GETH_DISCOVERY_V5)
Enables the experimental RLPx V5 (Topic Discovery) mechanism
--identity value ($GETH_IDENTITY)
Custom node name Custom node name
--maxpeers value (default: 50) --maxpeers value (default: 50) ($GETH_MAXPEERS)
Maximum number of network peers (network disabled if set to 0) Maximum number of network peers (network disabled if set to 0)
--maxpendpeers value (default: 0) --maxpendpeers value (default: 0) ($GETH_MAXPENDPEERS)
Maximum number of pending connection attempts (defaults used if set to 0) Maximum number of pending connection attempts (defaults used if set to 0)
--nat value (default: "any") --nat value (default: "any") ($GETH_NAT)
NAT port mapping mechanism (any|none|upnp|pmp|pmp:<IP>|extip:<IP>) NAT port mapping mechanism (any|none|upnp|pmp|pmp:<IP>|extip:<IP>)
--netrestrict value --netrestrict value ($GETH_NETRESTRICT)
Restricts network communication to the given IP networks (CIDR masks) Restricts network communication to the given IP networks (CIDR masks)
--nodekey value --nodekey value ($GETH_NODEKEY)
P2P node key file P2P node key file
--nodekeyhex value --nodekeyhex value ($GETH_NODEKEYHEX)
P2P node key as hex (for testing) P2P node key as hex (for testing)
--nodiscover (default: false) --nodiscover (default: false) ($GETH_NODISCOVER)
Disables the peer discovery mechanism (manual peer addition) Disables the peer discovery mechanism (manual peer addition)
--port value (default: 30303) --port value (default: 30303) ($GETH_PORT)
Network listening port Network listening port
--v5disc (default: false)
Enables the experimental RLPx V5 (Topic Discovery) mechanism
PERFORMANCE TUNING PERFORMANCE TUNING
--cache value (default: 1024)
--cache value (default: 1024) ($GETH_CACHE)
Megabytes of memory allocated to internal caching (default = 4096 mainnet full Megabytes of memory allocated to internal caching (default = 4096 mainnet full
node, 128 light mode) node, 128 light mode)
--cache.blocklogs value (default: 32) --cache.blocklogs value (default: 32) ($GETH_CACHE_BLOCKLOGS)
Size (in number of blocks) of the log cache for filtering Size (in number of blocks) of the log cache for filtering
--cache.database value (default: 50) --cache.database value (default: 50) ($GETH_CACHE_DATABASE)
Percentage of cache memory allowance to use for database io Percentage of cache memory allowance to use for database io
--cache.gc value (default: 25) --cache.gc value (default: 25) ($GETH_CACHE_GC)
Percentage of cache memory allowance to use for trie pruning (default = 25% full Percentage of cache memory allowance to use for trie pruning (default = 25% full
mode, 0% archive mode) mode, 0% archive mode)
--cache.noprefetch (default: false) --cache.noprefetch (default: false) ($GETH_CACHE_NOPREFETCH)
Disable heuristic state prefetch during block import (less CPU and disk IO, more Disable heuristic state prefetch during block import (less CPU and disk IO, more
time waiting for data) time waiting for data)
--cache.preimages (default: false) --cache.preimages (default: false) ($GETH_CACHE_PREIMAGES)
Enable recording the SHA3/keccak preimages of trie keys Enable recording the SHA3/keccak preimages of trie keys
--cache.snapshot value (default: 10) --cache.snapshot value (default: 10) ($GETH_CACHE_SNAPSHOT)
Percentage of cache memory allowance to use for snapshot caching (default = 10% Percentage of cache memory allowance to use for snapshot caching (default = 10%
full mode, 20% archive mode) full mode, 20% archive mode)
--cache.trie value (default: 15) --cache.trie value (default: 15) ($GETH_CACHE_TRIE)
Percentage of cache memory allowance to use for trie caching (default = 15% full Percentage of cache memory allowance to use for trie caching (default = 15% full
mode, 30% archive mode) mode, 30% archive mode)
--cache.trie.journal value (default: "triecache") --crypto.kzg value (default: "gokzg") ($GETH_CRYPTO_KZG)
Disk journal directory for trie cache to survive node restarts KZG library implementation to use; gokzg (recommended) or ckzg
--cache.trie.rejournal value (default: 1h0m0s) --fdlimit value (default: 0) ($GETH_FDLIMIT)
Time interval to regenerate the trie cache journal
--fdlimit value (default: 0)
Raise the open file descriptor resource limit (default = system fd limit) Raise the open file descriptor resource limit (default = system fd limit)
TRANSACTION POOL STATE HISTORY MANAGEMENT
--txpool.accountqueue value (default: 64)
--gcmode value (default: "full") ($GETH_GCMODE)
Blockchain garbage collection mode, only relevant in state.scheme=hash ("full",
"archive")
--history.state value (default: 90000) ($GETH_HISTORY_STATE)
Number of recent blocks to retain state history for (default = 90,000 blocks, 0
= entire chain)
--history.transactions value (default: 2350000) ($GETH_HISTORY_TRANSACTIONS)
Number of recent blocks to maintain transactions index for (default = about one
year, 0 = entire chain)
--state.scheme value (default: "hash") ($GETH_STATE_SCHEME)
Scheme to use for storing ethereum state ('hash' or 'path')
--syncmode value (default: snap) ($GETH_SYNCMODE)
Blockchain sync mode ("snap", "full" or "light")
TRANSACTION POOL (BLOB)
--blobpool.datacap value (default: 10737418240) ($GETH_BLOBPOOL_DATACAP)
Disk space to allocate for pending blob transactions (soft limit)
--blobpool.datadir value (default: "blobpool") ($GETH_BLOBPOOL_DATADIR)
Data directory to store blob transactions in
--blobpool.pricebump value (default: 100) ($GETH_BLOBPOOL_PRICEBUMP)
Price bump percentage to replace an already existing blob transaction
TRANSACTION POOL (EVM)
--txpool.accountqueue value (default: 64) ($GETH_TXPOOL_ACCOUNTQUEUE)
Maximum number of non-executable transaction slots permitted per account Maximum number of non-executable transaction slots permitted per account
--txpool.accountslots value (default: 16) --txpool.accountslots value (default: 16) ($GETH_TXPOOL_ACCOUNTSLOTS)
Minimum number of executable transaction slots guaranteed per account Minimum number of executable transaction slots guaranteed per account
--txpool.globalqueue value (default: 1024) --txpool.globalqueue value (default: 1024) ($GETH_TXPOOL_GLOBALQUEUE)
Maximum number of non-executable transaction slots for all accounts Maximum number of non-executable transaction slots for all accounts
--txpool.globalslots value (default: 5120) --txpool.globalslots value (default: 5120) ($GETH_TXPOOL_GLOBALSLOTS)
Maximum number of executable transaction slots for all accounts Maximum number of executable transaction slots for all accounts
--txpool.journal value (default: "transactions.rlp") --txpool.journal value (default: "transactions.rlp") ($GETH_TXPOOL_JOURNAL)
Disk journal for local transaction to survive node restarts Disk journal for local transaction to survive node restarts
--txpool.lifetime value (default: 3h0m0s) --txpool.lifetime value (default: 3h0m0s) ($GETH_TXPOOL_LIFETIME)
Maximum amount of time non-executable transaction are queued Maximum amount of time non-executable transaction are queued
--txpool.locals value --txpool.locals value ($GETH_TXPOOL_LOCALS)
Comma separated accounts to treat as locals (no flush, priority inclusion) Comma separated accounts to treat as locals (no flush, priority inclusion)
--txpool.nolocals (default: false) --txpool.nolocals (default: false) ($GETH_TXPOOL_NOLOCALS)
Disables price exemptions for locally submitted transactions Disables price exemptions for locally submitted transactions
--txpool.pricebump value (default: 10) --txpool.pricebump value (default: 10) ($GETH_TXPOOL_PRICEBUMP)
Price bump percentage to replace an already existing transaction Price bump percentage to replace an already existing transaction
--txpool.pricelimit value (default: 1) --txpool.pricelimit value (default: 1) ($GETH_TXPOOL_PRICELIMIT)
Minimum gas price limit to enforce for acceptance into the pool Minimum gas price tip to enforce for acceptance into the pool
--txpool.rejournal value (default: 1h0m0s) --txpool.rejournal value (default: 1h0m0s) ($GETH_TXPOOL_REJOURNAL)
Time interval to regenerate the local transaction journal Time interval to regenerate the local transaction journal
VIRTUAL MACHINE VIRTUAL MACHINE
--vmdebug (default: false)
--vmdebug (default: false) ($GETH_VMDEBUG)
Record information useful for VM and contract debugging Record information useful for VM and contract debugging

5
docs/fundamentals/private-network.md
View file

@ -127,6 +127,11 @@ When Geth is started using `--datadir data` the genesis block defined in `genesi
geth --datadir data --networkid 12345 geth --datadir data --networkid 12345
``` ```
The default value for the storage scheme is `hash.` In case the plan is to use the `path` based storage scheme, the `--state.scheme=path` needs to be passed during the `init` step. This will ensure that the database is initialized with the correct storage scheme for the network.
```sh
geth --state.scheme=path init --datadir data genesis.json
```
### Scheduling Hard Forks {#scheduling-hard-forks} ### Scheduling Hard Forks {#scheduling-hard-forks}
As Ethereum protocol development progresses, new features become available. To enable these features on an existing private network, a hard fork must be scheduled. To do this, a future block number must be chosen which determines precisely when the hard fork will activate. Continuing the `genesis.json` example above and assuming the current block number is 35421, a hard fork might be scheduled for block 40000. This hard fork might upgrade the network to conform to the 'London' specs. First, all the Geth instances on the private network must be recent enough to support the specific hard fork. If so, `genesis.json` can be updated so that the `londonBlock` key gets the value 40000. The Geth instances are then shut down and `geth init` is run to update their configuration. When the nodes are restarted they will pick up where they left off and run normally until block 40000, at which point they will automatically upgrade. As Ethereum protocol development progresses, new features become available. To enable these features on an existing private network, a hard fork must be scheduled. To do this, a future block number must be chosen which determines precisely when the hard fork will activate. Continuing the `genesis.json` example above and assuming the current block number is 35421, a hard fork might be scheduled for block 40000. This hard fork might upgrade the network to conform to the 'London' specs. First, all the Geth instances on the private network must be recent enough to support the specific hard fork. If so, `genesis.json` can be updated so that the `londonBlock` key gets the value 40000. The Geth instances are then shut down and `geth init` is run to update their configuration. When the nodes are restarted they will pick up where they left off and run normally until block 40000, at which point they will automatically upgrade.