update executor proto (#2122)

* update executor proto

* gas price as string

Signed-off-by: Nikolay Nedkov <nikolai_nedkov@yahoo.com>

config/config_test.go

@@ -185,6 +185,14 @@ func Test_Defaults(t *testing.T) {
 			path:          "Sequencer.Finalizer.TimestampResolution",
 			expectedValue: types.NewDuration(15 * time.Second),
 		},
+		{
+			path:          "Sequencer.Finalizer.EffectiveGasPrice.BreakEvenGasPriceGuaranteedPeriod",
+			expectedValue: types.NewDuration(30 * time.Second),
+		},
+		{
+			path:          "Sequencer.Finalizer.EffectiveGasPrice.MaxBreakEvenGasPriceDeviationPercentage",
+			expectedValue: uint64(10),
+		},
 		{
 			path:          "Sequencer.DBManager.PoolRetrievalInterval",
 			expectedValue: types.NewDuration(500 * time.Millisecond),
@@ -342,6 +350,18 @@ func Test_Defaults(t *testing.T) {
 			path:          "Pool.DB.MaxConns",
 			expectedValue: 200,
 		},
+		{
+			path:          "Pool.EffectiveGasPrice.L1GasPricePercentageForL2MinPrice",
+			expectedValue: uint64(10),
+		},
+		{
+			path:          "Pool.EffectiveGasPrice.ByteGasCost",
+			expectedValue: uint64(16),
+		},
+		{
+			path:          "Pool.EffectiveGasPrice.MarginFactorPercentage",
+			expectedValue: uint64(10),
+		},
 		{
 			path:          "RPC.Host",
 			expectedValue: "0.0.0.0",

config/default.go

@@ -33,6 +33,10 @@ PollMinAllowedGasPriceInterval = "15s"
 	Port = "5432"
 	EnableLog = false
 	MaxConns = 200
+	[Pool.EffectiveGasPrice]
+	L1GasPricePercentageForL2MinPrice = 10
+	ByteGasCost = 16
+	MarginFactorPercentage = 10
 
 [Etherman]
 URL = "http://localhost:8545"
@@ -99,6 +103,9 @@ MaxTxLifetime = "3h"
 		ClosingSignalsManagerWaitForCheckingForcedBatches = "10s"
 		ForcedBatchesFinalityNumberOfBlocks = 64
 		TimestampResolution = "15s"	
+		[Sequencer.Finalizer.EffectiveGasPrice]
+			BreakEvenGasPriceGuaranteedPeriod = "30s"
+			MaxBreakEvenGasPriceDeviationPercentage = 10
 	[Sequencer.DBManager]
 		PoolRetrievalInterval = "500ms"
 		L2ReorgRetrievalInterval = "5s"

config/environments/local/local.node.config.toml

@@ -22,13 +22,17 @@ DefaultMinGasPriceAllowed = 1000000000
 MinAllowedGasPriceInterval = "5m"
 PollMinAllowedGasPriceInterval = "15s"
 	[Pool.DB]
-	User = "pool_user"
-	Password = "pool_password"
-	Name = "pool_db"
-	Host = "zkevm-pool-db"
-	Port = "5432"
-	EnableLog = false
-	MaxConns = 200
+		User = "pool_user"
+		Password = "pool_password"
+		Name = "pool_db"
+		Host = "zkevm-pool-db"
+		Port = "5432"
+		EnableLog = false
+		MaxConns = 200
+	[Pool.EffectiveGasPrice]
+		L1GasPricePercentageForL2MinPrice = 10
+		ByteGasCost = 16
+		MarginFactorPercentage = 10
 
 [Etherman]
 URL = "http://your.L1node.url"
@@ -89,6 +93,9 @@ MaxTxLifetime = "3h"
 		ClosingSignalsManagerWaitForCheckingForcedBatches = "10s"
 		ForcedBatchesFinalityNumberOfBlocks = 64
 		TimestampResolution = "15s"
+		[Sequencer.Finalizer.EffectiveGasPrice]
+			BreakEvenGasPriceGuaranteedPeriod = "30s"
+			MaxBreakEvenGasPriceDeviationPercentage = 10
 	[Sequencer.DBManager]
 		PoolRetrievalInterval = "500ms"
 		L2ReorgRetrievalInterval = "5s"

event/event.go

@@ -32,6 +32,8 @@ const (
 	EventID_ExecutorRLPError EventID = "EXECUTOR RLP ERROR"
 	// EventID_FinalizerHalt is triggered when the finalizer halts
 	EventID_FinalizerHalt EventID = "FINALIZER HALT"
+	// EventID_FinalizerBreakEvenGasPriceBigDifference is triggered when the finalizer recalculates the break even gas price and detects a big difference
+	EventID_FinalizerBreakEvenGasPriceBigDifference EventID = "FINALIZER BREAK EVEN GAS PRICE BIG DIFFERENCE"
 
 	// Source_Node is the source of the event
 	Source_Node Source = "node"

gasprice/config.go

@@ -29,26 +29,4 @@ type Config struct {
 	Percentile         int            `mapstructure:"Percentile"`
 	UpdatePeriod       types.Duration `mapstructure:"UpdatePeriod"`
 	Factor             float64        `mapstructure:"Factor"`
-
-	// BreakEvenGasPriceCalcCfg is the configuration for the break even gas price calculation
-	BreakEvenGasPriceCalcCfg BreakEvenGasPriceCalculationCfg `mapstructure:"BreakEvenGasPriceCalculationCfg"`
-}
-
-// BreakEvenGasPriceCalculationCfg has parameters for the gas price calculation.
-// TODO: Add config tests
-type BreakEvenGasPriceCalculationCfg struct {
-	// L1GasPricePercentageForL2MinPrice is the percentage of the L1 gas price that will be used as the L2 min gas price
-	L1GasPricePercentageForL2MinPrice uint64 `mapstructure:"L1GasPricePercentageForL2MinPrice"`
-
-	// ByteGasCost is the gas cost per byte
-	ByteGasCost uint64 `mapstructure:"ByteGasCost"`
-
-	// MarginFactorPercentage is the margin factor percentage to be added to the L2 min gas price
-	MarginFactorPercentage uint64 `mapstructure:"MarginFactorPercentage"`
-
-	// TxPriceGuaranteePeriod is the period of time that the gas price will be guaranteed
-	TxPriceGuaranteePeriod types.Duration `mapstructure:"TxPriceGuaranteePeriod"`
-
-	// MaxBreakEvenGasPriceDeviationPercentage is the max allowed deviation percentage BreakEvenGasPrice on re-calculation
-	MaxBreakEvenGasPriceDeviationPercentage float64 `mapstructure:"MaxBreakEvenGasPriceDeviationPercentage"`
 }

pool/config.go

@@ -29,13 +29,12 @@ type Config struct {
 	// PollMinAllowedGasPriceInterval is the interval to poll the suggested min gas price for a tx
 	PollMinAllowedGasPriceInterval types.Duration `mapstructure:"PollMinAllowedGasPriceInterval"`
 
-	// GasPriceEstimationCfg is the configuration for the gas price estimation
-	GasPriceEstimationCfg GasPriceEstimationConfig `mapstructure:"GasPriceEstimationConfig"`
+	// EffectiveGasPrice is the configuration for the break even and effective gas price calculation
+	EffectiveGasPrice EffectiveGasPrice `mapstructure:"EffectiveGasPrice"`
 }
 
-// GasPriceEstimationConfig has parameters for the gas price calculation.
-// TODO: Add config tests
-type GasPriceEstimationConfig struct {
+// EffectiveGasPrice has parameters for the effective gas price calculation.
+type EffectiveGasPrice struct {
 	// L1GasPricePercentageForL2MinPrice is the percentage of the L1 gas price that will be used as the L2 min gas price
 	L1GasPricePercentageForL2MinPrice uint64 `mapstructure:"L1GasPricePercentageForL2MinPrice"`
 
@@ -44,7 +43,4 @@ type GasPriceEstimationConfig struct {
 
 	// MarginFactorPercentage is the margin factor percentage to be added to the L2 min gas price
 	MarginFactorPercentage uint64 `mapstructure:"MarginFactorPercentage"`
-
-	// TxPriceGuaranteePeriod is the period of time that the gas price will be guaranteed
-	TxPriceGuaranteePeriod types.Duration `mapstructure:"TxPriceGuaranteePeriod"`
 }

pool/pgpoolstorage/pgpoolstorage.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"database/sql"
 	"errors"
+	"math/big"
 	"time"
 
 	"github.com/0xPolygonHermez/zkevm-node/db"
@@ -125,7 +126,7 @@ func (p *PostgresPoolStorage) AddTx(ctx context.Context, tx pool.Transaction) er
 		fromAddress,
 		tx.IsWIP,
 		tx.IP,
-		tx.BreakEvenGasPrice); err != nil {
+		tx.BreakEvenGasPrice.String()); err != nil {
 		return err
 	}
 	return nil
@@ -141,10 +142,10 @@ func (p *PostgresPoolStorage) GetTxsByStatus(ctx context.Context, status pool.Tx
 		sql  string
 	)
 	if limit == 0 {
-		sql = "SELECT encoded, status, received_at, is_wip, ip, failed_reason FROM pool.transaction WHERE status = $1 ORDER BY gas_price DESC"
+		sql = "SELECT encoded, status, received_at, is_wip, ip, failed_reason, break_even_gas_price FROM pool.transaction WHERE status = $1 ORDER BY gas_price DESC"
 		rows, err = p.db.Query(ctx, sql, status.String())
 	} else {
-		sql = "SELECT encoded, status, received_at, is_wip, ip, failed_reason FROM pool.transaction WHERE status = $1 ORDER BY gas_price DESC LIMIT $2"
+		sql = "SELECT encoded, status, received_at, is_wip, ip, failed_reason, break_even_gas_price FROM pool.transaction WHERE status = $1 ORDER BY gas_price DESC LIMIT $2"
 		rows, err = p.db.Query(ctx, sql, status.String(), limit)
 	}
 	if err != nil {
@@ -169,15 +170,37 @@ func (p *PostgresPoolStorage) GetTxsByStatus(ctx context.Context, status pool.Tx
 // if limit = 0, then there is no limit
 func (p *PostgresPoolStorage) GetNonWIPTxsByStatus(ctx context.Context, status pool.TxStatus, limit uint64) ([]pool.Transaction, error) {
 	var (
-		rows pgx.Rows
-		err  error
-		sql  string
+		rows                                pgx.Rows
+		err                                 error
+		sql                                 string
+		encoded, ip, breakEvenGasPriceAsStr string
+		failedReason                        *string
+		cumulativeGasUsed                   uint64
+		usedKeccakHashes, usedPoseidonHashes, usedPoseidonPaddings,
+		usedMemAligns, usedArithmetics, usedBinaries, usedSteps uint32
+		receivedAt time.Time
+		isWIP, ok  bool
 	)
+	sql = `SELECT 
+    				encoded,
+					cumulative_gas_used,
+					used_keccak_hashes,
+					used_poseidon_hashes,
+					used_poseidon_paddings,
+					used_mem_aligns,
+					used_arithmetics,
+					used_binaries,
+					used_steps,
+       				received_at,
+       				is_wip,
+       				ip,
+       				failed_reason,
+       				break_even_gas_price
+				FROM pool.transaction WHERE is_wip IS FALSE and status = $1 ORDER BY gas_price DESC`
 	if limit == 0 {
-		sql = "SELECT encoded, status, received_at, is_wip, ip, failed_reason FROM pool.transaction WHERE is_wip IS FALSE and status = $1 ORDER BY gas_price DESC"
 		rows, err = p.db.Query(ctx, sql, status.String())
 	} else {
-		sql = "SELECT encoded, status, received_at, is_wip, ip, failed_reason FROM pool.transaction WHERE is_wip IS FALSE and status = $1 ORDER BY gas_price DESC LIMIT $2"
+		sql += " LIMIT $2"
 		rows, err = p.db.Query(ctx, sql, status.String(), limit)
 	}
 	if err != nil {
@@ -187,11 +210,56 @@ func (p *PostgresPoolStorage) GetNonWIPTxsByStatus(ctx context.Context, status p
 
 	txs := make([]pool.Transaction, 0, len(rows.RawValues()))
 	for rows.Next() {
-		tx, err := scanTx(rows)
+		err := rows.Scan(
+			&encoded,
+			&cumulativeGasUsed,
+			&usedKeccakHashes,
+			&usedPoseidonHashes,
+			&usedPoseidonPaddings,
+			&usedMemAligns,
+			&usedArithmetics,
+			&usedBinaries,
+			&usedSteps,
+			&receivedAt,
+			&isWIP,
+			&ip,
+			&failedReason,
+			&breakEvenGasPriceAsStr,
+		)
+
 		if err != nil {
 			return nil, err
 		}
-		txs = append(txs, *tx)
+		tx := pool.Transaction{}
+		b, err := hex.DecodeHex(encoded)
+		if err != nil {
+			return nil, err
+		}
+		if err := tx.UnmarshalBinary(b); err != nil {
+			return nil, err
+		}
+
+		tx.Status = status
+		tx.ZKCounters = state.ZKCounters{
+			CumulativeGasUsed:    cumulativeGasUsed,
+			UsedKeccakHashes:     usedKeccakHashes,
+			UsedPoseidonHashes:   usedPoseidonHashes,
+			UsedPoseidonPaddings: usedPoseidonPaddings,
+			UsedMemAligns:        usedMemAligns,
+			UsedArithmetics:      usedArithmetics,
+			UsedBinaries:         usedBinaries,
+			UsedSteps:            usedSteps,
+		}
+		tx.ReceivedAt = receivedAt
+		tx.IsWIP = isWIP
+		tx.IP = ip
+		tx.FailedReason = failedReason
+		tx.BreakEvenGasPrice, ok = new(big.Int).SetString(breakEvenGasPriceAsStr, 10)
+		if !ok {
+			return nil, errors.New("invalid break even gas price")
+		}
+
+		txs = append(txs, tx)
 	}
 
 	return txs, nil
@@ -235,7 +303,8 @@ func (p *PostgresPoolStorage) GetTxs(ctx context.Context, filterStatus pool.TxSt
 			received_at,
 			nonce,
 			is_wip,
-			ip
+			ip,
+			break_even_gas_price
 		FROM
 			pool.transaction p1
 		WHERE 
@@ -263,7 +332,8 @@ func (p *PostgresPoolStorage) GetTxs(ctx context.Context, filterStatus pool.TxSt
 				received_at,
 				nonce,
 				is_wip,
-				ip
+				ip,
+				break_even_gas_price
 			FROM
 				pool.transaction p1
 			WHERE
@@ -278,14 +348,13 @@ func (p *PostgresPoolStorage) GetTxs(ctx context.Context, filterStatus pool.TxSt
 	}
 
 	var (
-		encoded, status, ip string
-		receivedAt          time.Time
-		cumulativeGasUsed   uint64
-
+		encoded, status, ip, breakEvenGasPriceAsStr string
+		receivedAt                                  time.Time
+		cumulativeGasUsed                           uint64
 		usedKeccakHashes, usedPoseidonHashes, usedPoseidonPaddings,
 		usedMemAligns, usedArithmetics, usedBinaries, usedSteps uint32
-		nonce uint64
-		isWIP bool
+		nonce     uint64
+		isWIP, ok bool
 	)
 
 	args := []interface{}{filterStatus, minGasPrice, limit}
@@ -314,6 +383,7 @@ func (p *PostgresPoolStorage) GetTxs(ctx context.Context, filterStatus pool.TxSt
 			&nonce,
 			&isWIP,
 			&ip,
+			&breakEvenGasPriceAsStr,
 		)
 
 		if err != nil {
@@ -342,6 +412,10 @@ func (p *PostgresPoolStorage) GetTxs(ctx context.Context, filterStatus pool.TxSt
 		}
 		tx.IsWIP = isWIP
 		tx.IP = ip
+		tx.BreakEvenGasPrice, ok = new(big.Int).SetString(breakEvenGasPriceAsStr, 10)
+		if !ok {
+			return nil, errors.New("invalid break even gas price")
+		}
 
 		txs = append(txs, tx)
 	}