"300ms"
PollMinAllowedGasPriceInterval is the interval to poll the suggested min gas price for a tx
"1m"
"300ms"
-AccountQueue represents the maximum number of non-executable transaction slots permitted per account
GlobalQueue represents the maximum number of non-executable transaction slots for all accounts
Enabled is a flag to enable/disable the effective gas price
L1GasPriceFactor is the percentage of the L1 gas price that will be used as the L2 min gas price
ByteGasCost is the gas cost per byte that is not 0
ZeroByteGasCost is the gas cost per byte that is 0
NetProfit is the profit margin to apply to the calculated breakEvenGasPrice
BreakEvenFactor is the factor to apply to the calculated breakevenGasPrice when comparing it with the gasPriceSigned of a tx
FinalDeviationPct is the max allowed deviation percentage BreakEvenGasPrice on re-calculation
L2GasPriceSuggesterFactor is the factor to apply to L1 gas price to get the suggested L2 gas price used in the
calculations when the effective gas price is disabled (testing/metrics purposes)
ForkID is the current fork ID of the chain
Host defines the network adapter that will be used to serve the HTTP requests
Port defines the port to serve the endpoints via HTTP
ReadTimeout is the HTTP server read timeout
check net/http.server.ReadTimeout and net/http.server.ReadHeaderTimeout
"1m"
+AccountQueue represents the maximum number of non-executable transaction slots permitted per account
GlobalQueue represents the maximum number of non-executable transaction slots for all accounts
Enabled is a flag to enable/disable the effective gas price
L1GasPriceFactor is the percentage of the L1 gas price that will be used as the L2 min gas price
ByteGasCost is the gas cost per byte that is not 0
ZeroByteGasCost is the gas cost per byte that is 0
NetProfit is the profit margin to apply to the calculated breakEvenGasPrice
BreakEvenFactor is the factor to apply to the calculated breakevenGasPrice when comparing it with the gasPriceSigned of a tx
FinalDeviationPct is the max allowed deviation percentage BreakEvenGasPrice on re-calculation
EthTransferGasPrice is the fixed gas price returned as effective gas price for txs tha are ETH transfers (0 means disabled)
Only one of EthTransferGasPrice or EthTransferL1GasPriceFactor params can be different than 0. If both params are set to 0, the sequencer will halt and log an error
EthTransferL1GasPriceFactor is the percentage of L1 gas price returned as effective gas price for txs tha are ETH transfers (0 means disabled)
Only one of EthTransferGasPrice or EthTransferL1GasPriceFactor params can be different than 0. If both params are set to 0, the sequencer will halt and log an error
L2GasPriceSuggesterFactor is the factor to apply to L1 gas price to get the suggested L2 gas price used in the
calculations when the effective gas price is disabled (testing/metrics purposes)
ForkID is the current fork ID of the chain
Host defines the network adapter that will be used to serve the HTTP requests
Port defines the port to serve the endpoints via HTTP
ReadTimeout is the HTTP server read timeout
check net/http.server.ReadTimeout and net/http.server.ReadHeaderTimeout
"1m"
"300ms"
WriteTimeout is the HTTP server write timeout
check net/http.server.WriteTimeout
"1m"
"300ms"
@@ -50,11 +50,13 @@
"300ms"
L2BlockMaxDeltaTimestamp is the resolution of the timestamp used to close a L2 block
"1m"
"300ms"
-HaltOnBatchNumber specifies the batch number where the Sequencer will stop to process more transactions and generate new batches. The Sequencer will halt after it closes the batch equal to this number
SequentialBatchSanityCheck indicates if the reprocess of a closed batch (sanity check) must be done in a
sequential way (instead than in parallel)
Port to listen on
Filename of the binary data file
Enabled is a flag to enable/disable the data streamer
WaitPeriodSendSequence is the time the sequencer waits until
trying to send a sequence to L1
"1m"
+HaltOnBatchNumber specifies the batch number where the Sequencer will stop to process more transactions and generate new batches.
The Sequencer will halt after it closes the batch equal to this number
SequentialBatchSanityCheck indicates if the reprocess of a closed batch (sanity check) must be done in a
sequential way (instead than in parallel)
SequentialProcessL2Block indicates if the processing of a L2 Block must be done in the same finalizer go func instead
in the processPendingL2Blocks go func
Port to listen on
Filename of the binary data file
Version of the binary data file
ChainID is the chain ID
Enabled is a flag to enable/disable the data streamer
WaitPeriodSendSequence is the time the sequencer waits until
trying to send a sequence to L1
"1m"
"300ms"
LastBatchVirtualizationTimeMaxWaitPeriod is time since sequences should be sent
"1m"
"300ms"
-MaxTxSizeForL1 is the maximum size a single transaction can have. This field has
non-trivial consequences: larger transactions than 128KB are significantly harder and
more expensive to propagate; larger transactions also take more resources
to validate whether they fit into the pool or not.
SenderAddress defines which private key the eth tx manager needs to use
to sign the L1 txs
Must contain a minimum of 20 items
Must contain a maximum of 20 items
L2Coinbase defines which address is going to receive the fees
Must contain a minimum of 20 items
Must contain a maximum of 20 items
Path is the file path for the key store file
Password is the password to decrypt the key store file
Batch number where there is a forkid change (fork upgrade)
GasOffset is the amount of gas to be added to the gas estimation in order
to provide an amount that is higher than the estimated one. This is used
to avoid the TX getting reverted in case something has changed in the network
state after the estimation which can cause the TX to require more gas to be
executed.
ex:
gas estimation: 1000
gas offset: 100
final gas: 1100
MaxBatchesForL1 is the maximum amount of batches to be sequenced in a single L1 tx
Host for the grpc server
Port for the grpc server
RetryTime is the time the aggregator main loop sleeps if there are no proofs to aggregate
or batches to generate proofs. It is also used in the isSynced loop
"1m"
+L1BlockTimestampMargin is the time difference (margin) that must exists between last L1 block and last L2 block in the sequence before
to send the sequence to L1. If the difference is lower than this value then sequencesender will wait until the difference is equal or greater
"1m"
+"300ms"
+MaxTxSizeForL1 is the maximum size a single transaction can have. This field has
non-trivial consequences: larger transactions than 128KB are significantly harder and
more expensive to propagate; larger transactions also take more resources
to validate whether they fit into the pool or not.
SenderAddress defines which private key the eth tx manager needs to use
to sign the L1 txs
Must contain a minimum of 20 items
Must contain a maximum of 20 items
L2Coinbase defines which address is going to receive the fees
Must contain a minimum of 20 items
Must contain a maximum of 20 items
Path is the file path for the key store file
Password is the password to decrypt the key store file
Batch number where there is a forkid change (fork upgrade)
GasOffset is the amount of gas to be added to the gas estimation in order
to provide an amount that is higher than the estimated one. This is used
to avoid the TX getting reverted in case something has changed in the network
state after the estimation which can cause the TX to require more gas to be
executed.
ex:
gas estimation: 1000
gas offset: 100
final gas: 1100
MaxBatchesForL1 is the maximum amount of batches to be sequenced in a single L1 tx
Datastream server to connect
Environment defining the log format ("production" or "development").
In development mode enables development mode (which makes DPanicLevel logs panic), uses a console encoder, writes to standard error, and disables sampling. Stacktraces are automatically included on logs of WarnLevel and above.
Check here
Level of log. As lower value more logs are going to be generated
Outputs
Host for the grpc server
Port for the grpc server
RetryTime is the time the aggregator main loop sleeps if there are no proofs to aggregate
or batches to generate proofs. It is also used in the isSynced loop
"1m"
"300ms"
VerifyProofInterval is the interval of time to verify/send an proof in L1
"1m"
"300ms"
@@ -64,7 +66,7 @@
"300ms"
ChainID is the L2 ChainID provided by the Network Config
ForkID is the L2 ForkID provided by the Network Config
SenderAddress defines which private key the eth tx manager needs to use
to sign the L1 txs
CleanupLockedProofsInterval is the interval of time to clean up locked proofs.
"1m"
"300ms"
-GeneratingProofCleanupThreshold represents the time interval after
which a proof in generating state is considered to be stuck and
allowed to be cleared.
GasOffset is the amount of gas to be added to the gas estimation in order
to provide an amount that is higher than the estimated one. This is used
to avoid the TX getting reverted in case something has changed in the network
state after the estimation which can cause the TX to require more gas to be
executed.
ex:
gas estimation: 1000
gas offset: 100
final gas: 1100
Chain ID of the L1 network
ZkEVMAddr Address of the L1 contract polygonZkEVMAddress
Must contain a minimum of 20 items
Must contain a maximum of 20 items
RollupManagerAddr Address of the L1 contract
Must contain a minimum of 20 items
Must contain a maximum of 20 items
PolAddr Address of the L1 Pol token Contract
Must contain a minimum of 20 items
Must contain a maximum of 20 items
GlobalExitRootManagerAddr Address of the L1 GlobalExitRootManager contract
Must contain a minimum of 20 items
Must contain a maximum of 20 items
BlockNumber is the block number where the polygonZKEVM smc was deployed on L1
Root hash of the genesis block
Must contain a minimum of 32 items
Must contain a maximum of 32 items
Actions is the data to populate into the state trie
DefaultGasPriceWei is used to set the gas price to be used by the default gas pricer or as minimim gas price by the follower gas pricer.
MaxGasPriceWei is used to limit the gas price returned by the follower gas pricer to a maximum value. It is ignored if 0.
"1m"
+GeneratingProofCleanupThreshold represents the time interval after
which a proof in generating state is considered to be stuck and
allowed to be cleared.
GasOffset is the amount of gas to be added to the gas estimation in order
to provide an amount that is higher than the estimated one. This is used
to avoid the TX getting reverted in case something has changed in the network
state after the estimation which can cause the TX to require more gas to be
executed.
ex:
gas estimation: 1000
gas offset: 100
final gas: 1100
UpgradeEtrogBatchNumber is the number of the first batch after upgrading to etrog
Chain ID of the L1 network
ZkEVMAddr Address of the L1 contract polygonZkEVMAddress
Must contain a minimum of 20 items
Must contain a maximum of 20 items
RollupManagerAddr Address of the L1 contract
Must contain a minimum of 20 items
Must contain a maximum of 20 items
PolAddr Address of the L1 Pol token Contract
Must contain a minimum of 20 items
Must contain a maximum of 20 items
GlobalExitRootManagerAddr Address of the L1 GlobalExitRootManager contract
Must contain a minimum of 20 items
Must contain a maximum of 20 items
BlockNumber is the block number where the polygonZKEVM smc was deployed on L1
Root hash of the genesis block
Must contain a minimum of 32 items
Must contain a maximum of 32 items
Actions is the data to populate into the state trie
DefaultGasPriceWei is used to set the gas price to be used by the default gas pricer or as minimim gas price by the follower gas pricer.
MaxGasPriceWei is used to limit the gas price returned by the follower gas pricer to a maximum value. It is ignored if 0.
"1m"
"300ms"
"1m"
"300ms"
diff --git a/docs/config-file/node-config-doc.md b/docs/config-file/node-config-doc.md
index b334368c7c..c094c7ebf6 100644
--- a/docs/config-file/node-config-doc.md
+++ b/docs/config-file/node-config-doc.md
@@ -720,16 +720,18 @@ GlobalQueue=1024
**Type:** : `object`
**Description:** EffectiveGasPrice is the config for the effective gas price calculation
-| Property | Pattern | Type | Deprecated | Definition | Title/Description |
-| --------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| - [Enabled](#Pool_EffectiveGasPrice_Enabled ) | No | boolean | No | - | Enabled is a flag to enable/disable the effective gas price |
-| - [L1GasPriceFactor](#Pool_EffectiveGasPrice_L1GasPriceFactor ) | No | number | No | - | L1GasPriceFactor is the percentage of the L1 gas price that will be used as the L2 min gas price |
-| - [ByteGasCost](#Pool_EffectiveGasPrice_ByteGasCost ) | No | integer | No | - | ByteGasCost is the gas cost per byte that is not 0 |
-| - [ZeroByteGasCost](#Pool_EffectiveGasPrice_ZeroByteGasCost ) | No | integer | No | - | ZeroByteGasCost is the gas cost per byte that is 0 |
-| - [NetProfit](#Pool_EffectiveGasPrice_NetProfit ) | No | number | No | - | NetProfit is the profit margin to apply to the calculated breakEvenGasPrice |
-| - [BreakEvenFactor](#Pool_EffectiveGasPrice_BreakEvenFactor ) | No | number | No | - | BreakEvenFactor is the factor to apply to the calculated breakevenGasPrice when comparing it with the gasPriceSigned of a tx |
-| - [FinalDeviationPct](#Pool_EffectiveGasPrice_FinalDeviationPct ) | No | integer | No | - | FinalDeviationPct is the max allowed deviation percentage BreakEvenGasPrice on re-calculation |
-| - [L2GasPriceSuggesterFactor](#Pool_EffectiveGasPrice_L2GasPriceSuggesterFactor ) | No | number | No | - | L2GasPriceSuggesterFactor is the factor to apply to L1 gas price to get the suggested L2 gas price used in the
calculations when the effective gas price is disabled (testing/metrics purposes) |
+| Property | Pattern | Type | Deprecated | Definition | Title/Description |
+| ------------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| - [Enabled](#Pool_EffectiveGasPrice_Enabled ) | No | boolean | No | - | Enabled is a flag to enable/disable the effective gas price |
+| - [L1GasPriceFactor](#Pool_EffectiveGasPrice_L1GasPriceFactor ) | No | number | No | - | L1GasPriceFactor is the percentage of the L1 gas price that will be used as the L2 min gas price |
+| - [ByteGasCost](#Pool_EffectiveGasPrice_ByteGasCost ) | No | integer | No | - | ByteGasCost is the gas cost per byte that is not 0 |
+| - [ZeroByteGasCost](#Pool_EffectiveGasPrice_ZeroByteGasCost ) | No | integer | No | - | ZeroByteGasCost is the gas cost per byte that is 0 |
+| - [NetProfit](#Pool_EffectiveGasPrice_NetProfit ) | No | number | No | - | NetProfit is the profit margin to apply to the calculated breakEvenGasPrice |
+| - [BreakEvenFactor](#Pool_EffectiveGasPrice_BreakEvenFactor ) | No | number | No | - | BreakEvenFactor is the factor to apply to the calculated breakevenGasPrice when comparing it with the gasPriceSigned of a tx |
+| - [FinalDeviationPct](#Pool_EffectiveGasPrice_FinalDeviationPct ) | No | integer | No | - | FinalDeviationPct is the max allowed deviation percentage BreakEvenGasPrice on re-calculation |
+| - [EthTransferGasPrice](#Pool_EffectiveGasPrice_EthTransferGasPrice ) | No | integer | No | - | EthTransferGasPrice is the fixed gas price returned as effective gas price for txs tha are ETH transfers (0 means disabled)
Only one of EthTransferGasPrice or EthTransferL1GasPriceFactor params can be different than 0. If both params are set to 0, the sequencer will halt and log an error |
+| - [EthTransferL1GasPriceFactor](#Pool_EffectiveGasPrice_EthTransferL1GasPriceFactor ) | No | number | No | - | EthTransferL1GasPriceFactor is the percentage of L1 gas price returned as effective gas price for txs tha are ETH transfers (0 means disabled)
Only one of EthTransferGasPrice or EthTransferL1GasPriceFactor params can be different than 0. If both params are set to 0, the sequencer will halt and log an error |
+| - [L2GasPriceSuggesterFactor](#Pool_EffectiveGasPrice_L2GasPriceSuggesterFactor ) | No | number | No | - | L2GasPriceSuggesterFactor is the factor to apply to L1 gas price to get the suggested L2 gas price used in the
calculations when the effective gas price is disabled (testing/metrics purposes) |
#### 7.11.1. `Pool.EffectiveGasPrice.Enabled`
@@ -829,7 +831,37 @@ BreakEvenFactor=1.1
FinalDeviationPct=10
```
-#### 7.11.8. `Pool.EffectiveGasPrice.L2GasPriceSuggesterFactor`
+#### 7.11.8. `Pool.EffectiveGasPrice.EthTransferGasPrice`
+
+**Type:** : `integer`
+
+**Default:** `0`
+
+**Description:** EthTransferGasPrice is the fixed gas price returned as effective gas price for txs tha are ETH transfers (0 means disabled)
+Only one of EthTransferGasPrice or EthTransferL1GasPriceFactor params can be different than 0. If both params are set to 0, the sequencer will halt and log an error
+
+**Example setting the default value** (0):
+```
+[Pool.EffectiveGasPrice]
+EthTransferGasPrice=0
+```
+
+#### 7.11.9. `Pool.EffectiveGasPrice.EthTransferL1GasPriceFactor`
+
+**Type:** : `number`
+
+**Default:** `0`
+
+**Description:** EthTransferL1GasPriceFactor is the percentage of L1 gas price returned as effective gas price for txs tha are ETH transfers (0 means disabled)
+Only one of EthTransferGasPrice or EthTransferL1GasPriceFactor params can be different than 0. If both params are set to 0, the sequencer will halt and log an error
+
+**Example setting the default value** (0):
+```
+[Pool.EffectiveGasPrice]
+EthTransferL1GasPriceFactor=0
+```
+
+#### 7.11.10. `Pool.EffectiveGasPrice.L2GasPriceSuggesterFactor`
**Type:** : `number`
@@ -1697,19 +1729,20 @@ StateConsistencyCheckInterval="5s"
**Type:** : `object`
**Description:** Finalizer's specific config properties
-| Property | Pattern | Type | Deprecated | Definition | Title/Description |
-| ---------------------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| - [ForcedBatchesTimeout](#Sequencer_Finalizer_ForcedBatchesTimeout ) | No | string | No | - | Duration |
-| - [NewTxsWaitInterval](#Sequencer_Finalizer_NewTxsWaitInterval ) | No | string | No | - | Duration |
-| - [ResourceExhaustedMarginPct](#Sequencer_Finalizer_ResourceExhaustedMarginPct ) | No | integer | No | - | ResourceExhaustedMarginPct is the percentage window of the resource left out for the batch to be closed |
-| - [ForcedBatchesL1BlockConfirmations](#Sequencer_Finalizer_ForcedBatchesL1BlockConfirmations ) | No | integer | No | - | ForcedBatchesL1BlockConfirmations is number of blocks to consider GER final |
-| - [L1InfoTreeL1BlockConfirmations](#Sequencer_Finalizer_L1InfoTreeL1BlockConfirmations ) | No | integer | No | - | L1InfoTreeL1BlockConfirmations is number of blocks to consider L1InfoRoot final |
-| - [ForcedBatchesCheckInterval](#Sequencer_Finalizer_ForcedBatchesCheckInterval ) | No | string | No | - | Duration |
-| - [L1InfoTreeCheckInterval](#Sequencer_Finalizer_L1InfoTreeCheckInterval ) | No | string | No | - | Duration |
-| - [BatchMaxDeltaTimestamp](#Sequencer_Finalizer_BatchMaxDeltaTimestamp ) | No | string | No | - | Duration |
-| - [L2BlockMaxDeltaTimestamp](#Sequencer_Finalizer_L2BlockMaxDeltaTimestamp ) | No | string | No | - | Duration |
-| - [HaltOnBatchNumber](#Sequencer_Finalizer_HaltOnBatchNumber ) | No | integer | No | - | HaltOnBatchNumber specifies the batch number where the Sequencer will stop to process more transactions and generate new batches. The Sequencer will halt after it closes the batch equal to this number |
-| - [SequentialBatchSanityCheck](#Sequencer_Finalizer_SequentialBatchSanityCheck ) | No | boolean | No | - | SequentialBatchSanityCheck indicates if the reprocess of a closed batch (sanity check) must be done in a
sequential way (instead than in parallel) |
+| Property | Pattern | Type | Deprecated | Definition | Title/Description |
+| ---------------------------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - [ForcedBatchesTimeout](#Sequencer_Finalizer_ForcedBatchesTimeout ) | No | string | No | - | Duration |
+| - [NewTxsWaitInterval](#Sequencer_Finalizer_NewTxsWaitInterval ) | No | string | No | - | Duration |
+| - [ResourceExhaustedMarginPct](#Sequencer_Finalizer_ResourceExhaustedMarginPct ) | No | integer | No | - | ResourceExhaustedMarginPct is the percentage window of the resource left out for the batch to be closed |
+| - [ForcedBatchesL1BlockConfirmations](#Sequencer_Finalizer_ForcedBatchesL1BlockConfirmations ) | No | integer | No | - | ForcedBatchesL1BlockConfirmations is number of blocks to consider GER final |
+| - [L1InfoTreeL1BlockConfirmations](#Sequencer_Finalizer_L1InfoTreeL1BlockConfirmations ) | No | integer | No | - | L1InfoTreeL1BlockConfirmations is number of blocks to consider L1InfoRoot final |
+| - [ForcedBatchesCheckInterval](#Sequencer_Finalizer_ForcedBatchesCheckInterval ) | No | string | No | - | Duration |
+| - [L1InfoTreeCheckInterval](#Sequencer_Finalizer_L1InfoTreeCheckInterval ) | No | string | No | - | Duration |
+| - [BatchMaxDeltaTimestamp](#Sequencer_Finalizer_BatchMaxDeltaTimestamp ) | No | string | No | - | Duration |
+| - [L2BlockMaxDeltaTimestamp](#Sequencer_Finalizer_L2BlockMaxDeltaTimestamp ) | No | string | No | - | Duration |
+| - [HaltOnBatchNumber](#Sequencer_Finalizer_HaltOnBatchNumber ) | No | integer | No | - | HaltOnBatchNumber specifies the batch number where the Sequencer will stop to process more transactions and generate new batches.
The Sequencer will halt after it closes the batch equal to this number |
+| - [SequentialBatchSanityCheck](#Sequencer_Finalizer_SequentialBatchSanityCheck ) | No | boolean | No | - | SequentialBatchSanityCheck indicates if the reprocess of a closed batch (sanity check) must be done in a
sequential way (instead than in parallel) |
+| - [SequentialProcessL2Block](#Sequencer_Finalizer_SequentialProcessL2Block ) | No | boolean | No | - | SequentialProcessL2Block indicates if the processing of a L2 Block must be done in the same finalizer go func instead
in the processPendingL2Blocks go func |
#### 10.7.1. `Sequencer.Finalizer.ForcedBatchesTimeout`
@@ -1915,7 +1948,8 @@ L2BlockMaxDeltaTimestamp="3s"
**Default:** `0`
-**Description:** HaltOnBatchNumber specifies the batch number where the Sequencer will stop to process more transactions and generate new batches. The Sequencer will halt after it closes the batch equal to this number
+**Description:** HaltOnBatchNumber specifies the batch number where the Sequencer will stop to process more transactions and generate new batches.
+The Sequencer will halt after it closes the batch equal to this number
**Example setting the default value** (0):
```
@@ -1938,6 +1972,21 @@ sequential way (instead than in parallel)
SequentialBatchSanityCheck=false
```
+#### 10.7.12. `Sequencer.Finalizer.SequentialProcessL2Block`
+
+**Type:** : `boolean`
+
+**Default:** `true`
+
+**Description:** SequentialProcessL2Block indicates if the processing of a L2 Block must be done in the same finalizer go func instead
+in the processPendingL2Blocks go func
+
+**Example setting the default value** (true):
+```
+[Sequencer.Finalizer]
+SequentialProcessL2Block=true
+```
+
### 10.8. `[Sequencer.StreamServer]`
**Type:** : `object`
@@ -1947,6 +1996,8 @@ SequentialBatchSanityCheck=false
| ----------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------- |
| - [Port](#Sequencer_StreamServer_Port ) | No | integer | No | - | Port to listen on |
| - [Filename](#Sequencer_StreamServer_Filename ) | No | string | No | - | Filename of the binary data file |
+| - [Version](#Sequencer_StreamServer_Version ) | No | integer | No | - | Version of the binary data file |
+| - [ChainID](#Sequencer_StreamServer_ChainID ) | No | integer | No | - | ChainID is the chain ID |
| - [Enabled](#Sequencer_StreamServer_Enabled ) | No | boolean | No | - | Enabled is a flag to enable/disable the data streamer |
| - [Log](#Sequencer_StreamServer_Log ) | No | object | No | - | Log is the log configuration |
@@ -1978,7 +2029,35 @@ Port=0
Filename=""
```
-#### 10.8.3. `Sequencer.StreamServer.Enabled`
+#### 10.8.3. `Sequencer.StreamServer.Version`
+
+**Type:** : `integer`
+
+**Default:** `0`
+
+**Description:** Version of the binary data file
+
+**Example setting the default value** (0):
+```
+[Sequencer.StreamServer]
+Version=0
+```
+
+#### 10.8.4. `Sequencer.StreamServer.ChainID`
+
+**Type:** : `integer`
+
+**Default:** `0`
+
+**Description:** ChainID is the chain ID
+
+**Example setting the default value** (0):
+```
+[Sequencer.StreamServer]
+ChainID=0
+```
+
+#### 10.8.5. `Sequencer.StreamServer.Enabled`
**Type:** : `boolean`
@@ -1992,7 +2071,7 @@ Filename=""
Enabled=false
```
-#### 10.8.4. `[Sequencer.StreamServer.Log]`
+#### 10.8.6. `[Sequencer.StreamServer.Log]`
**Type:** : `object`
**Description:** Log is the log configuration
@@ -2003,7 +2082,7 @@ Enabled=false
| - [Level](#Sequencer_StreamServer_Log_Level ) | No | enum (of string) | No | - | - |
| - [Outputs](#Sequencer_StreamServer_Log_Outputs ) | No | array of string | No | - | - |
-##### 10.8.4.1. `Sequencer.StreamServer.Log.Environment`
+##### 10.8.6.1. `Sequencer.StreamServer.Log.Environment`
**Type:** : `enum (of string)`
@@ -2019,7 +2098,7 @@ Must be one of:
* "production"
* "development"
-##### 10.8.4.2. `Sequencer.StreamServer.Log.Level`
+##### 10.8.6.2. `Sequencer.StreamServer.Log.Level`
**Type:** : `enum (of string)`
@@ -2040,7 +2119,7 @@ Must be one of:
* "panic"
* "fatal"
-##### 10.8.4.3. `Sequencer.StreamServer.Log.Outputs`
+##### 10.8.6.3. `Sequencer.StreamServer.Log.Outputs`
**Type:** : `array of string`
@@ -2053,6 +2132,7 @@ Must be one of:
| ------------------------------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| - [WaitPeriodSendSequence](#SequenceSender_WaitPeriodSendSequence ) | No | string | No | - | Duration |
| - [LastBatchVirtualizationTimeMaxWaitPeriod](#SequenceSender_LastBatchVirtualizationTimeMaxWaitPeriod ) | No | string | No | - | Duration |
+| - [L1BlockTimestampMargin](#SequenceSender_L1BlockTimestampMargin ) | No | string | No | - | Duration |
| - [MaxTxSizeForL1](#SequenceSender_MaxTxSizeForL1 ) | No | integer | No | - | MaxTxSizeForL1 is the maximum size a single transaction can have. This field has
non-trivial consequences: larger transactions than 128KB are significantly harder and
more expensive to propagate; larger transactions also take more resources
to validate whether they fit into the pool or not. |
| - [SenderAddress](#SequenceSender_SenderAddress ) | No | array of integer | No | - | SenderAddress defines which private key the eth tx manager needs to use
to sign the L1 txs |
| - [L2Coinbase](#SequenceSender_L2Coinbase ) | No | array of integer | No | - | L2Coinbase defines which address is going to receive the fees |
@@ -2060,6 +2140,7 @@ Must be one of:
| - [ForkUpgradeBatchNumber](#SequenceSender_ForkUpgradeBatchNumber ) | No | integer | No | - | Batch number where there is a forkid change (fork upgrade) |
| - [GasOffset](#SequenceSender_GasOffset ) | No | integer | No | - | GasOffset is the amount of gas to be added to the gas estimation in order
to provide an amount that is higher than the estimated one. This is used
to avoid the TX getting reverted in case something has changed in the network
state after the estimation which can cause the TX to require more gas to be
executed.
ex:
gas estimation: 1000
gas offset: 100
final gas: 1100 |
| - [MaxBatchesForL1](#SequenceSender_MaxBatchesForL1 ) | No | integer | No | - | MaxBatchesForL1 is the maximum amount of batches to be sequenced in a single L1 tx |
+| - [StreamClient](#SequenceSender_StreamClient ) | No | object | No | - | StreamClientCfg is the config for the stream client |
### 11.1. `SequenceSender.WaitPeriodSendSequence`
@@ -2114,7 +2195,34 @@ WaitPeriodSendSequence="5s"
LastBatchVirtualizationTimeMaxWaitPeriod="5s"
```
-### 11.3. `SequenceSender.MaxTxSizeForL1`
+### 11.3. `SequenceSender.L1BlockTimestampMargin`
+
+**Title:** Duration
+
+**Type:** : `string`
+
+**Default:** `"30s"`
+
+**Description:** L1BlockTimestampMargin is the time difference (margin) that must exists between last L1 block and last L2 block in the sequence before
+to send the sequence to L1. If the difference is lower than this value then sequencesender will wait until the difference is equal or greater
+
+**Examples:**
+
+```json
+"1m"
+```
+
+```json
+"300ms"
+```
+
+**Example setting the default value** ("30s"):
+```
+[SequenceSender]
+L1BlockTimestampMargin="30s"
+```
+
+### 11.4. `SequenceSender.MaxTxSizeForL1`
**Type:** : `integer`
@@ -2131,13 +2239,13 @@ to validate whether they fit into the pool or not.
MaxTxSizeForL1=131072
```
-### 11.4. `SequenceSender.SenderAddress`
+### 11.5. `SequenceSender.SenderAddress`
**Type:** : `array of integer`
**Description:** SenderAddress defines which private key the eth tx manager needs to use
to sign the L1 txs
-### 11.5. `SequenceSender.L2Coinbase`
+### 11.6. `SequenceSender.L2Coinbase`
**Type:** : `array of integer`
@@ -2151,7 +2259,7 @@ to sign the L1 txs
L2Coinbase="0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266"
```
-### 11.6. `[SequenceSender.PrivateKey]`
+### 11.7. `[SequenceSender.PrivateKey]`
**Type:** : `object`
**Description:** PrivateKey defines all the key store files that are going
@@ -2162,7 +2270,7 @@ to be read in order to provide the private keys to sign the L1 txs
| - [Path](#SequenceSender_PrivateKey_Path ) | No | string | No | - | Path is the file path for the key store file |
| - [Password](#SequenceSender_PrivateKey_Password ) | No | string | No | - | Password is the password to decrypt the key store file |
-#### 11.6.1. `SequenceSender.PrivateKey.Path`
+#### 11.7.1. `SequenceSender.PrivateKey.Path`
**Type:** : `string`
@@ -2176,7 +2284,7 @@ to be read in order to provide the private keys to sign the L1 txs
Path="/pk/sequencer.keystore"
```
-#### 11.6.2. `SequenceSender.PrivateKey.Password`
+#### 11.7.2. `SequenceSender.PrivateKey.Password`
**Type:** : `string`
@@ -2190,7 +2298,7 @@ Path="/pk/sequencer.keystore"
Password="testonly"
```
-### 11.7. `SequenceSender.ForkUpgradeBatchNumber`
+### 11.8. `SequenceSender.ForkUpgradeBatchNumber`
**Type:** : `integer`
@@ -2204,7 +2312,7 @@ Password="testonly"
ForkUpgradeBatchNumber=0
```
-### 11.8. `SequenceSender.GasOffset`
+### 11.9. `SequenceSender.GasOffset`
**Type:** : `integer`
@@ -2227,7 +2335,7 @@ final gas: 1100
GasOffset=80000
```
-### 11.9. `SequenceSender.MaxBatchesForL1`
+### 11.10. `SequenceSender.MaxBatchesForL1`
**Type:** : `integer`
@@ -2241,6 +2349,89 @@ GasOffset=80000
MaxBatchesForL1=300
```
+### 11.11. `[SequenceSender.StreamClient]`
+
+**Type:** : `object`
+**Description:** StreamClientCfg is the config for the stream client
+
+| Property | Pattern | Type | Deprecated | Definition | Title/Description |
+| ------------------------------------------------ | ------- | ------ | ---------- | ---------- | ---------------------------- |
+| - [Server](#SequenceSender_StreamClient_Server ) | No | string | No | - | Datastream server to connect |
+| - [Log](#SequenceSender_StreamClient_Log ) | No | object | No | - | Log is the log configuration |
+
+#### 11.11.1. `SequenceSender.StreamClient.Server`
+
+**Type:** : `string`
+
+**Default:** `""`
+
+**Description:** Datastream server to connect
+
+**Example setting the default value** (""):
+```
+[SequenceSender.StreamClient]
+Server=""
+```
+
+#### 11.11.2. `[SequenceSender.StreamClient.Log]`
+
+**Type:** : `object`
+**Description:** Log is the log configuration
+
+| Property | Pattern | Type | Deprecated | Definition | Title/Description |
+| -------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| - [Environment](#SequenceSender_StreamClient_Log_Environment ) | No | enum (of string) | No | - | Environment defining the log format ("production" or "development").
In development mode enables development mode (which makes DPanicLevel logs panic), uses a console encoder, writes to standard error, and disables sampling. Stacktraces are automatically included on logs of WarnLevel and above.
Check [here](https://pkg.go.dev/go.uber.org/zap@v1.24.0#NewDevelopmentConfig) |
+| - [Level](#SequenceSender_StreamClient_Log_Level ) | No | enum (of string) | No | - | Level of log. As lower value more logs are going to be generated |
+| - [Outputs](#SequenceSender_StreamClient_Log_Outputs ) | No | array of string | No | - | Outputs |
+
+##### 11.11.2.1. `SequenceSender.StreamClient.Log.Environment`
+
+**Type:** : `enum (of string)`
+
+**Default:** `""`
+
+**Description:** Environment defining the log format ("production" or "development").
+In development mode enables development mode (which makes DPanicLevel logs panic), uses a console encoder, writes to standard error, and disables sampling. Stacktraces are automatically included on logs of WarnLevel and above.
+Check [here](https://pkg.go.dev/go.uber.org/zap@v1.24.0#NewDevelopmentConfig)
+
+**Example setting the default value** (""):
+```
+[SequenceSender.StreamClient.Log]
+Environment=""
+```
+
+Must be one of:
+* "production"
+* "development"
+
+##### 11.11.2.2. `SequenceSender.StreamClient.Log.Level`
+
+**Type:** : `enum (of string)`
+
+**Default:** `""`
+
+**Description:** Level of log. As lower value more logs are going to be generated
+
+**Example setting the default value** (""):
+```
+[SequenceSender.StreamClient.Log]
+Level=""
+```
+
+Must be one of:
+* "debug"
+* "info"
+* "warn"
+* "error"
+* "dpanic"
+* "panic"
+* "fatal"
+
+##### 11.11.2.3. `SequenceSender.StreamClient.Log.Outputs`
+
+**Type:** : `array of string`
+**Description:** Outputs
+
## 12. `[Aggregator]`
**Type:** : `object`
@@ -2262,6 +2453,7 @@ MaxBatchesForL1=300
| - [CleanupLockedProofsInterval](#Aggregator_CleanupLockedProofsInterval ) | No | string | No | - | Duration |
| - [GeneratingProofCleanupThreshold](#Aggregator_GeneratingProofCleanupThreshold ) | No | string | No | - | GeneratingProofCleanupThreshold represents the time interval after
which a proof in generating state is considered to be stuck and
allowed to be cleared. |
| - [GasOffset](#Aggregator_GasOffset ) | No | integer | No | - | GasOffset is the amount of gas to be added to the gas estimation in order
to provide an amount that is higher than the estimated one. This is used
to avoid the TX getting reverted in case something has changed in the network
state after the estimation which can cause the TX to require more gas to be
executed.
ex:
gas estimation: 1000
gas offset: 100
final gas: 1100 |
+| - [UpgradeEtrogBatchNumber](#Aggregator_UpgradeEtrogBatchNumber ) | No | integer | No | - | UpgradeEtrogBatchNumber is the number of the first batch after upgrading to etrog |
### 12.1. `Aggregator.Host`
@@ -2525,6 +2717,20 @@ final gas: 1100
GasOffset=0
```
+### 12.15. `Aggregator.UpgradeEtrogBatchNumber`
+
+**Type:** : `integer`
+
+**Default:** `0`
+
+**Description:** UpgradeEtrogBatchNumber is the number of the first batch after upgrading to etrog
+
+**Example setting the default value** (0):
+```
+[Aggregator]
+UpgradeEtrogBatchNumber=0
+```
+
## 13. `[NetworkConfig]`
**Type:** : `object`
diff --git a/docs/config-file/node-config-schema.json b/docs/config-file/node-config-schema.json
index 15ccfebe96..1e61f94238 100644
--- a/docs/config-file/node-config-schema.json
+++ b/docs/config-file/node-config-schema.json
@@ -303,6 +303,16 @@
"description": "FinalDeviationPct is the max allowed deviation percentage BreakEvenGasPrice on re-calculation",
"default": 10
},
+ "EthTransferGasPrice": {
+ "type": "integer",
+ "description": "EthTransferGasPrice is the fixed gas price returned as effective gas price for txs tha are ETH transfers (0 means disabled)\nOnly one of EthTransferGasPrice or EthTransferL1GasPriceFactor params can be different than 0. If both params are set to 0, the sequencer will halt and log an error",
+ "default": 0
+ },
+ "EthTransferL1GasPriceFactor": {
+ "type": "number",
+ "description": "EthTransferL1GasPriceFactor is the percentage of L1 gas price returned as effective gas price for txs tha are ETH transfers (0 means disabled)\nOnly one of EthTransferGasPrice or EthTransferL1GasPriceFactor params can be different than 0. If both params are set to 0, the sequencer will halt and log an error",
+ "default": 0
+ },
"L2GasPriceSuggesterFactor": {
"type": "number",
"description": "L2GasPriceSuggesterFactor is the factor to apply to L1 gas price to get the suggested L2 gas price used in the\ncalculations when the effective gas price is disabled (testing/metrics purposes)",
@@ -717,13 +727,18 @@
},
"HaltOnBatchNumber": {
"type": "integer",
- "description": "HaltOnBatchNumber specifies the batch number where the Sequencer will stop to process more transactions and generate new batches. The Sequencer will halt after it closes the batch equal to this number",
+ "description": "HaltOnBatchNumber specifies the batch number where the Sequencer will stop to process more transactions and generate new batches.\nThe Sequencer will halt after it closes the batch equal to this number",
"default": 0
},
"SequentialBatchSanityCheck": {
"type": "boolean",
"description": "SequentialBatchSanityCheck indicates if the reprocess of a closed batch (sanity check) must be done in a\nsequential way (instead than in parallel)",
"default": false
+ },
+ "SequentialProcessL2Block": {
+ "type": "boolean",
+ "description": "SequentialProcessL2Block indicates if the processing of a L2 Block must be done in the same finalizer go func instead\nin the processPendingL2Blocks go func",
+ "default": true
}
},
"additionalProperties": false,
@@ -742,6 +757,16 @@
"description": "Filename of the binary data file",
"default": ""
},
+ "Version": {
+ "type": "integer",
+ "description": "Version of the binary data file",
+ "default": 0
+ },
+ "ChainID": {
+ "type": "integer",
+ "description": "ChainID is the chain ID",
+ "default": 0
+ },
"Enabled": {
"type": "boolean",
"description": "Enabled is a flag to enable/disable the data streamer",
@@ -813,6 +838,16 @@
"300ms"
]
},
+ "L1BlockTimestampMargin": {
+ "type": "string",
+ "title": "Duration",
+ "description": "L1BlockTimestampMargin is the time difference (margin) that must exists between last L1 block and last L2 block in the sequence before\nto send the sequence to L1. If the difference is lower than this value then sequencesender will wait until the difference is equal or greater",
+ "default": "30s",
+ "examples": [
+ "1m",
+ "300ms"
+ ]
+ },
"MaxTxSizeForL1": {
"type": "integer",
"description": "MaxTxSizeForL1 is the maximum size a single transaction can have. This field has\nnon-trivial consequences: larger transactions than 128KB are significantly harder and\nmore expensive to propagate; larger transactions also take more resources\nto validate whether they fit into the pool or not.",
@@ -868,6 +903,55 @@
"type": "integer",
"description": "MaxBatchesForL1 is the maximum amount of batches to be sequenced in a single L1 tx",
"default": 300
+ },
+ "StreamClient": {
+ "properties": {
+ "Server": {
+ "type": "string",
+ "description": "Datastream server to connect",
+ "default": ""
+ },
+ "Log": {
+ "properties": {
+ "Environment": {
+ "type": "string",
+ "enum": [
+ "production",
+ "development"
+ ],
+ "description": "Environment defining the log format (\"production\" or \"development\").\nIn development mode enables development mode (which makes DPanicLevel logs panic), uses a console encoder, writes to standard error, and disables sampling. Stacktraces are automatically included on logs of WarnLevel and above.\nCheck [here](https://pkg.go.dev/go.uber.org/zap@v1.24.0#NewDevelopmentConfig)",
+ "default": ""
+ },
+ "Level": {
+ "type": "string",
+ "enum": [
+ "debug",
+ "info",
+ "warn",
+ "error",
+ "dpanic",
+ "panic",
+ "fatal"
+ ],
+ "description": "Level of log. As lower value more logs are going to be generated",
+ "default": ""
+ },
+ "Outputs": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Outputs"
+ }
+ },
+ "additionalProperties": false,
+ "type": "object",
+ "description": "Log is the log configuration"
+ }
+ },
+ "additionalProperties": false,
+ "type": "object",
+ "description": "StreamClientCfg is the config for the stream client"
}
},
"additionalProperties": false,
@@ -971,6 +1055,11 @@
"type": "integer",
"description": "GasOffset is the amount of gas to be added to the gas estimation in order\nto provide an amount that is higher than the estimated one. This is used\nto avoid the TX getting reverted in case something has changed in the network\nstate after the estimation which can cause the TX to require more gas to be\nexecuted.\n\nex:\ngas estimation: 1000\ngas offset: 100\nfinal gas: 1100",
"default": 0
+ },
+ "UpgradeEtrogBatchNumber": {
+ "type": "integer",
+ "description": "UpgradeEtrogBatchNumber is the number of the first batch after upgrading to etrog",
+ "default": 0
}
},
"additionalProperties": false,
diff --git a/docs/diff/diff.html b/docs/diff/diff.html
index 82763a318d..ec3b3cb9da 100644
--- a/docs/diff/diff.html
+++ b/docs/diff/diff.html
@@ -2,7 +2,7 @@
- zkEVM node vs CDK validium node</br><h2>zkevm-node version: v0.5.0-RC4<h2/>
+ zkEVM node vs CDK validium node</br><h2>zkevm-node version: v0.5.0-RC23<h2/>