Skip to content
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

Auto-update docs #249

Merged
merged 1 commit into from
Dec 11, 2024
Merged

Auto-update docs #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
122 changes: 103 additions & 19 deletions docs/fundamentals/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,6 +667,9 @@ The configuration options are case-sensitive and can be defined only once unless
Whether to enable censorship detection. Allowed values: `true` `false`. Defaults to `false`.


### Clique
Copy link
Contributor

Choose a reason for hiding this comment

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

We should not have any empty sections. Need to check.



### EthStats

- #### `EthStats.Contact` \{#ethstats-contact\}
Expand Down Expand Up @@ -1317,7 +1320,7 @@ The configuration options are case-sensitive and can be defined only once unless
</TabItem>
</Tabs>

The path to the test chain spec file. Defaults to `/chain.rlp`.
The path to the chain definition should be specified as an RLP-encoded block sequence. Defaults to `/chain.rlp`.

- #### `Hive.Enabled` \{#hive-enabled\}

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

The path to a file with the list of new-line-separated JSON-RPC calls. If specified, only the calls from that file are allowed. Defaults to `Data/jsonrpc.filter`.

- #### `JsonRpc.CorsOrigins` \{#jsonrpc-corsorigins\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--jsonrpc-corsorigins <value>
--JsonRpc.CorsOrigins <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_JSONRPCCONFIG_CORSORIGINS=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"JsonRpc": {
"CorsOrigins": <value>
}
}
```
</TabItem>
</Tabs>

The JSON-RPC server CORS origins. Defaults to `*`.

- #### `JsonRpc.Enabled` \{#jsonrpc-enabled\}

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

An array of JSON-RPC namespaces to enable. For instance, `[debug,eth]`.

Built-in namespaces:

- `admin`
- `client`
- `debug`
Expand All @@ -2151,7 +2181,7 @@ The configuration options are case-sensitive and can be defined only once unless
- `trace`
- `txpool`
- `web3`

Defaults to `[Eth,Subscribe,Trace,TxPool,Web3,Personal,Proof,Net,Parity,Health,Rpc]`.

- #### `JsonRpc.EngineEnabledModules` \{#jsonrpc-engineenabledmodules\}
Expand Down Expand Up @@ -2288,15 +2318,15 @@ The configuration options are case-sensitive and can be defined only once unless
</Tabs>

The number of concurrent instances for non-sharable calls:

- `eth_call`
- `eth_estimateGas`
- `eth_getLogs`
- `eth_newBlockFilter`
- `eth_newFilter`
- `eth_newPendingTransactionFilter`
- `eth_uninstallFilter`

This limits the load on the CPU and I/O to reasonable levels. If the limit is exceeded, HTTP 503 is returned along with the JSON-RPC error. Defaults to the number of logical processors.

- #### `JsonRpc.GasCap` \{#jsonrpc-gascap\}
Expand Down Expand Up @@ -2676,15 +2706,15 @@ The configuration options are case-sensitive and can be defined only once unless
</Tabs>

The max number of concurrent requests in the queue for:

- `eth_call`
- `eth_estimateGas`
- `eth_getLogs`
- `eth_newFilter`
- `eth_newBlockFilter`
- `eth_newPendingTransactionFilter`
- `eth_uninstallFilter`

`0` to lift the limit. Defaults to `500`.

- #### `JsonRpc.RpcRecorderBaseFilePath` \{#jsonrpc-rpcrecorderbasefilepath\}
Expand Down Expand Up @@ -3376,13 +3406,13 @@ The configuration options are case-sensitive and can be defined only once unless
</Tabs>

The number of requests to the garbage collector (GC) to release the process memory.

Allowed values:

- `-1`: No requests.
- `0`: Requests every time.
- A positive number: Requests after that many Engine API calls.

Defaults to `25`.

- #### `Merge.CompactMemory` \{#merge-compactmemory\}
Expand Down Expand Up @@ -3754,7 +3784,7 @@ The configuration options are case-sensitive and can be defined only once unless
</TabItem>
</Tabs>

The port to expose Prometheus metrics at. Defaults to `null`.
The port to expose Prometheus metrics at.

- #### `Metrics.IntervalSeconds` \{#metrics-intervalseconds\}

Expand Down Expand Up @@ -3783,6 +3813,60 @@ The configuration options are case-sensitive and can be defined only once unless

The frequency of pushing metrics to Prometheus, in seconds. Defaults to `5`.

- #### `Metrics.MonitoringGroup` \{#metrics-monitoringgroup\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--metrics-monitoringgroup <value>
--Metrics.MonitoringGroup <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_METRICSCONFIG_MONITORINGGROUP=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"Metrics": {
"MonitoringGroup": <value>
}
}
```
</TabItem>
</Tabs>

