From 0712e51b907acbb7daca8db8a5215938b50881e1 Mon Sep 17 00:00:00 2001 From: zhangkai Date: Thu, 29 Aug 2024 16:35:42 +0800 Subject: [PATCH] format doc --- docs/config-file/node-config-doc.html | 2 +- docs/config-file/node-config-doc.md | 25 +++++++++++++++++++------ 2 files changed, 20 insertions(+), 7 deletions(-) diff --git a/docs/config-file/node-config-doc.html b/docs/config-file/node-config-doc.html index e825ebd042..8b58221b25 100644 --- a/docs/config-file/node-config-doc.html +++ b/docs/config-file/node-config-doc.html @@ -20,7 +20,7 @@ 
"300ms"
RPC.MaxRequestsPerIPAndSecond=
Default: 500Type: number

MaxRequestsPerIPAndSecond defines how much requests a single IP can
send within a single second
RPC.SequencerNodeURI=
Default: ""Type: string

SequencerNodeURI is used allow Non-Sequencer nodes
to relay transactions to the Sequencer node
RPC.MaxCumulativeGasUsed=
Default: 0Type: integer

MaxCumulativeGasUsed is the max gas allowed per batch

WebSockets configuration
RPC.WebSockets.Enabled=
Default: trueType: boolean

Enabled defines if the WebSocket requests are enabled or disabled
RPC.WebSockets.Host=
Default: "0.0.0.0"Type: string

Host defines the network adapter that will be used to serve the WS requests
RPC.WebSockets.Port=
Default: 8546Type: integer

Port defines the port to serve the endpoints via WS
RPC.WebSockets.ReadLimit=
Default: 104857600Type: integer

ReadLimit defines the maximum size of a message read from the client (in bytes)
RPC.EnableL2SuggestedGasPricePolling=
Default: trueType: boolean

EnableL2SuggestedGasPricePolling enables polling of the L2 gas price to block tx in the RPC with lower gas price.
RPC.BatchRequestsEnabled=
Default: falseType: boolean

BatchRequestsEnabled defines if the Batch requests are enabled or disabled
RPC.BatchRequestsLimit=
Default: 20Type: integer

BatchRequestsLimit defines the limit of requests that can be incorporated into each batch request
RPC.L2Coinbase=
Type: array of integer

L2Coinbase defines which address is going to receive the fees

Must contain a minimum of 20 items

Must contain a maximum of 20 items

Each item of this array must be:

RPC.L2Coinbase.L2Coinbase items=
Type: integer
RPC.MaxLogsCount=
Default: 10000Type: integer

MaxLogsCount is a configuration to set the max number of logs that can be returned
in a single call to the state, if zero it means no limit
RPC.MaxLogsBlockRange=
Default: 10000Type: integer

MaxLogsBlockRange is a configuration to set the max range for block number when querying TXs
logs in a single call to the state, if zero it means no limit
RPC.MaxNativeBlockHashBlockRange=
Default: 60000Type: integer

MaxNativeBlockHashBlockRange is a configuration to set the max range for block number when querying
native block hashes in a single call to the state, if zero it means no limit
RPC.EnableHttpLog=
Default: trueType: boolean

EnableHttpLog allows the user to enable or disable the logs related to the HTTP
requests to be captured by the server.

ZKCountersLimits defines the ZK Counter limits
RPC.ZKCountersLimits.MaxKeccakHashes=
Default: 0Type: integer
RPC.ZKCountersLimits.MaxPoseidonHashes=
Default: 0Type: integer
RPC.ZKCountersLimits.MaxPoseidonPaddings=
Default: 0Type: integer
RPC.ZKCountersLimits.MaxMemAligns=
Default: 0Type: integer
RPC.ZKCountersLimits.MaxArithmetics=
Default: 0Type: integer
RPC.ZKCountersLimits.MaxBinaries=
Default: 0Type: integer
RPC.ZKCountersLimits.MaxSteps=
Default: 0Type: integer
RPC.ZKCountersLimits.MaxSHA256Hashes=
Default: 0Type: integer
RPC.EnablePendingTransactionFilter=
Default: falseType: boolean

XLayer config
EnablePendingTransactionFilter enables pending transaction filter that can support query L2 pending transaction

Nacos configuration
RPC.Nacos.URLs=
Default: ""Type: string

URLs nacos server urls for discovery service of rest api, url is separated by ","
RPC.Nacos.NamespaceId=
Default: ""Type: string

NamespaceId nacos namepace id for discovery service of rest api
RPC.Nacos.ApplicationName=
Default: ""Type: string

