@aztec/p2p 0.0.0-test.0

package/README.md

@@ -0,0 +1,7 @@
+# P2P
+
+This package includes the functionality of the P2P networking required by the aztec node. The `P2PClient` provides an interface for the introduction of transactions to the Tx Pool and propagation of those transactions through the network. The `P2PService` offers an abstraction of the P2P networking.
+
+The package depends on a block source in order to reconcile the transaction pool and remove settled transactions.
+
+Additionally, the `BootstrapNode` class provides the functionality for running a P2P 'bootnode', one that serves the purpose of introducing new peers to the network. It does not participate in transaction exchange.

package/dest/bootstrap/bootstrap.d.ts

@@ -0,0 +1,38 @@
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import type { P2PBootstrapApi } from '@aztec/stdlib/interfaces/server';
+import { type TelemetryClient } from '@aztec/telemetry-client';
+import type { PeerId } from '@libp2p/interface';
+import type { BootnodeConfig } from '../config.js';
+/**
+ * Encapsulates a 'Bootstrap' node, used for the purpose of assisting new joiners in acquiring peers.
+ */
+export declare class BootstrapNode implements P2PBootstrapApi {
+    private store;
+    private telemetry;
+    private logger;
+    private node?;
+    private peerId?;
+    constructor(store: AztecAsyncKVStore, telemetry: TelemetryClient, logger?: import("@aztec/foundation/log").Logger);
+    /**
+     * Starts the bootstrap node.
+     * @param config - A partial P2P configuration. No need for TCP values as well as aztec node specific values.
+     * @returns An empty promise.
+     */
+    start(config: BootnodeConfig): Promise<void>;
+    /**
+     * Stops the bootstrap node.
+     * @returns And empty promise.
+     */
+    stop(): Promise<void>;
+    private assertNodeStarted;
+    private assertPeerId;
+    /**
+     * Returns the peerId of this node.
+     * @returns The node's peer Id
+     */
+    getPeerId(): PeerId;
+    getENR(): any;
+    getEncodedEnr(): Promise<any>;
+    getRoutingTable(): Promise<any>;
+}
+//# sourceMappingURL=bootstrap.d.ts.map

package/dest/bootstrap/bootstrap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../../src/bootstrap/bootstrap.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAsB,KAAK,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAInF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAGhD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAInD;;GAEG;AACH,qBAAa,aAAc,YAAW,eAAe;IAKjD,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,MAAM;IANhB,OAAO,CAAC,IAAI,CAAC,CAA0C;IACvD,OAAO,CAAC,MAAM,CAAC,CAAS;gBAGd,KAAK,EAAE,iBAAiB,EACxB,SAAS,EAAE,eAAe,EAC1B,MAAM,yCAAgC;IAGhD;;;;OAIG;IACU,KAAK,CAAC,MAAM,EAAE,cAAc;IAmEzC;;;OAGG;IACU,IAAI;IAOjB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,YAAY;IAMpB;;;OAGG;IACI,SAAS;IAKT,MAAM;IAKN,aAAa;IAKb,eAAe;CAIvB"}

package/dest/bootstrap/bootstrap.js

