fix: Make lanes mutually exclusive by default (#206)

* lanes always mutually exclusive * nit 1.0.0.0 * gg adding back interface --------- Co-authored-by: Alex Johnson <[email protected]>
skip-mev · Nov 20, 2023 · f607439 · f607439
1 parent f1beb21
commit f607439
Show file tree

Hide file tree

Showing 17 changed files with 475 additions and 247 deletions.
diff --git a/abci/abci_test.go b/abci/abci_test.go
@@ -672,7 +672,7 @@ func (s *ProposalsTestSuite) TestPrepareProposal() {
 
 func (s *ProposalsTestSuite) TestPrepareProposalEdgeCases() {
 	s.Run("can build a proposal if a lane panics first", func() {
-		panicLane := s.setUpPanicLane(math.LegacyMustNewDecFromStr("0.25"))
+		panicLane := s.setUpPanicLane("panik1", math.LegacyMustNewDecFromStr("0.25"))
 
 		tx, err := testutils.CreateRandomTx(
 			s.encodingConfig.TxConfig,
@@ -708,19 +708,21 @@ func (s *ProposalsTestSuite) TestPrepareProposalEdgeCases() {
 			},
 		}
 
-		mempool := block.NewLanedMempool(
-			log.NewTestLogger(s.T()),
-			false,
+		mempool, err := block.NewLanedMempool(
+			log.NewNopLogger(),
+			lanes,
 			mocks.NewMockLaneFetcher(func() (blocksdkmoduletypes.Lane, error) {
 				return blocksdkmoduletypes.Lane{}, nil
 			}, func() []blocksdkmoduletypes.Lane {
 				return chainLanes
 			}),
-			lanes...,
 		)
+		s.Require().NoError(err)
+
+		defaultLane.SetIgnoreList(nil)
 
 		proposalHandler := abci.NewProposalHandler(
-			log.NewTestLogger(s.T()),
+			log.NewNopLogger(),
 			s.encodingConfig.TxConfig.TxDecoder(),
 			s.encodingConfig.TxConfig.TxEncoder(),
 			mempool,
@@ -748,7 +750,7 @@ func (s *ProposalsTestSuite) TestPrepareProposalEdgeCases() {
 	})
 
 	s.Run("can build a proposal if second lane panics", func() {
-		panicLane := s.setUpPanicLane(math.LegacyMustNewDecFromStr("0.25"))
+		panicLane := s.setUpPanicLane("panik1", math.LegacyMustNewDecFromStr("0.25"))
 
 		tx, err := testutils.CreateRandomTx(
 			s.encodingConfig.TxConfig,
@@ -784,19 +786,21 @@ func (s *ProposalsTestSuite) TestPrepareProposalEdgeCases() {
 			},
 		}
 
-		mempool := block.NewLanedMempool(
-			log.NewTestLogger(s.T()),
-			false,
+		mempool, err := block.NewLanedMempool(
+			log.NewNopLogger(),
+			lanes,
 			mocks.NewMockLaneFetcher(func() (blocksdkmoduletypes.Lane, error) {
 				return blocksdkmoduletypes.Lane{}, nil
 			}, func() []blocksdkmoduletypes.Lane {
 				return chainLanes
 			}),
-			lanes...,
 		)
+		s.Require().NoError(err)
+
+		defaultLane.SetIgnoreList(nil)
 
 		proposalHandler := abci.NewProposalHandler(
-			log.NewTestLogger(s.T()),
+			log.NewNopLogger(),
 			s.encodingConfig.TxConfig.TxDecoder(),
 			s.encodingConfig.TxConfig.TxEncoder(),
 			mempool,
@@ -824,8 +828,8 @@ func (s *ProposalsTestSuite) TestPrepareProposalEdgeCases() {
 	})
 
 	s.Run("can build a proposal if multiple consecutive lanes panic", func() {
-		panicLane := s.setUpPanicLane(math.LegacyMustNewDecFromStr("0.25"))
-		panicLane2 := s.setUpPanicLane(math.LegacyMustNewDecFromStr("0.25"))
+		panicLane := s.setUpPanicLane("panik1", math.LegacyMustNewDecFromStr("0.25"))
+		panicLane2 := s.setUpPanicLane("panik2", math.LegacyMustNewDecFromStr("0.25"))
 
 		tx, err := testutils.CreateRandomTx(
 			s.encodingConfig.TxConfig,
@@ -867,18 +871,23 @@ func (s *ProposalsTestSuite) TestPrepareProposalEdgeCases() {
 			},
 		}
 
-		mempool := block.NewLanedMempool(
-			log.NewTestLogger(s.T()),
-			false,
+		mempool, err := block.NewLanedMempool(
+			log.NewNopLogger(),
+			lanes,
 			mocks.NewMockLaneFetcher(func() (blocksdkmoduletypes.Lane, error) {
 				return blocksdkmoduletypes.Lane{}, nil
 			}, func() []blocksdkmoduletypes.Lane {
 				return chainLanes
 			}),
-			lanes...,
 		)
+		s.Require().NoError(err)
+
+		panicLane.SetIgnoreList(nil)
+		panicLane2.SetIgnoreList(nil)
+		defaultLane.SetIgnoreList(nil)
+
 		proposalHandler := abci.NewProposalHandler(
-			log.NewTestLogger(s.T()),
+			log.NewNopLogger(),
 			s.encodingConfig.TxConfig.TxDecoder(),
 			s.encodingConfig.TxConfig.TxEncoder(),
 			mempool,
@@ -906,8 +915,8 @@ func (s *ProposalsTestSuite) TestPrepareProposalEdgeCases() {
 	})
 
 	s.Run("can build a proposal if the last few lanes panic", func() {
-		panicLane := s.setUpPanicLane(math.LegacyMustNewDecFromStr("0.25"))
-		panicLane2 := s.setUpPanicLane(math.LegacyMustNewDecFromStr("0.25"))
+		panicLane := s.setUpPanicLane("panik1", math.LegacyMustNewDecFromStr("0.25"))
+		panicLane2 := s.setUpPanicLane("panik2", math.LegacyMustNewDecFromStr("0.25"))
 
 		tx, err := testutils.CreateRandomTx(
 			s.encodingConfig.TxConfig,
@@ -949,19 +958,23 @@ func (s *ProposalsTestSuite) TestPrepareProposalEdgeCases() {
 			},
 		}
 
-		mempool := block.NewLanedMempool(
-			log.NewTestLogger(s.T()),
-			false,
+		mempool, err := block.NewLanedMempool(
+			log.NewNopLogger(),
+			lanes,
 			mocks.NewMockLaneFetcher(func() (blocksdkmoduletypes.Lane, error) {
 				return blocksdkmoduletypes.Lane{}, nil
 			}, func() []blocksdkmoduletypes.Lane {
 				return chainLanes
 			}),
-			lanes...,
 		)
+		s.Require().NoError(err)
+
+		panicLane.SetIgnoreList(nil)
+		panicLane2.SetIgnoreList(nil)
+		defaultLane.SetIgnoreList(nil)
 
 		proposalHandler := abci.NewProposalHandler(
-			log.NewTestLogger(s.T()),
+			log.NewNopLogger(),
 			s.encodingConfig.TxConfig.TxDecoder(),
 			s.encodingConfig.TxConfig.TxEncoder(),
 			mempool,
@@ -1237,7 +1250,7 @@ func (s *ProposalsTestSuite) TestProcessProposal() {
 
 	s.Run("rejects a proposal when a lane panics", func() {
 		mevLane := s.setUpTOBLane(math.LegacyMustNewDecFromStr("0.25"), map[sdk.Tx]bool{})
-		panicLane := s.setUpPanicLane(math.LegacyMustNewDecFromStr("0.0"))
+		panicLane := s.setUpPanicLane("default", math.LegacyMustNewDecFromStr("0.0"))
 
 		txbz, err := testutils.CreateRandomTxBz(
 			s.encodingConfig.TxConfig,

diff --git a/abci/utils_test.go b/abci/utils_test.go
@@ -60,7 +60,7 @@ func (s *ProposalsTestSuite) setUpAnteHandler(expectedExecution map[sdk.Tx]bool)
 
 func (s *ProposalsTestSuite) setUpStandardLane(maxBlockSpace math.LegacyDec, expectedExecution map[sdk.Tx]bool) *defaultlane.DefaultLane {
 	cfg := base.LaneConfig{
-		Logger:          log.NewTestLogger(s.T()),
+		Logger:          log.NewNopLogger(),
 		TxEncoder:       s.encodingConfig.TxConfig.TxEncoder(),
 		TxDecoder:       s.encodingConfig.TxConfig.TxDecoder(),
 		AnteHandler:     s.setUpAnteHandler(expectedExecution),
@@ -74,7 +74,7 @@ func (s *ProposalsTestSuite) setUpStandardLane(maxBlockSpace math.LegacyDec, exp
 
 func (s *ProposalsTestSuite) setUpTOBLane(maxBlockSpace math.LegacyDec, expectedExecution map[sdk.Tx]bool) *mev.MEVLane {
 	cfg := base.LaneConfig{
-		Logger:          log.NewTestLogger(s.T()),
+		Logger:          log.NewNopLogger(),
 		TxEncoder:       s.encodingConfig.TxConfig.TxEncoder(),
 		TxDecoder:       s.encodingConfig.TxConfig.TxDecoder(),
 		AnteHandler:     s.setUpAnteHandler(expectedExecution),
@@ -87,7 +87,7 @@ func (s *ProposalsTestSuite) setUpTOBLane(maxBlockSpace math.LegacyDec, expected
 
 func (s *ProposalsTestSuite) setUpFreeLane(maxBlockSpace math.LegacyDec, expectedExecution map[sdk.Tx]bool) *free.FreeLane {
 	cfg := base.LaneConfig{
-		Logger:          log.NewTestLogger(s.T()),
+		Logger:          log.NewNopLogger(),
 		TxEncoder:       s.encodingConfig.TxConfig.TxEncoder(),
 		TxDecoder:       s.encodingConfig.TxConfig.TxDecoder(),
 		AnteHandler:     s.setUpAnteHandler(expectedExecution),
@@ -98,9 +98,9 @@ func (s *ProposalsTestSuite) setUpFreeLane(maxBlockSpace math.LegacyDec, expecte
 	return free.NewFreeLane(cfg, base.DefaultTxPriority(), free.DefaultMatchHandler())
 }
 
-func (s *ProposalsTestSuite) setUpPanicLane(maxBlockSpace math.LegacyDec) *base.BaseLane {
+func (s *ProposalsTestSuite) setUpPanicLane(name string, maxBlockSpace math.LegacyDec) *base.BaseLane {
 	cfg := base.LaneConfig{
-		Logger:          log.NewTestLogger(s.T()),
+		Logger:          log.NewNopLogger(),
 		TxEncoder:       s.encodingConfig.TxConfig.TxEncoder(),
 		TxDecoder:       s.encodingConfig.TxConfig.TxDecoder(),
 		MaxBlockSpace:   maxBlockSpace,
@@ -109,7 +109,7 @@ func (s *ProposalsTestSuite) setUpPanicLane(maxBlockSpace math.LegacyDec) *base.
 
 	lane := base.NewBaseLane(
 		cfg,
-		"panic",
+		name,
 		base.NewMempool[string](base.DefaultTxPriority(), cfg.TxEncoder, cfg.SignerExtractor, 0),
 		base.DefaultMatchHandler(),
 	)
@@ -138,15 +138,15 @@ func (s *ProposalsTestSuite) setUpProposalHandlers(lanes []block.Lane) *abci.Pro
 			return blocksdkLanes
 		})
 
-	mempool := block.NewLanedMempool(log.NewTestLogger(
-		s.T()),
-		false,
+	mempool, err := block.NewLanedMempool(
+		log.NewNopLogger(),
+		lanes,
 		laneFetcher,
-		lanes...,
 	)
+	s.Require().NoError(err)
 
 	return abci.NewProposalHandler(
-		log.NewTestLogger(s.T()),
+		log.NewNopLogger(),
 		s.encodingConfig.TxConfig.TxDecoder(),
 		s.encodingConfig.TxConfig.TxEncoder(),
 		mempool,

diff --git a/block/base/lane.go b/block/base/lane.go
@@ -128,6 +128,10 @@ func (l *BaseLane) Match(ctx sdk.Context, tx sdk.Tx) bool {
 // list is utilized to prevent transactions that should be considered in other lanes
 // from being considered from this lane.
 func (l *BaseLane) CheckIgnoreList(ctx sdk.Context, tx sdk.Tx) bool {
+	if l.cfg.IgnoreList == nil {
+		return false
+	}
+
 	for _, lane := range l.cfg.IgnoreList {
 		if lane.Match(ctx, tx) {
 			return true
@@ -148,6 +152,12 @@ func (l *BaseLane) SetIgnoreList(lanes []block.Lane) {
 	l.cfg.IgnoreList = lanes
 }
 
+// GetIgnoreList returns the ignore list for the lane. The ignore list is a list
+// of lanes that the lane should ignore when processing transactions.
+func (l *BaseLane) GetIgnoreList() []block.Lane {
+	return l.cfg.IgnoreList
+}
+
 // SetAnteHandler sets the ante handler for the lane.
 func (l *BaseLane) SetAnteHandler(anteHandler sdk.AnteHandler) {
 	l.cfg.AnteHandler = anteHandler

diff --git a/block/lane.go b/block/lane.go
@@ -69,6 +69,9 @@ type Lane interface {
 	// SetIgnoreList sets the lanes that should be ignored by this lane.
 	SetIgnoreList(ignoreList []Lane)
 
+	// GetIgnoreList returns the lanes that should be ignored by this lane.
+	GetIgnoreList() []Lane
+
 	// Match determines if a transaction belongs to this lane.
 	Match(ctx sdk.Context, tx sdk.Tx) bool
 }