replace Remove with RemoveWithReason

Author: swift1337

baseapp/abci_utils.go

@@ -285,12 +285,19 @@ func (h *DefaultProposalHandler) PrepareProposalHandler() sdk.PrepareProposalHan
 			return &abci.ResponsePrepareProposal{Txs: h.txSelector.SelectedTxs(ctx)}, nil
 		}
 
-		selectedTxsSignersSeqs := make(map[string]uint64)
+		type invalidTx struct {
+			tx  sdk.Tx
+			err error
+		}
+
 		var (
-			resError        error
-			selectedTxsNums int
-			invalidTxs      []sdk.Tx // invalid txs to be removed out of the loop to avoid dead lock
+			// invalid txs to be removed out of the loop to avoid dead lock
+			invalidTxs             []invalidTx
+			resError               error
+			selectedTxsNums        int
+			selectedTxsSignersSeqs = make(map[string]uint64)
 		)
+
 		mempool.SelectBy(ctx, h.mempool, req.Txs, func(memTx sdk.Tx) bool {
 			unorderedTx, ok := memTx.(sdk.TxWithUnordered)
 			isUnordered := ok && unorderedTx.GetUnordered()
@@ -335,7 +342,7 @@ func (h *DefaultProposalHandler) PrepareProposalHandler() sdk.PrepareProposalHan
 			// check again.
 			txBz, err := h.txVerifier.PrepareProposalVerifyTx(memTx)
 			if err != nil {
-				invalidTxs = append(invalidTxs, memTx)
+				invalidTxs = append(invalidTxs, invalidTx{tx: memTx, err: err})
 			} else {
 				stop := h.txSelector.SelectTxForProposal(ctx, uint64(req.MaxTxBytes), maxBlockGas, memTx, txBz)
 				if stop {
@@ -370,8 +377,13 @@ func (h *DefaultProposalHandler) PrepareProposalHandler() sdk.PrepareProposalHan
 			return nil, resError
 		}
 
-		for _, tx := range invalidTxs {
-			err := h.mempool.Remove(tx)
+		for _, invalidTx := range invalidTxs {
+			reason := mempool.RemoveReason{
+				Caller: "prepare_proposal.remove_invalid_tx",
+				Error:  invalidTx.err,
+			}
+
+			err := mempool.RemoveWithReason(ctx, h.mempool, invalidTx.tx, reason)
 			if err != nil && !errors.Is(err, mempool.ErrTxNotFound) {
 				return nil, err
 			}

baseapp/baseapp.go

@@ -881,10 +881,16 @@ func (app *BaseApp) RunTx(mode sdk.ExecMode, txBytes []byte, tx sdk.Tx, txIndex
 		if err != nil {
 			if mode == execModeReCheck {
 				// if the ante handler fails on recheck, we want to remove the tx from the mempool
-				if mempoolErr := app.mempool.Remove(tx); mempoolErr != nil {
-					return gInfo, nil, anteEvents, errors.Join(err, mempoolErr)
+				errMempool := mempool.RemoveWithReason(ctx, app.mempool, tx, mempool.RemoveReason{
+					Caller: "run_tx.recheck",
+					Error:  err,
+				})
+
+				if errMempool != nil {
+					return gInfo, nil, anteEvents, errors.Join(err, errMempool)
 				}
 			}
+
 			return gInfo, nil, nil, err
 		}
 
@@ -899,10 +905,9 @@ func (app *BaseApp) RunTx(mode sdk.ExecMode, txBytes []byte, tx sdk.Tx, txIndex
 			return gInfo, nil, anteEvents, err
 		}
 	case execModeFinalize:
-		err = app.mempool.Remove(tx)
+		err = mempool.RemoveWithReason(ctx, app.mempool, tx, mempool.RemoveReason{Caller: "run_tx.finalize"})
 		if err != nil && !errors.Is(err, mempool.ErrTxNotFound) {
-			return gInfo, nil, anteEvents,
-				fmt.Errorf("failed to remove tx from mempool: %w", err)
+			return gInfo, nil, anteEvents, fmt.Errorf("failed to remove tx from mempool: %w", err)
 		}
 	}
 

types/mempool/mempool.go

@@ -26,7 +26,7 @@ type Mempool interface {
 
 // ExtMempool is an extension of Mempool interface introduced in v0.50
 // for not be breaking in a patch release.
-// In v0.52+, this interface will be merged into Mempool interface.
+// In v0.54+, this function is removed and RemoveWithReason is merged into Mempool interface.
 type ExtMempool interface {
 	Mempool
 
@@ -78,3 +78,13 @@ func SelectBy(ctx context.Context, mempool Mempool, txs [][]byte, callback func(
 		iter = iter.Next()
 	}
 }
+
+// RemoveWithReason is compatible with old interface to avoid breaking api.
+// In v0.54+, this function is removed and RemoveWithReason is merged into Mempool interface.
+func RemoveWithReason(ctx context.Context, mempool Mempool, tx sdk.Tx, reason RemoveReason) error {
+	if ext, ok := mempool.(ExtMempool); ok {
+		return ext.RemoveWithReason(ctx, tx, reason)
+	}
+
+	return mempool.Remove(tx)
+}