@aztec/p2p 0.41.0 → 0.43.0

package/src/service/discV5_service.ts

@@ -1,5 +1,6 @@
 import { createDebugLogger } from '@aztec/foundation/log';
 import { RunningPromise } from '@aztec/foundation/running-promise';
+import { sleep } from '@aztec/foundation/sleep';
 
 import { Discv5, type Discv5EventEmitter } from '@chainsafe/discv5';
 import { type ENR, SignableENR } from '@chainsafe/enr';
@@ -8,6 +9,7 @@ import { multiaddr } from '@multiformats/multiaddr';
 import EventEmitter from 'events';
 
 import type { P2PConfig } from '../config.js';
+import { convertToMultiaddr } from '../util.js';
 import { type PeerDiscoveryService, PeerDiscoveryState } from './service.js';
 
 export const AZTEC_ENR_KEY = 'aztec_network';
@@ -39,17 +41,24 @@ export class DiscV5Service extends EventEmitter implements PeerDiscoveryService
 
   constructor(private peerId: PeerId, config: P2PConfig, private logger = createDebugLogger('aztec:discv5_service')) {
     super();
-    const { announceHostname, tcpListenPort, udpListenIp, udpListenPort, bootstrapNodes } = config;
+    const { tcpAnnounceAddress, udpAnnounceAddress, udpListenAddress, bootstrapNodes } = config;
     this.bootstrapNodes = bootstrapNodes;
     // create ENR from PeerId
     this.enr = SignableENR.createFromPeerId(peerId);
     // Add aztec identification to ENR
     this.enr.set(AZTEC_ENR_KEY, Uint8Array.from([AZTEC_NET]));
 
-    const multiAddrUdp = multiaddr(`${announceHostname}/udp/${udpListenPort}/p2p/${peerId.toString()}`);
-    const multiAddrTcp = multiaddr(`${announceHostname}/tcp/${tcpListenPort}/p2p/${peerId.toString()}`);
+    if (!tcpAnnounceAddress) {
+      throw new Error('You need to provide at least a TCP announce address.');
+    }
+
+    const multiAddrTcp = multiaddr(`${convertToMultiaddr(tcpAnnounceAddress, 'tcp')}/p2p/${peerId.toString()}`);
+    // if no udp announce address is provided, use the tcp announce address
+    const multiAddrUdp = multiaddr(
+      `${convertToMultiaddr(udpAnnounceAddress || tcpAnnounceAddress, 'udp')}/p2p/${peerId.toString()}`,
+    );
 
-    const listenMultiAddrUdp = multiaddr(`/ip4/${udpListenIp}/udp/${udpListenPort}`);
+    const listenMultiAddrUdp = multiaddr(convertToMultiaddr(udpListenAddress, 'udp'));
 
     // set location multiaddr in ENR record
     this.enr.setLocationMultiaddr(multiAddrUdp);
@@ -61,6 +70,7 @@ export class DiscV5Service extends EventEmitter implements PeerDiscoveryService
       bindAddrs: { ip4: listenMultiAddrUdp },
       config: {
         lookupTimeout: 2000,
+        allowUnverifiedSessions: true,
       },
     });
 
@@ -85,6 +95,7 @@ export class DiscV5Service extends EventEmitter implements PeerDiscoveryService
     }
     this.logger.info('Starting DiscV5');
     await this.discv5.start();
+
     this.logger.info('DiscV5 started');
     this.currentState = PeerDiscoveryState.RUNNING;
 
@@ -100,6 +111,10 @@ export class DiscV5Service extends EventEmitter implements PeerDiscoveryService
       }
     }
 
+    // First, wait some time before starting the peer discovery
+    // reference: https://github.com/ChainSafe/lodestar/issues/3423
+    await sleep(2000);
+
     this.runningPromise.start();
   }
 

package/src/service/libp2p_service.ts

@@ -1,7 +1,6 @@
 import { type Tx, type TxHash } from '@aztec/circuit-types';
 import { SerialQueue } from '@aztec/foundation/fifo';
 import { createDebugLogger } from '@aztec/foundation/log';
