@aztec/p2p 0.47.0 → 0.48.0

package/src/config.ts

@@ -1,4 +1,10 @@
-import { SemVer } from 'semver';
+import {
+  type ConfigMappingsType,
+  booleanConfigHelper,
+  getConfigFromMappings,
+  numberConfigHelper,
+  pickConfigMappings,
+} from '@aztec/foundation/config';
 
 /**
  * P2P client configuration values.
@@ -12,17 +18,17 @@ export interface P2PConfig {
   /**
    * The frequency in which to check for new L2 blocks.
    */
-  p2pBlockCheckIntervalMS: number;
+  blockCheckIntervalMS: number;
 
   /**
    * The frequency in which to check for new peers.
    */
-  p2pPeerCheckIntervalMS: number;
+  peerCheckIntervalMS: number;
 
   /**
    * Size of queue of L2 blocks to store.
    */
-  p2pL2QueueSize: number;
+  l2QueueSize: number;
 
   /**
    * The announce address for TCP.
@@ -59,11 +65,6 @@ export interface P2PConfig {
    */
   transactionProtocol: string;
 
-  /**
-   * Whether to enable NAT from libp2p (ignored for bootstrap node).
-   */
-  enableNat?: boolean;
-
   /**
    * The minimum number of peers (a peer count below this will cause the node to look for more peers)
    */
@@ -79,61 +80,121 @@ export interface P2PConfig {
    */
   dataDirectory?: string;
 
-  /**
-   * The transaction gossiping message version.
-   */
-  txGossipVersion: SemVer;
-
   /**
    * If announceUdpAddress or announceTcpAddress are not provided, query for the IP address of the machine. Default is false.
    */
   queryForIp: boolean;
+
+  /** How many blocks have to pass after a block is proven before its txs are deleted (zero to delete immediately once proven) */
+  keepProvenTxsInPoolFor: number;
 }
 
+export const p2pConfigMappings: ConfigMappingsType<P2PConfig> = {
+  p2pEnabled: {
+    env: 'P2P_ENABLED',
+    description: 'A flag dictating whether the P2P subsystem should be enabled.',
+    ...booleanConfigHelper(),
+  },
+  blockCheckIntervalMS: {
+    env: 'P2P_BLOCK_CHECK_INTERVAL_MS',
+    description: 'The frequency in which to check for new L2 blocks.',
+    ...numberConfigHelper(100),
+  },
+  peerCheckIntervalMS: {
+    env: 'P2P_PEER_CHECK_INTERVAL_MS',
+    description: 'The frequency in which to check for new peers.',
+    ...numberConfigHelper(1_000),
+  },
+  l2QueueSize: {
+    env: 'P2P_L2_QUEUE_SIZE',
+    description: 'Size of queue of L2 blocks to store.',
+    ...numberConfigHelper(1_000),
+  },
+  tcpListenAddress: {
+    env: 'TCP_LISTEN_ADDR',
+    defaultValue: '0.0.0.0:40400',
+    description: 'The listen address for TCP. Format: <IP_ADDRESS>:<PORT>.',
+  },
+  udpListenAddress: {
+    env: 'UDP_LISTEN_ADDR',
+    defaultValue: '0.0.0.0:40400',
+    description: 'The listen address for UDP. Format: <IP_ADDRESS>:<PORT>.',
+  },
+  tcpAnnounceAddress: {
+    env: 'P2P_TCP_ANNOUNCE_ADDR',
+    description:
+      'The announce address for TCP. Format: <IP_ADDRESS>:<PORT>. Leave IP_ADDRESS blank to query for public IP.',
+  },
+  udpAnnounceAddress: {
+    env: 'P2P_UDP_ANNOUNCE_ADDR',
+    description:
+      'The announce address for UDP. Format: <IP_ADDRESS>:<PORT>. Leave IP_ADDRESS blank to query for public IP.',
+  },
+  peerIdPrivateKey: {
+    env: 'PEER_ID_PRIVATE_KEY',
+    description: 'An optional peer id private key. If blank, will generate a random key.',
+  },
+  bootstrapNodes: {
+    env: 'BOOTSTRAP_NODES',
+    parseEnv: (val: string) => val.split(','),
+    description: 'A list of bootstrap peer ENRs to connect to. Separated by commas.',
+  },
+  transactionProtocol: {
+    env: 'P2P_TX_PROTOCOL',
+    description: 'Protocol identifier for transaction gossiping.',
+    defaultValue: '/aztec/0.1.0',
+  },
+  minPeerCount: {
+    env: 'P2P_MIN_PEERS',
+    description: 'The minimum number of peers to connect to.',
+    ...numberConfigHelper(10),
+  },
+  maxPeerCount: {
+    env: 'P2P_MAX_PEERS',
+    description: 'The maximum number of peers to connect to.',
+    ...numberConfigHelper(100),
+  },
+  dataDirectory: {
+    env: 'DATA_DIRECTORY',
+    description: 'Data directory for peer & tx databases. Will use temporary location if not set.',
+  },
+  queryForIp: {
+    env: 'P2P_QUERY_FOR_IP',
+    description:
+      'If announceUdpAddress or announceTcpAddress are not provided, query for the IP address of the machine. Default is false.',
+    ...booleanConfigHelper(),
+  },
+  keepProvenTxsInPoolFor: {
+    env: 'P2P_TX_POOL_KEEP_PROVEN_FOR',
+    description:
+      'How many blocks have to pass after a block is proven before its txs are deleted (zero to delete immediately once proven)',
+    ...numberConfigHelper(0),
+  },
+};
+
 /**
  * Gets the config values for p2p client from environment variables.
  * @returns The config values for p2p client.
  */
 export function getP2PConfigEnvVars(): P2PConfig {
-  const {
-    P2P_ENABLED,
-    P2P_BLOCK_CHECK_INTERVAL_MS,
-    P2P_PEER_CHECK_INTERVAL_MS,
-    P2P_L2_BLOCK_QUEUE_SIZE,
-    P2P_TCP_LISTEN_ADDR,
-    P2P_UDP_LISTEN_ADDR,
-    P2P_TCP_ANNOUNCE_ADDR,
-    P2P_UDP_ANNOUNCE_ADDR,
-    PEER_ID_PRIVATE_KEY,
-    BOOTSTRAP_NODES,
-    P2P_NAT_ENABLED,
-    P2P_MIN_PEERS,
-    P2P_MAX_PEERS,
-    DATA_DIRECTORY,
-    TX_GOSSIP_VERSION,
-    P2P_TX_PROTOCOL,
-    P2P_QUERY_FOR_IP,
-  } = process.env;
-  // P2P listen & announce addresses passed in format: <IP_ADDRESS>:<PORT>
-  // P2P announce multiaddrs passed in format: /ip4/<IP_ADDRESS>/<protocol>/<PORT>
-  const envVars: P2PConfig = {
-    tcpAnnounceAddress: P2P_TCP_ANNOUNCE_ADDR,
-    udpAnnounceAddress: P2P_UDP_ANNOUNCE_ADDR,
-    tcpListenAddress: P2P_TCP_LISTEN_ADDR || '0.0.0.0:40400',
-    udpListenAddress: P2P_UDP_LISTEN_ADDR || '0.0.0.0:40400',
-    p2pEnabled: P2P_ENABLED === 'true',
-    p2pBlockCheckIntervalMS: P2P_BLOCK_CHECK_INTERVAL_MS ? +P2P_BLOCK_CHECK_INTERVAL_MS : 100,
-    p2pPeerCheckIntervalMS: P2P_PEER_CHECK_INTERVAL_MS ? +P2P_PEER_CHECK_INTERVAL_MS : 1000,
-    p2pL2QueueSize: P2P_L2_BLOCK_QUEUE_SIZE ? +P2P_L2_BLOCK_QUEUE_SIZE : 1000,
-    peerIdPrivateKey: PEER_ID_PRIVATE_KEY,
-    bootstrapNodes: BOOTSTRAP_NODES ? BOOTSTRAP_NODES.split(',') : [],
-    transactionProtocol: P2P_TX_PROTOCOL ? P2P_TX_PROTOCOL : '/aztec/0.1.0',
-    enableNat: P2P_NAT_ENABLED === 'true',
-    minPeerCount: P2P_MIN_PEERS ? +P2P_MIN_PEERS : 10,
-    maxPeerCount: P2P_MAX_PEERS ? +P2P_MAX_PEERS : 100,
-    dataDirectory: DATA_DIRECTORY,
-    txGossipVersion: TX_GOSSIP_VERSION ? new SemVer(TX_GOSSIP_VERSION) : new SemVer('0.1.0'),
-    queryForIp: P2P_QUERY_FOR_IP === 'true',
-  };
-  return envVars;
+  return getConfigFromMappings<P2PConfig>(p2pConfigMappings);
 }
