fix(transaction): implement EIP-1559 compliant fee calculation (#5118)

Co-authored-by: Acha Bill <[email protected]>

Author: gacevicljubisa

pkg/config/chain.go

@@ -25,7 +25,7 @@ type ChainConfig struct {
 	StakingAddress         common.Address
 	PostageStampAddress    common.Address
 	RedistributionAddress  common.Address
-	SwapPriceOracleAddress common.Address
+	SwapPriceOracleAddress common.Address // Swap swear and swindle (S3) Contracts
 	CurrentFactoryAddress  common.Address
 
 	// ABIs.

pkg/node/chain.go

@@ -346,6 +346,11 @@ type noOpChainBackend struct {
 	chainID int64
 }
 
+// BlockByNumber implements transaction.Backend.
+func (m *noOpChainBackend) BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) {
+	return nil, postagecontract.ErrChainDisabled
+}
+
 func (m noOpChainBackend) Metrics() []prometheus.Collector {
 	return nil
 }

pkg/sctx/sctx.go

@@ -12,10 +12,8 @@ import (
 	"math/big"
 )
 
-var (
-	// ErrTargetPrefix is returned when target prefix decoding fails.
-	ErrTargetPrefix = errors.New("error decoding prefix string")
-)
+// ErrTargetPrefix is returned when target prefix decoding fails.
+var ErrTargetPrefix = errors.New("error decoding prefix string")
 
 type (
 	HTTPRequestIDKey struct{}
@@ -60,7 +58,6 @@ func GetGasLimitWithDefault(ctx context.Context, defaultLimit uint64) uint64 {
 
 func SetGasPrice(ctx context.Context, price *big.Int) context.Context {
 	return context.WithValue(ctx, gasPriceKey{}, price)
-
 }
 
 func GetGasPrice(ctx context.Context) *big.Int {

pkg/storageincentives/redistribution/redistribution.go

@@ -47,7 +47,6 @@ func New(
 	incentivesContractABI abi.ABI,
 	setGasLimit bool,
 ) Contract {
-
 	var gasLimit uint64
 	if setGasLimit {
 		gasLimit = transaction.DefaultGasLimit
@@ -118,7 +117,7 @@ func (c *contract) Claim(ctx context.Context, proofs ChunkInclusionProofs) (comm
 		Value:                big.NewInt(0),
 		Description:          "claim win transaction",
 	}
-	txHash, err := c.sendAndWait(ctx, request, 50)
+	txHash, err := c.sendAndWait(ctx, request, transaction.RedistributionTipBoostPercent)
 	if err != nil {
 		return txHash, fmt.Errorf("claim: %w", err)
 	}
@@ -141,7 +140,7 @@ func (c *contract) Commit(ctx context.Context, obfusHash []byte, round uint64) (
 		Value:                big.NewInt(0),
 		Description:          "commit transaction",
 	}
-	txHash, err := c.sendAndWait(ctx, request, 50)
+	txHash, err := c.sendAndWait(ctx, request, transaction.RedistributionTipBoostPercent)
 	if err != nil {
 		return txHash, fmt.Errorf("commit: obfusHash %v: %w", common.BytesToHash(obfusHash), err)
 	}
@@ -164,7 +163,7 @@ func (c *contract) Reveal(ctx context.Context, storageDepth uint8, reserveCommit
 		Value:                big.NewInt(0),
 		Description:          "reveal transaction",
 	}
-	txHash, err := c.sendAndWait(ctx, request, 50)
+	txHash, err := c.sendAndWait(ctx, request, transaction.RedistributionTipBoostPercent)
 	if err != nil {
 		return txHash, fmt.Errorf("reveal: storageDepth %d reserveCommitmentHash %v RandomNonce %v: %w", storageDepth, common.BytesToHash(reserveCommitmentHash), common.BytesToHash(RandomNonce), err)
 	}

pkg/storageincentives/staking/contract.go

@@ -73,7 +73,6 @@ func New(
 	setGasLimit bool,
 	height uint8,
 ) Contract {
-
 	var gasLimit uint64
 	if setGasLimit {
 		gasLimit = transaction.DefaultGasLimit
@@ -142,7 +141,6 @@ func (c *contract) ChangeStakeOverlay(ctx context.Context, nonce common.Hash) (c
 
 // UpdateHeight submits the reserve doubling height to the contract only if the height is a new value.
 func (c *contract) UpdateHeight(ctx context.Context) (common.Hash, bool, error) {
-
 	h, err := c.getHeight(ctx)
 	if err != nil {
 		return common.Hash{}, false, fmt.Errorf("staking contract: failed to read previous height: %w", err)
@@ -267,7 +265,7 @@ func (c *contract) sendApproveTransaction(ctx context.Context, amount *big.Int)
 		)
 	}()
 
-	txHash, err := c.transactionService.Send(ctx, request, 0)
+	txHash, err := c.transactionService.Send(ctx, request, transaction.DefaultTipBoostPercent)
 	if err != nil {
 		return nil, err
 	}

pkg/transaction/backend.go

@@ -29,6 +29,7 @@ type Backend interface {
 	TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
 	TransactionByHash(ctx context.Context, hash common.Hash) (tx *types.Transaction, isPending bool, err error)
 	BlockNumber(ctx context.Context) (uint64, error)
+	BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error)
 	BalanceAt(ctx context.Context, address common.Address, block *big.Int) (*big.Int, error)
 	NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)
 	FilterLogs(ctx context.Context, query ethereum.FilterQuery) ([]types.Log, error)

pkg/transaction/backendmock/backend.go

@@ -108,7 +108,7 @@ func (m *backendMock) BlockNumber(ctx context.Context) (uint64, error) {
 }
 
 func (m *backendMock) BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) {
-	if m.blockNumber != nil {
+	if m.blockByNumber != nil {
 		return m.blockByNumber(ctx, number)
 	}
 	return nil, errors.New("not implemented")
@@ -136,7 +136,7 @@ func (m *backendMock) NonceAt(ctx context.Context, account common.Address, block
 }
 
 func (m *backendMock) SuggestGasTipCap(ctx context.Context) (*big.Int, error) {
-	if m.suggestGasPrice != nil {
+	if m.suggestGasTipCap != nil {
 		return m.suggestGasTipCap(ctx)
 	}
 	return nil, errors.New("not implemented")

pkg/transaction/transaction.go

@@ -41,11 +41,14 @@ var (
 	ErrTransactionReverted = errors.New("transaction reverted")
 	ErrUnknownTransaction  = errors.New("unknown transaction")
 	ErrAlreadyImported     = errors.New("already imported")
+	ErrEIP1559NotSupported = errors.New("network does not appear to support EIP-1559 (no baseFee)")
 )
 
 const (
-	DefaultTipBoostPercent = 20
-	DefaultGasLimit        = 1_000_000
+	DefaultGasLimit               = 1_000_000
+	DefaultTipBoostPercent        = 25
+	MinimumGasTipCap              = 1_500_000_000 // 1.5 Gwei
+	RedistributionTipBoostPercent = 50
 )
 
 // TxRequest describes a request for a transaction that can be executed.
@@ -226,8 +229,8 @@ func (t *transactionService) waitForPendingTx(txHash common.Hash) {
 	t.wg.Add(1)
 	go func() {
 		defer t.wg.Done()
-		switch _, err := t.WaitForReceipt(t.ctx, txHash); {
-		case err == nil:
+		switch _, err := t.WaitForReceipt(t.ctx, txHash); err {
+		case nil:
 			t.logger.Info("pending transaction confirmed", "tx", txHash)
 			err = t.store.Delete(pendingTransactionKey(txHash))
 			if err != nil {
@@ -286,7 +289,7 @@ func (t *transactionService) prepareTransaction(ctx context.Context, request *Tx
 			gasLimit = request.MinEstimatedGasLimit
 		}
 
-		gasLimit += gasLimit / 4 // add 25% on top
+		gasLimit += gasLimit / 2 // add 50% buffer to the estimated gas limit
 		if gasLimit < request.MinEstimatedGasLimit {
 			gasLimit = request.MinEstimatedGasLimit
 		}
@@ -324,28 +327,48 @@ func (t *transactionService) prepareTransaction(ctx context.Context, request *Tx
 }
 
 func (t *transactionService) suggestedFeeAndTip(ctx context.Context, gasPrice *big.Int, boostPercent int) (*big.Int, *big.Int, error) {
-	var err error
+	gasTipCap, err := t.backend.SuggestGasTipCap(ctx)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	multiplier := big.NewInt(int64(boostPercent) + 100)
+	gasTipCap = new(big.Int).Div(new(big.Int).Mul(gasTipCap, multiplier), big.NewInt(100))
+
+	minimumTip := big.NewInt(MinimumGasTipCap)
+	if gasTipCap.Cmp(minimumTip) < 0 {
+		gasTipCap = new(big.Int).Set(minimumTip)
+	}
+
+	var gasFeeCap *big.Int
 
 	if gasPrice == nil {
-		gasPrice, err = t.backend.SuggestGasPrice(ctx)
+		latestBlockHeader, err := t.backend.HeaderByNumber(ctx, nil)
 		if err != nil {
-			return nil, nil, err
+			return nil, nil, fmt.Errorf("failed to get latest block: %w", err)
 		}
-		gasPrice = new(big.Int).Div(new(big.Int).Mul(big.NewInt(int64(boostPercent)+100), gasPrice), big.NewInt(100))
-	}
 
-	gasTipCap, err := t.backend.SuggestGasTipCap(ctx)
-	if err != nil {
-		return nil, nil, err
+		if latestBlockHeader.BaseFee == nil {
+			return nil, nil, ErrEIP1559NotSupported
+		}
+
+		// gasFeeCap = (2 * baseFee) + gasTipCap
+		gasFeeCap = new(big.Int).Add(
+			new(big.Int).Mul(latestBlockHeader.BaseFee, big.NewInt(2)),
+			gasTipCap,
+		)
+	} else {
+		gasFeeCap = new(big.Int).Set(gasPrice)
 	}
 
-	gasTipCap = new(big.Int).Div(new(big.Int).Mul(big.NewInt(int64(boostPercent)+100), gasTipCap), big.NewInt(100))
-	gasFeeCap := new(big.Int).Add(gasTipCap, gasPrice)
+	if gasTipCap.Cmp(gasFeeCap) > 0 {
+		t.logger.Warning("gas tip cap is higher than gas fee cap, using gas fee cap as gas tip cap", "gas_tip_cap", gasTipCap, "gas_fee_cap", gasFeeCap)
+		gasTipCap = new(big.Int).Set(gasFeeCap)
+	}
 
-	t.logger.Debug("prepare transaction", "gas_price", gasPrice, "gas_max_fee", gasFeeCap, "gas_max_tip", gasTipCap)
+	t.logger.Debug("prepare transaction", "gas_max_fee", gasFeeCap, "gas_max_tip", gasTipCap)
 
 	return gasFeeCap, gasTipCap, nil
-
 }
 
 func storedTransactionKey(txHash common.Hash) string {
@@ -371,10 +394,9 @@ func (t *transactionService) nextNonce(ctx context.Context) (uint64, error) {
 
 	// PendingNonceAt returns the nonce we should use, but we will
 	// compare this to our pending tx list, therefore the -1.
-	var maxNonce uint64 = onchainNonce - 1
+	var maxNonce = onchainNonce - 1
 	for _, txHash := range pendingTxs {
 		trx, _, err := t.backend.TransactionByHash(ctx, txHash)
-
 		if err != nil {
 			t.logger.Error(err, "pending transaction not found", "tx", txHash)
 			return 0, err
@@ -419,7 +441,7 @@ func (t *transactionService) WatchSentTransaction(txHash common.Hash) (<-chan ty
 }
 
 func (t *transactionService) PendingTransactions() ([]common.Hash, error) {
-	var txHashes []common.Hash = make([]common.Hash, 0)
+	var txHashes = make([]common.Hash, 0)
 	err := t.store.Iterate(pendingTransactionPrefix, func(key, value []byte) (stop bool, err error) {
 		txHash := common.HexToHash(strings.TrimPrefix(string(key), pendingTransactionPrefix))
 		txHashes = append(txHashes, txHash)
@@ -438,7 +460,6 @@ func (t *transactionService) filterPendingTransactions(ctx context.Context, txHa
 
 	for _, txHash := range txHashes {
 		_, isPending, err := t.backend.TransactionByHash(ctx, txHash)
-
 		// When error occurres consider transaction as pending (so this transaction won't be filtered out),
 		// unless it was not found
 		if err != nil {