@@ -0,0 +1,123 @@
+import { createLogger } from '@aztec/foundation/log';
+import { OtelMetricsAdapter } from '@aztec/telemetry-client';
+import { Discv5 } from '@chainsafe/discv5';
+import { ENR } from '@chainsafe/enr';
+import { multiaddr } from '@multiformats/multiaddr';
+import { createBootnodeENRandPeerId } from '../enr/generate-enr.js';
+import { convertToMultiaddr, getPeerIdPrivateKey } from '../util.js';
+/**
+ * Encapsulates a 'Bootstrap' node, used for the purpose of assisting new joiners in acquiring peers.
+ */ export class BootstrapNode {
+    store;
+    telemetry;
+    logger;
+    node;
+    peerId;
+    constructor(store, telemetry, logger = createLogger('p2p:bootstrap')){
+        this.store = store;
+        this.telemetry = telemetry;
+        this.logger = logger;
+        this.node = undefined;
+    }
+    /**
+   * Starts the bootstrap node.
+   * @param config - A partial P2P configuration. No need for TCP values as well as aztec node specific values.
+   * @returns An empty promise.
+   */ async start(config) {
+        const { udpListenAddress, udpAnnounceAddress } = config;
+        const listenAddrUdp = multiaddr(convertToMultiaddr(udpListenAddress, 'udp'));
+        if (!udpAnnounceAddress) {
+            throw new Error('You need to provide a UDP announce address.');
+        }
+        const peerIdPrivateKey = await getPeerIdPrivateKey(config, this.store);
+        const { enr: ourEnr, peerId } = await createBootnodeENRandPeerId(peerIdPrivateKey, udpAnnounceAddress, config.l1ChainId);
+        this.peerId = peerId;
+        this.logger.debug(`Starting bootstrap node ${peerId} listening on ${listenAddrUdp.toString()}`);
+        const metricsRegistry = new OtelMetricsAdapter(this.telemetry);
+        this.node = Discv5.create({
+            enr: ourEnr,
+            peerId,
+            bindAddrs: {
+                ip4: listenAddrUdp
+            },
+            config: {
+                lookupTimeout: 2000,
+                allowUnverifiedSessions: true
+            },
+            metricsRegistry
+        });
+        this.node.on('multiaddrUpdated', (addr)=>{
+            this.logger.info('Advertised socket address updated', {
+                addr: addr.toString()
+            });
+        });
+        this.node.on('discovered', async (enr)=>{
+            const addr = await enr.getFullMultiaddr('udp');
+            this.logger.verbose(`Discovered new peer`, {
+                enr: enr.encodeTxt(),
+                addr: addr?.toString()
+            });
+        });
+        try {
+            this.logger.info('Starting bootnode');
+            await this.node.start();
+            this.logger.info('Bootstrap node started', {
+                peerId,
+                enr: ourEnr.encodeTxt(),
+                addr: listenAddrUdp.toString()
+            });
+        } catch (e) {
+            this.logger.error('Error starting Discv5', e);
+        }
+        // Add bootnode ENRs if provided, making sure we filter our own
+        if (config.bootstrapNodes?.length) {
+            const otherBootnodeENRs = config.bootstrapNodes.map((x)=>ENR.decodeTxt(x)).filter((b)=>b.nodeId !== ourEnr.nodeId);
+            this.logger.info(`Adding bootstrap nodes ENRs: ${otherBootnodeENRs.map((x)=>x.encodeTxt()).join(', ')}`);
+            try {
+                otherBootnodeENRs.forEach((enr)=>{
+                    this.node.addEnr(enr);
+                });
+            } catch (e) {
+                this.logger.error(`Error adding bootnode ENRs: ${e}`);
+            }
+        }
+    }
+    /**
+   * Stops the bootstrap node.
+   * @returns And empty promise.
+   */ async stop() {
+        // stop libp2p
+        this.logger.debug('Stopping bootstrap node');
+        await this.node?.stop();
+        this.logger.info('Bootstrap node stopped');
+    }
+    assertNodeStarted() {
+        if (!this.node) {
+            throw new Error('Node not started');
+        }
+    }
+    assertPeerId() {
+        if (!this.peerId) {
+            throw new Error('No peerId found');
+        }
+    }
+    /**
+   * Returns the peerId of this node.
+   * @returns The node's peer Id
+   */ getPeerId() {
+        this.assertPeerId();
+        return this.peerId;
+    }
+    getENR() {
+        this.assertNodeStarted();
+        return this.node?.enr.toENR();
+    }
+    getEncodedEnr() {
+        this.assertNodeStarted();
+        return Promise.resolve(this.node.enr.encodeTxt());
+    }
+    getRoutingTable() {
+        this.assertNodeStarted();
+        return Promise.resolve(this.node.kadValues().map((enr)=>enr.encodeTxt()));
+    }
+}

package/dest/client/factory.d.ts