The Prometheus metrics group name. Defaults to `nethermind`.

- #### `Metrics.MonitoringJob` \{#metrics-monitoringjob\}

<Tabs groupId="usage">
<TabItem value="cli" label="CLI">
```
--metrics-monitoringjob <value>
--Metrics.MonitoringJob <value>
```
</TabItem>
<TabItem value="env" label="Environment variable">
```
NETHERMIND_METRICSCONFIG_MONITORINGJOB=<value>
```
</TabItem>
<TabItem value="config" label="Configuration file">
```json
{
"Metrics": {
"MonitoringJob": <value>
}
}
```
</TabItem>
</Tabs>

The Prometheus metrics job name. Defaults to `nethermind`.

- #### `Metrics.NodeName` \{#metrics-nodename\}

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

The name to display on the Grafana dashboard. Defaults to `"Nethermind"`.
The name to display on the Grafana dashboard. Defaults to `Nethermind`.

- #### `Metrics.PushGatewayUrl` \{#metrics-pushgatewayurl\}

Expand Down Expand Up @@ -4450,15 +4534,15 @@ The configuration options are case-sensitive and can be defined only once unless
</Tabs>

The max number of parallel tasks that can be used by full pruning.

Allowed values:

- `-1`: Uses the number of logical processors.
- `0`: Uses 25% of logical processors.
- `1`: Runs on a single thread.

The recommended value depends on the type of the node:

- If the node needs to be responsive (serves for RPC or validator), then the recommended value is `0` or `-1`.
- If the node doesn't have many other responsibilities but needs to be able to follow the chain reliably without any delays and produce live logs, the `0` or `1` is recommended.
- If the node doesn't have to be responsive, has very fast I/O (like NVMe) and the shortest pruning time is to be achieved, then `-1` is recommended. Defaults to `0`.
Expand Down Expand Up @@ -5358,7 +5442,7 @@ The configuration options are case-sensitive and can be defined only once unless
</Tabs>

The earliest body downloaded with fast sync when `DownloadBodiesInFastSync` is set to `true`. The actual value is determined as follows:

```
max{ 1, min{ PivotNumber, AncientBodiesBarrier } }
```
Expand Down Expand Up @@ -5390,7 +5474,7 @@ The configuration options are case-sensitive and can be defined only once unless
</Tabs>

The earliest receipt downloaded with fast sync when `DownloadReceiptsInFastSync` is set to `true`. The actual value is determined as follows:

