@aztec/p2p 0.47.1 → 0.49.2

package/src/service/libp2p_service.ts

@@ -1,6 +1,6 @@
-import { Tx } from '@aztec/circuit-types';
-import { SerialQueue } from '@aztec/foundation/fifo';
+import { type Gossipable, type RawGossipMessage, TopicType, TopicTypeMap, Tx } from '@aztec/circuit-types';
 import { createDebugLogger } from '@aztec/foundation/log';
+import { SerialQueue } from '@aztec/foundation/queue';
 import { RunningPromise } from '@aztec/foundation/running-promise';
 import type { AztecKVStore } from '@aztec/kv-store';
 
@@ -21,7 +21,6 @@ import { convertToMultiaddr } from '../util.js';
 import { AztecDatastore } from './data_store.js';
 import { PeerManager } from './peer_manager.js';
 import type { P2PService, PeerDiscoveryService } from './service.js';
-import { AztecTxMessageCreator } from './tx_messages.js';
 
 export interface PubSubLibp2p extends Libp2p {
   services: {
@@ -49,7 +48,6 @@ export async function createLibP2PPeerId(privateKey?: string): Promise<PeerId> {
  */
 export class LibP2PService implements P2PService {
   private jobQueue: SerialQueue = new SerialQueue();
-  private messageCreator: AztecTxMessageCreator;
   private peerManager: PeerManager;
   private discoveryRunningPromise?: RunningPromise;
   constructor(
@@ -59,7 +57,6 @@ export class LibP2PService implements P2PService {
     private txPool: TxPool,
     private logger = createDebugLogger('aztec:libp2p_service'),
   ) {
-    this.messageCreator = new AztecTxMessageCreator(config.txGossipVersion);
     this.peerManager = new PeerManager(node, peerDiscoveryService, config, logger);
   }
 
@@ -89,20 +86,22 @@ export class LibP2PService implements P2PService {
     this.logger.info(`Started P2P client with Peer ID ${this.node.peerId.toString()}`);
 
     // Subscribe to standard GossipSub topics by default
-    this.subscribeToTopic(this.messageCreator.getTopic());
+    for (const topic in TopicType) {
+      this.subscribeToTopic(TopicTypeMap[topic].p2pTopic);
+    }
 
     // add GossipSub listener
     this.node.services.pubsub.addEventListener('gossipsub:message', async e => {
       const { msg } = e.detail;
       this.logger.debug(`Received PUBSUB message.`);
 
-      await this.jobQueue.put(() => this.handleNewGossipMessage(msg.topic, msg.data));
+      await this.jobQueue.put(() => this.handleNewGossipMessage(msg));
     });
 
     // Start running promise for peer discovery
     this.discoveryRunningPromise = new RunningPromise(() => {
       this.peerManager.discover();
-    }, this.config.p2pPeerCheckIntervalMS);
+    }, this.config.peerCheckIntervalMS);
     this.discoveryRunningPromise.start();
   }
 
@@ -142,20 +141,6 @@ export class LibP2PService implements P2PService {
 
     const datastore = new AztecDatastore(store);
 
-    // The autonat service seems quite problematic in that using it seems to cause a lot of attempts
-    // to dial ephemeral ports. I suspect that it works better if you can get the uPNPnat service to
-    // work as then you would have a permanent port to be dialled.
-    // Alas, I struggled to get this to work reliably either. I find there is a race between the
-    // service that reads our listener addresses and the uPnP service.
-    // The result being the uPnP service can't find an address to use for the port forward.
-    // Need to investigate further.
-    // if (enableNat) {
-    //   services.autoNAT = autoNATService({
-    //     protocolPrefix: 'aztec',
-    //   });
-    //   services.uPnPNAT = uPnPNATService();
-    // }
-
     const node = await createLibp2p({
       start: false,
       peerId,
@@ -233,14 +218,13 @@ export class LibP2PService implements P2PService {
    * @param topic - The message's topic.
    * @param data - The message data
    */
-  private async handleNewGossipMessage(topic: string, data: Uint8Array) {
-    if (topic !== this.messageCreator.getTopic()) {
-      // Invalid TX Topic, ignore
-      return;
+  private async handleNewGossipMessage(message: RawGossipMessage) {
+    if (message.topic === Tx.p2pTopic) {
+      const tx = Tx.fromBuffer(Buffer.from(message.data));
+      await this.processTxFromPeer(tx);
     }
 
-    const tx = Tx.fromBuffer(Buffer.from(data));
-    await this.processTxFromPeer(tx);
+    return;
   }
 
   /**
@@ -248,7 +232,7 @@ export class LibP2PService implements P2PService {
    * @param tx - The transaction to propagate.
    */
   public propagateTx(tx: Tx): void {
-    void this.jobQueue.put(() => Promise.resolve(this.sendTxToPeers(tx)));
+    void this.jobQueue.put(() => Promise.resolve(this.sendToPeers(tx)));
   }
 
   private async processTxFromPeer(tx: Tx): Promise<void> {
@@ -258,11 +242,14 @@ export class LibP2PService implements P2PService {
     await this.txPool.addTxs([tx]);
   }
 
-  private async sendTxToPeers(tx: Tx) {
-    const { data: txData } = this.messageCreator.createTxMessage(tx);
-    this.logger.verbose(`Sending tx ${tx.getTxHash().toString()} to peers`);
-    const recipientsNum = await this.publishToTopic(this.messageCreator.getTopic(), txData);
-    this.logger.verbose(`Sent tx ${tx.getTxHash().toString()} to ${recipientsNum} peers`);
+  private async sendToPeers<T extends Gossipable>(message: T) {
+    const parent = message.constructor as typeof Gossipable;
+
+    const identifier = message.p2pMessageIdentifier().toString();
+    this.logger.verbose(`Sending tx ${identifier} to peers`);
+
+    const recipientsNum = await this.publishToTopic(parent.p2pTopic, message.toBuffer());
+    this.logger.verbose(`Sent tx ${identifier} to ${recipientsNum} peers`);
   }
 
   // Libp2p seems to hang sometimes if new peers are initiating connections.

package/src/tx_pool/aztec_kv_tx_pool.ts

@@ -42,11 +42,17 @@ export class AztecKVTxPool implements TxPool {
 
   public markAsMined(txHashes: TxHash[]): Promise<void> {
     return this.#store.transaction(() => {
+      let deleted = 0;
       for (const hash of txHashes) {
         const key = hash.toString();
         void this.#minedTxs.add(key);
-        void this.#pendingTxs.delete(key);
+        if (this.#pendingTxs.has(key)) {
+          deleted++;
+          void this.#pendingTxs.delete(key);
+        }
       }
+      this.#metrics.recordRemovedTxs('pending', deleted);
+      this.#metrics.recordAddedTxs('mined', txHashes.length);
     });
   }
 
@@ -87,6 +93,7 @@ export class AztecKVTxPool implements TxPool {
   public addTxs(txs: Tx[]): Promise<void> {
     const txHashes = txs.map(tx => tx.getTxHash());
     return this.#store.transaction(() => {
+      let pendingCount = 0;
       for (const [i, tx] of txs.entries()) {
         const txHash = txHashes[i];
         this.#log.info(`Adding tx with id ${txHash.toString()}`, {
@@ -97,12 +104,14 @@ export class AztecKVTxPool implements TxPool {
         const key = txHash.toString();
         void this.#txs.set(key, tx.toBuffer());
         if (!this.#minedTxs.has(key)) {
+          pendingCount++;
           // REFACTOR: Use an lmdb conditional write to avoid race conditions with this write tx
           void this.#pendingTxs.add(key);
+          this.#metrics.recordTxSize(tx);
         }
       }
 
-      this.#metrics.recordTxs(txs);
+      this.#metrics.recordAddedTxs('pending', pendingCount);
     });
   }
 
@@ -113,14 +122,24 @@ export class AztecKVTxPool implements TxPool {
    */
   public deleteTxs(txHashes: TxHash[]): Promise<void> {
     return this.#store.transaction(() => {
+      let pendingDeleted = 0;
+      let minedDeleted = 0;
       for (const hash of txHashes) {
         const key = hash.toString();
         void this.#txs.delete(key);
-        void this.#pendingTxs.delete(key);
-        void this.#minedTxs.delete(key);
+        if (this.#pendingTxs.has(key)) {
+          pendingDeleted++;
+          void this.#pendingTxs.delete(key);
+        }
+
+        if (this.#minedTxs.has(key)) {
+          minedDeleted++;
+          void this.#minedTxs.delete(key);
+        }
       }
 
-      this.#metrics.removeTxs(txHashes.length);
+      this.#metrics.recordRemovedTxs('pending', pendingDeleted);
+      this.#metrics.recordRemovedTxs('mined', minedDeleted);
     });
   }
 

package/src/tx_pool/instrumentation.ts

@@ -1,5 +1,7 @@
 import { type Tx } from '@aztec/circuit-types';
-import { type Histogram, Metrics, type TelemetryClient, type UpDownCounter } from '@aztec/telemetry-client';
+import { Attributes, type Histogram, Metrics, type TelemetryClient, type UpDownCounter } from '@aztec/telemetry-client';
+
+export type TxStatus = 'pending' | 'mined';
 
 /**
  * Instrumentation class for the TxPool.
@@ -33,26 +35,39 @@ export class TxPoolInstrumentation {
     });
   }
 
+  public recordTxSize(tx: Tx) {
+    this.txSize.record(tx.getSize());
+  }
+
   /**
    * Updates the metrics with the new transactions.
    * @param txs - The transactions to record
    */
-  public recordTxs(txs: Tx[]) {
-    for (const tx of txs) {
-      this.txSize.record(tx.getSize());
+  public recordAddedTxs(status: string, count = 1) {
+    if (count < 0) {
+      throw new Error('Count must be positive');
     }
-
-    this.txInMempool.add(txs.length);
+    if (count === 0) {
+      return;
+    }
+    this.txInMempool.add(count, {
+      [Attributes.STATUS]: status,
+    });
   }
 
   /**
    * Updates the metrics by removing transactions from the mempool.
    * @param count - The number of transactions to remove from the mempool
    */
-  public removeTxs(count = 1) {
+  public recordRemovedTxs(status: string, count = 1) {
     if (count < 0) {
       throw new Error('Count must be positive');
     }
-    this.txInMempool.add(-1 * count);
+    if (count === 0) {
+      return;
+    }
+    this.txInMempool.add(-1 * count, {
+      [Attributes.STATUS]: status,
+    });
   }
 }

package/src/tx_pool/memory_tx_pool.ts

@@ -36,6 +36,8 @@ export class InMemoryTxPool implements TxPool {
       this.minedTxs.add(key);
       this.pendingTxs.delete(key);
     }
+    this.metrics.recordRemovedTxs('pending', txHashes.length);
+    this.metrics.recordAddedTxs('mined', txHashes.length);
     return Promise.resolve();
   }
 
@@ -74,7 +76,7 @@ export class InMemoryTxPool implements TxPool {
    * @returns Empty promise.
    */
   public addTxs(txs: Tx[]): Promise<void> {
-    this.metrics.recordTxs(txs);
+    let pending = 0;
     for (const tx of txs) {
       const txHash = tx.getTxHash();
       this.log.debug(`Adding tx with id ${txHash.toString()}`, {
@@ -85,9 +87,13 @@ export class InMemoryTxPool implements TxPool {
       const key = txHash.toBigInt();
       this.txs.set(key, tx);
       if (!this.minedTxs.has(key)) {
+        pending++;
+        this.metrics.recordTxSize(tx);
         this.pendingTxs.add(key);
       }
     }
+
+    this.metrics.recordAddedTxs('pending', pending);
     return Promise.resolve();
   }
 
@@ -97,13 +103,19 @@ export class InMemoryTxPool implements TxPool {
    * @returns The number of transactions that was deleted from the pool.
    */
   public deleteTxs(txHashes: TxHash[]): Promise<void> {
-    this.metrics.removeTxs(txHashes.length);
+    let deletedMined = 0;
+    let deletedPending = 0;
+
     for (const txHash of txHashes) {
       const key = txHash.toBigInt();
       this.txs.delete(key);
-      this.pendingTxs.delete(key);
-      this.minedTxs.delete(key);
+      deletedPending += this.pendingTxs.delete(key) ? 1 : 0;
+      deletedMined += this.minedTxs.delete(key) ? 1 : 0;
     }
+
+    this.metrics.recordRemovedTxs('pending', deletedPending);
+    this.metrics.recordRemovedTxs('mined', deletedMined);
+
     return Promise.resolve();
   }
 

package/dest/service/tx_messages.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { type Tx } from '@aztec/circuit-types';
-import { type SemVer } from 'semver';
-export declare const TX_MESSAGE_TOPIC = "";
-export declare class AztecTxMessageCreator {
-    private readonly topic;
-    constructor(version: SemVer);
-    createTxMessage(tx: Tx): {
-        topic: string;
-        data: Buffer;
-    };
-    getTopic(): string;
-}
-//# sourceMappingURL=tx_messages.d.ts.map

package/dest/service/tx_messages.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tx_messages.d.ts","sourceRoot":"","sources":["../../src/service/tx_messages.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,eAAO,MAAM,gBAAgB,KAAK,CAAC;AAEnC,qBAAa,qBAAqB;IAChC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;gBACnB,OAAO,EAAE,MAAM;IAI3B,eAAe,CAAC,EAAE,EAAE,EAAE;;;;IAMtB,QAAQ;CAGT"}

package/dest/service/tx_messages.js

@@ -1,14 +0,0 @@
-export const TX_MESSAGE_TOPIC = '';
-export class AztecTxMessageCreator {
-    constructor(version) {
-        this.topic = `/aztec/tx/${version.toString()}`;
-    }
-    createTxMessage(tx) {
-        const messageData = tx.toBuffer();
-        return { topic: this.topic, data: messageData };
-    }
-    getTopic() {
-        return this.topic;
-    }
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHhfbWVzc2FnZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvc2VydmljZS90eF9tZXNzYWdlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFJQSxNQUFNLENBQUMsTUFBTSxnQkFBZ0IsR0FBRyxFQUFFLENBQUM7QUFFbkMsTUFBTSxPQUFPLHFCQUFxQjtJQUVoQyxZQUFZLE9BQWU7UUFDekIsSUFBSSxDQUFDLEtBQUssR0FBRyxhQUFhLE9BQU8sQ0FBQyxRQUFRLEVBQUUsRUFBRSxDQUFDO0lBQ2pELENBQUM7SUFFRCxlQUFlLENBQUMsRUFBTTtRQUNwQixNQUFNLFdBQVcsR0FBRyxFQUFFLENBQUMsUUFBUSxFQUFFLENBQUM7UUFFbEMsT0FBTyxFQUFFLEtBQUssRUFBRSxJQUFJLENBQUMsS0FBSyxFQUFFLElBQUksRUFBRSxXQUFXLEVBQUUsQ0FBQztJQUNsRCxDQUFDO0lBRUQsUUFBUTtRQUNOLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQztJQUNwQixDQUFDO0NBQ0YifQ==

package/src/service/tx_messages.ts

@@ -1,22 +0,0 @@
-import { type Tx } from '@aztec/circuit-types';
-
-import { type SemVer } from 'semver';
-
-export const TX_MESSAGE_TOPIC = '';
-
-export class AztecTxMessageCreator {
-  private readonly topic: string;
-  constructor(version: SemVer) {
-    this.topic = `/aztec/tx/${version.toString()}`;
-  }
-
-  createTxMessage(tx: Tx) {
-    const messageData = tx.toBuffer();
-
-    return { topic: this.topic, data: messageData };
-  }
-
-  getTopic() {
-    return this.topic;
-  }
-}