@@ -0,0 +1,21 @@
+import type { EpochCacheInterface } from '@aztec/epoch-cache';
+import { type Logger } from '@aztec/foundation/log';
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import type { DataStoreConfig } from '@aztec/kv-store/config';
+import type { L2BlockSource } from '@aztec/stdlib/block';
+import type { ClientProtocolCircuitVerifier, WorldStateSynchronizer } from '@aztec/stdlib/interfaces/server';
+import { P2PClientType } from '@aztec/stdlib/p2p';
+import { type TelemetryClient } from '@aztec/telemetry-client';
+import { P2PClient } from '../client/p2p_client.js';
+import type { P2PConfig } from '../config.js';
+import type { AttestationPool } from '../mem_pools/attestation_pool/attestation_pool.js';
+import { type TxPool } from '../mem_pools/tx_pool/index.js';
+type P2PClientDeps<T extends P2PClientType> = {
+    txPool?: TxPool;
+    store?: AztecAsyncKVStore;
+    attestationPool?: T extends P2PClientType.Full ? AttestationPool : undefined;
+    logger?: Logger;
+};
+export declare const createP2PClient: <T extends P2PClientType>(clientType: T, _config: P2PConfig & DataStoreConfig, l2BlockSource: L2BlockSource, proofVerifier: ClientProtocolCircuitVerifier, worldStateSynchronizer: WorldStateSynchronizer, epochCache: EpochCacheInterface, telemetry?: TelemetryClient, deps?: P2PClientDeps<T>) => Promise<P2PClient<T>>;
+export {};
+//# sourceMappingURL=factory.d.ts.map

package/dest/client/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/client/factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAClE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,6BAA6B,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC7G,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,KAAK,eAAe,EAAsB,MAAM,yBAAyB,CAAC;AAEnF,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mDAAmD,CAAC;AAGzF,OAAO,EAAiB,KAAK,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAM3E,KAAK,aAAa,CAAC,CAAC,SAAS,aAAa,IAAI;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,iBAAiB,CAAC;IAC1B,eAAe,CAAC,EAAE,CAAC,SAAS,aAAa,CAAC,IAAI,GAAG,eAAe,GAAG,SAAS,CAAC;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,eAAe,wCACd,CAAC,WACJ,SAAS,GAAG,eAAe,iBACrB,aAAa,iBACb,6BAA6B,0BACpB,sBAAsB,cAClC,mBAAmB,cACpB,eAAe,SACpB,cAAc,CAAC,CAAC,0BAoDvB,CAAC"}

package/dest/client/factory.js

@@ -0,0 +1,37 @@
+import { createLogger } from '@aztec/foundation/log';
+import { createStore } from '@aztec/kv-store/lmdb-v2';
+import { P2PClientType } from '@aztec/stdlib/p2p';
+import { getTelemetryClient } from '@aztec/telemetry-client';
+import { P2PClient } from '../client/p2p_client.js';
+import { InMemoryAttestationPool } from '../mem_pools/attestation_pool/memory_attestation_pool.js';
+import { AztecKVTxPool } from '../mem_pools/tx_pool/index.js';
+import { DiscV5Service } from '../services/discv5/discV5_service.js';
+import { DummyP2PService } from '../services/dummy_service.js';
+import { LibP2PService } from '../services/index.js';
+import { configureP2PClientAddresses, createLibP2PPeerIdFromPrivateKey, getPeerIdPrivateKey } from '../util.js';
+export const createP2PClient = async (clientType, _config, l2BlockSource, proofVerifier, worldStateSynchronizer, epochCache, telemetry = getTelemetryClient(), deps = {})=>{
+    let config = {
+        ..._config
+    };
+    const logger = deps.logger ?? createLogger('p2p');
+    const store = deps.store ?? await createStore('p2p', 1, config, createLogger('p2p:lmdb-v2'));
+    const archive = await createStore('p2p-archive', 1, config, createLogger('p2p-archive:lmdb-v2'));
+    const mempools = {
+        txPool: deps.txPool ?? new AztecKVTxPool(store, archive, telemetry, config.archivedTxLimit),
+        attestationPool: clientType === P2PClientType.Full ? deps.attestationPool ?? new InMemoryAttestationPool(telemetry) : undefined
+    };
+    let p2pService;
+    if (_config.p2pEnabled) {
+        logger.verbose('P2P is enabled. Using LibP2P service.');
+        config = await configureP2PClientAddresses(_config);
+        // Create peer discovery service
+        const peerIdPrivateKey = await getPeerIdPrivateKey(config, store);
+        const peerId = await createLibP2PPeerIdFromPrivateKey(peerIdPrivateKey);
+        const discoveryService = new DiscV5Service(peerId, config, telemetry, createLogger(`${logger.module}:discv5_service`));
+        p2pService = await LibP2PService.new(clientType, config, discoveryService, peerId, mempools, l2BlockSource, epochCache, proofVerifier, worldStateSynchronizer, store, telemetry, createLogger(`${logger.module}:libp2p_service`));
+    } else {
+        logger.verbose('P2P is disabled. Using dummy P2P service');
+        p2pService = new DummyP2PService();
+    }
+    return new P2PClient(clientType, store, l2BlockSource, mempools, p2pService, config, telemetry);
+};

