Skip to content

Commit 99101ac

Browse files
committed
docs: fix flag defaults and add missing flags in configuring-erigon README
1 parent 8435864 commit 99101ac

File tree

1 file changed

+31
-11
lines changed
  • docs/gitbook/src/fundamentals/configuring-erigon

1 file changed

+31
-11
lines changed

docs/gitbook/src/fundamentals/configuring-erigon/README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ These flags cover the general behavior and configuration of the Erigon client.
3838
* Default: `false`, means that Caplin is enabled.
3939
* `--override.osaka value`: Manually specifies the Osaka fork time.
4040
* Default: `0`
41+
* `--override.amsterdam value`: Manually specifies the Amsterdam fork time.
42+
* Default: `0`
4143
* `--vmdebug`: Records information for VM and contract debugging.
4244
* Default: `false`
4345
* `--gdbme`: Restarts Erigon under gdb for debugging.
@@ -80,9 +82,7 @@ Flags for managing how old chain data is handled and stored.
8082
* Default: `0`
8183
* `--prune.distance.blocks value`: Keeps block history for the latest `N` blocks.
8284
* Default: `0`
83-
* `--prune.experimental.include-commitment-history, --experimental.commitment-history`: Enables faster `eth_getProof` for executed blocks.
84-
* Default: `false`
85-
* `--prune.include-commitment-history` : (experimental) Enables the storage of commitment history. When enabled, it allows for blazing fast retrieval of Merkle proofs for executed blocks using the `eth_getProof` JSON-RPC method.
85+
* `--prune.include-commitment-history, --prune.experimental.include-commitment-history, --experimental.commitment-history`: (experimental) Enables blazing fast `eth_getProof` for executed blocks by storing commitment history.
8686
* Default: `false`
8787
* `--snap.keepblocks`: Keeps ancient blocks in the database for debugging.
8888
* Default: `false`
@@ -139,13 +139,9 @@ These flags manage network connectivity, peer discovery, and traffic control.
139139
* `--nodiscover`: Disables peer discovery.
140140
* Default: `false`
141141
* `--discovery.v4`, `--discv4`: Enables the Node Discovery Protocol v4 (Discv4) for managed ENRs and topic discovery.
142-
* Default: `true`
142+
* Default: `false`
143143
* `--discovery.v5`, `--discv5`, `--v5disc`: Enables the Node Discovery Protocol v5 (Discv5) for managed ENRs and topic discovery.
144144
* Default: `true`
145-
* `--discovery.parallelism value`: The number of concurrent lookup requests allowed per discovery query.
146-
* Default: `3`
147-
* `**`--discovery.ban-threshold value`: The number of failed handshake attempts before an IP is temporarily blacklisted.
148-
* Default: `5`
149145
* `--netrestrict value`: Restricts network communication to specific IP networks.
150146
* `--nodekey value`: The P2P node key file.
151147
* `--nodekeyhex value`: The P2P node key as a hexadecimal string.
@@ -242,6 +238,15 @@ Flags for configuring various RPC servers and their behavior.
242238
* `--healthcheck`: Enables gRPC health checks.
243239
* Default: `false`
244240

241+
### MCP Server
242+
243+
Flags for configuring the Model Context Protocol (MCP) server.
244+
245+
* `--mcp.addr value`: The MCP server listening address.
246+
* Default: `127.0.0.1`
247+
* `--mcp.port value`: The MCP server listening port.
248+
* Default: `8553`
249+
245250
### Logging and Profiling
246251

247252
Flags for controlling logging and performance profiling.
@@ -261,7 +266,7 @@ Flags for controlling logging and performance profiling.
261266
* `--log.dir.path value`: The path to store user and error logs.
262267
* `--log.dir.prefix value`: The file name prefix for logs stored on disk.
263268
* `--log.dir.verbosity value`: Sets the log verbosity for disk logs.
264-
* Default: `info`
269+
* Default: `dbug`
265270
* `--log.delays`: Enables block delay logging.
266271
* Default: `false`
267272
* `--pprof`: Enables the pprof HTTP server.
@@ -367,6 +372,17 @@ These flags control the block synchronization and data downloading process, incl
367372
* `--torrent.verbosity value`: Sets the verbosity level for BitTorrent logs. 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail (must set `--verbosity` to equal or higher level)
368373
* Default: `1`
369374

375+
### Fork Choice Update (FCU)
376+
377+
Flags for configuring Fork Choice Update behavior.
378+
379+
* `--fcu.timeout value`: FCU timeout before switching to async processing (use `0` to disable).
380+
* Default: `1s`
381+
* `--fcu.background.prune`: Enables background pruning after FCU.
382+
* Default: `true`
383+
* `--fcu.background.commit`: Enables background flush and commit after FCU.
384+
* Default: `false`
385+
370386
### Caplin (Consensus Layer)
371387

372388
Flags for configuring the Caplin consensus layer.
@@ -600,6 +616,7 @@ GLOBAL OPTIONS:
600616
--prune.include-commitment-history, --experimental.commitment-history, --prune.experimental.include-commitment-history Enables blazing fast eth_getProof for executed block (default: false)
601617
--fcu.timeout value FCU timeout before it switches to being process async (use 0 to disable) (default: 1s)
602618
--fcu.background.prune Enables background pruning post fcu (default: true)
619+
--fcu.background.commit Enables background flush and commit post fcu (default: false)
603620
--batchSize value Batch size for the execution stage (default: "512M")
604621
--bodies.cache value Limit on the cache for block bodies (default: "268435456")
605622
--database.verbosity value Enabling internal db logs. Very high verbosity levels may require recompile db. Default: 2, means warning. (default: 2)
@@ -688,7 +705,7 @@ GLOBAL OPTIONS:
688705
"stun" Uses STUN to detect an external IP using a default server
689706
"stun:<server>" Uses STUN to detect an external IP using the given server (host:port)
690707
--nodiscover Disables the peer discovery mechanism (manual peer addition) (default: false)
691-
--discovery.v4, --discv4 Enables the V4 discovery mechanism (default: true)
708+
--discovery.v4, --discv4 Enables the V4 discovery mechanism (default: false)
692709
--discovery.v5, --discv5, --v5disc Enables the V5 discovery mechanism (default: true)
693710
--netrestrict value Restricts network communication to the given IP networks (CIDR masks)
694711
--nodekey value P2P node key file
@@ -725,6 +742,8 @@ GLOBAL OPTIONS:
725742
--no-downloader Disables downloader component (default: false)
726743
--downloader.verify Verify snapshots on startup. It will not report problems found, but re-download broken pieces. (default: false)
727744
--healthcheck Enable grpc health check (default: false)
745+
--mcp.addr value MCP server listening interface (default: "127.0.0.1")
746+
--mcp.port value MCP server listening port (default: 8553)
728747
--bor.heimdall value URL of Heimdall service (default: "http://localhost:1317")
729748
--webseed value Comma-separated URL's, holding metadata about network-support infrastructure (like S3 buckets with snapshots, bootnodes, etc...)
730749
--bor.withoutheimdall Run without Heimdall service (for testing purposes) (default: false)
@@ -733,6 +752,7 @@ GLOBAL OPTIONS:
733752
--aa Enable AA transactions (default: false)
734753
--ethstats value Reporting URL of a ethstats service (nodename:secret@host:port)
735754
--override.osaka value Manually specify the Osaka fork time, overriding the bundled setting (default: 0)
755+
--override.amsterdam value Manually specify the Amsterdam fork time, overriding the bundled setting (default: 0)
736756
--override.balancer value Manually specify the Balancer fork time, overriding the bundled setting (default: 0)
737757
--keep.stored.chain.config Avoid overriding chain config already stored in the DB (default: false)
738758
--caplin.discovery.addr value Address for Caplin DISCV5 protocol (default: "0.0.0.0")
@@ -818,7 +838,7 @@ GLOBAL OPTIONS:
818838
--log.dir.disable disable disk logging (default: false)
819839
--log.dir.path value Path to store user and error logs to disk
820840
--log.dir.prefix value The file name prefix for logs stored to disk
821-
--log.dir.verbosity value Set the log verbosity for logs stored to disk (default: "info")
841+
--log.dir.verbosity value Set the log verbosity for logs stored to disk (default: "dbug")
822842
--log.delays Enable block delay logging (default: false)
823843
--config value Sets erigon flags from YAML/TOML file
824844
--help, -h show help

0 commit comments

Comments
 (0)