@aztec/p2p 0.42.0 → 0.44.0

package/src/tx_pool/aztec_kv_tx_pool.ts

@@ -2,7 +2,9 @@ import { Tx, TxHash } from '@aztec/circuit-types';
 import { type TxAddedToPoolStats } from '@aztec/circuit-types/stats';
 import { type Logger, createDebugLogger } from '@aztec/foundation/log';
 import { type AztecKVStore, type AztecMap } from '@aztec/kv-store';
+import { type TelemetryClient } from '@aztec/telemetry-client';
 
+import { TxPoolInstrumentation } from './instrumentation.js';
 import { type TxPool } from './tx_pool.js';
 
 /**
@@ -18,15 +20,18 @@ export class AztecKVTxPool implements TxPool {
 
   #log: Logger;
 
+  #metrics: TxPoolInstrumentation;
+
   /**
    * Class constructor for in-memory TxPool. Initiates our transaction pool as a JS Map.
    * @param store - A KV store.
    * @param log - A logger.
    */
-  constructor(store: AztecKVStore, log = createDebugLogger('aztec:tx_pool')) {
+  constructor(store: AztecKVStore, telemetry: TelemetryClient, log = createDebugLogger('aztec:tx_pool')) {
     this.#txs = store.openMap('txs');
     this.#store = store;
     this.#log = log;
+    this.#metrics = new TxPoolInstrumentation(telemetry, 'AztecKVTxPool');
   }
 
   /**
@@ -44,8 +49,8 @@ export class AztecKVTxPool implements TxPool {
    * @param txs - An array of txs to be added to the pool.
    * @returns Empty promise.
    */
-  public async addTxs(txs: Tx[]): Promise<void> {
-    const txHashes = await Promise.all(txs.map(tx => tx.getTxHash()));
+  public addTxs(txs: Tx[]): Promise<void> {
+    const txHashes = txs.map(tx => tx.getTxHash());
     return this.#store.transaction(() => {
       for (const [i, tx] of txs.entries()) {
         const txHash = txHashes[i];
@@ -56,6 +61,8 @@ export class AztecKVTxPool implements TxPool {
 
         void this.#txs.set(txHash.toString(), tx.toBuffer());
       }
+
+      this.#metrics.recordTxs(txs);
     });
   }
 
@@ -69,6 +76,8 @@ export class AztecKVTxPool implements TxPool {
       for (const hash of txHashes) {
         void this.#txs.delete(hash.toString());
       }
+
+      this.#metrics.removeTxs(txHashes.length);
     });
   }
 

package/src/tx_pool/instrumentation.ts

@@ -0,0 +1,58 @@
+import { type Tx } from '@aztec/circuit-types';
+import { type Histogram, Metrics, type TelemetryClient, type UpDownCounter } from '@aztec/telemetry-client';
+
+/**
+ * Instrumentation class for the TxPool.
+ */
+export class TxPoolInstrumentation {
+  /** The number of txs in the mempool */
+  private txInMempool: UpDownCounter;
+  /** Tracks tx size */
+  private txSize: Histogram;
+
+  constructor(telemetry: TelemetryClient, name: string) {
+    const meter = telemetry.getMeter(name);
+    this.txInMempool = meter.createUpDownCounter(Metrics.MEMPOOL_TX_COUNT, {
+      description: 'The current number of transactions in the mempool',
+    });
+
+    this.txSize = meter.createHistogram(Metrics.MEMPOOL_TX_SIZE, {
+      unit: 'By',
+      description: 'The size of transactions in the mempool',
+      advice: {
+        explicitBucketBoundaries: [
+          5_000, // 5KB
+          10_000,
+          20_000,
+          50_000,
+          75_000,
+          100_000, // 100KB
+          200_000,
+        ],
+      },
+    });
+  }
+
+  /**
+   * 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());
+    }
+
+    this.txInMempool.add(txs.length);
+  }
+
+  /**
+   * Updates the metrics by removing transactions from the mempool.
+   * @param count - The number of transactions to remove from the mempool
+   */
+  public removeTxs(count = 1) {
+    if (count < 0) {
+      throw new Error('Count must be positive');
+    }
+    this.txInMempool.add(-1 * count);
+  }
+}

package/src/tx_pool/memory_tx_pool.ts

@@ -1,7 +1,9 @@
 import { Tx, TxHash } from '@aztec/circuit-types';
 import { type TxAddedToPoolStats } from '@aztec/circuit-types/stats';
 import { createDebugLogger } from '@aztec/foundation/log';