package/dest/client/index.d.ts

@@ -0,0 +1,3 @@
+export * from './p2p_client.js';
+export * from './factory.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC"}

package/dest/client/index.js

@@ -0,0 +1,2 @@
+export * from './p2p_client.js';
+export * from './factory.js';

package/dest/client/p2p_client.d.ts

@@ -0,0 +1,314 @@
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import type { L2BlockId, L2BlockSource, L2BlockStreamEvent, L2Tips } from '@aztec/stdlib/block';
+import type { P2PApi, PeerInfo, ProverCoordination } from '@aztec/stdlib/interfaces/server';
+import type { BlockAttestation, BlockProposal, P2PClientType } from '@aztec/stdlib/p2p';
+import type { Tx, TxHash } from '@aztec/stdlib/tx';
+import { type TelemetryClient, WithTracer } from '@aztec/telemetry-client';
+import type { ENR } from '@chainsafe/enr';
+import { type P2PConfig } from '../config.js';
+import type { MemPools } from '../mem_pools/interface.js';
+import type { P2PService } from '../services/service.js';
+/**
+ * Enum defining the possible states of the p2p client.
+ */
+export declare enum P2PClientState {
+    IDLE = 0,
+    SYNCHING = 1,
+    RUNNING = 2,
+    STOPPED = 3
+}
+/**
+ * The synchronization status of the P2P client.
+ */
+export interface P2PSyncState {
+    /**
+     * The current state of the p2p client.
+     */
+    state: P2PClientState;
+    /**
+     * The block number that the p2p client is synced to.
+     */
+    syncedToL2Block: L2BlockId;
+}
+/**
+ * Interface of a P2P client.
+ **/
+export type P2P<T extends P2PClientType = P2PClientType.Full> = ProverCoordination & P2PApi<T> & {
+    /**
+     * Broadcasts a block proposal to other peers.
+     *
+     * @param proposal - the block proposal
+     */
+    broadcastProposal(proposal: BlockProposal): void;
+    /**
+     * Registers a callback from the validator client that determines how to behave when
+     * foreign block proposals are received
+     *
+     * @param handler - A function taking a received block proposal and producing an attestation
+     */
+    registerBlockProposalHandler(handler: (block: BlockProposal) => Promise<BlockAttestation | undefined>): void;
+    /**
+     * Request a list of transactions from another peer by their tx hashes.
+     * @param txHashes - Hashes of the txs to query.
+     * @returns A list of transactions or undefined if the transactions are not found.
+     */
+    requestTxs(txHashes: TxHash[]): Promise<(Tx | undefined)[]>;
+    /**
+     * Request a transaction from another peer by its tx hash.
+     * @param txHash - Hash of the tx to query.
+     */
+    requestTxByHash(txHash: TxHash): Promise<Tx | undefined>;
+    /**
+     * Verifies the 'tx' and, if valid, adds it to local tx pool and forwards it to other peers.
+     * @param tx - The transaction.
+     **/
+    sendTx(tx: Tx): Promise<void>;
+    /**
+     * Deletes 'txs' from the pool, given hashes.
+     * NOT used if we use sendTx as reconcileTxPool will handle this.
+     * @param txHashes - Hashes to check.
+     **/
+    deleteTxs(txHashes: TxHash[]): Promise<void>;
+    /**
+     * Returns a transaction in the transaction pool by its hash.
+     * @param txHash  - Hash of tx to return.
+     * @returns A single tx or undefined.
+     */
+    getTxByHashFromPool(txHash: TxHash): Promise<Tx | undefined>;
+    /**
+     * Returns a transaction in the transaction pool by its hash, requesting it from the network if it is not found.
+     * @param txHash  - Hash of tx to return.
+     * @returns A single tx or undefined.
+     */
+    getTxByHash(txHash: TxHash): Promise<Tx | undefined>;
+    /**
+     * Returns an archived transaction from the transaction pool by its hash.
+     * @param txHash  - Hash of tx to return.
+     * @returns A single tx or undefined.
+     */
+    getArchivedTxByHash(txHash: TxHash): Promise<Tx | undefined>;
+    /**
+     * Returns whether the given tx hash is flagged as pending or mined.
+     * @param txHash - Hash of the tx to query.
+     * @returns Pending or mined depending on its status, or undefined if not found.
+     */
+    getTxStatus(txHash: TxHash): Promise<'pending' | 'mined' | undefined>;
+    /** Returns an iterator over pending txs on the mempool. */
+    iteratePendingTxs(): AsyncIterableIterator<Tx>;
+    /** Returns the number of pending txs in the mempool. */
+    getPendingTxCount(): Promise<number>;
+    /**
+     * Starts the p2p client.
+     * @returns A promise signalling the completion of the block sync.
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the p2p client.
+     * @returns A promise signalling the completion of the stop process.
+     */
+    stop(): Promise<void>;
+    /**
+     * Indicates if the p2p client is ready for transaction submission.
+     * @returns A boolean flag indicating readiness.
+     */
+    isReady(): boolean;
+    /**
+     * Returns the current status of the p2p client.
+     */
+    getStatus(): Promise<P2PSyncState>;
+    /**
+     * Returns the ENR of this node, if any.
+     */
+    getEnr(): ENR | undefined;
+    /** Identifies a p2p client. */
+    isP2PClient(): true;
+};
+/**
+ * The P2P client implementation.
+ */
+export declare class P2PClient<T extends P2PClientType = P2PClientType.Full> extends WithTracer implements P2P, P2P<P2PClientType.Prover> {
+    #private;
+    private l2BlockSource;
+    private p2pService;
+    private log;
+    /** The JS promise that will be running to keep the client's data in sync. Can be interrupted if the client is stopped. */
+    private runningPromise;
+    private currentState;
+    private syncPromise;
+    private syncResolve?;
+    private latestBlockNumberAtStart;
+    private provenBlockNumberAtStart;
+    private synchedBlockHashes;
+    private synchedLatestBlockNumber;
+    private synchedProvenBlockNumber;
+    private txPool;
+    private attestationPool;
+    /** How many slots to keep attestations for. */
+    private keepAttestationsInPoolFor;
+    /** How many slots to keep proven txs for. */
+    private keepProvenTxsFor;
+    private blockStream;
+    /**
+     * In-memory P2P client constructor.
+     * @param store - The client's instance of the KV store.
+     * @param l2BlockSource - P2P client's source for fetching existing blocks.
+     * @param txPool - The client's instance of a transaction pool. Defaults to in-memory implementation.
+     * @param p2pService - The concrete instance of p2p networking to use.
+     * @param keepProvenTxsFor - How many blocks have to pass after a block is proven before its txs are deleted (zero to delete immediately once proven).
+     * @param log - A logger.
+     */
+    constructor(_clientType: T, store: AztecAsyncKVStore, l2BlockSource: L2BlockSource, mempools: MemPools<T>, p2pService: P2PService, config?: Partial<P2PConfig>, telemetry?: TelemetryClient, log?: import("@aztec/foundation/log").Logger);
+    isP2PClient(): true;
+    getPeers(includePending?: boolean): Promise<PeerInfo[]>;
+    getL2BlockHash(number: number): Promise<string | undefined>;
+    getL2Tips(): Promise<L2Tips>;
+    handleBlockStreamEvent(event: L2BlockStreamEvent): Promise<void>;
+    /**
+     * Starts the P2P client.
+     * @returns An empty promise signalling the synching process.
+     */
+    start(): Promise<void>;
+    /**
+     * Allows consumers to stop the instance of the P2P client.
+     * 'ready' will now return 'false' and the running promise that keeps the client synced is interrupted.
+     */
+    stop(): Promise<void>;
+    broadcastProposal(proposal: BlockProposal): void;
+    getAttestationsForSlot(slot: bigint, proposalId: string): Promise<BlockAttestation[]>;
+    registerBlockProposalHandler(handler: (block: BlockProposal) => Promise<BlockAttestation | undefined>): void;
+    /**
+     * Requests the transactions with the given hashes from the network.
+     *
+     * If a transaction can be retrieved, it will be returned, if not an undefined
+     * will be returned. In place.
+     *
+     * @param txHashes - The hashes of the transactions to request.
+     * @returns A promise that resolves to an array of transactions or undefined.
+     */
+    requestTxs(txHashes: TxHash[]): Promise<(Tx | undefined)[]>;
+    /**
+     * Uses the Request Response protocol to request a transaction from the network.
+     *
+     * If the underlying request response protocol fails, then we return undefined.
+     * If it succeeds then we add the transaction to our transaction pool and return.
+     *
+     * @param txHash - The hash of the transaction to request.
+     * @returns A promise that resolves to a transaction or undefined.
+     */
+    requestTxByHash(txHash: TxHash): Promise<Tx | undefined>;
+    /**
+     * Uses the batched Request Response protocol to request a set of transactions from the network.
+     */
+    requestTxsByHash(txHashes: TxHash[]): Promise<Tx[]>;
+    getPendingTxs(): Promise<Tx[]>;
+    getPendingTxCount(): Promise<number>;
+    iteratePendingTxs(): AsyncIterableIterator<Tx>;
+    /**
+     * Returns all transactions in the transaction pool.
+     * @returns An array of Txs.
+     */
+    getTxs(filter: 'all' | 'pending' | 'mined'): Promise<Tx[]>;
+    /**
+     * Returns a transaction in the transaction pool by its hash.
+     * @param txHash - Hash of the transaction to look for in the pool.
+     * @returns A single tx or undefined.
+     */
+    getTxByHashFromPool(txHash: TxHash): Promise<Tx | undefined>;
+    /**
+     * Returns a transaction in the transaction pool by its hash.
+     * If the transaction is not in the pool, it will be requested from the network.
+     * @param txHash - Hash of the transaction to look for in the pool.
+     * @returns A single tx or undefined.
+     */
+    getTxByHash(txHash: TxHash): Promise<Tx | undefined>;
+    /**
+     * Returns transactions in the transaction pool by hash.
+     * If a transaction is not in the pool, it will be requested from the network.
+     * @param txHashes - Hashes of the transactions to look for.
+     * @returns The txs found, not necessarily on the same order as the hashes.
+     */
+    getTxsByHash(txHashes: TxHash[]): Promise<Tx[]>;
+    /**
+     * Returns an archived transaction in the transaction pool by its hash.
+     * @param txHash - Hash of the archived transaction to look for.
+     * @returns A single tx or undefined.
+     */
+    getArchivedTxByHash(txHash: TxHash): Promise<Tx | undefined>;
+    /**
+     * Verifies the 'tx' and, if valid, adds it to local tx pool and forwards it to other peers.
+     * @param tx - The tx to verify.
+     * @returns Empty promise.
+     **/
+    sendTx(tx: Tx): Promise<void>;
+    /**
+     * Returns whether the given tx hash is flagged as pending or mined.
+     * @param txHash - Hash of the tx to query.
+     * @returns Pending or mined depending on its status, or undefined if not found.
+     */
+    getTxStatus(txHash: TxHash): Promise<'pending' | 'mined' | undefined>;
+    getEnr(): ENR | undefined;
+    getEncodedEnr(): Promise<string | undefined>;
+    /**
+     * Deletes the 'txs' from the pool.
+     * NOT used if we use sendTx as reconcileTxPool will handle this.
+     * @param txHashes - Hashes of the transactions to delete.
+     * @returns Empty promise.
+     **/
+    deleteTxs(txHashes: TxHash[]): Promise<void>;
+    /**
+     * Public function to check if the p2p client is fully synced and ready to receive txs.
+     * @returns True if the P2P client is ready to receive txs.
+     */
+    isReady(): boolean;
+    /**
+     * Public function to check the latest block number that the P2P client is synced to.
+     * @returns Block number of latest L2 Block we've synced with.
+     */
+    getSyncedLatestBlockNum(): Promise<number>;
+    /**
+     * Public function to check the latest proven block number that the P2P client is synced to.
+     * @returns Block number of latest proven L2 Block we've synced with.
+     */
+    getSyncedProvenBlockNum(): Promise<number>;
+    /**
+     * Method to check the status the p2p client.
+     * @returns Information about p2p client status: state & syncedToBlockNum.
+     */
+    getStatus(): Promise<P2PSyncState>;
+    /**
+     * Mark all txs from these blocks as mined.
+     * @param blocks - A list of existing blocks with txs that the P2P client needs to ensure the tx pool is reconciled with.
+     * @returns Empty promise.
+     */
+    private markTxsAsMinedFromBlocks;
+    /**
+     * Deletes txs from these blocks.
+     * @param blocks - A list of existing blocks with txs that the P2P client needs to ensure the tx pool is reconciled with.
+     * @returns Empty promise.
+     */
+    private deleteTxsFromBlocks;
+    /**
+     * Handles new mined blocks by marking the txs in them as mined.
+     * @param blocks - A list of existing blocks with txs that the P2P client needs to ensure the tx pool is reconciled with.
+     * @returns Empty promise.
+     */
+    private handleLatestL2Blocks;
+    /**
+     * Handles new proven blocks by deleting the txs in them, or by deleting the txs in blocks `keepProvenTxsFor` ago.
+     * @param blocks - A list of proven L2 blocks.
+     * @returns Empty promise.
+     */
+    private handleProvenL2Blocks;
+    /**
+     * Updates the tx pool after a chain prune.
+     * @param latestBlock - The block number the chain was pruned to.
+     */
+    private handlePruneL2Blocks;
+    private startServiceIfSynched;
+    /**
+     * Method to set the value of the current state.
+     * @param newState - New state value.
+     */
+    private setCurrentState;
+}
+//# sourceMappingURL=p2p_client.d.ts.map

