Skip to content

Commit d7a37fe

Browse files
core-repository-dispatch-app[bot]stdevMacrubo
authored
Auto-update docs (#326)
Co-authored-by: stdevMac <stdevMac@users.noreply.github.com> Co-authored-by: Ruben Buniatyan <rubo@users.noreply.github.com>
1 parent d00c015 commit d7a37fe

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+20879
-45
lines changed

‎docs/fundamentals/configuration.md‎

Lines changed: 193 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,33 @@ The configuration options are case-sensitive and can be defined only once unless
260260

261261
### Blocks
262262

263+
- #### `Blocks.BlockProductionBlobLimit` \{#blocks-blockproductionbloblimit\}
264+
265+
<Tabs groupId="usage">
266+
<TabItem value="cli" label="CLI">
267+
```
268+
--blocks-blockproductionbloblimit <value>
269+
--Blocks.BlockProductionBlobLimit <value>
270+
```
271+
</TabItem>
272+
<TabItem value="env" label="Environment variable">
273+
```
274+
NETHERMIND_BLOCKSCONFIG_BLOCKPRODUCTIONBLOBLIMIT=<value>
275+
```
276+
</TabItem>
277+
<TabItem value="config" label="Configuration file">
278+
```json
279+
{
280+
"Blocks": {
281+
"BlockProductionBlobLimit": <value>
282+
}
283+
}
284+
```
285+
</TabItem>
286+
</Tabs>
287+
288+
The max blob count after which the block producer should stop adding blobs. Minimum value is `0`. Defaults to `null`.
289+
263290
- #### `Blocks.BlockProductionMaxTxKilobytes` \{#blocks-blockproductionmaxtxkilobytes\}
264291

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

288-
The max transaction bytes to add in block production, in kilobytes. Defaults to `9728`.
315+
The max transaction bytes to add in block production, in kilobytes. Defaults to `7936`.
289316

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

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

16401667
Defaults to `Disabled`.
16411668

1669+
- #### `History.PruningInterval` \{#history-pruninginterval\}
1670+
1671+
<Tabs groupId="usage">
1672+
<TabItem value="cli" label="CLI">
1673+
```
1674+
--history-pruninginterval <value>
1675+
--History.PruningInterval <value>
1676+
```
1677+
</TabItem>
1678+
<TabItem value="env" label="Environment variable">
1679+
```
1680+
NETHERMIND_HISTORYCONFIG_PRUNINGINTERVAL=<value>
1681+
```
1682+
</TabItem>
1683+
<TabItem value="config" label="Configuration file">
1684+
```json
1685+
{
1686+
"History": {
1687+
"PruningInterval": <value>
1688+
}
1689+
}
1690+
```
1691+
</TabItem>
1692+
</Tabs>
1693+
1694+
Number of epochs to wait between each history pruning. Defaults to `8`.
1695+
16421696
- #### `History.RetentionEpochs` \{#history-retentionepochs\}
16431697

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

20492103
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`.
20502104

2051-
- #### `Init.IsMining` \{#init-ismining\}
2052-
2053-
<Tabs groupId="usage">
2054-
<TabItem value="cli" label="CLI">
2055-
```
2056-
--init-ismining [true|false]
2057-
--Init.IsMining [true|false]
2058-
```
2059-
</TabItem>
2060-
<TabItem value="env" label="Environment variable">
2061-
```
2062-
NETHERMIND_INITCONFIG_ISMINING=true|false
2063-
```
2064-
</TabItem>
2065-
<TabItem value="config" label="Configuration file">
2066-
```json
2067-
{
2068-
"Init": {
2069-
"IsMining": true|false
2070-
}
2071-
}
2072-
```
2073-
</TabItem>
2074-
</Tabs>
2075-
2076-
Whether to seal/mine new blocks. Allowed values: `true` `false`. Defaults to `false`.
2077-
20782105
- #### `Init.KeepDevWalletInMemory` \{#init-keepdevwalletinmemory\}
20792106

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

2346-
The path to the static nodes file. Defaults to `Data/static-nodes.json`.
2373+
The path to the static nodes file. Defaults to `static-nodes.json`.
23472374

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

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

2373-
The path to the trusted nodes file. Defaults to `Data/trusted-nodes.json`.
2400+
The path to the trusted nodes file. Defaults to `trusted-nodes.json`.
23742401

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

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

33173344
Defaults to `None`.
33183345

3346+
- #### `JsonRpc.StrictHexFormat` \{#jsonrpc-stricthexformat\}
3347+
3348+
<Tabs groupId="usage">
3349+
<TabItem value="cli" label="CLI">
3350+
```
3351+
--jsonrpc-stricthexformat [true|false]
3352+
--JsonRpc.StrictHexFormat [true|false]
3353+
```
3354+
</TabItem>
3355+
<TabItem value="env" label="Environment variable">
3356+
```
3357+
NETHERMIND_JSONRPCCONFIG_STRICTHEXFORMAT=true|false
3358+
```
3359+
</TabItem>
3360+
<TabItem value="config" label="Configuration file">
3361+
```json
3362+
{
3363+
"JsonRpc": {
3364+
"StrictHexFormat": true|false
3365+
}
3366+
}
3367+
```
3368+
</TabItem>
3369+
</Tabs>
3370+
3371+
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`.
3372+
33193373
- #### `JsonRpc.Timeout` \{#jsonrpc-timeout\}
33203374

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

5362-
Maximimum number of block worth of unpersisted state in memory. Default is 297, which is number of mainnet block per hour. Defaults to `297`.
5416+
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`.
53635417

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

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

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

6495+
- #### `Surge.MaxGasLimitRatio` \{#surge-maxgaslimitratio\}
6496+
6497+
<Tabs groupId="usage">
6498+
<TabItem value="cli" label="CLI">
6499+
```
6500+
--surge-maxgaslimitratio <value>
6501+
--Surge.MaxGasLimitRatio <value>
6502+
```
6503+
</TabItem>
6504+
<TabItem value="env" label="Environment variable">
6505+
```
6506+
NETHERMIND_SURGECONFIG_MAXGASLIMITRATIO=<value>
6507+
```
6508+
</TabItem>
6509+
<TabItem value="config" label="Configuration file">
6510+
```json
6511+
{
6512+
"Surge": {
6513+
"MaxGasLimitRatio": <value>
6514+
}
6515+
}
6516+
```
6517+
</TabItem>
6518+
</Tabs>
6519+
6520+
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`.
6521+
64416522
- #### `Surge.ProofPostingGas` \{#surge-proofpostinggas\}
64426523

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

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

7184+
- #### `Sync.SnapServingMaxDepth` \{#sync-snapservingmaxdepth\}
7185+
7186+
<Tabs groupId="usage">
7187+
<TabItem value="cli" label="CLI">
7188+
```
7189+
--sync-snapservingmaxdepth <value>
7190+
--Sync.SnapServingMaxDepth <value>
7191+
```
7192+
</TabItem>
7193+
<TabItem value="env" label="Environment variable">
7194+
```
7195+
NETHERMIND_SYNCCONFIG_SNAPSERVINGMAXDEPTH=<value>
7196+
```
7197+
</TabItem>
7198+
<TabItem value="config" label="Configuration file">
7199+
```json
7200+
{
7201+
"Sync": {
7202+
"SnapServingMaxDepth": <value>
7203+
}
7204+
}
7205+
```
7206+
</TabItem>
7207+
</Tabs>
7208+
7209+
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`.
7210+
71037211
- #### `Sync.SnapSync` \{#sync-snapsync\}
71047212

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

74517559
Defaults to `StorageWithReorgs`.
74527560

7561+
- #### `TxPool.CurrentBlobBaseFeeRequired` \{#txpool-currentblobbasefeerequired\}
7562+
7563+
<Tabs groupId="usage">
7564+
<TabItem value="cli" label="CLI">
7565+
```
7566+
--txpool-currentblobbasefeerequired [true|false]
7567+
--TxPool.CurrentBlobBaseFeeRequired [true|false]
7568+
```
7569+
</TabItem>
7570+
<TabItem value="env" label="Environment variable">
7571+
```
7572+
NETHERMIND_TXPOOLCONFIG_CURRENTBLOBBASEFEEREQUIRED=true|false
7573+
```
7574+
</TabItem>
7575+
<TabItem value="config" label="Configuration file">
7576+
```json
7577+
{
7578+
"TxPool": {
7579+
"CurrentBlobBaseFeeRequired": true|false
7580+
}
7581+
}
7582+
```
7583+
</TabItem>
7584+
</Tabs>
7585+
7586+
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`.
7587+
74537588
- #### `TxPool.GasLimit` \{#txpool-gaslimit\}
74547589

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

76677802
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`.
76687803

7804+
- #### `TxPool.MinBlobTxPriorityFee` \{#txpool-minblobtxpriorityfee\}
7805+
7806+
<Tabs groupId="usage">
7807+
<TabItem value="cli" label="CLI">
7808+
```
7809+
--txpool-minblobtxpriorityfee <value>
7810+
--TxPool.MinBlobTxPriorityFee <value>
7811+
```
7812+
</TabItem>
7813+
<TabItem value="env" label="Environment variable">
7814+
```
7815+
NETHERMIND_TXPOOLCONFIG_MINBLOBTXPRIORITYFEE=<value>
7816+
```
7817+
</TabItem>
7818+
<TabItem value="config" label="Configuration file">
7819+
```json
7820+
{
7821+
"TxPool": {
7822+
"MinBlobTxPriorityFee": <value>
7823+
}
7824+
}
7825+
```
7826+
</TabItem>
7827+
</Tabs>
7828+
7829+
The minimum priority fee in wei for blob transactions to be accepted into the transaction pool. Defaults to `0`.
7830+
76697831
- #### `TxPool.PeerNotificationThreshold` \{#txpool-peernotificationthreshold\}
76707832

76717833
<Tabs groupId="usage">

‎docs/interacting/json-rpc-ns/admin.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,7 @@ Information about this node
352352
- `eip2929Transition`: _string_ (hex integer)
353353
- `eip2930Transition`: _string_ (hex integer)
354354
- `eip2935ContractAddress`: _string_ (address)
355+
- `eip2935RingBufferSize`: _string_ (hex integer)
355356
- `eip2935TransitionTimestamp`: _string_ (hex integer)
356357
- `eip3198Transition`: _string_ (hex integer)
357358
- `eip3529Transition`: _string_ (hex integer)

‎docs/interacting/json-rpc-ns/eth.md‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,7 @@ curl localhost:8545 \
264264

265265
`result`: _object_
266266
- `accessList`: _object_
267+
- `error`: _string_
267268
- `gasUsed`: _string_ (hex integer)
268269

269270
</TabItem>
@@ -1014,10 +1015,11 @@ Reads logs
10141015
<TabItem value="params" label="Parameters">
10151016

10161017
1. `filter`: _object_
1017-
- `address`: _object_
1018+
- `address`: array of _object_
1019+
- `value`: _string_ (address)
10181020
- `fromBlock`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`)
10191021
- `toBlock`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`)
1020-
- `topics`: array of _object_
1022+
- `topics`: array of array of _string_ (hash)
10211023

10221024

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

10711073
1. `accountAddress`: _string_ (address)
10721074

1073-
2. `hashRate`: array of _string_ (hex integer)
1075+
2. `storageKeys`: array of _string_ (hex integer)
10741076

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

@@ -1086,7 +1088,7 @@ curl localhost:8545 \
10861088
"jsonrpc": "2.0",
10871089
"id": 0,
10881090
"method": "eth_getProof",
1089-
"params": [accountAddress, hashRate, blockParameter]
1091+
"params": [accountAddress, storageKeys, blockParameter]
10901092
}'
10911093
```
10921094

