Skip to content

Auto-update docs #326

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

Merged
rubo merged 2 commits into from
Jan 13, 2026
Merged

Auto-update docs #326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc6603c
Auto-update docs
stdevMac Jan 13, 2026
fbe03f4
Fix redirects
rubo Jan 13, 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
224 changes: 193 additions & 31 deletions docs/fundamentals/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,33 @@ The configuration options are case-sensitive and can be defined only once unless

### Blocks

- #### `Blocks.BlockProductionBlobLimit` \{#blocks-blockproductionbloblimit\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--blocks-blockproductionbloblimit <value>
--Blocks.BlockProductionBlobLimit <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_BLOCKSCONFIG_BLOCKPRODUCTIONBLOBLIMIT=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"Blocks": {
"BlockProductionBlobLimit": <value>
}
}
```
</TabItem>
</Tabs>

The max blob count after which the block producer should stop adding blobs. Minimum value is `0`. Defaults to `null`.

- #### `Blocks.BlockProductionMaxTxKilobytes` \{#blocks-blockproductionmaxtxkilobytes\}

<Tabs groupId="usage">
Expand All @@ -285,7 +312,7 @@ The configuration options are case-sensitive and can be defined only once unless
</TabItem>
</Tabs>

The max transaction bytes to add in block production, in kilobytes. Defaults to `9728`.
The max transaction bytes to add in block production, in kilobytes. Defaults to `7936`.

- #### `Blocks.BlockProductionTimeoutMs` \{#blocks-blockproductiontimeoutms\}

Expand Down Expand Up @@ -1639,6 +1666,33 @@ The configuration options are case-sensitive and can be defined only once unless

Defaults to `Disabled`.

- #### `History.PruningInterval` \{#history-pruninginterval\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--history-pruninginterval <value>
--History.PruningInterval <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_HISTORYCONFIG_PRUNINGINTERVAL=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"History": {
"PruningInterval": <value>
}
}
```
</TabItem>
</Tabs>

Number of epochs to wait between each history pruning. Defaults to `8`.

- #### `History.RetentionEpochs` \{#history-retentionepochs\}

<Tabs groupId="usage">
Expand Down Expand Up @@ -2048,33 +2102,6 @@ The configuration options are case-sensitive and can be defined only once unless

The hash of the genesis block. If not specified, the genesis block validity is not checked which is useful in the case of ad hoc test/private networks. Defaults to `null`.

- #### `Init.IsMining` \{#init-ismining\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--init-ismining [true|false]
--Init.IsMining [true|false]
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_INITCONFIG_ISMINING=true|false
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"Init": {
"IsMining": true|false
}
}
```
</TabItem>
</Tabs>

Whether to seal/mine new blocks. Allowed values: `true` `false`. Defaults to `false`.

- #### `Init.KeepDevWalletInMemory` \{#init-keepdevwalletinmemory\}

<Tabs groupId="usage">
Expand Down Expand Up @@ -2343,7 +2370,7 @@ The configuration options are case-sensitive and can be defined only once unless
</TabItem>
</Tabs>

The path to the static nodes file. Defaults to `Data/static-nodes.json`.
The path to the static nodes file. Defaults to `static-nodes.json`.

- #### `Init.TrustedNodesPath` \{#init-trustednodespath\}

Expand All @@ -2370,7 +2397,7 @@ The configuration options are case-sensitive and can be defined only once unless
</TabItem>
</Tabs>

The path to the trusted nodes file. Defaults to `Data/trusted-nodes.json`.
The path to the trusted nodes file. Defaults to `trusted-nodes.json`.

- #### `Init.WebSocketsEnabled` \{#init-websocketsenabled\}

Expand Down Expand Up @@ -3316,6 +3343,33 @@ The configuration options are case-sensitive and can be defined only once unless

Defaults to `None`.

- #### `JsonRpc.StrictHexFormat` \{#jsonrpc-stricthexformat\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--jsonrpc-stricthexformat [true|false]
--JsonRpc.StrictHexFormat [true|false]
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_JSONRPCCONFIG_STRICTHEXFORMAT=true|false
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"JsonRpc": {
"StrictHexFormat": true|false
}
}
```
</TabItem>
</Tabs>