package/dest/client/p2p_client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"p2p_client.d.ts","sourceRoot":"","sources":["../../src/client/p2p_client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAsC,MAAM,iBAAiB,CAAC;AAC7F,OAAO,KAAK,EAAW,SAAS,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACzG,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACxF,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAEL,KAAK,eAAe,EAEpB,UAAU,EAGX,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,KAAK,SAAS,EAAuB,MAAM,cAAc,CAAC;AAEnE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAG1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;GAEG;AACH,oBAAY,cAAc;IACxB,IAAI,IAAA;IACJ,QAAQ,IAAA;IACR,OAAO,IAAA;IACP,OAAO,IAAA;CACR;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,cAAc,CAAC;IACtB;;OAEG;IACH,eAAe,EAAE,SAAS,CAAC;CAC5B;AAED;;IAEI;AACJ,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,CAAC,IAAI,IAAI,kBAAkB,GAChF,MAAM,CAAC,CAAC,CAAC,GAAG;IACV;;;;OAIG;IACH,iBAAiB,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC;IAEjD;;;;;OAKG;IAGH,4BAA4B,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;IAE7G;;;;OAIG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC;IAE5D;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC;IAEzD;;;QAGI;IACJ,MAAM,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;;QAII;IACJ,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;OAIG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC;IAE7D;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC;IAErD;;;;OAIG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC;IAE7D;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;IAEtE,2DAA2D;IAC3D,iBAAiB,IAAI,qBAAqB,CAAC,EAAE,CAAC,CAAC;IAE/C,wDAAwD;IACxD,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAErC;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;OAGG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtB;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,IAAI,GAAG,GAAG,SAAS,CAAC;IAE1B,+BAA+B;IAC/B,WAAW,IAAI,IAAI,CAAC;CACrB,CAAC;AAEJ;;GAEG;AACH,qBAAa,SAAS,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa,CAAC,IAAI,CACjE,SAAQ,UACR,YAAW,GAAG,EAAE,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC;;IAqCvC,OAAO,CAAC,aAAa;IAErB,OAAO,CAAC,UAAU;IAGlB,OAAO,CAAC,GAAG;IAxCb,0HAA0H;IAC1H,OAAO,CAAC,cAAc,CAAiB;IAEvC,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,WAAW,CAAC,CAAyB;IAC7C,OAAO,CAAC,wBAAwB,CAAM;IACtC,OAAO,CAAC,wBAAwB,CAAM;IAEtC,OAAO,CAAC,kBAAkB,CAAgC;IAC1D,OAAO,CAAC,wBAAwB,CAA8B;IAC9D,OAAO,CAAC,wBAAwB,CAA8B;IAE9D,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,eAAe,CAA6D;IAEpF,+CAA+C;IAC/C,OAAO,CAAC,yBAAyB,CAAS;IAC1C,6CAA6C;IAC7C,OAAO,CAAC,gBAAgB,CAAS;IAEjC,OAAO,CAAC,WAAW,CAAC;IAEpB;;;;;;;;OAQG;gBAED,WAAW,EAAE,CAAC,EACd,KAAK,EAAE,iBAAiB,EAChB,aAAa,EAAE,aAAa,EACpC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EACb,UAAU,EAAE,UAAU,EAC9B,MAAM,GAAE,OAAO,CAAC,SAAS,CAAM,EAC/B,SAAS,GAAE,eAAsC,EACzC,GAAG,yCAAsB;IA0B5B,WAAW,IAAI,IAAI;IAInB,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAIvD,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAIrD,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IA6B5B,sBAAsB,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC7E;;;OAGG;IACU,KAAK;IAoClB;;;OAGG;IACU,IAAI;IAiBV,iBAAiB,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAK1C,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAM3F,4BAA4B,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,GAAG,IAAI;IAInH;;;;;;;;OAQG;IACU,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC;IAKxE;;;;;;;;OAQG;IACU,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAarE;;OAEG;IACU,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,EAAE,CAAC;IAQzD,aAAa,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;IAIxB,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;IAKnC,iBAAiB,IAAI,qBAAqB,CAAC,EAAE,CAAC;IAS5D;;;OAGG;IACU,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC,EAAE,EAAE,CAAC;IAiBvE;;;;OAIG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAI5D;;;;;OAKG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAQ1D;;;;;OAKG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,EAAE,CAAC;IAerD;;;;OAIG;IACH,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAI5D;;;;QAII;IACS,MAAM,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1C;;;;OAIG;IACI,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;IAIrE,MAAM,IAAI,GAAG,GAAG,SAAS;IAIzB,aAAa,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAInD;;;;;QAKI;IACS,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzD;;;OAGG;IACI,OAAO;IAId;;;OAGG;IACU,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIvD;;;OAGG;IACU,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIvD;;;OAGG;IACU,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC;IAgB/C;;;;OAIG;YACW,wBAAwB;IAOtC;;;;OAIG;YACW,mBAAmB;IAQjC;;;;OAIG;YACW,oBAAoB;IAelC;;;;OAIG;YACW,oBAAoB;IAgClC;;;OAGG;YACW,mBAAmB;YAoCnB,qBAAqB;IAenC;;;OAGG;IACH,OAAO,CAAC,eAAe;CAKxB"}