@@ -1108,7 +1110,7 @@ curl localhost:8545 \
11081110
- `nonce`: _string_ (hex integer)
11091111
- `proof`: array of _string_ (hex data)
11101112
- `storageProofs`: array of _object_
1111-
- `key`: _string_ (hex data)
1113+
- `key`: _string_
11121114
- `proof`: array of _string_ (hex data)
11131115
- `value`: _object_
11141116
- `hasValue`: _boolean_
@@ -1748,10 +1750,11 @@ Creates an update filter
17481750
<TabItem value="params" label="Parameters">
17491751

17501752
1. `filter`: _object_
1751-
- `address`: _object_
1753+
- `address`: array of _object_
1754+
- `value`: _string_ (address)
17521755
- `fromBlock`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`)
17531756
- `toBlock`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`)
1754-
- `topics`: array of _object_
1757+
- `topics`: array of array of _string_ (hash)
17551758

17561759

17571760
</TabItem>
@@ -2053,7 +2056,8 @@ curl localhost:8545 \
20532056
- `calls`: array of _object_
20542057
- `error`: _object_
20552058
- `code`: _string_ (hex integer)
2056-
- `data`: _string_
2059+
- `data`: _string_ (hex data)
2060+
- `evmException`: _integer_
20572061
- `message`: _string_
20582062
- `gasUsed`: _string_ (hex integer)
20592063
- `logs`: array of _object_
@@ -2072,7 +2076,8 @@ curl localhost:8545 \
20722076
- `traces`: array of _object_
20732077
- `error`: _object_
20742078
- `code`: _string_ (hex integer)
2075-
- `data`: _string_
2079+
- `data`: _string_ (hex data)
2080+
- `evmException`: _integer_
20762081
- `message`: _string_
20772082
- `gasUsed`: _string_ (hex integer)
20782083
- `logs`: array of _object_

0 commit comments

Comments
 (0)