```
max{ 1, min{ PivotNumber, max{ AncientBodiesBarrier, AncientReceiptsBarrier } } }
```
Expand Down
91 changes: 90 additions & 1 deletion docs/interacting/json-rpc-ns/admin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,94 @@ Information about this node
- `discovery`: *string* (hex integer)
- `listener`: *string* (hex integer)
- `protocols`: map of *object*
- `chainId`: *string* (hex integer)
- `config`: *object*
- `beaconChainGenesisTimestamp`: *string* (hex integer)
- `depositContractAddress`: *string* (address)
- `eip1014Transition`: *string* (hex integer)
- `eip1052Transition`: *string* (hex integer)
- `eip1108Transition`: *string* (hex integer)
- `eip1153TransitionTimestamp`: *string* (hex integer)
- `eip1283DisableTransition`: *string* (hex integer)
- `eip1283ReenableTransition`: *string* (hex integer)
- `eip1283Transition`: *string* (hex integer)
- `eip1344Transition`: *string* (hex integer)
- `eip140Transition`: *string* (hex integer)
- `eip145Transition`: *string* (hex integer)
- `eip150Transition`: *string* (hex integer)
- `eip152Transition`: *string* (hex integer)
- `eip1559BaseFeeInitialValue`: *string* (hex integer)
- `eip1559BaseFeeMaxChangeDenominator`: *string* (hex integer)
- `eip1559BaseFeeMinValue`: *string* (hex integer)
- `eip1559BaseFeeMinValueTransition`: *string* (hex integer)
- `eip1559ElasticityMultiplier`: *string* (hex integer)
- `eip1559FeeCollectorTransition`: *string* (hex integer)
- `eip1559Transition`: *string* (hex integer)
- `eip155Transition`: *string* (hex integer)
- `eip160Transition`: *string* (hex integer)
- `eip161abcTransition`: *string* (hex integer)
- `eip161dTransition`: *string* (hex integer)
- `eip1706Transition`: *string* (hex integer)
- `eip1884Transition`: *string* (hex integer)
- `eip2028Transition`: *string* (hex integer)
- `eip211Transition`: *string* (hex integer)
- `eip214Transition`: *string* (hex integer)
- `eip2200Transition`: *string* (hex integer)
- `eip2315Transition`: *string* (hex integer)
- `eip2537Transition`: *string* (hex integer)
- `eip2537TransitionTimestamp`: *string* (hex integer)
- `eip2565Transition`: *string* (hex integer)
- `eip2929Transition`: *string* (hex integer)
- `eip2930Transition`: *string* (hex integer)
- `eip2935ContractAddress`: *string* (address)
- `eip2935TransitionTimestamp`: *string* (hex integer)
- `eip3198Transition`: *string* (hex integer)
- `eip3529Transition`: *string* (hex integer)
- `eip3541Transition`: *string* (hex integer)
- `eip3607Transition`: *string* (hex integer)
- `eip3651TransitionTimestamp`: *string* (hex integer)
- `eip3855TransitionTimestamp`: *string* (hex integer)
- `eip3860TransitionTimestamp`: *string* (hex integer)
- `eip4788ContractAddress`: *string* (address)
- `eip4788TransitionTimestamp`: *string* (hex integer)
- `eip4844BlobGasPriceUpdateFraction`: *string* (hex integer)
- `eip4844FeeCollectorTransitionTimestamp`: *string* (hex integer)
- `eip4844MaxBlobGasPerBlock`: *string* (hex integer)
- `eip4844MinBlobGasPrice`: *string* (hex integer)
- `eip4844TargetBlobGasPerBlock`: *string* (hex integer)
- `eip4844TransitionTimestamp`: *string* (hex integer)
- `eip4895TransitionTimestamp`: *string* (hex integer)
- `eip5656TransitionTimestamp`: *string* (hex integer)
- `eip6110TransitionTimestamp`: *string* (hex integer)
- `eip658Transition`: *string* (hex integer)
- `eip6780TransitionTimestamp`: *string* (hex integer)
- `eip7002ContractAddress`: *string* (address)
- `eip7002TransitionTimestamp`: *string* (hex integer)
- `eip7251ContractAddress`: *string* (address)
- `eip7251TransitionTimestamp`: *string* (hex integer)
- `eip7702TransitionTimestamp`: *string* (hex integer)
- `eip7Transition`: *string* (hex integer)
- `feeCollector`: *string* (address)
- `forkBlock`: *string* (hex integer)
- `forkCanonHash`: *string* (hash)
- `gasLimitBoundDivisor`: *string* (hex integer)
- `maxCodeSize`: *string* (hex integer)
- `maxCodeSizeTransition`: *string* (hex integer)
- `maxCodeSizeTransitionTimestamp`: *string* (hex integer)
- `maximumExtraDataSize`: *string* (hex integer)
- `mergeForkIdTransition`: *string* (hex integer)
- `minGasLimit`: *string* (hex integer)
- `ontakeTransition`: *string* (hex integer)
- `opGraniteTransitionTimestamp`: *string* (hex integer)
- `opHoloceneTransitionTimestamp`: *string* (hex integer)
- `registrar`: *string* (address)
- `rip7212TransitionTimestamp`: *string* (hex integer)
- `terminalPoWBlockNumber`: *string* (hex integer)
- `terminalTotalDifficulty`: *string* (hex integer)
- `transactionPermissionContract`: *string* (address)
- `transactionPermissionContractTransition`: *string* (hex integer)
- `validateChainIdTransition`: *string* (hex integer)
- `validateReceiptsTransition`: *string* (hex integer)
- `difficulty`: *string* (hex integer)
- `genesisHash`: *string* (hash)
- `headHash`: *string* (hash)
Expand Down Expand Up @@ -142,15 +230,16 @@ List of connected peers including information

`result`: array of *object*
- `address`: *string*
- `clientId`: *string*
- `clientType`: *string*
- `enode`: *string*
- `ethDetails`: *string*
- `host`: *string*
- `id`: *string*
- `isBootnode`: *boolean*
- `isStatic`: *boolean*
- `isTrusted`: *boolean*
- `lastSignal`: *string*
- `name`: *string*
- `port`: *string* (hex integer)

</TabItem>
Expand Down
Loading
Loading