-import { type AztecKVStore } from '@aztec/kv-store';
 import { AztecLmdbStore } from '@aztec/kv-store/lmdb';
 
 import { ENR } from '@chainsafe/enr';
@@ -9,21 +8,20 @@ import { type GossipsubEvents, gossipsub } from '@chainsafe/libp2p-gossipsub';
 import { noise } from '@chainsafe/libp2p-noise';
 import { yamux } from '@chainsafe/libp2p-yamux';
 import { identify } from '@libp2p/identify';
-import type { IncomingStreamData, PeerId, PubSub, Stream } from '@libp2p/interface';
+import type { PeerId, PubSub, Stream } from '@libp2p/interface';
 import '@libp2p/kad-dht';
 import { mplex } from '@libp2p/mplex';
 import { peerIdFromString } from '@libp2p/peer-id';
 import { createFromJSON, createSecp256k1PeerId } from '@libp2p/peer-id-factory';
 import { tcp } from '@libp2p/tcp';
-import { pipe } from 'it-pipe';
 import { type Libp2p, createLibp2p } from 'libp2p';
 
 import { type P2PConfig } from '../config.js';
 import { type TxPool } from '../tx_pool/index.js';
+import { convertToMultiaddr } from '../util.js';
 import { AztecDatastore } from './data_store.js';
 import { KnownTxLookup } from './known_txs.js';
 import { PeerManager } from './peer_manager.js';
-import { AztecPeerDb, type AztecPeerStore } from './peer_store.js';
 import type { P2PService, PeerDiscoveryService } from './service.js';
 import { AztecTxMessageCreator, fromTxMessage } from './tx_messages.js';
 