ApplicationName rest application name in nacos
RPC.Nacos.ExternalListenAddr=
Default: ""Type: string

ExternalListenAddr Set the rest-server external ip and port, when it is launched by Docker

NacosWs configuration
RPC.NacosWs.URLs=
Default: ""Type: string

URLs nacos server urls for discovery service of rest api, url is separated by ","
RPC.NacosWs.NamespaceId=
Default: ""Type: string

NamespaceId nacos namepace id for discovery service of rest api
RPC.NacosWs.ApplicationName=
Default: ""Type: string

ApplicationName rest application name in nacos
RPC.NacosWs.ExternalListenAddr=
Default: ""Type: string

ExternalListenAddr Set the rest-server external ip and port, when it is launched by Docker
RPC.GasLimitFactor=
Default: 1Type: number

GasLimitFactor is used to multiply the suggested gas provided by the network
in order to allow a enough gas to be set for all the transactions default value is 1.

ex:
suggested gas limit: 100
GasLimitFactor: 1
gas limit = 100

suggested gas limit: 100
GasLimitFactor: 1.1
gas limit = 110

RPC.EnableEstimateGasOpt=
Default: falseType: boolean
RPC.EnableEstimateGasUltraOpt=
Default: falseType: boolean
RPC.DisableAPIs=
Default: []Type: array of string

DisableAPIs disable some API

Each item of this array must be:

RPC.DisableAPIs.DisableAPIs items=
Type: string

RateLimit enable rate limit
RPC.RateLimit.Enabled=
Default: falseType: boolean

Enabled defines if the rate limit is enabled or disabled
RPC.RateLimit.RateLimitApis=
Default: []Type: array of string

RateLimitApis defines the apis that need to be rate limited

Each item of this array must be:

RPC.RateLimit.RateLimitApis.RateLimitApis items=
Type: string
RPC.RateLimit.RateLimitCount=
Default: 100Type: integer

RateLimitBurst defines the maximum burst size of requests
RPC.RateLimit.RateLimitDuration=
Default: 1Type: integer

RateLimitDuration defines the time window for the rate limit
RPC.RateLimit.SpecialApis=
Default: []Type: array of object

SpecialApis defines the apis that need to be rate limited with special rate limit

Each item of this array must be:

RPC.RateLimit.SpecialApis.SpecialApis items.Api=
Type: string

Api defines the api that need to be rate limited
RPC.RateLimit.SpecialApis.SpecialApis items.Count=
Type: integer

Count defines the maximum burst size of requests
RPC.RateLimit.SpecialApis.SpecialApis items.Duration=
Type: integer

Duration defines the time window for the rate limit

DynamicGP defines the config of dynamic gas price
RPC.DynamicGP.Enabled=
Default: falseType: boolean

Enabled defines if the dynamic gas price is enabled or disabled
RPC.DynamicGP.CongestionTxThreshold=
Default: 100Type: integer

CongestionTxThreshold defines the tx threshold to measure whether there is congestion
RPC.DynamicGP.CheckBatches=
Default: 5Type: integer

CheckBatches defines the number of recent Batches used to sample gas price
RPC.DynamicGP.SampleNumber=
Default: 3Type: integer

SampleTxNumer defines the number of sampled gas prices in each batch
RPC.DynamicGP.Percentile=
Default: 70Type: integer

Percentile defines the sampling weight of all sampled gas prices
RPC.DynamicGP.MaxPrice=
Default: 20000000000Type: integer

MaxPrice defines the dynamic gas price upper limit
RPC.DynamicGP.MinPrice=
Default: 2000000000Type: integer

MinPrice defines the dynamic gas price lower limit
RPC.DynamicGP.UpdatePeriod=
Default: "10s"Type: string

UpdatePeriod defines the time interval for updating dynamic gas price
Examples:

"1m"
 
"300ms"
-
RPC.EnableInnerTxCacheDB=
Default: falseType: boolean

EnableInnerTxCacheDB enables the inner tx cache db
RPC.BridgeAddress=
Type: array of integer

BridgeAddress is the address of the bridge contract

Must contain a minimum of 20 items

Must contain a maximum of 20 items

Each item of this array must be:

RPC.BridgeAddress.BridgeAddress items=
Type: integer

ApiAuthentication defines the authentication configuration for the API
RPC.ApiAuthentication.Enabled=
Default: falseType: boolean

Enabled defines if the api authentication is enabled
RPC.ApiAuthentication.ApiKeys=
Default: []Type: array of object

ApiKeys defines the api keys

Each item of this array must be:

RPC.ApiAuthentication.ApiKeys.ApiKeys items.Project=
Type: string

Name defines the name of the key
RPC.ApiAuthentication.ApiKeys.ApiKeys items.Key=
Type: string

Key defines the key
RPC.ApiAuthentication.ApiKeys.ApiKeys items.Timeout=
Type: string

Timeout defines the timeout

ApiRelay defines the relay configuration for the API
RPC.ApiRelay.Enabled=
Default: falseType: boolean
RPC.ApiRelay.DestURI=
Default: ""Type: string
RPC.ApiRelay.RPCs=
Default: []Type: array of string

Each item of this array must be:

RPC.ApiRelay.RPCs.RPCs items=
Type: string
RPC.ApiRelay.Rerun=
Default: falseType: boolean

Configuration of service `Syncrhonizer`. For this service is also really important the value of `IsTrustedSequencer` because depending of this values is going to ask to a trusted node for trusted transactions or not
Synchronizer.SyncInterval=
Default: "1s"Type: string

SyncInterval is the delay interval between reading new rollup information
Examples:

"1m"
+
RPC.EnableInnerTxCacheDB=
Default: falseType: boolean

EnableInnerTxCacheDB enables the inner tx cache db
RPC.BridgeAddress=
Type: array of integer

BridgeAddress is the address of the bridge contract

Must contain a minimum of 20 items

Must contain a maximum of 20 items

Each item of this array must be:

RPC.BridgeAddress.BridgeAddress items=
Type: integer

ApiAuthentication defines the authentication configuration for the API
RPC.ApiAuthentication.Enabled=
Default: falseType: boolean

Enabled defines if the api authentication is enabled
RPC.ApiAuthentication.ApiKeys=
Default: []Type: array of object

ApiKeys defines the api keys

Each item of this array must be:

RPC.ApiAuthentication.ApiKeys.ApiKeys items.Project=
Type: string

Name defines the name of the key
RPC.ApiAuthentication.ApiKeys.ApiKeys items.Key=
Type: string

Key defines the key
RPC.ApiAuthentication.ApiKeys.ApiKeys items.Timeout=
Type: string

Timeout defines the timeout

ApiRelay defines the relay configuration for the API
RPC.ApiRelay.Enabled=
Default: falseType: boolean
RPC.ApiRelay.DestURI=
Default: ""Type: string
RPC.ApiRelay.RPCs=
Default: []Type: array of string

Each item of this array must be:

RPC.ApiRelay.RPCs.RPCs items=
Type: string
RPC.ApiRelay.Rerun=
Default: falseType: boolean
RPC.ApiRelay.RelayAll=
Default: falseType: boolean

Configuration of service `Syncrhonizer`. For this service is also really important the value of `IsTrustedSequencer` because depending of this values is going to ask to a trusted node for trusted transactions or not
Synchronizer.SyncInterval=
Default: "1s"Type: string

SyncInterval is the delay interval between reading new rollup information
Examples:

"1m"
 
"300ms"
Synchronizer.SyncChunkSize=
Default: 100Type: integer

SyncChunkSize is the number of blocks to sync on each chunk
Synchronizer.TrustedSequencerURL=
Default: ""Type: string

TrustedSequencerURL is the rpc url to connect and sync the trusted state
Synchronizer.SyncBlockProtection=
Default: "safe"Type: string

SyncBlockProtection specify the state to sync (lastest, finalized or safe)
Synchronizer.L1SyncCheckL2BlockHash=
Default: trueType: boolean

L1SyncCheckL2BlockHash if is true when a batch is closed is force to check L2Block hash against trustedNode (only apply for permissionless)
Synchronizer.L1SyncCheckL2BlockNumberhModulus=
Default: 600Type: integer

L1SyncCheckL2BlockNumberhModulus is the modulus used to choose the l2block to check
a modules 5, for instance, means check all l2block multiples of 5 (10,15,20,...)
Synchronizer.L1BlockCheck.Enabled=
Default: trueType: boolean

If enabled then the check l1 Block Hash is active
Synchronizer.L1BlockCheck.L1SafeBlockPoint=
Default: "finalized"Type: enum (of string)

L1SafeBlockPoint is the point that a block is considered safe enough to be checked
it can be: finalized, safe,pending or latest

Must be one of:

  • "finalized"
  • "safe"
  • "latest"
Synchronizer.L1BlockCheck.L1SafeBlockOffset=
Default: 0Type: integer

