Added config to enable or disable the TXM

smartcontractkit · Dec 16, 2024 · 1a6a2ac · 1a6a2ac
1 parent bd0296a
commit 1a6a2ac
Show file tree

Hide file tree

Showing 21 changed files with 132 additions and 10 deletions.
diff --git a/core/chains/evm/config/chain_scoped.go b/core/chains/evm/config/chain_scoped.go
@@ -191,3 +191,7 @@ func (e *EVMConfig) FinalizedBlockOffset() uint32 {
 func (e *EVMConfig) NoNewFinalizedHeadsThreshold() time.Duration {
 	return e.C.NoNewFinalizedHeadsThreshold.Duration()
 }
+
+func (e *EVMConfig) TXMEnabled() bool {
+	return *e.C.TXMEnabled
+}
diff --git a/core/chains/evm/config/config.go b/core/chains/evm/config/config.go
@@ -49,6 +49,7 @@ type EVM interface {
 	NodeNoNewHeadsThreshold() time.Duration
 	FinalizedBlockOffset() uint32
 	NoNewFinalizedHeadsThreshold() time.Duration
+	TXMEnabled() bool
 
 	IsEnabled() bool
 	TOMLString() (string, error)

diff --git a/core/chains/evm/config/config_test.go b/core/chains/evm/config/config_test.go
@@ -219,9 +219,20 @@ func TestChainScopedConfig(t *testing.T) {
 
 			assert.Equal(t, false, cfg3.EVM().LogBroadcasterEnabled())
 		})
+	})
+
+	t.Run("TXMEnabled", func(t *testing.T) {
+		t.Run("turn on TXMEnabled by default", func(t *testing.T) {
+			assert.Equal(t, true, cfg.EVM().TXMEnabled())
+		})
 
-		t.Run("use Noop logBroadcaster when LogBroadcaster is disabled", func(t *testing.T) {
+		t.Run("verify TXMEnabled is set correctly", func(t *testing.T) {
+			val := false
+			cfg3 := testutils.NewTestChainScopedConfig(t, func(c *toml.EVMConfig) {
+				c.TXMEnabled = ptr(val)
+			})
 
+			assert.Equal(t, false, cfg3.EVM().TXMEnabled())
 		})
 	})
 }

diff --git a/core/chains/evm/config/toml/config.go b/core/chains/evm/config/toml/config.go
@@ -386,6 +386,7 @@ type Chain struct {
 	RPCBlockQueryDelay           *uint16
 	FinalizedBlockOffset         *uint32
 	NoNewFinalizedHeadsThreshold *commonconfig.Duration
+	TXMEnabled                   *bool
 
 	Transactions   Transactions      `toml:",omitempty"`
 	BalanceMonitor BalanceMonitor    `toml:",omitempty"`

diff --git a/core/chains/evm/config/toml/defaults.go b/core/chains/evm/config/toml/defaults.go
@@ -236,10 +236,12 @@ func (c *Chain) SetFrom(f *Chain) {
 	if v := f.FinalizedBlockOffset; v != nil {
 		c.FinalizedBlockOffset = v
 	}
-
 	if v := f.NoNewFinalizedHeadsThreshold; v != nil {
 		c.NoNewFinalizedHeadsThreshold = v
 	}
+	if v := f.TXMEnabled; v != nil {
+		c.TXMEnabled = v
+	}
 
 	c.Transactions.setFrom(&f.Transactions)
 	c.BalanceMonitor.setFrom(&f.BalanceMonitor)

diff --git a/core/chains/evm/config/toml/defaults/fallback.toml b/core/chains/evm/config/toml/defaults/fallback.toml
@@ -17,6 +17,7 @@ RPCBlockQueryDelay = 1
 FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '0'
 LogBroadcasterEnabled = true
+TXMEnabled = true
 
 [Transactions]
 ForwardersEnabled = false

diff --git a/core/chains/legacyevm/chain.go b/core/chains/legacyevm/chain.go
@@ -245,9 +245,18 @@ func newChain(ctx context.Context, cfg *evmconfig.ChainScoped, nodes []*toml.Nod
 	}
 
 	// note: gas estimator is started as a part of the txm
-	txm, gasEstimator, err := newEvmTxm(opts.DS, cfg.EVM(), opts.AppConfig.EVMRPCEnabled(), opts.AppConfig.Database(), opts.AppConfig.Database().Listener(), client, l, logPoller, opts, headTracker, clientsByChainID)
-	if err != nil {
-		return nil, fmt.Errorf("failed to instantiate EvmTxm for chain with ID %s: %w", chainID.String(), err)
+	var txm txmgr.TxManager
+	var gasEstimator gas.EvmFeeEstimator
+	if !opts.AppConfig.EVMRPCEnabled() {
+		txm = &txmgr.NullTxManager{ErrMsg: fmt.Sprintf("Ethereum is disabled for chain %d", chainID)}
+	} else if !cfg.EVM().TXMEnabled() {
+		txm = &txmgr.NullTxManager{ErrMsg: fmt.Sprintf("TXM disabled for chain %d", chainID)}
+	} else {
+		var err error
+		txm, gasEstimator, err = newEvmTxm(opts.DS, cfg.EVM(), opts.AppConfig.Database(), opts.AppConfig.Database().Listener(), client, l, logPoller, opts, headTracker, clientsByChainID)
+		if err != nil {
+			return nil, fmt.Errorf("failed to instantiate EvmTxm for chain with ID %s: %w", chainID.String(), err)
+		}
 	}
 
 	headBroadcaster.Subscribe(txm)

diff --git a/core/chains/legacyevm/evm_txm.go b/core/chains/legacyevm/evm_txm.go
@@ -17,7 +17,6 @@ import (
 func newEvmTxm(
 	ds sqlutil.DataSource,
 	cfg evmconfig.EVM,
-	evmRPCEnabled bool,
 	databaseConfig txmgr.DatabaseConfig,
 	listenerConfig txmgr.ListenerConfig,
 	client evmclient.Client,
@@ -31,10 +30,6 @@ func newEvmTxm(
 	err error,
 ) {
 	chainID := cfg.ChainID()
-	if !evmRPCEnabled {
-		txm = &txmgr.NullTxManager{ErrMsg: fmt.Sprintf("Ethereum is disabled for chain %d", chainID)}
-		return txm, nil, nil
-	}
 
 	lggr = lggr.Named("Txm")
 	lggr.Infow("Initializing EVM transaction manager",

diff --git a/core/config/docs/chains-evm.toml b/core/config/docs/chains-evm.toml
@@ -104,6 +104,8 @@ LogBroadcasterEnabled = true # Default
 #
 # Set to zero to disable.
 NoNewFinalizedHeadsThreshold = '0' # Default
+# TXMEnabled is a feature flag for the Transaction Manager
+TXMEnabled = true # Default
 
 [EVM.Transactions]
 # ForwardersEnabled enables or disables sending transactions through forwarder contracts.

diff --git a/core/services/chainlink/config_test.go b/core/services/chainlink/config_test.go
@@ -586,6 +586,7 @@ func TestConfig_Marshal(t *testing.T) {
 				FinalityTagEnabled:   ptr[bool](true),
 				FlagsContractAddress: mustAddress("0xae4E781a6218A8031764928E88d457937A954fC3"),
 				FinalizedBlockOffset: ptr[uint32](16),
+				TXMEnabled:           ptr(true),
 
 				GasEstimator: evmcfg.GasEstimator{
 					Mode:               ptr("SuggestedPrice"),

diff --git a/core/services/chainlink/testdata/config-full.toml b/core/services/chainlink/testdata/config-full.toml
@@ -335,6 +335,7 @@ RPCDefaultBatchSize = 17
 RPCBlockQueryDelay = 10
 FinalizedBlockOffset = 16
 NoNewFinalizedHeadsThreshold = '1h0m0s'
+TXMEnabled = true
 
 [EVM.Transactions]
 ForwardersEnabled = true

diff --git a/core/services/chainlink/testdata/config-multi-chain-effective.toml b/core/services/chainlink/testdata/config-multi-chain-effective.toml
@@ -318,6 +318,7 @@ RPCDefaultBatchSize = 250
 RPCBlockQueryDelay = 1
 FinalizedBlockOffset = 12
 NoNewFinalizedHeadsThreshold = '9m0s'
+TXMEnabled = true
 
 [EVM.Transactions]
 ForwardersEnabled = false
@@ -428,6 +429,7 @@ RPCDefaultBatchSize = 250
 RPCBlockQueryDelay = 1
 FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '0s'
+TXMEnabled = true
 
 [EVM.Transactions]
 ForwardersEnabled = false
@@ -532,6 +534,7 @@ RPCDefaultBatchSize = 100
 RPCBlockQueryDelay = 10
 FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '6m0s'
+TXMEnabled = true
 
 [EVM.Transactions]
 ForwardersEnabled = false

diff --git a/core/web/resolver/testdata/config-full.toml b/core/web/resolver/testdata/config-full.toml
@@ -335,6 +335,7 @@ RPCDefaultBatchSize = 17
 RPCBlockQueryDelay = 10
 FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '15m0s'
+TXMEnabled = true
 
 [EVM.Transactions]
 ForwardersEnabled = true

diff --git a/core/web/resolver/testdata/config-multi-chain-effective.toml b/core/web/resolver/testdata/config-multi-chain-effective.toml
@@ -318,6 +318,7 @@ RPCDefaultBatchSize = 250
 RPCBlockQueryDelay = 1
 FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '9m0s'
+TXMEnabled = true
 
 [EVM.Transactions]
 ForwardersEnabled = false
@@ -428,6 +429,7 @@ RPCDefaultBatchSize = 250
 RPCBlockQueryDelay = 1
 FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '0s'
+TXMEnabled = true
 
 [EVM.Transactions]
 ForwardersEnabled = false
@@ -532,6 +534,7 @@ RPCDefaultBatchSize = 100
 RPCBlockQueryDelay = 10
 FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '6m0s'
+TXMEnabled = true
 
 [EVM.Transactions]
 ForwardersEnabled = false