@@ -61,7 +59,6 @@ export class LibP2PService implements P2PService {
     private config: P2PConfig,
     private node: PubSubLibp2p,
     private peerDiscoveryService: PeerDiscoveryService,
-    private peerStore: AztecPeerStore,
     private protocolId: string,
     private txPool: TxPool,
     private bootstrapPeerIds: PeerId[] = [],
@@ -79,15 +76,16 @@ export class LibP2PService implements P2PService {
     if (this.node.status === 'started') {
       throw new Error('P2P service already started');
     }
-    const { enableNat, tcpListenIp, tcpListenPort, announceHostname, announcePort } = this.config;
-    this.logger.info(`Starting P2P node on ${tcpListenIp}:${tcpListenPort}`);
-    if (announceHostname) {
-      this.logger.info(`Announcing at ${announceHostname}/tcp/${announcePort ?? tcpListenPort}`);
-    }
-    if (enableNat) {
-      this.logger.info(`Enabling NAT in libp2p module`);
+    const { tcpListenAddress, tcpAnnounceAddress } = this.config;
+    this.logger.info(`Starting P2P node on ${tcpListenAddress}`);
+
+    if (!tcpAnnounceAddress) {
+      throw new Error('Announce address not provided.');
     }
 
+    const announceTcpMultiaddr = convertToMultiaddr(tcpAnnounceAddress, 'tcp');
+
+    this.logger.info(`Announcing at ${announceTcpMultiaddr}`);
     // handle discovered peers from external discovery service
     this.peerDiscoveryService.on('peer:discovered', async (enr: ENR) => {
       await this.addPeer(enr);
@@ -101,9 +99,9 @@ export class LibP2PService implements P2PService {
     this.node.addEventListener('peer:disconnect', async evt => {
       const peerId = evt.detail;
       if (this.isBootstrapPeer(peerId)) {
-        this.logger.verbose(`Disconnect from bootstrap peer ${peerId.toString()}`);
+        this.logger.info(`Disconnect from bootstrap peer ${peerId.toString()}`);
       } else {
-        this.logger.verbose(`Disconnected from transaction peer ${peerId.toString()}`);
+        this.logger.info(`Disconnected from transaction peer ${peerId.toString()}`);
         await this.peerManager.updateDiscoveryService();
       }
     });
@@ -111,9 +109,6 @@ export class LibP2PService implements P2PService {
     this.jobQueue.start();
     await this.peerDiscoveryService.start();
     await this.node.start();
-    await this.node.handle(this.protocolId, (incoming: IncomingStreamData) =>
-      this.jobQueue.put(() => Promise.resolve(this.handleProtocolDial(incoming))),
-    );
     this.logger.info(`Started P2P client with Peer ID ${this.node.peerId.toString()}`);
 
     // Subscribe to standard topics by default
@@ -124,7 +119,7 @@ export class LibP2PService implements P2PService {
       const { msg } = e.detail;
       this.logger.debug(`Received PUBSUB message.`);
 
-      await this.handleNewGossipMessage(msg.topic, msg.data);
+      await this.jobQueue.put(() => this.handleNewGossipMessage(msg.topic, msg.data));
     });
   }
 
@@ -151,17 +146,11 @@ export class LibP2PService implements P2PService {
     peerDiscoveryService: PeerDiscoveryService,
     peerId: PeerId,
     txPool: TxPool,
-    store: AztecKVStore,
   ) {
-    const {
-      tcpListenIp,
-      tcpListenPort,
-      minPeerCount,
-      maxPeerCount,
-      dataDirectory,
-      transactionProtocol: protocolId,
-    } = config;
-    const bindAddrTcp = `/ip4/${tcpListenIp}/tcp/${tcpListenPort}`;
+    const { tcpListenAddress, minPeerCount, maxPeerCount, transactionProtocol: protocolId } = config;
+    const bindAddrTcp = convertToMultiaddr(tcpListenAddress, 'tcp');
+
+    const datastore = new AztecDatastore(AztecLmdbStore.open());
 
     // 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
@@ -177,8 +166,6 @@ export class LibP2PService implements P2PService {
     //   services.uPnPNAT = uPnPNATService();
     // }
 
-    const datastore = new AztecDatastore(AztecLmdbStore.open(dataDirectory));
-
     const node = await createLibp2p({
       start: false,
       peerId,
@@ -213,9 +200,6 @@ export class LibP2PService implements P2PService {
       },
     });
 
-    // Create an LMDB peer store
-    const peerDb = new AztecPeerDb(store);
-
     // extract bootstrap node peer IDs
     let bootstrapPeerIds: PeerId[] = [];
     if (config.bootstrapNodes.length) {
@@ -224,7 +208,7 @@ export class LibP2PService implements P2PService {
       );
     }
 
-    return new LibP2PService(config, node, peerDiscoveryService, peerDb, protocolId, txPool, bootstrapPeerIds);
+    return new LibP2PService(config, node, peerDiscoveryService, protocolId, txPool, bootstrapPeerIds);
   }
 
   /**
@@ -307,13 +291,8 @@ export class LibP2PService implements P2PService {
       let stream: Stream | undefined;
       try {
         stream = await this.node.dialProtocol(peerMultiAddr, this.protocolId);
-
-        // dial successful, add to DB as well
-        if (!this.peerStore.getPeer(peerIdStr)) {
-          await this.peerStore.addPeer(peerIdStr, enr);
-        }
       } catch (err) {
-        this.logger.error(`Failed to dial peer ${peerIdStr}`, err);
+        this.logger.debug(`Failed to dial peer ${peerIdStr}: ${err}`);
       } finally {
         if (stream) {
           await stream.close();
@@ -322,38 +301,11 @@ export class LibP2PService implements P2PService {
     }
   }
 
-  private async handleProtocolDial(incomingStreamData: IncomingStreamData) {
-    try {
-      const { message, peer } = await this.consumeInboundStream(incomingStreamData);
-      if (!message.length) {
-        this.logger.verbose(`Ignoring 0 byte message from peer${peer.toString()}`);
-      }
-      // await this.processTransactionMessage(message, peer);
-    } catch (err) {
-      this.logger.error(
-        `Failed to handle received message from peer ${incomingStreamData.connection.remotePeer.toString()}`,
-        err,
-      );
-    }
-  }
-
-  private async consumeInboundStream(incomingStreamData: IncomingStreamData) {
-    let buffer = Buffer.alloc(0);
-    await pipe(incomingStreamData.stream, async source => {
-      for await (const msg of source) {
-        const payload = msg.subarray();
-        buffer = Buffer.concat([buffer, Buffer.from(payload)]);
-      }
-    });
-    await incomingStreamData.stream.close();
-    return { message: buffer, peer: incomingStreamData.connection.remotePeer };
-  }
-
   private async handleNewConnection(peerId: PeerId) {
     if (this.isBootstrapPeer(peerId)) {
-      this.logger.verbose(`Connected to bootstrap peer ${peerId.toString()}`);
+      this.logger.info(`Connected to bootstrap peer ${peerId.toString()}`);
     } else {
-      this.logger.verbose(`Connected to transaction peer ${peerId.toString()}`);
+      this.logger.info(`Connected to transaction peer ${peerId.toString()}`);
       await this.peerManager.updateDiscoveryService();
     }
   }

package/src/service/tx_messages.ts

@@ -1,4 +1,4 @@
-import { EncryptedTxL2Logs, Tx, UnencryptedTxL2Logs } from '@aztec/circuit-types';
+import { EncryptedNoteTxL2Logs, EncryptedTxL2Logs, Tx, UnencryptedTxL2Logs } from '@aztec/circuit-types';
 import { PrivateKernelTailCircuitPublicInputs, Proof, PublicCallRequest } from '@aztec/circuits.js';
 import { numToUInt32BE } from '@aztec/foundation/serialize';
 
@@ -115,9 +115,9 @@ export function fromTxMessage(buffer: Buffer): Tx {
   const publicInputs = toObject(buffer.subarray(4), PrivateKernelTailCircuitPublicInputs);
   const proof = toObject(publicInputs.remainingData, Proof);
 
-  const noteEncryptedLogs = toObject(proof.remainingData, EncryptedTxL2Logs);
+  const noteEncryptedLogs = toObject(proof.remainingData, EncryptedNoteTxL2Logs);
   if (!noteEncryptedLogs.obj) {
-    noteEncryptedLogs.obj = new EncryptedTxL2Logs([]);
+    noteEncryptedLogs.obj = new EncryptedNoteTxL2Logs([]);
   }
   const encryptedLogs = toObject(noteEncryptedLogs.remainingData, EncryptedTxL2Logs);
   if (!encryptedLogs.obj) {

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/peer_store.d.ts

@@ -1,18 +0,0 @@
-import type { AztecKVStore } from '@aztec/kv-store';
-import type { ENR } from '@chainsafe/enr';
-export interface AztecPeerStore {
-    addPeer(peerId: string, enr: ENR): Promise<void>;
-    removePeer(peerId: string): Promise<void>;
-    getPeer(peerId: string): ENR | undefined;
-    getAllPeers(): IterableIterator<ENR>;
-}
-export declare class AztecPeerDb implements AztecPeerStore {
-    #private;
-    private db;
-    constructor(db: AztecKVStore);
-    addPeer(peerId: string, enr: ENR): Promise<void>;
-    removePeer(peerId: string): Promise<void>;
-    getPeer(peerId: string): ENR | undefined;
-    getAllPeers(): IterableIterator<ENR>;
-}
-//# sourceMappingURL=peer_store.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"peer_store.d.ts","sourceRoot":"","sources":["../../src/service/peer_store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAY,MAAM,iBAAiB,CAAC;AAE9D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAE1C,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAAC;IACzC,WAAW,IAAI,gBAAgB,CAAC,GAAG,CAAC,CAAC;CACtC;AAED,qBAAa,WAAY,YAAW,cAAc;;IAGpC,OAAO,CAAC,EAAE;gBAAF,EAAE,EAAE,YAAY;IAI9B,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS;IAIvC,WAAW,IAAI,gBAAgB,CAAC,GAAG,CAAC;CAKtC"}

package/dest/service/peer_store.js

@@ -1,25 +0,0 @@
-var _AztecPeerDb_peers;
-import { __classPrivateFieldGet, __classPrivateFieldSet } from "tslib";
-export class AztecPeerDb {
-    constructor(db) {
-        this.db = db;
-        _AztecPeerDb_peers.set(this, void 0);
-        __classPrivateFieldSet(this, _AztecPeerDb_peers, db.openMap('p2p_peers'), "f");
-    }
-    async addPeer(peerId, enr) {
-        void (await __classPrivateFieldGet(this, _AztecPeerDb_peers, "f").set(peerId, enr));
-    }
-    async removePeer(peerId) {
-        void (await __classPrivateFieldGet(this, _AztecPeerDb_peers, "f").delete(peerId));
-    }
-    getPeer(peerId) {
-        return __classPrivateFieldGet(this, _AztecPeerDb_peers, "f").get(peerId);
-    }
-    *getAllPeers() {
-        for (const enr of __classPrivateFieldGet(this, _AztecPeerDb_peers, "f").values()) {
-            yield enr;
-        }
-    }
-}
-_AztecPeerDb_peers = new WeakMap();
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGVlcl9zdG9yZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zZXJ2aWNlL3BlZXJfc3RvcmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFXQSxNQUFNLE9BQU8sV0FBVztJQUd0QixZQUFvQixFQUFnQjtRQUFoQixPQUFFLEdBQUYsRUFBRSxDQUFjO1FBRnBDLHFDQUE4QjtRQUc1Qix1QkFBQSxJQUFJLHNCQUFVLEVBQUUsQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDLE1BQUEsQ0FBQztJQUN4QyxDQUFDO0lBRUQsS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFjLEVBQUUsR0FBUTtRQUNwQyxLQUFLLENBQUMsTUFBTSx1QkFBQSxJQUFJLDBCQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sRUFBRSxHQUFHLENBQUMsQ0FBQyxDQUFDO0lBQzVDLENBQUM7SUFFRCxLQUFLLENBQUMsVUFBVSxDQUFDLE1BQWM7UUFDN0IsS0FBSyxDQUFDLE1BQU0sdUJBQUEsSUFBSSwwQkFBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO0lBQzFDLENBQUM7SUFFRCxPQUFPLENBQUMsTUFBYztRQUNwQixPQUFPLHVCQUFBLElBQUksMEJBQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDakMsQ0FBQztJQUVELENBQUMsV0FBVztRQUNWLEtBQUssTUFBTSxHQUFHLElBQUksdUJBQUEsSUFBSSwwQkFBTyxDQUFDLE1BQU0sRUFBRSxFQUFFLENBQUM7WUFDdkMsTUFBTSxHQUFHLENBQUM7UUFDWixDQUFDO0lBQ0gsQ0FBQztDQUNGIn0=

package/src/service/peer_store.ts

@@ -1,36 +0,0 @@
-import type { AztecKVStore, AztecMap } from '@aztec/kv-store';
-
-import type { ENR } from '@chainsafe/enr';
-
-export interface AztecPeerStore {
-  addPeer(peerId: string, enr: ENR): Promise<void>;
-  removePeer(peerId: string): Promise<void>;
-  getPeer(peerId: string): ENR | undefined;
-  getAllPeers(): IterableIterator<ENR>;
-}
-
-export class AztecPeerDb implements AztecPeerStore {
-  #peers: AztecMap<string, ENR>;
-
-  constructor(private db: AztecKVStore) {
-    this.#peers = db.openMap('p2p_peers');
-  }
-
-  async addPeer(peerId: string, enr: ENR): Promise<void> {
-    void (await this.#peers.set(peerId, enr));
-  }
-
-  async removePeer(peerId: string): Promise<void> {
-    void (await this.#peers.delete(peerId));
-  }
-
-  getPeer(peerId: string): ENR | undefined {
-    return this.#peers.get(peerId);
-  }
-
-  *getAllPeers(): IterableIterator<ENR> {
-    for (const enr of this.#peers.values()) {
-      yield enr;
-    }
-  }
-}