L1SafeBlockOffset is the offset to add to L1SafeBlockPoint as a safe point
it can be positive or negative
Example: L1SafeBlockPoint= finalized, L1SafeBlockOffset= -10, then the safe block ten blocks before the finalized block
Synchronizer.L1BlockCheck.ForceCheckBeforeStart=
Default: trueType: boolean

ForceCheckBeforeStart if is true then the first time the system is started it will force to check all pending blocks
Synchronizer.L1BlockCheck.PreCheckEnabled=
Default: trueType: boolean

If enabled then the pre-check is active, will check blocks between L1SafeBlock and L1PreSafeBlock
Synchronizer.L1BlockCheck.L1PreSafeBlockPoint=
Default: "safe"Type: enum (of string)

L1PreSafeBlockPoint is the point that a block is considered safe enough to be checked
it can be: finalized, safe,pending or latest

Must be one of:

  • "finalized"
  • "safe"
  • "latest"
Synchronizer.L1BlockCheck.L1PreSafeBlockOffset=
Default: 0Type: integer

L1PreSafeBlockOffset is the offset to add to L1PreSafeBlockPoint as a safe point
it can be positive or negative
Example: L1PreSafeBlockPoint= finalized, L1PreSafeBlockOffset= -10, then the safe block ten blocks before the finalized block
Synchronizer.L1SynchronizationMode=
Default: "sequential"Type: enum (of string)

L1SynchronizationMode define how to synchronize with L1:
- parallel: Request data to L1 in parallel, and process sequentially. The advantage is that executor is not blocked waiting for L1 data
- sequential: Request data to L1 and execute

Must be one of:

  • "sequential"
  • "parallel"

L1ParallelSynchronization Configuration for parallel mode (if L1SynchronizationMode equal to 'parallel')
Synchronizer.L1ParallelSynchronization.MaxClients=
Default: 10Type: integer

MaxClients Number of clients used to synchronize with L1
Synchronizer.L1ParallelSynchronization.MaxPendingNoProcessedBlocks=
Default: 25Type: integer

MaxPendingNoProcessedBlocks Size of the buffer used to store rollup information from L1, must be >= to NumberOfEthereumClientsToSync
sugested twice of NumberOfParallelOfEthereumClients
Synchronizer.L1ParallelSynchronization.RequestLastBlockPeriod=
Default: "5s"Type: string

RequestLastBlockPeriod is the time to wait to request the
last block to L1 to known if we need to retrieve more data.
This value only apply when the system is synchronized
Examples:

"1m"
 
"300ms"
diff --git a/docs/config-file/node-config-doc.md b/docs/config-file/node-config-doc.md
index cf6cba6a3a..e13f7abb5b 100644
--- a/docs/config-file/node-config-doc.md
+++ b/docs/config-file/node-config-doc.md
@@ -2412,12 +2412,13 @@ ApiKeys=[]
 **Type:** : `object`
 **Description:** ApiRelay defines the relay configuration for the API
 
-| Property                            | Pattern | Type            | Deprecated | Definition | Title/Description |
-| ----------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
-| - [Enabled](#RPC_ApiRelay_Enabled ) | No      | boolean         | No         | -          | -                 |
-| - [DestURI](#RPC_ApiRelay_DestURI ) | No      | string          | No         | -          | -                 |
-| - [RPCs](#RPC_ApiRelay_RPCs )       | No      | array of string | No         | -          | -                 |
-| - [Rerun](#RPC_ApiRelay_Rerun )     | No      | boolean         | No         | -          | -                 |
+| Property                              | Pattern | Type            | Deprecated | Definition | Title/Description |
+| ------------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
+| - [Enabled](#RPC_ApiRelay_Enabled )   | No      | boolean         | No         | -          | -                 |
+| - [DestURI](#RPC_ApiRelay_DestURI )   | No      | string          | No         | -          | -                 |
+| - [RPCs](#RPC_ApiRelay_RPCs )         | No      | array of string | No         | -          | -                 |
+| - [Rerun](#RPC_ApiRelay_Rerun )       | No      | boolean         | No         | -          | -                 |
+| - [RelayAll](#RPC_ApiRelay_RelayAll ) | No      | boolean         | No         | -          | -                 |
 
 #### 8.30.1. `RPC.ApiRelay.Enabled`
 
@@ -2467,6 +2468,18 @@ RPCs=[]
 Rerun=false
 ```
 
+#### 8.30.5. `RPC.ApiRelay.RelayAll`
+
+**Type:** : `boolean`
+
+**Default:** `false`
+
+**Example setting the default value** (false):
+```
+[RPC.ApiRelay]
+RelayAll=false
+```
+
 ## 9. `[Synchronizer]`
 
 **Type:** : `object`