+import { type TelemetryClient } from '@aztec/telemetry-client';
 
+import { TxPoolInstrumentation } from './instrumentation.js';
 import { type TxPool } from './tx_pool.js';
 
 /**
@@ -13,12 +15,15 @@ export class InMemoryTxPool implements TxPool {
    */
   private txs: Map<bigint, Tx>;
 
+  private metrics: TxPoolInstrumentation;
+
   /**
    * Class constructor for in-memory TxPool. Initiates our transaction pool as a JS Map.
    * @param log - A logger.
    */
-  constructor(private log = createDebugLogger('aztec:tx_pool')) {
+  constructor(telemetry: TelemetryClient, private log = createDebugLogger('aztec:tx_pool')) {
     this.txs = new Map<bigint, Tx>();
+    this.metrics = new TxPoolInstrumentation(telemetry, 'InMemoryTxPool');
   }
 
   /**
@@ -37,6 +42,7 @@ export class InMemoryTxPool implements TxPool {
    * @returns Empty promise.
    */
   public addTxs(txs: Tx[]): Promise<void> {
+    this.metrics.recordTxs(txs);
     for (const tx of txs) {
       const txHash = tx.getTxHash();
       this.log.debug(`Adding tx with id ${txHash.toString()}`, {
@@ -54,6 +60,7 @@ 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);
     for (const txHash of txHashes) {
       this.txs.delete(txHash.toBigInt());
     }

package/src/util.ts

@@ -0,0 +1,62 @@
+/**
+ * Converts an address string to a multiaddr string.
+ * Example usage:
+ * const tcpAddr = '123.456.7.8:80' -> /ip4/123.456.7.8/tcp/80
+ * const udpAddr = '[2001:db8::1]:8080' -> /ip6/2001:db8::1/udp/8080
+ * const dnsAddr = 'example.com:443' -> /dns4/example.com/tcp/443
+ * @param address - The address string to convert. Has to be in the format <addr>:<port>.
+ * @param protocol - The protocol to use in the multiaddr string.
+ * @returns A multiaddr compliant string.
+ */
+export function convertToMultiaddr(address: string, protocol: 'tcp' | 'udp'): string {
+  const [addr, port] = splitAddressPort(address, false);
+
+  let multiaddrPrefix: string;
+
+  if (addr.includes(':')) {
+    // IPv6 address
+    multiaddrPrefix = 'ip6';
+  } else if (addr.match(/^[\d.]+$/)) {
+    // IPv4 address
+    multiaddrPrefix = 'ip4';
+  } else {
+    throw new Error('Invalid address format. Expected an IPv4 or IPv6 address.');
+  }
+
+  return `/${multiaddrPrefix}/${addr}/${protocol}/${port}`;
+}
+
+/**
+ * Splits an <address>:<port> string into its components.
+ * @returns The ip6 or ip4 address & port separately
+ */
+export function splitAddressPort(address: string, allowEmptyAddress: boolean): [string, string] {
+  let addr: string;
+  let port: string;
+
+  if (address.startsWith('[')) {
+    // IPv6 address enclosed in square brackets
+    const match = address.match(/^\[([^\]]+)\]:(\d+)$/);
+    if (!match) {
+      throw new Error(`Invalid IPv6 address format:${address}. Expected format: [<addr>]:<port>`);
+    }
+    [, addr, port] = match;
+  } else {
+    // IPv4 address
+    [addr, port] = address.split(':');
+    if ((!addr && !allowEmptyAddress) || !port) {
+      throw new Error(`Invalid address format: ${address}. Expected format: <addr>:<port>`);
+    }
+  }
+
+  return [addr, port];
+}
+
+/**
+ * Queries the public IP address of the machine.
+ */
+export async function getPublicIp(): Promise<string> {
+  const resp = await fetch('http://checkip.amazonaws.com/');
+  const text = await resp.text();
+  return text.trim();
+}

package/dest/service/ip_query.d.ts

@@ -1,2 +0,0 @@
-export declare function getPublicIp(): Promise<string>;
-//# sourceMappingURL=ip_query.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ip_query.d.ts","sourceRoot":"","sources":["../../src/service/ip_query.ts"],"names":[],"mappings":"AAAA,wBAAsB,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAInD"}

package/dest/service/ip_query.js

@@ -1,6 +0,0 @@
-export async function getPublicIp() {
-    const resp = await fetch('http://checkip.amazonaws.com/');
-    const text = await resp.text();
-    return text.trim();
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaXBfcXVlcnkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvc2VydmljZS9pcF9xdWVyeS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLENBQUMsS0FBSyxVQUFVLFdBQVc7SUFDL0IsTUFBTSxJQUFJLEdBQUcsTUFBTSxLQUFLLENBQUMsK0JBQStCLENBQUMsQ0FBQztJQUMxRCxNQUFNLElBQUksR0FBRyxNQUFNLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUMvQixPQUFPLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztBQUNyQixDQUFDIn0=

package/dest/service/known_txs.d.ts

@@ -1,31 +0,0 @@
-import { type PeerId } from '@libp2p/interface';
-/**
- * Keeps a record of which Peers have 'seen' which transactions.
- */
-export declare class KnownTxLookup {
-    private lookup;
-    constructor();
-    /**
-     * Inform this lookup that a peer has 'seen' a transaction.
-     * @param peerId - The peerId of the peer that has 'seen' the transaction.
-     * @param txHash - The thHash of the 'seen' transaction.
-     */
-    addPeerForTx(peerId: PeerId, txHash: string): void;
-    /**
-     * Determine if a peer has 'seen' a transaction.
-     * @param peerId - The peerId of the peer.
-     * @param txHash - The thHash of the transaction.
-     * @returns A boolean indicating if the transaction has been 'seen' by the peer.
-     */
-    hasPeerSeenTx(peerId: PeerId, txHash: string): boolean;
-    /**
-     * Updates the lookup from the result of settled txs
-     * These txs will be cleared out of the lookup.
-     * It is possible that some txs could still be gossiped for a
-     * short period of time meaning they come back into this lookup
-     * but this should be infrequent and cause no undesirable effects
-     * @param txHashes - The hashes of the newly settled transactions
-     */
-    handleSettledTxs(txHashes: string[]): void;
-}
-//# sourceMappingURL=known_txs.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"known_txs.d.ts","sourceRoot":"","sources":["../../src/service/known_txs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAqD;;IAInE;;;;OAIG;IACI,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAYlD;;;;;OAKG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IASnD;;;;;;;OAOG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE;CAK3C"}

package/dest/service/known_txs.js

@@ -1,52 +0,0 @@
-/**
- * Keeps a record of which Peers have 'seen' which transactions.
- */
-export class KnownTxLookup {
-    constructor() {
-        this.lookup = {};
-    }
-    /**
-     * Inform this lookup that a peer has 'seen' a transaction.
-     * @param peerId - The peerId of the peer that has 'seen' the transaction.
-     * @param txHash - The thHash of the 'seen' transaction.
-     */
-    addPeerForTx(peerId, txHash) {
-        const peerIdAsString = peerId.toString();
-        const existingLookup = this.lookup[txHash];
-        if (existingLookup === undefined) {
-            const newLookup = {};
-            newLookup[peerIdAsString] = true;
-            this.lookup[txHash] = newLookup;
-            return;
-        }
-        existingLookup[peerIdAsString] = true;
-    }
-    /**
-     * Determine if a peer has 'seen' a transaction.
-     * @param peerId - The peerId of the peer.
-     * @param txHash - The thHash of the transaction.
-     * @returns A boolean indicating if the transaction has been 'seen' by the peer.
-     */
-    hasPeerSeenTx(peerId, txHash) {
-        const existingLookup = this.lookup[txHash];
-        if (existingLookup === undefined) {
-            return false;
-        }
-        const peerIdAsString = peerId.toString();
-        return !!existingLookup[peerIdAsString];
-    }
-    /**
-     * Updates the lookup from the result of settled txs
-     * These txs will be cleared out of the lookup.
-     * It is possible that some txs could still be gossiped for a
-     * short period of time meaning they come back into this lookup
-     * but this should be infrequent and cause no undesirable effects
-     * @param txHashes - The hashes of the newly settled transactions
-     */
-    handleSettledTxs(txHashes) {
-        for (const txHash of txHashes) {
-            delete this.lookup[txHash];
-        }
-    }
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoia25vd25fdHhzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3NlcnZpY2Uva25vd25fdHhzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBOztHQUVHO0FBQ0gsTUFBTSxPQUFPLGFBQWE7SUFHeEI7UUFGUSxXQUFNLEdBQWtELEVBQUUsQ0FBQztJQUVwRCxDQUFDO0lBRWhCOzs7O09BSUc7SUFDSSxZQUFZLENBQUMsTUFBYyxFQUFFLE1BQWM7UUFDaEQsTUFBTSxjQUFjLEdBQUcsTUFBTSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ3pDLE1BQU0sY0FBYyxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDM0MsSUFBSSxjQUFjLEtBQUssU0FBUyxFQUFFLENBQUM7WUFDakMsTUFBTSxTQUFTLEdBQStCLEVBQUUsQ0FBQztZQUNqRCxTQUFTLENBQUMsY0FBYyxDQUFDLEdBQUcsSUFBSSxDQUFDO1lBQ2pDLElBQUksQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLEdBQUcsU0FBUyxDQUFDO1lBQ2hDLE9BQU87UUFDVCxDQUFDO1FBQ0QsY0FBYyxDQUFDLGNBQWMsQ0FBQyxHQUFHLElBQUksQ0FBQztJQUN4QyxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSSxhQUFhLENBQUMsTUFBYyxFQUFFLE1BQWM7UUFDakQsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUMzQyxJQUFJLGNBQWMsS0FBSyxTQUFTLEVBQUUsQ0FBQztZQUNqQyxPQUFPLEtBQUssQ0FBQztRQUNmLENBQUM7UUFDRCxNQUFNLGNBQWMsR0FBRyxNQUFNLENBQUMsUUFBUSxFQUFFLENBQUM7UUFDekMsT0FBTyxDQUFDLENBQUMsY0FBYyxDQUFDLGNBQWMsQ0FBQyxDQUFDO0lBQzFDLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0ksZ0JBQWdCLENBQUMsUUFBa0I7UUFDeEMsS0FBSyxNQUFNLE1BQU0sSUFBSSxRQUFRLEVBQUUsQ0FBQztZQUM5QixPQUFPLElBQUksQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDN0IsQ0FBQztJQUNILENBQUM7Q0FDRiJ9

package/src/service/ip_query.ts

@@ -1,5 +0,0 @@
-export async function getPublicIp(): Promise<string> {
-  const resp = await fetch('http://checkip.amazonaws.com/');
-  const text = await resp.text();
-  return text.trim();
-}

package/src/service/known_txs.ts

@@ -1,56 +0,0 @@
-import { type PeerId } from '@libp2p/interface';
-
-/**
- * Keeps a record of which Peers have 'seen' which transactions.
- */
-export class KnownTxLookup {
-  private lookup: { [key: string]: { [key: string]: boolean } } = {};
-
-  constructor() {}
-
-  /**
-   * Inform this lookup that a peer has 'seen' a transaction.
-   * @param peerId - The peerId of the peer that has 'seen' the transaction.
-   * @param txHash - The thHash of the 'seen' transaction.
-   */
-  public addPeerForTx(peerId: PeerId, txHash: string) {
-    const peerIdAsString = peerId.toString();
-    const existingLookup = this.lookup[txHash];
-    if (existingLookup === undefined) {
-      const newLookup: { [key: string]: boolean } = {};
-      newLookup[peerIdAsString] = true;
-      this.lookup[txHash] = newLookup;
-      return;
-    }
-    existingLookup[peerIdAsString] = true;
-  }
-
-  /**
-   * Determine if a peer has 'seen' a transaction.
-   * @param peerId - The peerId of the peer.
-   * @param txHash - The thHash of the transaction.
-   * @returns A boolean indicating if the transaction has been 'seen' by the peer.
-   */
-  public hasPeerSeenTx(peerId: PeerId, txHash: string) {
-    const existingLookup = this.lookup[txHash];
-    if (existingLookup === undefined) {
-      return false;
-    }
-    const peerIdAsString = peerId.toString();
-    return !!existingLookup[peerIdAsString];
-  }
-
-  /**
-   * Updates the lookup from the result of settled txs
-   * These txs will be cleared out of the lookup.
-   * It is possible that some txs could still be gossiped for a
-   * short period of time meaning they come back into this lookup
-   * but this should be infrequent and cause no undesirable effects
-   * @param txHashes - The hashes of the newly settled transactions
-   */
-  public handleSettledTxs(txHashes: string[]) {
-    for (const txHash of txHashes) {
-      delete this.lookup[txHash];
-    }
-  }
-}