chore: Add config to evict txs after reorg

Author: spalladino

yarn-project/foundation/src/config/env_var.ts

@@ -134,6 +134,7 @@ export type EnvVar =
   | 'P2P_SEEN_MSG_CACHE_SIZE'
   | 'P2P_DROP_TX'
   | 'P2P_DROP_TX_CHANCE'
+  | 'P2P_TX_POOL_DELETE_TXS_AFTER_REORG'
   | 'PEER_ID_PRIVATE_KEY'
   | 'PEER_ID_PRIVATE_KEY_PATH'
   | 'PROVER_AGENT_COUNT'

yarn-project/p2p/src/client/p2p_client.test.ts

@@ -12,6 +12,7 @@ import { TxArray, TxHash, TxHashArray } from '@aztec/stdlib/tx';
 import { expect, jest } from '@jest/globals';
 import { type MockProxy, mock } from 'jest-mock-extended';
 
+import type { P2PConfig } from '../config.js';
 import { InMemoryAttestationPool, type P2PService } from '../index.js';
 import type { AttestationPool } from '../mem_pools/attestation_pool/attestation_pool.js';
 import type { MemPools } from '../mem_pools/interface.js';
@@ -57,8 +58,8 @@ describe('P2P Client', () => {
     client = createClient();
   });
 
-  const createClient = () =>
-    new P2PClient(P2PClientType.Full, kvStore, blockSource, mempools, p2pService, txCollection);
+  const createClient = (config: Partial<P2PConfig> = {}) =>
+    new P2PClient(P2PClientType.Full, kvStore, blockSource, mempools, p2pService, txCollection, config);
 
   const advanceToProvenBlock = async (blockNumber: number) => {
     blockSource.setProvenBlockNumber(blockNumber);
@@ -277,6 +278,34 @@ describe('P2P Client', () => {
   });
 
   describe('Chain prunes', () => {
+    it('deletes transactions mined in pruned blocks when flag is enabled', async () => {
+      client = createClient({ txPoolDeleteTxsAfterReorg: true });
+      blockSource.setProvenBlockNumber(0);
+      await client.start();
+
+      // Create two transactions:
+      // 1. A transaction mined in block 95 (which will be pruned)
+      // 2. A transaction mined in block 90 (which will remain)
+      const txMinedInPrunedBlock = await mockTx();
+      const txMinedInKeptBlock = await mockTx();
+
+      // Mock the mined transactions
+      txPool.getMinedTxHashes.mockResolvedValue([
+        [txMinedInPrunedBlock.getTxHash(), 95],
+        [txMinedInKeptBlock.getTxHash(), 90],
+      ]);
+
+      txPool.getAllTxs.mockResolvedValue([txMinedInPrunedBlock, txMinedInKeptBlock]);
+
+      // Prune the chain back to block 90
+      blockSource.removeBlocks(10);
+      await client.sync();
+
+      // Verify only the transaction mined in the pruned block is deleted
+      expect(txPool.deleteTxs).toHaveBeenCalledWith([txMinedInPrunedBlock.getTxHash()]);
+      await client.stop();
+    });
+
     it('moves the tips on a chain reorg', async () => {
       blockSource.setProvenBlockNumber(0);
       await client.start();

yarn-project/p2p/src/client/p2p_client.ts

@@ -799,29 +799,33 @@ export class P2PClient<T extends P2PClientType = P2PClientType.Full>
       }
     }
 
-    this.log.info(
-      `Detected chain prune. Removing invalid txs count=${
-        txsToDelete.size
-      } newLatestBlock=${latestBlock} previousLatestBlock=${await this.getSyncedLatestBlockNum()}`,
-    );
+    this.log.info(`Detected chain prune. Removing ${txsToDelete.size} txs built against pruned blocks.`, {
+      newLatestBlock: latestBlock,
+      previousLatestBlock: await this.getSyncedLatestBlockNum(),
+    });
 
     // delete invalid txs (both pending and mined)
     await this.txPool.deleteTxs(Array.from(txsToDelete.values()));
 
     // everything left in the mined set was built against a block on the proven chain so its still valid
-    // move back to pending the txs that were reorged out of the chain
+    // move back to pending the txs that were reorged out of the chain, unless txPoolDeleteTxsAfterReorg is set,
+    // in which case we clean them up to avoid potential reorg loops
     // NOTE: we can't move _all_ txs back to pending because the tx pool could keep hold of mined txs for longer
     // (see this.keepProvenTxsFor)
-
-    const txsToMoveToPending: TxHash[] = [];
+    const minedTxsFromReorg: TxHash[] = [];
     for (const [txHash, blockNumber] of minedTxs) {
       if (blockNumber > latestBlock) {
-        txsToMoveToPending.push(txHash);
+        minedTxsFromReorg.push(txHash);
       }
     }
 
-    this.log.info(`Moving ${txsToMoveToPending.length} mined txs back to pending`);
-    await this.txPool.markMinedAsPending(txsToMoveToPending);
+    if (this.config.txPoolDeleteTxsAfterReorg) {
+      this.log.info(`Deleting ${minedTxsFromReorg.length} mined txs from reorg`);
+      await this.txPool.deleteTxs(minedTxsFromReorg);
+    } else {
+      this.log.info(`Moving ${minedTxsFromReorg.length} mined txs from reorg back to pending`);
+      await this.txPool.markMinedAsPending(minedTxsFromReorg);
+    }
 
     await this.synchedLatestBlockNumber.set(latestBlock);
     // no need to update block hashes, as they will be updated as new blocks are added

yarn-project/p2p/src/config.ts

@@ -161,6 +161,9 @@ export interface P2PConfig extends P2PReqRespConfig, ChainConfig, TxCollectionCo
 
   /** The probability that a transaction is discarded. - For testing purposes only */
   dropTransactionsProbability: number;
+
+  /** Whether to delete transactions from the pool after a reorg instead of moving them back to pending. */
+  txPoolDeleteTxsAfterReorg: boolean;
 }
 
 export const DEFAULT_P2P_PORT = 40400;
@@ -412,6 +415,11 @@ export const p2pConfigMappings: ConfigMappingsType<P2PConfig> = {
       'Whether transactions are disabled for this node. This means transactions will be rejected at the RPC and P2P layers.',
     ...booleanConfigHelper(false),
   },
+  txPoolDeleteTxsAfterReorg: {
+    env: 'P2P_TX_POOL_DELETE_TXS_AFTER_REORG',
+    description: 'Whether to delete transactions from the pool after a reorg instead of moving them back to pending.',
+    ...booleanConfigHelper(false),
+  },
   ...p2pReqRespConfigMappings,
   ...chainConfigMappings,
   ...txCollectionConfigMappings,