Fixed config tests

core/chains/evm/config/toml/config.go

@@ -456,18 +456,17 @@ func (a *AutoPurgeConfig) ValidateConfig() (err error) {
 			return commonconfig.ErrInvalid{Name: "AutoPurgeDetectionApiUrl", Value: a.AutoPurgeDetectionApiUrl.Scheme, Msg: "must be http or https"}
 		}
 	}
-	var errorList []error
 	if a.AutoPurgeThreshold == nil {
-		errorList = append(errorList, commonconfig.ErrMissing{Name: "AutoPurgeThreshold", Msg: "needs to be set if AutoPurgeStuckTxs is enabled and AutoPurgeDetectionApiUrl not set"})
+		err = errors.Join(err, commonconfig.ErrMissing{Name: "AutoPurgeThreshold", Msg: "needs to be set if AutoPurgeStuckTxs is enabled and AutoPurgeDetectionApiUrl not set"})
 	} else if *a.AutoPurgeThreshold == 0 {
-		errorList = append(errorList, commonconfig.ErrInvalid{Name: "AutoPurgeThreshold", Value: *a.AutoPurgeThreshold, Msg: "cannot be 0 if AutoPurgeStuckTxs is enabled and AutoPurgeDetectionApiUrl not set"})
+		err = errors.Join(err, commonconfig.ErrInvalid{Name: "AutoPurgeThreshold", Value: *a.AutoPurgeThreshold, Msg: "cannot be 0 if AutoPurgeStuckTxs is enabled and AutoPurgeDetectionApiUrl not set"})
 	}
 	if a.AutoPurgeMinAttempts == nil {
-		errorList = append(errorList, commonconfig.ErrMissing{Name: "AutoPurgeMinAttempts", Msg: "needs to be set if AutoPurgeStuckTxs is enabled and AutoPurgeDetectionApiUrl not set"})
+		err = errors.Join(err, commonconfig.ErrMissing{Name: "AutoPurgeMinAttempts", Msg: "needs to be set if AutoPurgeStuckTxs is enabled and AutoPurgeDetectionApiUrl not set"})
 	} else if *a.AutoPurgeMinAttempts == 0 {
-		errorList = append(errorList, commonconfig.ErrInvalid{Name: "AutoPurgeMinAttempts", Value: *a.AutoPurgeMinAttempts, Msg: "cannot be 0 if AutoPurgeStuckTxs is enabled and AutoPurgeDetectionApiUrl not set"})
+		err = errors.Join(err, commonconfig.ErrInvalid{Name: "AutoPurgeMinAttempts", Value: *a.AutoPurgeMinAttempts, Msg: "cannot be 0 if AutoPurgeStuckTxs is enabled and AutoPurgeDetectionApiUrl not set"})
 	}
