Add config to toggle the TXM (#15714)

* Added config to enable or disable the TXM * Added changeset * Fixed test * Fixed linting * Fixed linting * Updated config description * Regenerated config doc * Updated error message * Updated the config name and nolint comment * Initialized gas estimator regardless of TXM toggle * Fixed logger name to match previous naming * Fixed linting error * Addressed feedback * Moved EVM.TransactionManagerEnabled config to EVM.Transactions.Enabled * Fixed linting
smartcontractkit · Dec 19, 2024 · e706d72 · e706d72
1 parent cc49b25
commit e706d72
Show file tree

Hide file tree

Showing 22 changed files with 166 additions and 22 deletions.
diff --git a/.changeset/wild-cats-think.md b/.changeset/wild-cats-think.md
@@ -0,0 +1,5 @@
+---
+"chainlink": minor
+---
+
+Added the `EVM.Transactions.Enabled` config to enable or disable the transaction manager. #added
diff --git a/core/chains/evm/config/chain_scoped_transactions.go b/core/chains/evm/config/chain_scoped_transactions.go
@@ -11,6 +11,10 @@ type transactionsConfig struct {
 	c toml.Transactions
 }
 
+func (t *transactionsConfig) Enabled() bool {
+	return *t.c.Enabled
+}
+
 func (t *transactionsConfig) ForwardersEnabled() bool {
 	return *t.c.ForwardersEnabled
 }

diff --git a/core/chains/evm/config/config.go b/core/chains/evm/config/config.go
@@ -103,6 +103,7 @@ type ClientErrors interface {
 }
 
 type Transactions interface {
+	Enabled() bool
 	ForwardersEnabled() bool
 	ReaperInterval() time.Duration
 	ResendAfterThreshold() time.Duration

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("EVM.Transactions.Enabled", func(t *testing.T) {
+		t.Run("turn on EVM.Transactions.Enabled by default", func(t *testing.T) {
+			assert.True(t, cfg.EVM().Transactions().Enabled())
+		})
 
-		t.Run("use Noop logBroadcaster when LogBroadcaster is disabled", func(t *testing.T) {
+		t.Run("verify EVM.Transactions.Enabled is set correctly", func(t *testing.T) {
+			val := false
+			cfg3 := testutils.NewTestChainScopedConfig(t, func(c *toml.EVMConfig) {
+				c.Transactions.Enabled = ptr(val)
+			})
 
+			assert.False(t, cfg3.EVM().Transactions().Enabled())
 		})
 	})
 }

diff --git a/core/chains/evm/config/toml/config.go b/core/chains/evm/config/toml/config.go
@@ -472,6 +472,7 @@ func (c *Chain) ValidateConfig() (err error) {
 }
 
 type Transactions struct {
+	Enabled              *bool
 	ForwardersEnabled    *bool
 	MaxInFlight          *uint32
 	MaxQueued            *uint32
@@ -483,6 +484,9 @@ type Transactions struct {
 }
 
 func (t *Transactions) setFrom(f *Transactions) {
+	if v := f.Enabled; v != nil {
+		t.Enabled = v
+	}
 	if v := f.ForwardersEnabled; v != nil {
 		t.ForwardersEnabled = v
 	}

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

diff --git a/core/chains/evm/config/toml/defaults/fallback.toml b/core/chains/evm/config/toml/defaults/fallback.toml
@@ -19,6 +19,7 @@ NoNewFinalizedHeadsThreshold = '0'
 LogBroadcasterEnabled = true
 
 [Transactions]
+Enabled = true
 ForwardersEnabled = false
 MaxInFlight = 16
 MaxQueued = 250

diff --git a/core/chains/legacyevm/chain.go b/core/chains/legacyevm/chain.go
@@ -194,10 +194,10 @@ func newChain(ctx context.Context, cfg *evmconfig.ChainScoped, nodes []*toml.Nod
 	chainID := cfg.EVM().ChainID()
 	l := opts.Logger
 	var client evmclient.Client
+	var err error
 	if !opts.AppConfig.EVMRPCEnabled() {
 		client = evmclient.NewNullClient(chainID, l)
 	} else if opts.GenEthClient == nil {
-		var err error
 		client, err = evmclient.NewEvmClient(cfg.EVM().NodePool(), cfg.EVM(), cfg.EVM().NodePool().Errors(), l, chainID, nodes, cfg.EVM().ChainType())
 		if err != nil {
 			return nil, err
@@ -244,10 +244,24 @@ 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)
+	// initialize gas estimator
+	gasEstimator, err := newGasEstimator(cfg.EVM(), client, l, opts, clientsByChainID)
 	if err != nil {
-		return nil, fmt.Errorf("failed to instantiate EvmTxm for chain with ID %s: %w", chainID.String(), err)
+		return nil, fmt.Errorf("failed to instantiate gas estimator for chain with ID %s: %w", chainID, err)
+	}
+
+	// note: gas estimator is started as a part of the txm
+	var txm txmgr.TxManager
+	//nolint:gocritic // ignoring suggestion to convert to switch statement
+	if !opts.AppConfig.EVMRPCEnabled() {
+		txm = &txmgr.NullTxManager{ErrMsg: fmt.Sprintf("Ethereum is disabled for chain %d", chainID)}
+	} else if !cfg.EVM().Transactions().Enabled() {
+		txm = &txmgr.NullTxManager{ErrMsg: fmt.Sprintf("TXM disabled for chain %d", chainID)}
+	} else {
+		txm, err = newEvmTxm(opts.DS, cfg.EVM(), opts.AppConfig.Database(), opts.AppConfig.Database().Listener(), client, l, logPoller, opts, headTracker, gasEstimator)
+		if err != nil {
+			return nil, fmt.Errorf("failed to instantiate EvmTxm for chain with ID %s: %w", chainID, err)
+		}
 	}
 
 	headBroadcaster.Subscribe(txm)

diff --git a/core/chains/legacyevm/evm_txm.go b/core/chains/legacyevm/evm_txm.go
@@ -17,24 +17,18 @@ import (
 func newEvmTxm(
 	ds sqlutil.DataSource,
 	cfg evmconfig.EVM,
-	evmRPCEnabled bool,
 	databaseConfig txmgr.DatabaseConfig,
 	listenerConfig txmgr.ListenerConfig,
 	client evmclient.Client,
 	lggr logger.Logger,
 	logPoller logpoller.LogPoller,
 	opts ChainRelayOpts,
 	headTracker httypes.HeadTracker,
-	clientsByChainID map[string]rollups.DAClient,
-) (txm txmgr.TxManager,
 	estimator gas.EvmFeeEstimator,
+) (txm txmgr.TxManager,
 	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",
@@ -45,15 +39,6 @@ func newEvmTxm(
 		"limitDefault", cfg.GasEstimator().LimitDefault(),
 	)
 
-	// build estimator from factory
-	if opts.GenGasEstimator == nil {
-		if estimator, err = gas.NewEstimator(lggr, client, cfg.ChainType(), chainID, cfg.GasEstimator(), clientsByChainID); err != nil {
-			return nil, nil, fmt.Errorf("failed to initialize estimator: %w", err)
-		}
-	} else {
-		estimator = opts.GenGasEstimator(chainID)
-	}
-
 	if opts.GenTxManager == nil {
 		txm, err = txmgr.NewTxm(
 			ds,
@@ -74,3 +59,23 @@ func newEvmTxm(
 	}
 	return
 }
+
+func newGasEstimator(
+	cfg evmconfig.EVM,
+	client evmclient.Client,
+	lggr logger.Logger,
+	opts ChainRelayOpts,
+	clientsByChainID map[string]rollups.DAClient,
+) (estimator gas.EvmFeeEstimator, err error) {
+	lggr = lggr.Named("Txm")
+	chainID := cfg.ChainID()
+	// build estimator from factory
+	if opts.GenGasEstimator == nil {
+		if estimator, err = gas.NewEstimator(lggr, client, cfg.ChainType(), chainID, cfg.GasEstimator(), clientsByChainID); err != nil {
+			return nil, fmt.Errorf("failed to initialize estimator: %w", err)
+		}
+	} else {
+		estimator = opts.GenGasEstimator(chainID)
+	}
+	return
+}
diff --git a/core/config/docs/chains-evm.toml b/core/config/docs/chains-evm.toml
@@ -106,6 +106,8 @@ LogBroadcasterEnabled = true # Default
 NoNewFinalizedHeadsThreshold = '0' # Default
 
 [EVM.Transactions]
+# Enabled is a feature flag for the Transaction Manager. This flag also enables or disables the gas estimator since it is dependent on the TXM to start it.
+Enabled = true # Default
 # ForwardersEnabled enables or disables sending transactions through forwarder contracts.
 ForwardersEnabled = false # Default
 # MaxInFlight controls how many transactions are allowed to be "in-flight" i.e. broadcast but unconfirmed at any one time. You can consider this a form of transaction throttling.

diff --git a/core/services/chainlink/config_test.go b/core/services/chainlink/config_test.go
@@ -654,6 +654,7 @@ func TestConfig_Marshal(t *testing.T) {
 				NoNewFinalizedHeadsThreshold: &hour,
 
 				Transactions: evmcfg.Transactions{
+					Enabled:              ptr(true),
 					MaxInFlight:          ptr[uint32](19),
 					MaxQueued:            ptr[uint32](99),
 					ReaperInterval:       &minute,
@@ -1118,6 +1119,7 @@ FinalizedBlockOffset = 16
 NoNewFinalizedHeadsThreshold = '1h0m0s'
 
 [EVM.Transactions]
+Enabled = true
 ForwardersEnabled = true
 MaxInFlight = 19
 MaxQueued = 99

diff --git a/core/services/chainlink/testdata/config-full.toml b/core/services/chainlink/testdata/config-full.toml
@@ -337,6 +337,7 @@ FinalizedBlockOffset = 16
 NoNewFinalizedHeadsThreshold = '1h0m0s'
 
 [EVM.Transactions]
+Enabled = true
 ForwardersEnabled = true
 MaxInFlight = 19
 MaxQueued = 99

diff --git a/core/services/chainlink/testdata/config-multi-chain-effective.toml b/core/services/chainlink/testdata/config-multi-chain-effective.toml
@@ -320,6 +320,7 @@ FinalizedBlockOffset = 12
 NoNewFinalizedHeadsThreshold = '9m0s'
 
 [EVM.Transactions]
+Enabled = true
 ForwardersEnabled = false
 MaxInFlight = 16
 MaxQueued = 250
@@ -430,6 +431,7 @@ FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '0s'
 
 [EVM.Transactions]
+Enabled = true
 ForwardersEnabled = false
 MaxInFlight = 16
 MaxQueued = 250
@@ -534,6 +536,7 @@ FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '6m0s'
 
 [EVM.Transactions]
+Enabled = true
 ForwardersEnabled = false
 MaxInFlight = 16
 MaxQueued = 5000

diff --git a/core/web/resolver/testdata/config-full.toml b/core/web/resolver/testdata/config-full.toml
@@ -337,6 +337,7 @@ FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '15m0s'
 
 [EVM.Transactions]
+Enabled = true
 ForwardersEnabled = true
 MaxInFlight = 19
 MaxQueued = 99

diff --git a/core/web/resolver/testdata/config-multi-chain-effective.toml b/core/web/resolver/testdata/config-multi-chain-effective.toml
@@ -320,6 +320,7 @@ FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '9m0s'
 
 [EVM.Transactions]
+Enabled = true
 ForwardersEnabled = false
 MaxInFlight = 16
 MaxQueued = 250
@@ -430,6 +431,7 @@ FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '0s'
 
 [EVM.Transactions]
+Enabled = true
 ForwardersEnabled = false
 MaxInFlight = 16
 MaxQueued = 250
@@ -534,6 +536,7 @@ FinalizedBlockOffset = 0
 NoNewFinalizedHeadsThreshold = '6m0s'
 
 [EVM.Transactions]
+Enabled = true
 ForwardersEnabled = false
 MaxInFlight = 16
 MaxQueued = 5000