Enable strict parsing rules for Block Params and Hashas in RPC requests. this will decrease compatibility but increase compliance with the spec. Allowed values: `true` `false`. Defaults to `true`.

- #### `JsonRpc.Timeout` \{#jsonrpc-timeout\}

<Tabs groupId="usage">
Expand Down Expand Up @@ -5359,7 +5413,7 @@ The configuration options are case-sensitive and can be defined only once unless
</TabItem>
</Tabs>

Maximimum number of block worth of unpersisted state in memory. Default is 297, which is number of mainnet block per hour. Defaults to `297`.
Maximum number of blocks worth of unpersisted state in memory. Default is 297, which is the number of mainnet blocks per hour. Defaults to `297`.

- #### `Pruning.MinUnpersistedBlockCount` \{#pruning-minunpersistedblockcount\}

Expand Down Expand Up @@ -6438,6 +6492,33 @@ The configuration options are case-sensitive and can be defined only once unless

Number of recent L2 batches to consider for computing the moving average of gas usage. Defaults to `20`.

- #### `Surge.MaxGasLimitRatio` \{#surge-maxgaslimitratio\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--surge-maxgaslimitratio <value>
--Surge.MaxGasLimitRatio <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_SURGECONFIG_MAXGASLIMITRATIO=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"Surge": {
"MaxGasLimitRatio": <value>
}
}
```
</TabItem>
</Tabs>

Filter transactions exceeding the max allowed ratio of gas limit to the actual gas used (e.g. 1, 2 etc.). Set to 0 to disable. Defaults to `0`.

- #### `Surge.ProofPostingGas` \{#surge-proofpostinggas\}

<Tabs groupId="usage">
Expand Down Expand Up @@ -7100,6 +7181,33 @@ The configuration options are case-sensitive and can be defined only once unless

The total difficulty of the pivot block for the Fast sync mode. Defaults to `null`.

- #### `Sync.SnapServingMaxDepth` \{#sync-snapservingmaxdepth\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--sync-snapservingmaxdepth <value>
--Sync.SnapServingMaxDepth <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_SYNCCONFIG_SNAPSERVINGMAXDEPTH=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"Sync": {
"SnapServingMaxDepth": <value>
}
}
```
</TabItem>
</Tabs>

The maximum depth (in blocks) for serving snap sync requests. Higher values allow serving requests for older blocks, useful for networks with fast block times like Arbitrum. Defaults to `128`.

- #### `Sync.SnapSync` \{#sync-snapsync\}

<Tabs groupId="usage">
Expand Down Expand Up @@ -7450,6 +7558,33 @@ The configuration options are case-sensitive and can be defined only once unless

Defaults to `StorageWithReorgs`.

- #### `TxPool.CurrentBlobBaseFeeRequired` \{#txpool-currentblobbasefeerequired\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--txpool-currentblobbasefeerequired [true|false]
--TxPool.CurrentBlobBaseFeeRequired [true|false]
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_TXPOOLCONFIG_CURRENTBLOBBASEFEEREQUIRED=true|false
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"TxPool": {
"CurrentBlobBaseFeeRequired": true|false
}
}
```
</TabItem>
</Tabs>

Whether to require the max fee per blob gas to be greater than or equal to the current blob base fee when adding a blob transaction to the pool. Allowed values: `true` `false`. Defaults to `true`.

- #### `TxPool.GasLimit` \{#txpool-gaslimit\}

<Tabs groupId="usage">
Expand Down Expand Up @@ -7666,6 +7801,33 @@ The configuration options are case-sensitive and can be defined only once unless

The minimal percentage of the current base fee that must be surpassed by the max fee (`max_fee_per_gas`) for the transaction to be broadcasted. Defaults to `70`.

- #### `TxPool.MinBlobTxPriorityFee` \{#txpool-minblobtxpriorityfee\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--txpool-minblobtxpriorityfee <value>
--TxPool.MinBlobTxPriorityFee <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_TXPOOLCONFIG_MINBLOBTXPRIORITYFEE=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"TxPool": {
"MinBlobTxPriorityFee": <value>
}
}
```
</TabItem>
</Tabs>

