diff --git a/docs/fundamentals/configuration.md b/docs/fundamentals/configuration.md index dfd39bd0e..32860b644 100644 --- a/docs/fundamentals/configuration.md +++ b/docs/fundamentals/configuration.md @@ -1522,7 +1522,7 @@ The configuration options are case-sensitive and can be defined only once unless - An escaped JSON paylod to be sent to the web hook on failure. + An escaped JSON payload to be sent to the web hook on failure. Defaults to: ```json @@ -1574,7 +1574,7 @@ The configuration options are case-sensitive and can be defined only once unless - An escaped JSON paylod to be sent to the web hook on recovery. + An escaped JSON payload to be sent to the web hook on recovery. Defaults to: ```json @@ -4295,6 +4295,33 @@ The configuration options are case-sensitive and can be defined only once unless Whether to publish metrics using .NET diagnostics that can be collected with dotnet-counters. Allowed values: `true` `false`. Defaults to `false`. +- #### `Metrics.DbMetricIntervalSeconds` \{#metrics-dbmetricintervalseconds\} + + + + ``` + --metrics-dbmetricintervalseconds + --Metrics.DbMetricIntervalSeconds + ``` + + + ``` + NETHERMIND_METRICSCONFIG_DBMETRICINTERVALSECONDS= + ``` + + + ```json + { + "Metrics": { + "DbMetricIntervalSeconds": + } + } + ``` + + + + The frequency of updating db metrics, in seconds. Defaults to `60`. + - #### `Metrics.EnableDbSizeMetrics` \{#metrics-enabledbsizemetrics\} @@ -4538,6 +4565,33 @@ The configuration options are case-sensitive and can be defined only once unless The name to display on the Grafana dashboard. Defaults to `Nethermind`. +- #### `Metrics.PauseDbMetricDuringBlockProcessing` \{#metrics-pausedbmetricduringblockprocessing\} + + + + ``` + --metrics-pausedbmetricduringblockprocessing [true|false] + --Metrics.PauseDbMetricDuringBlockProcessing [true|false] + ``` + + + ``` + NETHERMIND_METRICSCONFIG_PAUSEDBMETRICDURINGBLOCKPROCESSING=true|false + ``` + + + ```json + { + "Metrics": { + "PauseDbMetricDuringBlockProcessing": true|false + } + } + ``` + + + + Pause db metric collection during block processing to prevent overhead. Allowed values: `true` `false`. Defaults to `true`. + - #### `Metrics.PushGatewayUrl` \{#metrics-pushgatewayurl\} @@ -5115,7 +5169,7 @@ The configuration options are case-sensitive and can be defined only once unless - The in-memory cache size, in MB. Bigger size tend to improve performance. Defaults to `1280`. + The in-memory cache size, in MB. Bigger size tend to improve performance. Defaults to `1792`. - #### `Pruning.DirtyCacheMb` \{#pruning-dirtycachemb\} @@ -5142,7 +5196,7 @@ The configuration options are case-sensitive and can be defined only once unless - The in-memory cache size for dirty nodes, in MB. Increasing this reduces pruning interval but cause increased pruning time. Defaults to `1024`. + The in-memory cache size for dirty nodes, in MB. Increasing this reduces pruning interval but cause increased pruning time. Defaults to `1536`. - #### `Pruning.DirtyNodeShardBit` \{#pruning-dirtynodeshardbit\} @@ -6627,6 +6681,90 @@ The configuration options are case-sensitive and can be defined only once unless The address of the TaikoInbox contract. Defaults to `null`. +- #### `Surge.TdxEnabled` \{#surge-tdxenabled\} + + + + ``` + --surge-tdxenabled [true|false] + --Surge.TdxEnabled [true|false] + ``` + + + ``` + NETHERMIND_SURGECONFIG_TDXENABLED=true|false + ``` + + + ```json + { + "Surge": { + "TdxEnabled": true|false + } + } + ``` + + + + Enable TDX attestation support. Allowed values: `true` `false`. Defaults to `false`. + + +### SurgeTdx + +- #### `SurgeTdx.ConfigPath` \{#surgetdx-configpath\} + + + + ``` + --surgetdx-configpath + --SurgeTdx.ConfigPath + ``` + + + ``` + NETHERMIND_SURGETDXCONFIG_CONFIGPATH= + ``` + + + ```json + { + "SurgeTdx": { + "ConfigPath": + } + } + ``` + + + + Path to store TDX bootstrap data and keys. Defaults to `~/.config/nethermind/tdx`. + +- #### `SurgeTdx.SocketPath` \{#surgetdx-socketpath\} + + + + ``` + --surgetdx-socketpath + --SurgeTdx.SocketPath + ``` + + + ``` + NETHERMIND_SURGETDXCONFIG_SOCKETPATH= + ``` + + + ```json + { + "SurgeTdx": { + "SocketPath": + } + } + ``` + + + + Path to the tdxs Unix socket. Defaults to `/var/tdxs.sock`. + ### Sync diff --git a/docs/interacting/json-rpc-ns/debug.md b/docs/interacting/json-rpc-ns/debug.md index 316cc7626..e64b930eb 100644 --- a/docs/interacting/json-rpc-ns/debug.md +++ b/docs/interacting/json-rpc-ns/debug.md @@ -461,7 +461,7 @@ curl localhost:8545 \ ### debug_getSyncStage -Retrives Nethermind Sync Stage, With extra Metadata +Retrieves Nethermind Sync Stage, With extra Metadata @@ -670,6 +670,7 @@ Retrieves geth like traces of the simulated blocks - `calls`: array of _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -689,6 +690,14 @@ Retrieves geth like traces of the simulated blocks 2. `blockParameter`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`) 3. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -788,6 +797,14 @@ This method is similar to the `debug_standardTraceBlockToFile` method, but can b 1. `blockHash`: _string_ (hash) 2. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -851,6 +868,14 @@ Writes to a file the full stack trace of all invoked opcodes of the transaction 1. `blockHash`: _string_ (hash) 2. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -914,6 +939,14 @@ Returns the full stack trace of all invoked opcodes of all transactions that wer 1. `blockRlp`: _string_ (hex data) 2. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -994,6 +1027,14 @@ Similar to debug_traceBlock, this method accepts a block hash and replays the bl 1. `blockHash`: _string_ (hash) 2. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -1074,6 +1115,14 @@ Similar to debug_traceBlock, this method accepts a block number as well as "late 1. `blockParameter`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`) 2. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -1154,6 +1203,7 @@ This method lets you run an eth_call within the context of the given block execu 1. `call`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -1162,6 +1212,14 @@ This method lets you run an eth_call within the context of the given block execu 2. `blockParameter`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`) 3. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -1258,6 +1316,7 @@ Executes a list of bundles of transactions without creating transactions on the - `transactions`: array of _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -1266,6 +1325,14 @@ Executes a list of bundles of transactions without creating transactions on the 2. `blockParameter`: _string_ (block number or hash or either of `earliest`, `finalized`, `latest`, `pending`, or `safe`) 3. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -1346,6 +1413,14 @@ This method will attempt to run the transaction in the exact same manner as it w 1. `transactionHash`: _string_ (hash) 2. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -1426,6 +1501,14 @@ curl localhost:8545 \ 2. `txIndex`: _string_ (hex integer) 3. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -1506,6 +1589,14 @@ curl localhost:8545 \ 2. `txIndex`: _string_ (hex integer) 3. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -1586,6 +1677,14 @@ curl localhost:8545 \ 2. `transactionHash`: _string_ (hash) 3. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ @@ -1666,6 +1765,14 @@ curl localhost:8545 \ 2. `txIndex`: _string_ (hex integer) 3. `options`: _object_ + - `blockOverrides`: _object_ + - `baseFeePerGas`: _string_ (hex integer) + - `blobBaseFee`: _string_ (hex integer) + - `feeRecipient`: _string_ (address) + - `gasLimit`: _string_ (hex integer) + - `number`: _string_ (hex integer) + - `prevRandao`: _string_ (hash) + - `time`: _string_ (hex integer) - `disableMemory`: _boolean_ - `disableStack`: _boolean_ - `disableStorage`: _boolean_ diff --git a/docs/interacting/json-rpc-ns/eth.md b/docs/interacting/json-rpc-ns/eth.md index 90af5c6e7..9a1df0f94 100644 --- a/docs/interacting/json-rpc-ns/eth.md +++ b/docs/interacting/json-rpc-ns/eth.md @@ -87,6 +87,7 @@ Executes a tx call (does not create a transaction) 1. `transactionCall`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -226,6 +227,7 @@ Creates an [EIP2930](https://eips.ethereum.org/EIPS/eip-2930) type AccessList fo 1. `transactionCall`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -280,6 +282,7 @@ Executes a tx call and returns gas used (does not create a transaction) 1. `transactionCall`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -1253,6 +1256,7 @@ curl localhost:8545 \ `result`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -1302,6 +1306,7 @@ curl localhost:8545 \ `result`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -1349,6 +1354,7 @@ curl localhost:8545 \ `result`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -1359,7 +1365,7 @@ curl localhost:8545 \ ### eth_getTransactionCount -Returns account nonce (number of trnsactions from the account since genesis) at the given block number +Returns account nonce (number of transactions from the account since genesis) at the given block number @@ -1856,6 +1862,7 @@ curl localhost:8545 \ `result`: array of _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -1950,6 +1957,7 @@ Send a transaction to the tx pool and broadcasting 1. `rpcTx`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -2007,6 +2015,7 @@ Executes a simulation across multiple blocks (does not create a transaction or b - `calls`: array of _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) diff --git a/docs/interacting/json-rpc-ns/proof.md b/docs/interacting/json-rpc-ns/proof.md index 01be941e8..ba20e6b5a 100644 --- a/docs/interacting/json-rpc-ns/proof.md +++ b/docs/interacting/json-rpc-ns/proof.md @@ -50,6 +50,7 @@ curl localhost:8545 \ - `transaction`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) diff --git a/docs/interacting/json-rpc-ns/trace.md b/docs/interacting/json-rpc-ns/trace.md index 13595d05c..718b3cf92 100644 --- a/docs/interacting/json-rpc-ns/trace.md +++ b/docs/interacting/json-rpc-ns/trace.md @@ -89,6 +89,7 @@ curl localhost:8545 \ 1. `call`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -202,6 +203,7 @@ Performs multiple traces on top of a block - `transaction`: _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -752,6 +754,7 @@ Returns parity like traces for simulated blocks - `calls`: array of _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) diff --git a/docs/interacting/json-rpc-ns/txpool.md b/docs/interacting/json-rpc-ns/txpool.md index ea8bda171..31e8a7d9d 100644 --- a/docs/interacting/json-rpc-ns/txpool.md +++ b/docs/interacting/json-rpc-ns/txpool.md @@ -42,6 +42,7 @@ curl localhost:8545 \ map of _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) @@ -50,6 +51,7 @@ map of _object_ map of _object_ - `blockHash`: _string_ (hash) - `blockNumber`: _string_ (hex integer) + - `blockTimestamp`: _string_ (hex integer) - `gas`: _string_ (hex integer) - `hash`: _string_ (hash) - `transactionIndex`: _string_ (hex integer) diff --git a/docs/monitoring/metrics/metrics.md b/docs/monitoring/metrics/metrics.md index 1c5b02bcd..92fa106c8 100644 --- a/docs/monitoring/metrics/metrics.md +++ b/docs/monitoring/metrics/metrics.md @@ -156,9 +156,14 @@ Currently, Nethermind provides the following options to monitor and collect metr Database writes per database +- #### `nethermind_detailed_metrics_enabled` \{#detailed_metrics_enabled\} +- #### `nethermind_prewarmer_get_time` \{#prewarmer_get_time\} + + Prewarmer get operation times + - #### `nethermind_state_db_pruning` \{#state_db_pruning\} - Indicator if StadeDb is being pruned. + Indicator if StateDb is being pruned. - #### `nethermind_state_reader_reads` \{#state_reader_reads\}