Skip to content

Debug API description #18726

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bloxster wants to merge 10 commits into from
Closed

Debug API description #18726

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2f5238c
broken link, added debug APIs description
bloxster Jan 19, 2026
2a8cec5
GITBOOK-3: No subject
bloxster Jan 19, 2026
6f846e2
GITBOOK-4: No subject
bloxster Jan 20, 2026
5421b41
GITBOOK-5: No subject
bloxster Jan 20, 2026
ab0f989
GITBOOK-6: No subject
bloxster Jan 20, 2026
8f4631f
GITBOOK-7: No subject
bloxster Jan 20, 2026
1e954bb
GITBOOK-8: No subject
bloxster Jan 20, 2026
ea0d4b9
GITBOOK-9: No subject
bloxster Jan 23, 2026
ddee3ac
GITBOOK-10: No subject
bloxster Jan 26, 2026
32ba1a2
updated --h to 3.3.7
bloxster Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/gitbook/src/.gitbook/vars.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version: 3.2.2
version: 3.3.3
21 changes: 13 additions & 8 deletions docs/gitbook/src/fundamentals/configuring-erigon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@ These flags control database performance and memory usage.

Flags for managing how old chain data is handled and stored.

* `--prune.mode value`: Selects a pruning preset (`full`, `archive`, `minimal`, `blocks`). See also [Sync Modes](../fundamentals/sync-modes.md)
* `--prune.mode value`: Selects a pruning preset (`full`, `archive`, `minimal`, `blocks`). See also [Sync Modes](sync-modes.md)
* Default: `"full"`
* `--prune.distance value`: Keeps state history for the latest `N` blocks.
* Default: `0`
* `--prune.distance.blocks value`: Keeps block history for the latest `N` blocks.
* Default: `0`
* `--prune.experimental.include-commitment-history, --experimental.commitment-history`: Enables faster `eth_getProof` for executed blocks.
* Default: `false` 
* Default: `false`
* `--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.
* Default: `false`
* `--snap.keepblocks`: Keeps ancient blocks in the database for debugging.
Expand Down Expand Up @@ -557,7 +557,7 @@ USAGE:
erigon [command] [flags]

VERSION:
3.3.0-dev-fc7a858a
3.3.4-745451f6

COMMANDS:
init Bootstrap and initialize a new genesis block
Expand All @@ -568,8 +568,8 @@ COMMANDS:
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--datadir value Data directory for the databases (default: /home/user/.local/share/erigon)
--ethash.dagdir value Directory to store the ethash mining DAGs (default: /home/user/.local/share/erigon-ethash)
--datadir value Data directory for the databases (default: /home/bloxster/.local/share/erigon)

@sudeepdino008 sudeepdino008 Jan 26, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong default

@bloxster bloxster Jan 26, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected.

--ethash.dagdir value Directory to store the ethash mining DAGs (default: /home/bloxster/.local/share/erigon-ethash)
--externalcl Enables the external consensus layer (default: false)
--txpool.disable External pool and block producer, see ./cmd/txpool/readme.md for more info. Disabling internal txpool and block producer. (default: false)
--txpool.pricelimit value Minimum gas price (fee cap) limit to enforce for acceptance into the pool (default: 1)
Expand All @@ -591,6 +591,8 @@ GLOBAL OPTIONS:
archive: Keep the entire state history and all blocks,
minimal: Keep only latest state (default: "full")
--prune.include-commitment-history, --experimental.commitment-history, --prune.experimental.include-commitment-history Enables blazing fast eth_getProof for executed block (default: false)
--fcu.timeout value FCU timeout before it switches to being process async (use 0 to disable) (default: 1s)
--fcu.background.prune Enables background pruning post fcu (default: true)
--batchSize value Batch size for the execution stage (default: "512M")
--bodies.cache value Limit on the cache for block bodies (default: "268435456")
--database.verbosity value Enabling internal db logs. Very high verbosity levels may require recompile db. Default: 2, means warning. (default: 2)
Expand All @@ -602,7 +604,6 @@ GLOBAL OPTIONS:
--tls.key value Specify key file
--tls.cacert value Specify certificate authority
--state.stream.disable Disable streaming of state changes from core to RPC daemon (default: false)
--experimental.bal generate block access list (default: false)
--sync.loop.throttle value Sets the minimum time between sync loop starts (e.g. 1h30m, default is none)
--bad.block value Marks block with given hex string as bad and forces initial reorg before normal staged sync
--http JSON-RPC server (enabled by default). Use --http=false to disable it (default: true)
Expand Down Expand Up @@ -636,6 +637,7 @@ GLOBAL OPTIONS:
--rpc.txfeecap value Sets a cap on transaction fee (in ether) that can be sent via the RPC APIs (0 = no cap) (default: 1)
--txpool.api.addr value TxPool api network address, for example: 127.0.0.1:9090 (default: use value of --private.api.addr)
--trace.maxtraces value Sets a limit on traces that can be returned in trace_filter (default: 200)
--experimental.always-generate-changesets Allows to override changesets generation logic (default: false)
--http.timeouts.read value Maximum duration for reading the entire request, including the body. (default: 30s)
--http.timeouts.write value Maximum duration before timing out writes of the response. It is reset whenever a new request's header is read. (default: 30m0s)
--http.timeouts.idle value Maximum amount of time to wait for the next request when keep-alive connections are enabled. If http.timeouts.idle is zero, the value of http.timeouts.read is used. (default: 2m0s)
Expand Down Expand Up @@ -679,7 +681,8 @@ GLOBAL OPTIONS:
"stun" Uses STUN to detect an external IP using a default server
"stun:<server>" Uses STUN to detect an external IP using the given server (host:port)
--nodiscover Disables the peer discovery mechanism (manual peer addition) (default: false)
--v5disc Enables the experimental RLPx V5 (Topic Discovery) mechanism (default: false)
--discovery.v4, --discv4 Enables the V4 discovery mechanism (default: false)
--discovery.v5, --discv5 Enables the V5 discovery mechanism (default: false)

@sudeepdino008 sudeepdino008 Jan 26, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't discv5 enabled by default now? (i might be wrong)

@yperbasis yperbasis Jan 26, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think @anacrolix enabled discv5 by default

@bloxster bloxster Jan 26, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated, but we should also update erigon --h output

@anacrolix anacrolix Jan 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#18818

--netrestrict value Restricts network communication to the given IP networks (CIDR masks)
--nodekey value P2P node key file
--nodekeyhex value P2P node key as hex (for testing)
Expand Down Expand Up @@ -723,6 +726,7 @@ GLOBAL OPTIONS:
--aa Enable AA transactions (default: false)
--ethstats value Reporting URL of a ethstats service (nodename:secret@host:port)
--override.osaka value Manually specify the Osaka fork time, overriding the bundled setting (default: 0)
--override.balancer value Manually specify the Balancer fork time, overriding the bundled setting (default: 0)
--keep.stored.chain.config Avoid overriding chain config already stored in the DB (default: false)
--caplin.discovery.addr value Address for Caplin DISCV5 protocol (default: "0.0.0.0")
--caplin.discovery.port value Port for Caplin DISCV5 protocol (default: 4000)
Expand Down Expand Up @@ -773,7 +777,7 @@ GLOBAL OPTIONS:
--caplin.custom-genesis value set the custom genesis for caplin
--caplin.use-engine-api Use engine API for internal Caplin. useful for testing and if CL network is degraded (default: false)
--trusted-setup-file value Absolute path to trusted_setup.json file
--rpc.slow value Print in logs RPC requests slower than given threshold: 100ms, 1s, 1m. Excluded methods: eth_getBlock,eth_getBlockByNumber,eth_getBlockByHash,eth_blockNumber,erigon_blockNumber,erigon_getHeaderByNumber,erigon_getHeaderByHash,erigon_getBlockByTimestamp,eth_call (default: 0s)
--rpc.slow value Print in logs RPC requests slower than given threshold: 100ms, 1s, 1m. Exluded methods: eth_getBlock,eth_getBlockByNumber,eth_getBlockByHash,eth_blockNumber,erigon_blockNumber,erigon_getHeaderByNumber,erigon_getHeaderByHash,erigon_getBlockByTimestamp,eth_call (default: 0s)
--txpool.gossip.disable Disabling p2p gossip of txs. Any txs received by p2p - will be dropped. Some networks like 'Optimism execution engine'/'Optimistic Rollup' - using it to protect against MEV attacks (default: false)
--sync.loop.block.limit value Sets the maximum number of blocks to process per loop iteration (default: 5000)
--sync.loop.break.after value Sets the last stage of the sync loop to run
Expand Down Expand Up @@ -812,5 +816,6 @@ GLOBAL OPTIONS:
--config value Sets erigon flags from YAML/TOML file
--help, -h show help
--version, -v print the version

```
{% endcode %}
4 changes: 2 additions & 2 deletions docs/gitbook/src/interacting-with-erigon/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ The Erigon RPC Service, managed by Erigon's modular [RPC daemon](../fundamentals