The minimum priority fee in wei for blob transactions to be accepted into the transaction pool. Defaults to `0`.

- #### `TxPool.PeerNotificationThreshold` \{#txpool-peernotificationthreshold\}

<Tabs groupId="usage">
Expand Down
1 change: 1 addition & 0 deletions docs/interacting/json-rpc-ns/admin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ Information about this node
- `eip2929Transition`: _string_ (hex integer)
- `eip2930Transition`: _string_ (hex integer)
- `eip2935ContractAddress`: _string_ (address)
- `eip2935RingBufferSize`: _string_ (hex integer)
- `eip2935TransitionTimestamp`: _string_ (hex integer)
- `eip3198Transition`: _string_ (hex integer)
- `eip3529Transition`: _string_ (hex integer)
Expand Down
23 changes: 14 additions & 9 deletions docs/interacting/json-rpc-ns/eth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,7 @@ curl localhost:8545 \

`result`: _object_
- `accessList`: _object_
- `error`: _string_
- `gasUsed`: _string_ (hex integer)

</TabItem>
Expand Down Expand Up @@ -1014,10 +1015,11 @@ Reads logs
<TabItem value="params" label="Parameters">

1. `filter`: _object_
- `address`: _object_
- `address`: array of _object_
- `value`: _string_ (address)
- `fromBlock`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`)
- `toBlock`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`)
- `topics`: array of _object_
- `topics`: array of array of _string_ (hash)


</TabItem>
Expand Down Expand Up @@ -1070,7 +1072,7 @@ https://github.com/ethereum/EIPs/issues/1186

1. `accountAddress`: _string_ (address)

2. `hashRate`: array of _string_ (hex integer)
2. `storageKeys`: array of _string_ (hex integer)

3. `blockParameter`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`)

Expand All @@ -1086,7 +1088,7 @@ curl localhost:8545 \
"jsonrpc": "2.0",
"id": 0,
"method": "eth_getProof",
"params": [accountAddress, hashRate, blockParameter]
"params": [accountAddress, storageKeys, blockParameter]
}'
```

Expand All @@ -1108,7 +1110,7 @@ curl localhost:8545 \
- `nonce`: _string_ (hex integer)
- `proof`: array of _string_ (hex data)
- `storageProofs`: array of _object_
- `key`: _string_ (hex data)
- `key`: _string_
- `proof`: array of _string_ (hex data)
- `value`: _object_
- `hasValue`: _boolean_
Expand Down Expand Up @@ -1748,10 +1750,11 @@ Creates an update filter
<TabItem value="params" label="Parameters">

1. `filter`: _object_
- `address`: _object_
- `address`: array of _object_
- `value`: _string_ (address)
- `fromBlock`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`)
- `toBlock`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`)
- `topics`: array of _object_
- `topics`: array of array of _string_ (hash)


</TabItem>
Expand Down Expand Up @@ -2053,7 +2056,8 @@ curl localhost:8545 \
- `calls`: array of _object_
- `error`: _object_
- `code`: _string_ (hex integer)
- `data`: _string_
- `data`: _string_ (hex data)
- `evmException`: _integer_
- `message`: _string_
- `gasUsed`: _string_ (hex integer)
- `logs`: array of _object_
Expand All @@ -2072,7 +2076,8 @@ curl localhost:8545 \
- `traces`: array of _object_
- `error`: _object_
- `code`: _string_ (hex integer)
- `data`: _string_
- `data`: _string_ (hex data)
- `evmException`: _integer_
- `message`: _string_
- `gasUsed`: _string_ (hex integer)
- `logs`: array of _object_
Expand Down
Loading