-	return errors.Join(errorList...)
+	return
 }
 
 func (a *AutoPurgeConfig) setFrom(f *AutoPurgeConfig) {

core/chains/evm/txmgr/test_helpers.go

@@ -1,6 +1,8 @@
 package txmgr
 
 import (
+	"math/big"
+	"net/url"
 	"testing"
 	"time"
 
@@ -11,6 +13,7 @@ import (
 	evmconfig "github.com/smartcontractkit/chainlink/v2/core/chains/evm/config"
 	"github.com/smartcontractkit/chainlink/v2/core/chains/evm/utils"
 	"github.com/smartcontractkit/chainlink/v2/core/config"
+	"github.com/smartcontractkit/chainlink/v2/core/internal/testutils"
 )
 
 func ptr[T any](t T) *T { return &t }
@@ -42,22 +45,28 @@ func (d *TestDatabaseConfig) Listener() config.Listener {
 
 type TestEvmConfig struct {
 	evmconfig.EVM
-	MaxInFlight          uint32
-	ReaperInterval       time.Duration
-	ReaperThreshold      time.Duration
-	ResendAfterThreshold time.Duration
-	BumpThreshold        uint64
-	MaxQueued            uint64
+	MaxInFlight              uint32
+	ReaperInterval           time.Duration
+	ReaperThreshold          time.Duration
+	ResendAfterThreshold     time.Duration
+	BumpThreshold            uint64
+	MaxQueued                uint64
+	AutoPurgeStuckTxs        bool
+	AutoPurgeThreshold       uint32
+	AutoPurgeMinAttempts     uint32
+	AutoPurgeDetectionApiUrl *url.URL
 }
 
 func (e *TestEvmConfig) Transactions() evmconfig.Transactions {
-	return &transactionsConfig{e: e}
+	return &transactionsConfig{e: e, autoPurge: &autoPurgeConfig{}}
 }
 
 func (e *TestEvmConfig) NonceAutoSync() bool { return true }
 
 func (e *TestEvmConfig) FinalityDepth() uint32 { return 42 }
 
+func (e *TestEvmConfig) ChainID() *big.Int { return testutils.FixtureChainID }
+
 type TestGasEstimatorConfig struct {
 	bumpThreshold uint64
 }
@@ -115,15 +124,24 @@ func (b *TestBlockHistoryConfig) TransactionPercentile() uint16     { return 42
 
 type transactionsConfig struct {
 	evmconfig.Transactions
-	e *TestEvmConfig
+	e         *TestEvmConfig
+	autoPurge evmconfig.AutoPurgeConfig
 }
 
-func (*transactionsConfig) ForwardersEnabled() bool               { return true }
-func (t *transactionsConfig) MaxInFlight() uint32                 { return t.e.MaxInFlight }
-func (t *transactionsConfig) MaxQueued() uint64                   { return t.e.MaxQueued }
-func (t *transactionsConfig) ReaperInterval() time.Duration       { return t.e.ReaperInterval }
-func (t *transactionsConfig) ReaperThreshold() time.Duration      { return t.e.ReaperThreshold }
-func (t *transactionsConfig) ResendAfterThreshold() time.Duration { return t.e.ResendAfterThreshold }
+func (*transactionsConfig) ForwardersEnabled() bool                { return true }
+func (t *transactionsConfig) MaxInFlight() uint32                  { return t.e.MaxInFlight }
+func (t *transactionsConfig) MaxQueued() uint64                    { return t.e.MaxQueued }
+func (t *transactionsConfig) ReaperInterval() time.Duration        { return t.e.ReaperInterval }
+func (t *transactionsConfig) ReaperThreshold() time.Duration       { return t.e.ReaperThreshold }
+func (t *transactionsConfig) ResendAfterThreshold() time.Duration  { return t.e.ResendAfterThreshold }
+func (t *transactionsConfig) AutoPurge() evmconfig.AutoPurgeConfig { return t.autoPurge }
+
+type autoPurgeConfig struct{}
+
+func (a *autoPurgeConfig) AutoPurgeStuckTxs() bool            { return false }
+func (a *autoPurgeConfig) AutoPurgeThreshold() uint32         { return 0 }
+func (a *autoPurgeConfig) AutoPurgeMinAttempts() uint32       { return 0 }
+func (a *autoPurgeConfig) AutoPurgeDetectionApiUrl() *url.URL { return &url.URL{} }
 
 type MockConfig struct {
 	EvmConfig           *TestEvmConfig

core/config/docs/chains-evm.toml

@@ -112,6 +112,16 @@ ReaperThreshold = '168h' # Default
 # ResendAfterThreshold controls how long to wait before re-broadcasting a transaction that has not yet been confirmed.
 ResendAfterThreshold = '1m' # Default
 
+[EVM.Transactions.AutoPurge]
+# AutoPurgeStuckTxs enables or disables automatically purging transactions that have been idenitified as terminally stuck (will never be included on-chain). This feature is only expected to be used by ZK chains.
+AutoPurgeStuckTxs = false # Default
+# AutoPurgeDetectionApiUrl configures the base url of a custom endpoint used to identify terminally stuck transactions.
+AutoPurgeDetectionApiUrl = 'https://venus.scroll.io' # Example
+# AutoPurgeThreshold configures the number of blocks a transaction has to remain unconfirmed before it is evaluated for being terminally stuck. This threshold is only applied if there is no custom API to identify stuck transactions provided by the chain.
+AutoPurgeThreshold = 5 # Example
+# AutoPurgeMinAttempts cnofigures the minimum number of broadcasted attempts a transaction has to have before it is evaluated further for being terminally stuck. This threshold is only applied if there is no custom API to identify stuck transactions provided by the chain.
+AutoPurgeMinAttempts = 3 # Example
+
 [EVM.BalanceMonitor]
 # Enabled balance monitoring for all keys.
 Enabled = true # Default

core/services/chainlink/config_test.go

@@ -567,6 +567,9 @@ func TestConfig_Marshal(t *testing.T) {
 					ReaperThreshold:      &minute,
 					ResendAfterThreshold: &hour,
 					ForwardersEnabled:    ptr(true),
+					AutoPurge: evmcfg.AutoPurgeConfig{
+						AutoPurgeStuckTxs: ptr(false),
+					},
 				},
 
 				HeadTracker: evmcfg.HeadTracker{
@@ -968,6 +971,9 @@ ReaperInterval = '1m0s'
 ReaperThreshold = '1m0s'
 ResendAfterThreshold = '1h0m0s'
 
+[EVM.Transactions.AutoPurge]
+AutoPurgeStuckTxs = false
+
 [EVM.BalanceMonitor]
 Enabled = true
 
@@ -1177,6 +1183,15 @@ func TestConfig_full(t *testing.T) {
 				got.EVM[c].Nodes[n].Order = ptr(int32(100))
 			}
 		}
+		if got.EVM[c].Transactions.AutoPurge.AutoPurgeThreshold == nil {
+			got.EVM[c].Transactions.AutoPurge.AutoPurgeThreshold = ptr(uint32(0))
+		}
+		if got.EVM[c].Transactions.AutoPurge.AutoPurgeMinAttempts == nil {
+			got.EVM[c].Transactions.AutoPurge.AutoPurgeMinAttempts = ptr(uint32(0))
+		}
+		if got.EVM[c].Transactions.AutoPurge.AutoPurgeDetectionApiUrl == nil {
+			got.EVM[c].Transactions.AutoPurge.AutoPurgeDetectionApiUrl = new(commoncfg.URL)
+		}
 	}
 
 	cfgtest.AssertFieldsNotNil(t, got)
@@ -1221,11 +1236,14 @@ func TestConfig_Validate(t *testing.T) {
 					- WSURL: missing: required for primary nodes
 					- HTTPURL: missing: required for all nodes
 				- 1.HTTPURL: missing: required for all nodes
-		- 1: 6 errors:
+		- 1: 7 errors:
 			- ChainType: invalid value (Foo): must not be set with this chain id
 			- Nodes: missing: must have at least one node
 			- ChainType: invalid value (Foo): must be one of arbitrum, celo, gnosis, kroma, metis, optimismBedrock, scroll, wemix, zksync or omitted
 			- HeadTracker.HistoryDepth: invalid value (30): must be equal to or greater than FinalityDepth
+			- Transactions.AutoPurge: 2 errors:
+					- AutoPurgeThreshold: missing: needs to be set if AutoPurgeStuckTxs is enabled and AutoPurgeDetectionApiUrl not set
+					- AutoPurgeMinAttempts: missing: needs to be set if AutoPurgeStuckTxs is enabled and AutoPurgeDetectionApiUrl not set
 			- GasEstimator: 2 errors:
 				- FeeCapDefault: invalid value (101 wei): must be equal to PriceMax (99 wei) since you are using FixedPrice estimation with gas bumping disabled in EIP1559 mode - PriceMax will be used as the FeeCap for transactions instead of FeeCapDefault
 				- PriceMax: invalid value (1 gwei): must be greater than or equal to PriceDefault

core/services/chainlink/testdata/config-full.toml

@@ -287,6 +287,9 @@ ReaperInterval = '1m0s'
 ReaperThreshold = '1m0s'
 ResendAfterThreshold = '1h0m0s'
 
+[EVM.Transactions.AutoPurge]
+AutoPurgeStuckTxs = false
+
 [EVM.BalanceMonitor]
 Enabled = true
 

core/services/chainlink/testdata/config-invalid.toml

@@ -54,6 +54,9 @@ ChainID = '1'
 ChainType = 'Foo'
 FinalityDepth = 32
 
+[EVM.Transactions.AutoPurge]
+AutoPurgeStuckTxs = true
+
 [EVM.GasEstimator]
 Mode = 'FixedPrice'
 BumpThreshold = 0

core/services/chainlink/testdata/config-multi-chain-effective.toml

@@ -274,6 +274,9 @@ ReaperInterval = '1h0m0s'
 ReaperThreshold = '168h0m0s'
 ResendAfterThreshold = '1m0s'
 
+[EVM.Transactions.AutoPurge]
+AutoPurgeStuckTxs = false
+
 [EVM.BalanceMonitor]
 Enabled = true
 
@@ -365,6 +368,9 @@ ReaperInterval = '1h0m0s'
 ReaperThreshold = '168h0m0s'
 ResendAfterThreshold = '1m0s'
 
+[EVM.Transactions.AutoPurge]
+AutoPurgeStuckTxs = false
+
 [EVM.BalanceMonitor]
 Enabled = true
 
@@ -450,6 +456,9 @@ ReaperInterval = '1h0m0s'
 ReaperThreshold = '168h0m0s'
 ResendAfterThreshold = '1m0s'
 
+[EVM.Transactions.AutoPurge]
+AutoPurgeStuckTxs = false
+
 [EVM.BalanceMonitor]
 Enabled = true
 

core/web/resolver/testdata/config-full.toml

@@ -287,6 +287,9 @@ ReaperInterval = '1m0s'
 ReaperThreshold = '1m0s'
 ResendAfterThreshold = '1h0m0s'
 
+[EVM.Transactions.AutoPurge]
+AutoPurgeStuckTxs = false
+
 [EVM.BalanceMonitor]
 Enabled = true
 

docs/CONFIG.md

@@ -6947,6 +6947,40 @@ ResendAfterThreshold = '1m' # Default
 ```
 ResendAfterThreshold controls how long to wait before re-broadcasting a transaction that has not yet been confirmed.
 
+## EVM.Transactions.AutoPurge
+```toml
+[EVM.Transactions.AutoPurge]
+AutoPurgeStuckTxs = false # Default
+AutoPurgeDetectionApiUrl = 'https://venus.scroll.io' # Example
+AutoPurgeThreshold = 5 # Example
+AutoPurgeMinAttempts = 3 # Example
+```
+
+
+### AutoPurgeStuckTxs
+```toml
+AutoPurgeStuckTxs = false # Default
+```
+AutoPurgeStuckTxs enables or disables automatically purging transactions that have been idenitified as terminally stuck (will never be included on-chain). This feature is only expected to be used by ZK chains.
+
+### AutoPurgeDetectionApiUrl
+```toml
+AutoPurgeDetectionApiUrl = 'https://venus.scroll.io' # Example
+```
+AutoPurgeDetectionApiUrl configures the base url of a custom endpoint used to identify terminally stuck transactions.
+
+### AutoPurgeThreshold
+```toml
+AutoPurgeThreshold = 5 # Example
+```
+AutoPurgeThreshold configures the number of blocks a transaction has to remain unconfirmed before it is evaluated for being terminally stuck. This threshold is only applied if there is no custom API to identify stuck transactions provided by the chain.
+
+### AutoPurgeMinAttempts
+```toml
+AutoPurgeMinAttempts = 3 # Example
+```
+AutoPurgeMinAttempts cnofigures the minimum number of broadcasted attempts a transaction has to have before it is evaluated further for being terminally stuck. This threshold is only applied if there is no custom API to identify stuck transactions provided by the chain.
+
 ## EVM.BalanceMonitor
 ```toml
 [EVM.BalanceMonitor]