+
+/**
+ * Required P2P config values for a bootstrap node.
+ */
+export type BootnodeConfig = Pick<
+  P2PConfig,
+  'udpAnnounceAddress' | 'peerIdPrivateKey' | 'minPeerCount' | 'maxPeerCount'
+> &
+  Required<Pick<P2PConfig, 'udpListenAddress'>>;
+
+const bootnodeConfigKeys: (keyof BootnodeConfig)[] = [
+  'udpAnnounceAddress',
+  'peerIdPrivateKey',
+  'minPeerCount',
+  'maxPeerCount',
+  'udpListenAddress',
+];
+
+export const bootnodeConfigMappings = pickConfigMappings(p2pConfigMappings, bootnodeConfigKeys);

package/src/service/libp2p_service.ts

@@ -1,6 +1,6 @@
-import { type 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, fromTxMessage } 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 = fromTxMessage(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,32 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { 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;
-}
-/**
- * Decode a POOLED_TRANSACTIONS message into the original transaction objects.
- * @param message - The binary message to be decoded.
- * @returns - The array of transactions originally encoded into the message.
- */
-export declare function decodeTransactionsMessage(message: Buffer): Tx[];
-/**
- * Creates a tx 'message' for sending to a peer.
- * @param tx - The transaction to convert to a message.
- * @returns - The message.
- */
-export declare function toTxMessage(tx: Tx): Buffer;
-/**
- * Reproduces a transaction from a transaction 'message'
- * @param buffer - The message buffer to convert to a tx.
- * @returns - The reproduced transaction.
- */
-export declare function fromTxMessage(buffer: Buffer): Tx;
-//# 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,EAA4C,EAAE,EAAuB,MAAM,sBAAsB,CAAC;AAIzG,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;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,MAAM,QAWxD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,EAAE,GAAG,MAAM,CA8B1C;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,EAAE,CAyDhD"}