feat(sender): improve default values setting (#628)

Author: davidtaikocha

go.mod

@@ -5,6 +5,7 @@ go 1.21
 require (
 	github.com/btcsuite/btcd/btcec/v2 v2.3.2
 	github.com/cenkalti/backoff/v4 v4.1.3
+	github.com/creasty/defaults v1.7.0
 	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.2.0
 	github.com/ethereum/go-ethereum v1.13.14
 	github.com/go-resty/resty/v2 v2.7.0

go.sum

@@ -196,6 +196,8 @@ github.com/crate-crypto/go-kzg-4844 v0.7.0 h1:C0vgZRk4q4EZ/JgPfzuSoxdCq3C3mOZMBS
 github.com/crate-crypto/go-kzg-4844 v0.7.0/go.mod h1:1kMhvPgI0Ky3yIa+9lFySEBUBXkYxeOi8ZF1sYioxhc=
 github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
+github.com/creasty/defaults v1.7.0 h1:eNdqZvc5B509z18lD8yc212CAqJNvfT1Jq6L8WowdBA=
+github.com/creasty/defaults v1.7.0/go.mod h1:iGzKe6pbEHnpMPtfDXZEr0NVxWnPTjb1bbDy08fPzYM=
 github.com/d4l3k/messagediff v1.2.1 h1:ZcAIMYsUg0EAp9X+tt8/enBE/Q8Yd5kzPynLyKptt9U=
 github.com/d4l3k/messagediff v1.2.1/go.mod h1:Oozbb1TVXFac9FtSIxHBMnBCq2qeH/2KkEQxENCrlLo=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

pkg/sender/common.go

@@ -3,8 +3,8 @@ package sender
 import (
 	"fmt"
 	"math/big"
-	"time"
 
+	"github.com/creasty/defaults"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/log"
@@ -142,26 +142,11 @@ func (s *Sender) buildTxData(tx *types.Transaction) (types.TxData, error) {
 	}
 }
 
-// setDefault sets the default value if the given value is 0.
-func setDefault[T uint64 | time.Duration](src, dest T) T {
-	if src == 0 {
-		return dest
-	}
-	return src
-}
-
 // setConfigWithDefaultValues sets the config with default values if the given config is nil.
 func setConfigWithDefaultValues(config *Config) *Config {
 	if config == nil {
-		return DefaultConfig
-	}
-	return &Config{
-		ConfirmationDepth: setDefault(config.ConfirmationDepth, DefaultConfig.ConfirmationDepth),
-		MaxRetrys:         setDefault(config.MaxRetrys, DefaultConfig.MaxRetrys),
-		MaxWaitingTime:    setDefault(config.MaxWaitingTime, DefaultConfig.MaxWaitingTime),
-		GasLimit:          setDefault(config.GasLimit, DefaultConfig.GasLimit),
-		GasGrowthRate:     setDefault(config.GasGrowthRate, DefaultConfig.GasGrowthRate),
-		MaxGasFee:         setDefault(config.MaxGasFee, DefaultConfig.MaxGasFee),
-		MaxBlobFee:        setDefault(config.MaxBlobFee, DefaultConfig.MaxBlobFee),
+		config = new(Config)
 	}
+	_ = defaults.Set(config)
+	return config
 }

pkg/sender/common_test.go

@@ -0,0 +1,21 @@
+package sender
+
+import (
+	"math"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSetConfigWithDefaultValues(t *testing.T) {
+	cfg := setConfigWithDefaultValues(&Config{MaxRetrys: 1, MaxBlobFee: 1024})
+	assert.Equal(t, uint64(50), cfg.GasGrowthRate)
+	assert.Equal(t, uint64(1), cfg.MaxRetrys)
+	assert.Equal(t, 5*time.Minute, cfg.MaxWaitingTime)
+	assert.Equal(t, uint64(math.MaxUint64), cfg.MaxGasFee)
+	assert.Equal(t, uint64(1024), cfg.MaxBlobFee)
+
+	cfg = setConfigWithDefaultValues(nil)
+	assert.Equal(t, cfg.GasGrowthRate, uint64(50))
+}

pkg/sender/sender.go

@@ -3,6 +3,7 @@ package sender
 import (
 	"context"
 	"crypto/ecdsa"
+	"errors"
 	"fmt"
 	"math/big"
 	"os"
@@ -13,7 +14,6 @@ import (
 	"github.com/ethereum/go-ethereum"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/common/math"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/log"
 	cmap "github.com/orcaman/concurrent-map/v2"
@@ -28,33 +28,26 @@ var (
 	nonceIncorrectRetrys        = 3
 	unconfirmedTxsCheckInternal = 2 * time.Second
 	chainHeadFetchInterval      = 3 * time.Second
-	errTimeoutInMempool         = fmt.Errorf("transaction in mempool for too long")
-	DefaultConfig               = &Config{
-		ConfirmationDepth: 0,
-		MaxRetrys:         0,
-		MaxWaitingTime:    5 * time.Minute,
-		GasGrowthRate:     50,
-		MaxGasFee:         math.MaxUint64,
-		MaxBlobFee:        math.MaxUint64,
-	}
+	errTimeoutInMempool         = errors.New("transaction in mempool for too long")
+	errToManyPendings           = errors.New("too many pending transactions")
 )
 
 // Config represents the configuration of the transaction sender.
 type Config struct {
 	// The minimum block confirmations to wait to confirm a transaction.
-	ConfirmationDepth uint64
+	ConfirmationDepth uint64 `default:"0"`
 	// The maximum retry times when sending transactions.
-	MaxRetrys uint64
+	MaxRetrys uint64 `default:"0"`
 	// The maximum waiting time for the inclusion of transactions.
-	MaxWaitingTime time.Duration
-
+	MaxWaitingTime time.Duration `default:"5m"`
 	// The gas limit for transactions.
-	GasLimit uint64
+	GasLimit uint64 `default:"0"`
 	// The gas rate to increase the gas price, 20 means 20% gas growth rate.
-	GasGrowthRate uint64
+	GasGrowthRate uint64 `default:"50"`
 	// The maximum gas fee can be used when sending transactions.
-	MaxGasFee  uint64
-	MaxBlobFee uint64
+	MaxGasFee uint64 `default:"0xffffffffffffffff"` // Use `math.MaxUint64` as default value
+	// The maximum blob gas fee can be used when sending transactions.
+	MaxBlobFee uint64 `default:"0xffffffffffffffff"` // Use `math.MaxUint64` as default value
 }
 
 // TxToConfirm represents a transaction which is waiting for its confirmation.
@@ -149,6 +142,7 @@ func NewSender(ctx context.Context, cfg *Config, client *rpc.EthClient, priv *ec
 	return sender, nil
 }
 
+// CLose closes the sender.
 func (s *Sender) Close() {
 	close(s.stopCh)
 	s.wg.Wait()
@@ -205,13 +199,19 @@ func (s *Sender) SendRawTransaction(
 	data []byte,
 	sidecar *types.BlobTxSidecar,
 ) (string, error) {
+	// If there are too many pending transactions to be confirmed, return an error here.
 	if s.unconfirmedTxs.Count() >= unconfirmedTxsCap {
-		return "", fmt.Errorf("too many pending transactions")
+		return "", errToManyPendings
+	}
+	if nonce == 0 {
+		nonce = s.nonce
 	}
 
 	var (
 		originalTx types.TxData
 		opts       = s.GetOpts()
+		gasLimit   = s.GasLimit
+		err        error
 	)
 	if sidecar != nil {
 		opts.Value = value
@@ -222,28 +222,26 @@ func (s *Sender) SendRawTransaction(
 		if err != nil {
 			return "", err
 		}
-		blobTx.Nonce = setDefault(nonce, s.nonce)
+		blobTx.Nonce = nonce
 		originalTx = blobTx
 	} else {
-		gasLimit := s.GasLimit
 		if gasLimit == 0 {
-			var err error
-			gasLimit, err = s.client.EstimateGas(s.ctx, ethereum.CallMsg{
+			if gasLimit, err = s.client.EstimateGas(s.ctx, ethereum.CallMsg{
 				From:      opts.From,
 				To:        target,
 				Value:     value,
 				Data:      data,
 				GasTipCap: opts.GasTipCap,
 				GasFeeCap: opts.GasFeeCap,
-			})
-			if err != nil {
+			}); err != nil {
 				return "", err
 			}
 		}
+
 		originalTx = &types.DynamicFeeTx{
 			ChainID:   s.client.ChainID,
 			To:        target,
-			Nonce:     setDefault(nonce, s.nonce),
+			Nonce:     nonce,
 			GasFeeCap: opts.GasFeeCap,
 			GasTipCap: opts.GasTipCap,
 			Gas:       gasLimit,
@@ -252,12 +250,11 @@ func (s *Sender) SendRawTransaction(
 		}
 	}
 
-	txToConfirm := &TxToConfirm{
-		originalTx: originalTx,
-	}
+	txToConfirm := &TxToConfirm{originalTx: originalTx}
 
 	if err := s.send(txToConfirm, false); err != nil && !strings.Contains(err.Error(), "replacement transaction") {
-		log.Error("Failed to send transaction",
+		log.Error(
+			"Failed to send transaction",
 			"txId", txToConfirm.ID,
 			"nonce", nonce,
 			"err", err,
@@ -276,18 +273,15 @@ func (s *Sender) SendRawTransaction(
 // SendTransaction sends a transaction to the given Ethereum node.
 func (s *Sender) SendTransaction(tx *types.Transaction) (string, error) {
 	if s.unconfirmedTxs.Count() >= unconfirmedTxsCap {
-		return "", fmt.Errorf("too many pending transactions")
+		return "", errToManyPendings
 	}
 
 	txData, err := s.buildTxData(tx)
 	if err != nil {
 		return "", err
 	}
 
-	txToConfirm := &TxToConfirm{
-		originalTx: txData,
-		CurrentTx:  tx,
-	}
+	txToConfirm := &TxToConfirm{originalTx: txData, CurrentTx: tx}
 
 	if err = s.send(txToConfirm, true); err != nil && !strings.Contains(err.Error(), "replacement transaction") {
 		log.Error(