@aztec/p2p 0.0.0-test.0 → 0.0.1-commit.24de95ac

package/dest/mem_pools/tx_pool/aztec_kv_tx_pool.d.ts

@@ -1,13 +1,20 @@
 import { type Logger } from '@aztec/foundation/log';
+import type { TypedEventEmitter } from '@aztec/foundation/types';
 import type { AztecAsyncKVStore } from '@aztec/kv-store';
-import { Tx, TxHash } from '@aztec/stdlib/tx';
+import type { MerkleTreeReadOperations, WorldStateSynchronizer } from '@aztec/stdlib/interfaces/server';
+import { BlockHeader, Tx, TxHash } from '@aztec/stdlib/tx';
 import { type TelemetryClient } from '@aztec/telemetry-client';
-import type { TxPool } from './tx_pool.js';
+import { ArchiveCache } from '../../msg_validators/tx_validator/archive_cache.js';
+import { GasTxValidator } from '../../msg_validators/tx_validator/gas_validator.js';
+import type { TxPool, TxPoolEvents, TxPoolOptions } from './tx_pool.js';
+declare const AztecKVTxPool_base: new () => TypedEventEmitter<TxPoolEvents>;
 /**
  * KV implementation of the Transaction Pool.
  */
-export declare class AztecKVTxPool implements TxPool {
+export declare class AztecKVTxPool extends AztecKVTxPool_base implements TxPool {
     #private;
+    /** The tx evicion logic will kick after pool size is greater than maxTxPoolSize * txPoolOverflowFactor */
+    txPoolOverflowFactor: number;
     /**
      * Class constructor for KV TxPool. Initiates our transaction pool as an AztecMap.
      * @param store - A KV store for live txs in the pool.
@@ -16,18 +23,32 @@ export declare class AztecKVTxPool implements TxPool {
      * @param archivedTxLimit - The number of txs to archive.
      * @param log - A logger.
      */
-    constructor(store: AztecAsyncKVStore, archive: AztecAsyncKVStore, telemetry?: TelemetryClient, archivedTxLimit?: number, log?: Logger);
-    markAsMined(txHashes: TxHash[], blockNumber: number): Promise<void>;
+    constructor(store: AztecAsyncKVStore, archive: AztecAsyncKVStore, worldStateSynchronizer: WorldStateSynchronizer, telemetry?: TelemetryClient, config?: TxPoolOptions, log?: Logger);
+    private countTxs;
+    isEmpty(): Promise<boolean>;
+    /**
+     * Marks transactions as mined in a block and updates the pool state accordingly.
+     * Removes the transactions from the pending set and adds them to the mined set.
+     * Also evicts any transactions that become invalid after the block is mined.
+     * @param txHashes - Array of transaction hashes that were mined
+     * @param blockHeader - The header of the block the transactions were mined in
+     */
+    markAsMined(txHashes: TxHash[], blockHeader: BlockHeader): Promise<void>;
     markMinedAsPending(txHashes: TxHash[]): Promise<void>;
     getPendingTxHashes(): Promise<TxHash[]>;
     getMinedTxHashes(): Promise<[TxHash, number][]>;
-    getTxStatus(txHash: TxHash): Promise<'pending' | 'mined' | undefined>;
+    getPendingTxCount(): Promise<number>;
+    getMinedTxCount(): Promise<number>;
+    getTxStatus(txHash: TxHash): Promise<'pending' | 'mined' | 'deleted' | undefined>;
     /**
      * Checks if a transaction exists in the pool and returns it.
      * @param txHash - The generated tx hash.
      * @returns The transaction, if found, 'undefined' otherwise.
      */
     getTxByHash(txHash: TxHash): Promise<Tx | undefined>;
+    getTxsByHash(txHashes: TxHash[]): Promise<(Tx | undefined)[]>;
+    hasTxs(txHashes: TxHash[]): Promise<boolean[]>;
+    hasTx(txHash: TxHash): Promise<boolean>;
     /**
      * Checks if an archived tx exists and returns it.
      * @param txHash - The tx hash.
@@ -39,13 +60,19 @@ export declare class AztecKVTxPool implements TxPool {
      * @param txs - An array of txs to be added to the pool.
      * @returns Empty promise.
      */
-    addTxs(txs: Tx[]): Promise<void>;
+    addTxs(txs: Tx[], opts?: {
+        source?: string;
+    }): Promise<number>;
     /**
      * Deletes transactions from the pool. Tx hashes that are not present are ignored.
-     * @param txHashes - An array of tx hashes to be removed from the tx pool.
+     * Mined transactions are soft-deleted with a timestamp, pending transactions are permanently deleted.
+     * @param txHashes - An array of tx hashes to be deleted from the tx pool.
      * @returns Empty promise.
      */
-    deleteTxs(txHashes: TxHash[]): Promise<void>;
+    deleteTxs(txHashes: TxHash[], opts?: {
+        eviction?: boolean;
+        permanently?: boolean;
+    }): Promise<void>;
     /**
      * Gets all the transactions stored in the pool.
      * @returns Array of tx objects in the order they were added to the pool.
@@ -56,11 +83,68 @@ export declare class AztecKVTxPool implements TxPool {
      * @returns An array of transaction hashes found in the tx pool.
      */
     getAllTxHashes(): Promise<TxHash[]>;
+    updateConfig({ maxTxPoolSize, txPoolOverflowFactor, archivedTxLimit }: TxPoolOptions): void;
+    markTxsAsNonEvictable(txHashes: TxHash[]): Promise<void>;
+    /**
+     * Permanently deletes deleted mined transactions from blocks up to and including the specified block number.
+     * @param blockNumber - Block number threshold. Deleted mined txs from this block or earlier will be permanently deleted.
+     * @returns The number of transactions permanently deleted.
+     */
+    cleanupDeletedMinedTxs(blockNumber: number): Promise<number>;
+    /**
+     * Creates a GasTxValidator instance.
+     * @param db - DB for the validator to use
+     * @returns A GasTxValidator instance
+     */
+    protected createGasTxValidator(db: MerkleTreeReadOperations): GasTxValidator;
+    /**
+     * Creates an ArchiveCache instance.
+     * @param db - DB for the cache to use
+     * @returns An ArchiveCache instance
+     */
+    protected createArchiveCache(db: MerkleTreeReadOperations): ArchiveCache;
+    /**
+     * Checks if a cached transaction exists in the in-memory pending tx pool and returns it.
+     * Otherwise, it checks the tx pool, updates the pending tx pool, and returns the tx.
+     * @param txHash - The generated tx hash.
+     * @returns The transaction, if found, 'undefined' otherwise.
+     */
+    private getPendingTxByHash;
     /**
      * Archives a list of txs for future reference. The number of archived txs is limited by the specified archivedTxLimit.
      * @param txs - The list of transactions to archive.
      * @returns Empty promise.
      */
     private archiveTxs;
+    /**
+     * Evicts pending txs with the lowest priority fees from the pool to accomodate the max tx count and cumulative max tx size
+     * after new txs are added.
+     *
+     * @param newTxHashes - The tx hashes of the new txs added to the pool.
+     * @returns The total number of txs evicted from the pool and the number of new txs that were evicted.
+     */
+    private evictLowPriorityTxs;
+    /**
+     * Evicts invalid pending txs from the pool after a txs from a block are mined.
+     * Eviction criteria includes:
+     *   - txs with nullifiers that are already included in the mined block
+     *   - txs with an insufficient fee payer balance
+     *   - txs with an expiration timestamp lower than that of the mined block
+     *
+     * @param minedTxHashes - The tx hashes of the txs mined in the block.
+     * @param blockHeader - The header of the mined block.
+     * @returns The total number of txs evicted from the pool.
+     */
+    private evictInvalidTxsAfterMining;
+    /**
+     * Evicts pending txs that no longer have valid archive roots or fee payer balances from the pool after a reorg.
+     *
+     * @param txHashes - The tx hashes of the txs that were moved from mined to pending.
+     * @returns The total number of txs evicted from the pool.
+     */
+    private evictInvalidTxsAfterReorg;
+    private addPendingTxIndices;
+    private removePendingTxIndices;
 }
+export {};
 //# sourceMappingURL=aztec_kv_tx_pool.d.ts.map

package/dest/mem_pools/tx_pool/aztec_kv_tx_pool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aztec_kv_tx_pool.d.ts","sourceRoot":"","sources":["../../../src/mem_pools/tx_pool/aztec_kv_tx_pool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAClE,OAAO,KAAK,EAAE,iBAAiB,EAAqC,MAAM,iBAAiB,CAAC;AAG5F,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,KAAK,eAAe,EAAsB,MAAM,yBAAyB,CAAC;AAInF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C;;GAEG;AACH,qBAAa,aAAc,YAAW,MAAM;;IA4B1C;;;;;;;OAOG;gBAED,KAAK,EAAE,iBAAiB,EACxB,OAAO,EAAE,iBAAiB,EAC1B,SAAS,GAAE,eAAsC,EACjD,eAAe,GAAE,MAAU,EAC3B,GAAG,SAA8B;IAgB5B,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBnE,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB/C,kBAAkB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAKvC,gBAAgB,IAAI,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAK/C,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;IAalF;;;;OAIG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAUjE;;;;OAIG;IACU,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAUzE;;;;OAIG;IACU,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B7C;;;;OAIG;IACI,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCnD;;;OAGG;IACU,SAAS,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;IASvC;;;OAGG;IACU,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAKhD;;;;OAIG;YACW,UAAU;CAiCzB"}
+{"version":3,"file":"aztec_kv_tx_pool.d.ts","sourceRoot":"","sources":["../../../src/mem_pools/tx_pool/aztec_kv_tx_pool.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAClE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EAAE,iBAAiB,EAA0D,MAAM,iBAAiB,CAAC;AAGjH,OAAO,KAAK,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAIxG,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,KAAK,eAAe,EAAsB,MAAM,yBAAyB,CAAC;AAKnF,OAAO,EAAE,YAAY,EAAE,MAAM,oDAAoD,CAAC;AAClF,OAAO,EAAE,cAAc,EAAE,MAAM,oDAAoD,CAAC;AAGpF,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;kCAKpB,UAAU,iBAAiB,CAAC,YAAY,CAAC;AAH7F;;GAEG;AACH,qBAAa,aAAc,SAAQ,kBAA4D,YAAW,MAAM;;IAS9G,0GAA0G;IAC1G,oBAAoB,EAAE,MAAM,CAAK;IAgDjC;;;;;;;OAOG;gBAED,KAAK,EAAE,iBAAiB,EACxB,OAAO,EAAE,iBAAiB,EAC1B,sBAAsB,EAAE,sBAAsB,EAC9C,SAAS,GAAE,eAAsC,EACjD,MAAM,GAAE,aAAkB,EAC1B,GAAG,SAA8B;IA4BnC,OAAO,CAAC,QAAQ,CASd;IAEW,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAMxC;;;;;;OAMG;IACU,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IA4CxE,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBrD,kBAAkB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAKvC,gBAAgB,IAAI,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAK/C,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIpC,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC;IAIlC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;IAmB9F;;;;OAIG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAK3D,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC;IAK7D,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAI9C,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAK7C;;;;OAIG;IACU,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAKzE;;;;OAIG;IACU,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,IAAI,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAwC/E;;;;;OAKG;IACI,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,GAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAgD7G;;;OAGG;IACU,SAAS,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;IAKvC;;;OAGG;IACU,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAKzC,YAAY,CAAC,EAAE,aAAa,EAAE,oBAAoB,EAAE,eAAe,EAAE,EAAE,aAAa,GAAG,IAAI;IA0B3F,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/D;;;;OAIG;IACU,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmCzE;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,EAAE,EAAE,wBAAwB,GAAG,cAAc;IAI5E;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,CAAC,EAAE,EAAE,wBAAwB,GAAG,YAAY;IAIxE;;;;;OAKG;YACW,kBAAkB;IAoBhC;;;;OAIG;YACW,UAAU;IA2CxB;;;;;;OAMG;YACW,mBAAmB;IA8CjC;;;;;;;;;;OAUG;YACW,0BAA0B;IA4DxC;;;;;OAKG;YACW,yBAAyB;YAqCzB,mBAAmB;YAMnB,sBAAsB;CAMrC"}