Use cached checker for bundles

Author: LuisPH3

evmcore/bundle_integration.go

@@ -20,26 +20,13 @@ import (
 	"github.com/0xsoniclabs/sonic/gossip/blockproc/bundle"
 	"github.com/0xsoniclabs/sonic/inter/state"
 	"github.com/0xsoniclabs/sonic/opera"
+	"github.com/0xsoniclabs/sonic/utils"
 	"github.com/Fantom-foundation/lachesis-base/inter/idx"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	params "github.com/ethereum/go-ethereum/params"
 )
 
-//go:generate mockgen -source=bundle_integration.go -destination=bundle_integration_mock.go -package=evmcore
-
-// bundleChecker is an interface for checking if a bundle transaction is pending
-// for execution. A bundle is pending if it has not yet been processed, its
-// block range is not yet exceeded, and it is not permanently blocked due to an
-// on-chain state mutation (e.g. a mandatory transaction in the bundle using a
-// nonce that has already been used).
-//
-// This interface facilitates testing and decouples the bundle integration
-// logic from the transaction pool.
-type bundleChecker interface {
-	isPending(tx *types.Transaction) bool
-}
-
 // BundleIntegrationImplementation uses the chain and state to determine if a
 // bundle transaction is still pending for execution or obsolete.
 type BundleIntegrationImplementation struct {
@@ -48,18 +35,19 @@ type BundleIntegrationImplementation struct {
 	state state.StateDB
 }
 
-// newBundleChecker creates a new BundleChecker instance.
-func newBundleChecker(
+// createBundleChecker creates a new BundleChecker instance.
+func createBundleChecker(
 	rules opera.Rules,
 	chain StateReader,
 	state state.StateDB,
 	_ types.Signer, // needed for type compatibility
-) bundleChecker {
-	return &BundleIntegrationImplementation{
+) utils.Checker {
+	impl := &BundleIntegrationImplementation{
 		rules: rules,
 		chain: chain,
 		state: state,
 	}
+	return utils.NewUnchachedChecker(impl.isPending)
 }
 
 func (s *BundleIntegrationImplementation) isPending(tx *types.Transaction) bool {

evmcore/bundle_integration_mock.go

@@ -358,7 +358,7 @@ func (l *txList) Forward(threshold uint64) types.Transactions {
 // a point in calculating all the costs or if the balance covers all. If the threshold
 // is lower than the costgas cap, the caps will be reset to a new high after removing
 // the newly invalidated transactions.
-func (l *txList) Filter(costLimit *big.Int, gasLimit uint64, subsidiesChecker utils.Checker, bundleChecker bundleChecker) (types.Transactions, types.Transactions) {
+func (l *txList) Filter(costLimit *big.Int, gasLimit uint64, subsidiesChecker utils.Checker, bundleChecker utils.Checker) (types.Transactions, types.Transactions) {
 	hasSponsored := l.txs.containsFunc(subsidies.IsSponsorshipRequest)
 
 	// If all transactions are below the threshold, short circuit
@@ -373,7 +373,7 @@ func (l *txList) Filter(costLimit *big.Int, gasLimit uint64, subsidiesChecker ut
 		// Bundle transactions need to be checked before sponsored transactions
 		// since bundles qualify as sponsored transactions.
 		if bundle.IsEnvelope(tx) {
-			return !bundleChecker.isPending(tx)
+			return !bundleChecker.Check(tx)
 		}
 		if subsidies.IsSponsorshipRequest(tx) {
 			return !subsidiesChecker.Check(tx)

evmcore/tx_list.go

@@ -205,7 +205,7 @@ type bundleCheckerFactory func(
 	chain StateReader,
 	state state.StateDB,
 	signer types.Signer,
-) bundleChecker
+) utils.Checker
 
 // TxPoolConfig are the configuration parameters of the transaction pool.
 type TxPoolConfig struct {
@@ -352,6 +352,7 @@ type TxPool struct {
 	subsidiesCheckerCache   *utils.CheckerCache     // Cache for subsidies check results
 
 	bundleCheckerFactory bundleCheckerFactory // Factory to create a bundle checker instance
+	bundlesCheckerCache  *utils.CheckerCache  // Cache for bundle check results
 }
 
 type txpoolResetRequest struct {
@@ -364,7 +365,7 @@ func NewTxPool(
 	config TxPoolConfig,
 	chainconfig *params.ChainConfig,
 	chain StateReader) *TxPool {
-	return newTxPool(config, chainconfig, chain, createSubsidiesChecker, newBundleChecker)
+	return newTxPool(config, chainconfig, chain, createSubsidiesChecker, createBundleChecker)
 }
 
 func newTxPool(
@@ -402,7 +403,7 @@ func newTxPool(
 		subsidiesCheckerCache:   utils.NewCheckerCache(-1), // use default size
 
 		bundleCheckerFactory: bundleCheckerFactory,
-		// TODO: add a cache for bundle checker results if the checks are expensive
+		bundlesCheckerCache:  utils.NewCheckerCache(-1), // use default size
 	}
 	pool.locals = newAccountSet(pool.signer)
 	for _, addr := range config.Locals {
@@ -1522,13 +1523,14 @@ func (pool *TxPool) createCachedSubsidiesChecker() utils.Checker {
 		))
 }
 
-func (pool *TxPool) createBundleChecker() bundleChecker {
-	return pool.bundleCheckerFactory(
-		pool.chain.CurrentRules(),
-		pool.chain,
-		pool.currentState,
-		pool.signer,
-	)
+func (pool *TxPool) createBundleChecker() utils.Checker {
+	return pool.bundlesCheckerCache.Wrap(
+		pool.bundleCheckerFactory(
+			pool.chain.CurrentRules(),
+			pool.chain,
+			pool.currentState,
+			pool.signer,
+		))
 }
 
 // promoteExecutables moves transactions that have become processable from the

evmcore/tx_pool.go

@@ -63,7 +63,7 @@ func TestTxPool_SponsoredTransactionsAreIncludedInThePendingSet(t *testing.T) {
 	factory := func(opera.Rules, StateReader, state.StateDB, types.Signer) utils.Checker {
 		return subsidiesCheckerMock
 	}
-	pool := newTxPool(poolConfig, chainConfig, chain, factory, newBundleChecker)
+	pool := newTxPool(poolConfig, chainConfig, chain, factory, createBundleChecker)
 
 	// transactions per sender
 	const transactionsPerSender = 5

evmcore/tx_pool_subsidies_test.go

@@ -3426,6 +3426,8 @@ func testBundleCheckerFactory(
 	chain StateReader,
 	state state.StateDB,
 	signer types.Signer,
-) bundleChecker {
-	return nil
+) utils.Checker {
+	return utils.NewUnchachedChecker(func(tx *types.Transaction) bool {
+		panic("unexpected call to bundle features during legacy testing")
+	})
 }