{% include "../../../.gitbook/includes/warning-admin_-and-debug_-....md" %}

For a complete reference on the standard Ethereum JSON-RPC methods, especially those in the `eth`, `net`, and `web3` namespaces, it is recommended to consult the general documentation on [ethereum.org's JSON-RPC API page](https://ethereum.org/en/developers/docs/apis/json-rpc/). Additionally, for the formal specification of the `debug`, `engine`, and `eth` namespaces, including unique, detailed descriptions for methods like `eth_getProof` and `eth_simulateV1`, refer to the [Execution APIs documentation](https://ethereum.github.io/execution-apis/api-documentation/).
For a complete reference on the standard Ethereum JSON-RPC methods, especially those in the `eth`, `net`, and `web3` namespaces, it is recommended to consult the general documentation on [ethereum.org's JSON-RPC API page](https://ethereum.org/en/developers/docs/apis/json-rpc/). Additionally, for the formal specification of the `debug`, `engine`, and `eth` namespaces, including unique, detailed descriptions for methods like `eth_getProof` and `eth_simulateV1`, refer to the [Execution APIs documentation](https://ethereum.github.io/execution-apis).

{% embed url="https://ethereum.org/en/developers/docs/apis/json-rpc/" %}

{% embed url="https://ethereum.github.io/execution-apis/api-documentation/" %}
{% embed url="https://ethereum.github.io/execution-apis" %}

## Erigon RPC Transports

Expand Down
18 changes: 10 additions & 8 deletions docs/gitbook/src/interacting-with-erigon/admin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
---
description: Security-Sensitive Methods for Node Operators
metaLinks:
alternates:
- >-
https://app.gitbook.com/s/3DGBf2RdbfoitX1XMgq0/interacting-with-erigon/interacting-with-erigon/admin
---

# admin
Expand Down Expand Up @@ -34,7 +38,9 @@ The admin namespace must be explicitly enabled using the `--http.api` flag when

***

## **admin\_nodeInfo**
## **JSON-RPC Specification**

### **admin\_nodeInfo**

Returns information about the running node, including network details, protocols, and node identification.

Expand All @@ -56,9 +62,7 @@ curl -s --data '{"jsonrpc":"2.0","method":"admin_nodeInfo","params":[],"id":"1"}
| ------ | --------------------------------------------------------------- |
| Object | Node information object containing network and protocol details |

***

## **admin\_peers**
### **admin\_peers**

Returns information about connected peers, including their network addresses, protocols, and connection status.

Expand All @@ -82,7 +86,7 @@ curl -s --data '{"jsonrpc":"2.0","method":"admin_peers","params":[],"id":"1"}' -

***

## **admin\_addPeer**
### **admin\_addPeer**

Attempts to add a new peer to the node's peer list by connecting to the specified enode URL.

Expand All @@ -106,9 +110,7 @@ curl -s --data '{"jsonrpc":"2.0","method":"admin_addPeer","params":["enode://a97
| ------- | -------------------------------------------------------- |
| Boolean | True if the peer was successfully added, false otherwise |

***

## **admin\_removePeer**
### **admin\_removePeer**

Removes a peer from the node's peer list by disconnecting from the specified enode URL.

Expand Down
Loading
Loading