Introduce a chain agnostic Head interface in the core Transaction Manager

common/txmgr/types/fee_estimator.go

@@ -22,8 +22,8 @@ type PriorAttempt[FEE any, HASH any] interface {
 // FeeEstimator provides a generic interface for fee estimation
 //
 //go:generate mockery --quiet --name FeeEstimator --output ./mocks/ --case=underscore
-type FeeEstimator[HEAD any, FEE any, MAXPRICE any, HASH any] interface {
-	OnNewLongestChain(context.Context, HEAD)
+type FeeEstimator[H Head, FEE any, MAXPRICE any, HASH any] interface {
+	HeadTrackable[H]
 	Start(context.Context) error
 	Close() error
 

common/txmgr/types/head.go

@@ -0,0 +1,28 @@
+package types
+
+import "github.com/ethereum/go-ethereum/common"
+
+// Head provides access to a chain's head, as needed by the TxManager.
+// This is a generic interface which ALL chains will implement.
+//
+//go:generate mockery --quiet --name Head --output ./mocks/ --case=underscore
+type Head interface {
+	// BlockNumber is the head's block number
+	BlockNumber() int64
+
+	// ChainLength returns the length of the chain followed by recursively looking up parents
+	ChainLength() uint32
+
+	// EarliestInChain traverses through parents until it finds the earliest one
+	EarliestInChain() Head
+
+	// Hash is the head's block hash
+	BlockHash() common.Hash
+
+	// Parent is the head's parent block
+	GetParent() Head
+
+	// HashAtHeight returns the hash of the block at the given height, if it is in the chain.
+	// If not in chain, returns the zero hash
+	HashAtHeight(blockNum int64) common.Hash
+}

common/txmgr/types/head_trackable.go

@@ -0,0 +1,12 @@
+package types
+
+import "context"
+
+// HeadTrackable is implemented by the core txm,
+// to be able to receive head events from any chain.
+// Chain implementations should notify head events to the core txm via this interface.
+//
+//go:generate mockery --quiet --name HeadTrackable --output ./mocks/ --case=underscore
+type HeadTrackable[H Head] interface {
+	OnNewLongestChain(ctx context.Context, head H)
+}

core/chains/evm/chain.go

@@ -47,7 +47,7 @@ type chain struct {
 	id              *big.Int
 	cfg             evmconfig.ChainScopedConfig
 	client          evmclient.Client
-	txm             txmgr.TxManager
+	txm             *evmTxm
 	logger          logger.Logger
 	headBroadcaster httypes.HeadBroadcaster
 	headTracker     httypes.HeadTracker
@@ -115,15 +115,7 @@ func newChain(ctx context.Context, cfg evmconfig.ChainScopedConfig, nodes []*v2.
 		}
 	}
 
-	var txm txmgr.TxManager
-	if !cfg.EVMRPCEnabled() {
-		txm = &txmgr.NullTxManager{ErrMsg: fmt.Sprintf("Ethereum is disabled for chain %d", chainID)}
-	} else if opts.GenTxManager == nil {
-		checker := &txmgr.CheckerFactory{Client: client}
-		txm = txmgr.NewTxm(db, client, cfg, opts.KeyStore, opts.EventBroadcaster, l, checker, logPoller)
-	} else {
-		txm = opts.GenTxManager(chainID)
-	}
+	txm := newEvmTxm(db, cfg, client, l, logPoller, opts)
 
 	headBroadcaster.Subscribe(txm)
 
@@ -213,7 +205,7 @@ func (c *chain) Close() error {
 		merr = multierr.Combine(merr, c.headTracker.Close())
 		c.logger.Debug("Chain: stopping headBroadcaster")
 		merr = multierr.Combine(merr, c.headBroadcaster.Close())
-		c.logger.Debug("Chain: stopping txm")
+		c.logger.Debug("Chain: stopping evmTxm")
 		merr = multierr.Combine(merr, c.txm.Close())
 		c.logger.Debug("Chain: stopping client")
 		c.client.Close()
@@ -262,7 +254,7 @@ func (c *chain) Config() evmconfig.ChainScopedConfig      { return c.cfg }
 func (c *chain) LogBroadcaster() log.Broadcaster          { return c.logBroadcaster }
 func (c *chain) LogPoller() logpoller.LogPoller           { return c.logPoller }
 func (c *chain) HeadBroadcaster() httypes.HeadBroadcaster { return c.headBroadcaster }
-func (c *chain) TxManager() txmgr.TxManager               { return c.txm }
+func (c *chain) TxManager() txmgr.TxManager               { return c.txm.TxManager }
 func (c *chain) HeadTracker() httypes.HeadTracker         { return c.headTracker }
 func (c *chain) Logger() logger.Logger                    { return c.logger }
 func (c *chain) BalanceMonitor() monitor.BalanceMonitor   { return c.balanceMonitor }

core/chains/evm/evm_txm.go

@@ -0,0 +1,49 @@
+package evm
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/smartcontractkit/sqlx"
+
+	evmclient "github.com/smartcontractkit/chainlink/core/chains/evm/client"
+	evmconfig "github.com/smartcontractkit/chainlink/core/chains/evm/config"
+	httypes "github.com/smartcontractkit/chainlink/core/chains/evm/headtracker/types"
+	"github.com/smartcontractkit/chainlink/core/chains/evm/logpoller"
+	"github.com/smartcontractkit/chainlink/core/chains/evm/txmgr"
+	evmtypes "github.com/smartcontractkit/chainlink/core/chains/evm/types"
+	"github.com/smartcontractkit/chainlink/core/logger"
+)
+
+var _ httypes.HeadTrackable = &evmTxm{}
+
+// evmTxm is an evm wrapper over the generic TxManager interface
+type evmTxm struct {
+	httypes.HeadTrackable
+	txmgr.TxManager
+}
+
+func (e evmTxm) OnNewLongestChain(ctx context.Context, head *evmtypes.Head) {
+	e.TxManager.OnNewLongestChain(ctx, head)
+}
+
+func newEvmTxm(
+	db *sqlx.DB,
+	cfg evmconfig.ChainScopedConfig,
+	client evmclient.Client,
+	lggr logger.Logger,
+	logPoller logpoller.LogPoller,
+	opts ChainSetOpts,
+) *evmTxm {
+	chainID := cfg.ChainID()
+	var txm txmgr.TxManager
+	if !cfg.EVMRPCEnabled() {
+		txm = &txmgr.NullTxManager{ErrMsg: fmt.Sprintf("Ethereum is disabled for chain %d", chainID)}
+	} else if opts.GenTxManager == nil {
+		checker := &txmgr.CheckerFactory{Client: client}
+		txm = txmgr.NewTxm(db, client, cfg, opts.KeyStore, opts.EventBroadcaster, lggr, checker, logPoller)
+	} else {
+		txm = opts.GenTxManager(chainID)
+	}
+	return &evmTxm{TxManager: txm}
+}

core/chains/evm/gas/block_history_estimator.go

@@ -128,6 +128,7 @@ func NewBlockHistoryEstimator(lggr logger.Logger, ethClient evmclient.Client, cf
 // OnNewLongestChain recalculates and sets global gas price if a sampled new head comes
 // in and we are not currently fetching
 func (b *BlockHistoryEstimator) OnNewLongestChain(_ context.Context, head *evmtypes.Head) {
+
 	// set latest base fee here to avoid potential lag introduced by block delay
 	// it is really important that base fee be as up-to-date as possible
 	b.setLatest(head)
@@ -581,7 +582,7 @@ func (b *BlockHistoryEstimator) FetchBlocks(ctx context.Context, head *evmtypes.
 		// chain, refetch blocks that got re-org'd out.
 		// NOTE: Any blocks in the history that are older than the oldest block
 		// in the provided chain will be assumed final.
-		if block.Number < head.EarliestInChain().Number {
+		if block.Number < head.EarliestInChain().BlockNumber() {
 			blocks[block.Number] = block
 		} else if head.IsInChain(block.Hash) {
 			blocks[block.Number] = block

core/chains/evm/gas/l2_suggested_estimator.go

@@ -112,7 +112,7 @@ func (o *l2SuggestedPriceEstimator) refreshPrice() (t *time.Timer) {
 	return
 }
 
-func (o *l2SuggestedPriceEstimator) OnNewLongestChain(_ context.Context, _ *evmtypes.Head) {}
+func (o *l2SuggestedPriceEstimator) OnNewLongestChain(context.Context, *evmtypes.Head) {}
 
 func (*l2SuggestedPriceEstimator) GetDynamicFee(_ context.Context, _ uint32, _ *assets.Wei) (fee DynamicFee, chainSpecificGasLimit uint32, err error) {
 	err = errors.New("dynamic fees are not implemented for this layer 2")

core/chains/evm/gas/models.go

@@ -111,7 +111,7 @@ func MakeEvmPriorAttempt(a txmgrtypes.PriorAttempt[EvmFee, common.Hash]) EvmPrio
 //
 //go:generate mockery --quiet --name EvmEstimator --output ./mocks/ --case=underscore
 type EvmEstimator interface {
-	OnNewLongestChain(context.Context, *evmtypes.Head)
+	txmgrtypes.HeadTrackable[*evmtypes.Head]
 	Start(context.Context) error
 	Close() error
 	// GetLegacyGas Calculates initial gas fee for non-EIP1559 transaction
@@ -145,7 +145,6 @@ type WrappedEvmEstimator struct {
 	EIP1559Enabled bool
 }
 
-// var _ FeeEstimator = (*WrappedEvmEstimator)(nil)
 var _ txmgrtypes.FeeEstimator[*evmtypes.Head, EvmFee, *assets.Wei, common.Hash] = (*WrappedEvmEstimator)(nil)
 
 func NewWrappedEvmEstimator(e EvmEstimator, cfg Config) txmgrtypes.FeeEstimator[*evmtypes.Head, EvmFee, *assets.Wei, common.Hash] {

core/chains/evm/gas/models_test.go

@@ -4,13 +4,13 @@ import (
 	"context"
 	"testing"
 
-	"github.com/smartcontractkit/chainlink/core/assets"
-	"github.com/smartcontractkit/chainlink/core/chains/evm/gas"
-	"github.com/smartcontractkit/chainlink/core/chains/evm/gas/mocks"
-
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
+
+	"github.com/smartcontractkit/chainlink/core/assets"
+	"github.com/smartcontractkit/chainlink/core/chains/evm/gas"
+	"github.com/smartcontractkit/chainlink/core/chains/evm/gas/mocks"
 )
 
 func TestWrappedEvmEstimator(t *testing.T) {

core/chains/evm/headtracker/head_tracker.go

@@ -159,7 +159,7 @@ func (ht *headTracker) Backfill(ctx context.Context, headWithChain *evmtypes.Hea
 		baseHeight = 0
 	}
 
-	return ht.backfill(ctx, headWithChain.EarliestInChain(), baseHeight)
+	return ht.backfill(ctx, headWithChain.EarliestInChain().(*evmtypes.Head), baseHeight)
 }
 
 func (ht *headTracker) LatestChain() *evmtypes.Head {

core/chains/evm/headtracker/head_tracker_test.go

@@ -855,8 +855,8 @@ func TestHeadTracker_Backfill(t *testing.T) {
 
 		require.Equal(t, uint32(8), h.ChainLength())
 		earliestInChain := h.EarliestInChain()
-		assert.Equal(t, head8.Number, earliestInChain.Number)
-		assert.Equal(t, head8.Hash, earliestInChain.Hash)
+		assert.Equal(t, head8.Number, earliestInChain.BlockNumber())
+		assert.Equal(t, head8.Hash, earliestInChain.BlockHash())
 	})
 
 	t.Run("does not backfill if chain length is already greater than or equal to depth", func(t *testing.T) {
@@ -902,7 +902,7 @@ func TestHeadTracker_Backfill(t *testing.T) {
 		require.NotNil(t, h)
 
 		require.Equal(t, uint32(2), h.ChainLength())
-		require.Equal(t, int64(0), h.EarliestInChain().Number)
+		require.Equal(t, int64(0), h.EarliestInChain().BlockNumber())
 	})
 
 	t.Run("abandons backfill and returns error if the eth node returns not found", func(t *testing.T) {
@@ -933,7 +933,7 @@ func TestHeadTracker_Backfill(t *testing.T) {
 
 		// Should contain 12, 11, 10, 9
 		assert.Equal(t, 4, int(h.ChainLength()))
-		assert.Equal(t, int64(9), h.EarliestInChain().Number)
+		assert.Equal(t, int64(9), h.EarliestInChain().BlockNumber())
 	})
 
 	t.Run("abandons backfill and returns error if the context time budget is exceeded", func(t *testing.T) {
@@ -962,7 +962,7 @@ func TestHeadTracker_Backfill(t *testing.T) {
 
 		// Should contain 12, 11, 10, 9
 		assert.Equal(t, 4, int(h.ChainLength()))
-		assert.Equal(t, int64(9), h.EarliestInChain().Number)
+		assert.Equal(t, int64(9), h.EarliestInChain().BlockNumber())
 	})
 }
 

core/chains/evm/txmgr/eth_broadcaster_test.go

@@ -577,7 +577,8 @@ func TestEthBroadcaster_ProcessUnstartedEthTxs_OptimisticLockingOnEthTx(t *testi
 	chStartEstimate := make(chan struct{})
 	chBlock := make(chan struct{})
 
-	estimator := txmgrmocks.NewFeeEstimator[*evmtypes.Head, gas.EvmFee, *assets.Wei, gethCommon.Hash](t)
+	var estimator = txmgrmocks.NewFeeEstimator[*evmtypes.Head, gas.EvmFee, *assets.Wei, gethCommon.Hash](t)
+
 	estimator.On("GetFee", mock.Anything, mock.Anything, mock.Anything, evmcfg.KeySpecificMaxGasPriceWei(fromAddress)).Return(gas.EvmFee{Legacy: assets.GWei(32)}, uint32(500), nil).Run(func(_ mock.Arguments) {
 		close(chStartEstimate)
 		<-chBlock
@@ -1140,8 +1141,9 @@ func TestEthBroadcaster_ProcessUnstartedEthTxs_Errors(t *testing.T) {
 					require.NoError(t, err)
 					t.Cleanup(func() { assert.NoError(t, eventBroadcaster.Close()) })
 					lggr := logger.TestLogger(t)
+					estimator := gas.NewWrappedEvmEstimator(gas.NewFixedPriceEstimator(evmcfg, lggr), evmcfg)
 					eb = txmgr.NewEthBroadcaster(borm, ethClient, evmcfg, ethKeyStore, eventBroadcaster,
-						[]ethkey.State{keyState}, gas.NewWrappedEvmEstimator(gas.NewFixedPriceEstimator(evmcfg, lggr), evmcfg), fn, lggr,
+						[]ethkey.State{keyState}, estimator, fn, lggr,
 						&testCheckerFactory{}, false)
 
 					{