@waku/core 0.0.33-f599932.0 → 0.0.33

package/src/lib/stream_manager/stream_manager.ts

@@ -1,115 +1,173 @@
-import type { PeerUpdate, Stream } from "@libp2p/interface";
-import type { Peer, PeerId } from "@libp2p/interface";
-import { Libp2p } from "@waku/interfaces";
+import type { Peer, PeerId, PeerUpdate, Stream } from "@libp2p/interface";
+import type { Libp2p } from "@waku/interfaces";
 import { Logger } from "@waku/utils";
 
-import { selectConnection } from "./utils.js";
+import { selectOpenConnection } from "./utils.js";
 
-const CONNECTION_TIMEOUT = 5_000;
-const RETRY_BACKOFF_BASE = 1_000;
-const MAX_RETRIES = 3;
+const STREAM_LOCK_KEY = "consumed";
 
 export class StreamManager {
-  private readonly streamPool: Map<string, Promise<Stream | void>>;
   private readonly log: Logger;
 
+  private ongoingCreation: Set<string> = new Set();
+  private streamPool: Map<string, Promise<void>> = new Map();
+
   public constructor(
-    public multicodec: string,
-    public getConnections: Libp2p["getConnections"],
-    public addEventListener: Libp2p["addEventListener"]
+    private multicodec: string,
+    private getConnections: Libp2p["getConnections"],
+    private addEventListener: Libp2p["addEventListener"]
   ) {
     this.log = new Logger(`stream-manager:${multicodec}`);
-    this.streamPool = new Map();
     this.addEventListener("peer:update", this.handlePeerUpdateStreamPool);
   }
 
   public async getStream(peer: Peer): Promise<Stream> {
-    const peerIdStr = peer.id.toString();
-    const streamPromise = this.streamPool.get(peerIdStr);
+    const peerId = peer.id.toString();
+
+    const scheduledStream = this.streamPool.get(peerId);
 
-    if (!streamPromise) {
-      return this.createStream(peer);
+    if (scheduledStream) {
+      this.streamPool.delete(peerId);
+      await scheduledStream;
     }
 
-    this.streamPool.delete(peerIdStr);
-    this.prepareStream(peer);
+    let stream = this.getOpenStreamForCodec(peer.id);
 
-    try {
-      const stream = await streamPromise;
-      if (stream && stream.status !== "closed") {
-        return stream;
-      }
-    } catch (error) {
-      this.log.warn(`Failed to get stream for ${peerIdStr} -- `, error);
-      this.log.warn("Attempting to create a new stream for the peer");
+    if (stream) {
+      this.log.info(
+        `Found existing stream peerId=${peer.id.toString()} multicodec=${this.multicodec}`
+      );
+      this.lockStream(peer.id.toString(), stream);
+      return stream;
     }
 
-    return this.createStream(peer);
+    stream = await this.createStream(peer);
+    this.lockStream(peer.id.toString(), stream);
+
+    return stream;
   }
 
   private async createStream(peer: Peer, retries = 0): Promise<Stream> {
     const connections = this.getConnections(peer.id);
-    const connection = selectConnection(connections);
+    const connection = selectOpenConnection(connections);
 
     if (!connection) {
-      throw new Error("Failed to get a connection to the peer");
+      throw new Error(
+        `Failed to get a connection to the peer peerId=${peer.id.toString()} multicodec=${this.multicodec}`
+      );
     }
 
-    try {
-      return await connection.newStream(this.multicodec);
-    } catch (error) {
-      if (retries < MAX_RETRIES) {
-        const backoff = RETRY_BACKOFF_BASE * Math.pow(2, retries);
-        await new Promise((resolve) => setTimeout(resolve, backoff));
-        return this.createStream(peer, retries + 1);
+    let lastError: unknown;
+    let stream: Stream | undefined;
+
+    for (let i = 0; i < retries + 1; i++) {
+      try {
+        this.log.info(
+          `Attempting to create a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`
+        );
+        stream = await connection.newStream(this.multicodec);
+        this.log.info(
+          `Created stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`
+        );
+        break;
+      } catch (error) {
+        lastError = error;
       }
+    }
+
+    if (!stream) {
       throw new Error(
-        `Failed to create a new stream for ${peer.id.toString()} -- ` + error
+        `Failed to create a new stream for ${peer.id.toString()} -- ` +
+          lastError
       );
     }
+
+    return stream;
   }
 
-  private prepareStream(peer: Peer): void {
-    const timeoutPromise = new Promise<void>((resolve) =>
-      setTimeout(resolve, CONNECTION_TIMEOUT)
-    );
+  private async createStreamWithLock(peer: Peer): Promise<void> {
+    const peerId = peer.id.toString();
 
-    const streamPromise = Promise.race([
-      this.createStream(peer),
-      timeoutPromise.then(() => {
-        throw new Error("Connection timeout");
-      })
-    ]).catch((error) => {
-      this.log.error(
-        `Failed to prepare a new stream for ${peer.id.toString()} -- `,
-        error
+    if (this.ongoingCreation.has(peerId)) {
+      this.log.info(
+        `Skipping creation of a stream due to lock for peerId=${peerId} multicodec=${this.multicodec}`
       );
-    });
+      return;
+    }
+
+    try {
+      this.ongoingCreation.add(peerId);
+      await this.createStream(peer);
+    } catch (error) {
+      this.log.error(`Failed to createStreamWithLock:`, error);
+    } finally {
+      this.ongoingCreation.delete(peerId);
+    }
 
-    this.streamPool.set(peer.id.toString(), streamPromise);
+    return;
   }
 
   private handlePeerUpdateStreamPool = (evt: CustomEvent<PeerUpdate>): void => {
     const { peer } = evt.detail;
 
-    if (peer.protocols.includes(this.multicodec)) {
-      const isConnected = this.isConnectedTo(peer.id);
+    if (!peer.protocols.includes(this.multicodec)) {
+      return;
+    }
+
+    const stream = this.getOpenStreamForCodec(peer.id);
 
-      if (isConnected) {
-        this.log.info(`Preemptively opening a stream to ${peer.id.toString()}`);
-        this.prepareStream(peer);
-      } else {
-        const peerIdStr = peer.id.toString();
-        this.streamPool.delete(peerIdStr);
-        this.log.info(
-          `Removed pending stream for disconnected peer ${peerIdStr}`
-        );
-      }
+    if (stream) {
+      return;
     }
+
+    this.scheduleNewStream(peer);
   };
 
-  private isConnectedTo(peerId: PeerId): boolean {
+  private scheduleNewStream(peer: Peer): void {
+    this.log.info(
+      `Scheduling creation of a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`
+    );
+
+    // abandon previous attempt
+    if (this.streamPool.has(peer.id.toString())) {
+      this.streamPool.delete(peer.id.toString());
+    }
+
+    this.streamPool.set(peer.id.toString(), this.createStreamWithLock(peer));
+  }
+
+  private getOpenStreamForCodec(peerId: PeerId): Stream | undefined {
     const connections = this.getConnections(peerId);
-    return connections.some((connection) => connection.status === "open");
+    const connection = selectOpenConnection(connections);
+
+    if (!connection) {
+      return;
+    }
+
+    const stream = connection.streams.find(
+      (s) => s.protocol === this.multicodec
+    );
+
+    if (!stream) {
+      return;
+    }
+
+    const isStreamUnusable = ["done", "closed", "closing"].includes(
+      stream.writeStatus || ""
+    );
+    if (isStreamUnusable || this.isStreamLocked(stream)) {
+      return;
+    }
+
+    return stream;
+  }
+
+  private lockStream(peerId: string, stream: Stream): void {
+    this.log.info(`Locking stream for peerId:${peerId}\tstreamId:${stream.id}`);
+    stream.metadata[STREAM_LOCK_KEY] = true;
+  }
+
+  private isStreamLocked(stream: Stream): boolean {
+    return !!stream.metadata[STREAM_LOCK_KEY];
   }
 }

package/src/lib/stream_manager/utils.ts

@@ -1,22 +1,10 @@
 import type { Connection } from "@libp2p/interface";
 
-export function selectConnection(
+export function selectOpenConnection(
   connections: Connection[]
 ): Connection | undefined {
-  if (!connections.length) return;
-  if (connections.length === 1) return connections[0];
-
-  let latestConnection: Connection | undefined;
-
-  connections.forEach((connection) => {
-    if (connection.status === "open") {
-      if (!latestConnection) {
-        latestConnection = connection;
-      } else if (connection.timeline.open > latestConnection.timeline.open) {
-        latestConnection = connection;
-      }
-    }
-  });
-
-  return latestConnection;
+  return connections
+    .filter((c) => c.status === "open")
+    .sort((left, right) => right.timeline.open - left.timeline.open)
+    .at(0);
 }

package/dist/lib/wait_for_remote_peer.d.ts

@@ -1,22 +0,0 @@
-import type { Waku } from "@waku/interfaces";
-import { Protocols } from "@waku/interfaces";
-/**
- * Wait for a remote peer to be ready given the passed protocols.
- * Must be used after attempting to connect to nodes, using
- * {@link @waku/sdk!WakuNode.dial} or a bootstrap method with
- * {@link @waku/sdk!createLightNode}.
- *
- * If the passed protocols is a GossipSub protocol, then it resolves only once
- * a peer is in a mesh, to help ensure that other peers will send and receive
- * message to us.
- *
- * @param waku The Waku Node
- * @param protocols The protocols that need to be enabled by remote peers.
- * @param timeoutMs A timeout value in milliseconds..
- *
- * @returns A promise that **resolves** if all desired protocols are fulfilled by
- * remote nodes, **rejects** if the timeoutMs is reached.
- * @throws If passing a protocol that is not mounted
- * @default Wait for remote peers with protocols enabled locally and no time out is applied.
- */
-export declare function waitForRemotePeer(waku: Waku, protocols?: Protocols[], timeoutMs?: number): Promise<void>;

package/dist/lib/wait_for_remote_peer.js

@@ -1,142 +0,0 @@
-import { Protocols } from "@waku/interfaces";
-import { Logger } from "@waku/utils";
-import { pEvent } from "p-event";
-const log = new Logger("wait-for-remote-peer");
-//TODO: move this function within the Waku class: https://github.com/waku-org/js-waku/issues/1761
-/**
- * Wait for a remote peer to be ready given the passed protocols.
- * Must be used after attempting to connect to nodes, using
- * {@link @waku/sdk!WakuNode.dial} or a bootstrap method with
- * {@link @waku/sdk!createLightNode}.
- *
- * If the passed protocols is a GossipSub protocol, then it resolves only once
- * a peer is in a mesh, to help ensure that other peers will send and receive
- * message to us.
- *
- * @param waku The Waku Node
- * @param protocols The protocols that need to be enabled by remote peers.
- * @param timeoutMs A timeout value in milliseconds..
- *
- * @returns A promise that **resolves** if all desired protocols are fulfilled by
- * remote nodes, **rejects** if the timeoutMs is reached.
- * @throws If passing a protocol that is not mounted
- * @default Wait for remote peers with protocols enabled locally and no time out is applied.
- */
-export async function waitForRemotePeer(waku, protocols, timeoutMs) {
-    protocols = protocols ?? getEnabledProtocols(waku);
-    if (!waku.isStarted())
-        return Promise.reject("Waku node is not started");
-    const promises = [];
-    if (protocols.includes(Protocols.Relay)) {
-        if (!waku.relay)
-            throw new Error("Cannot wait for Relay peer: protocol not mounted");
-        promises.push(waitForGossipSubPeerInMesh(waku.relay));
-    }
-    if (protocols.includes(Protocols.Store)) {
-        if (!waku.store)
-            throw new Error("Cannot wait for Store peer: protocol not mounted");
-        promises.push(waitForConnectedPeer(waku.store.protocol, waku.libp2p.services.metadata));
-    }
-    if (protocols.includes(Protocols.LightPush)) {
-        if (!waku.lightPush)
-            throw new Error("Cannot wait for LightPush peer: protocol not mounted");
-        promises.push(waitForConnectedPeer(waku.lightPush.protocol, waku.libp2p.services.metadata));
-    }
-    if (protocols.includes(Protocols.Filter)) {
-        if (!waku.filter)
-            throw new Error("Cannot wait for Filter peer: protocol not mounted");
-        promises.push(waitForConnectedPeer(waku.filter.protocol, waku.libp2p.services.metadata));
-    }
-    if (timeoutMs) {
-        await rejectOnTimeout(Promise.all(promises), timeoutMs, "Timed out waiting for a remote peer.");
-    }
-    else {
-        await Promise.all(promises);
-    }
-}
-//TODO: move this function within protocol SDK class: https://github.com/waku-org/js-waku/issues/1761
-/**
- * Wait for a peer with the given protocol to be connected.
- * If sharding is enabled on the node, it will also wait for the peer to be confirmed by the metadata service.
- */
-async function waitForConnectedPeer(protocol, metadataService) {
-    const codec = protocol.multicodec;
-    const peers = await protocol.connectedPeers();
-    if (peers.length) {
-        if (!metadataService) {
-            log.info(`${codec} peer found: `, peers[0].id.toString());
-            return;
-        }
-        // once a peer is connected, we need to confirm the metadata handshake with at least one of those peers if sharding is enabled
-        try {
-            await Promise.any(peers.map((peer) => metadataService.confirmOrAttemptHandshake(peer.id)));
-            return;
-        }
-        catch (e) {
-            if (e.code === "ERR_CONNECTION_BEING_CLOSED")
-                log.error(`Connection with the peer was closed and possibly because it's on a different shard. Error: ${e}`);
-            log.error(`Error waiting for handshake confirmation: ${e}`);
-        }
-    }
-    log.info(`Waiting for ${codec} peer`);
-    // else we'll just wait for the next peer to connect
-    await new Promise((resolve) => {
-        const cb = (evt) => {
-            if (evt.detail?.protocols?.includes(codec)) {
-                if (metadataService) {
-                    metadataService
-                        .confirmOrAttemptHandshake(evt.detail.peerId)
-                        .then(() => {
-                        protocol.removeLibp2pEventListener("peer:identify", cb);
-                        resolve();
-                    })
-                        .catch((e) => {
-                        if (e.code === "ERR_CONNECTION_BEING_CLOSED")
-                            log.error(`Connection with the peer was closed and possibly because it's on a different shard. Error: ${e}`);
-                        log.error(`Error waiting for handshake confirmation: ${e}`);
-                    });
-                }
-                else {
-                    protocol.removeLibp2pEventListener("peer:identify", cb);
-                    resolve();
-                }
-            }
-        };
-        protocol.addLibp2pEventListener("peer:identify", cb);
-    });
-}
-/**
- * Wait for at least one peer with the given protocol to be connected and in the gossipsub
- * mesh for all pubsubTopics.
- */
-async function waitForGossipSubPeerInMesh(waku) {
-    let peers = waku.getMeshPeers();
-    const pubsubTopics = waku.pubsubTopics;
-    for (const topic of pubsubTopics) {
-        while (peers.length == 0) {
-            await pEvent(waku.gossipSub, "gossipsub:heartbeat");
-            peers = waku.getMeshPeers(topic);
-        }
-    }
-}
-const awaitTimeout = (ms, rejectReason) => new Promise((_resolve, reject) => setTimeout(() => reject(rejectReason), ms));
-async function rejectOnTimeout(promise, timeoutMs, rejectReason) {
-    await Promise.race([promise, awaitTimeout(timeoutMs, rejectReason)]);
-}
-function getEnabledProtocols(waku) {
-    const protocols = [];
-    if (waku.relay) {
-        protocols.push(Protocols.Relay);
-    }
-    if (waku.filter) {
-        protocols.push(Protocols.Filter);
-    }
-    if (waku.store) {
-        protocols.push(Protocols.Store);
-    }
-    if (waku.lightPush) {
-        protocols.push(Protocols.LightPush);
-    }
-    return protocols;
-}
-//# sourceMappingURL=wait_for_remote_peer.js.map

package/dist/lib/wait_for_remote_peer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"wait_for_remote_peer.js","sourceRoot":"","sources":["../../src/lib/wait_for_remote_peer.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAE/C,iGAAiG;AACjG;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,IAAU,EACV,SAAuB,EACvB,SAAkB;IAElB,SAAS,GAAG,SAAS,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAEnD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;QAAE,OAAO,OAAO,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;IAEzE,MAAM,QAAQ,GAAG,EAAE,CAAC;IAEpB,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,KAAK;YACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,QAAQ,CAAC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,KAAK;YACb,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACzE,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QAC1E,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAClB,IAAI,CAAC,SAAS,CAAC,QAAQ,EACvB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAC9B,CACF,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAC1E,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,eAAe,CACnB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EACrB,SAAS,EACT,sCAAsC,CACvC,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;AACH,CAAC;AAED,qGAAqG;AACrG;;;GAGG;AACH,KAAK,UAAU,oBAAoB,CACjC,QAA2B,EAC3B,eAA2B;IAE3B,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;IAClC,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,cAAc,EAAE,CAAC;IAE9C,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC1D,OAAO;QACT,CAAC;QAED,8HAA8H;QAC9H,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,yBAAyB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CACxE,CAAC;YACF,OAAO;QACT,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAK,CAAS,CAAC,IAAI,KAAK,6BAA6B;gBACnD,GAAG,CAAC,KAAK,CACP,8FAA8F,CAAC,EAAE,CAClG,CAAC;YAEJ,GAAG,CAAC,KAAK,CAAC,6CAA6C,CAAC,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED,GAAG,CAAC,IAAI,CAAC,eAAe,KAAK,OAAO,CAAC,CAAC;IAEtC,oDAAoD;IACpD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QAClC,MAAM,EAAE,GAAG,CAAC,GAAgC,EAAQ,EAAE;YACpD,IAAI,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3C,IAAI,eAAe,EAAE,CAAC;oBACpB,eAAe;yBACZ,yBAAyB,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC;yBAC5C,IAAI,CAAC,GAAG,EAAE;wBACT,QAAQ,CAAC,yBAAyB,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;wBACxD,OAAO,EAAE,CAAC;oBACZ,CAAC,CAAC;yBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;wBACX,IAAI,CAAC,CAAC,IAAI,KAAK,6BAA6B;4BAC1C,GAAG,CAAC,KAAK,CACP,8FAA8F,CAAC,EAAE,CAClG,CAAC;wBAEJ,GAAG,CAAC,KAAK,CAAC,6CAA6C,CAAC,EAAE,CAAC,CAAC;oBAC9D,CAAC,CAAC,CAAC;gBACP,CAAC;qBAAM,CAAC;oBACN,QAAQ,CAAC,yBAAyB,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;oBACxD,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QACF,QAAQ,CAAC,sBAAsB,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,0BAA0B,CAAC,IAAY;IACpD,IAAI,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;IAChC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;IAEvC,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC;YACpD,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,YAAY,GAAG,CAAC,EAAU,EAAE,YAAoB,EAAiB,EAAE,CACvE,IAAI,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAEhF,KAAK,UAAU,eAAe,CAC5B,OAAmB,EACnB,SAAiB,EACjB,YAAoB;IAEpB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,mBAAmB,CAAC,IAAU;IACrC,MAAM,SAAS,GAAG,EAAE,CAAC;IAErB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/src/lib/wait_for_remote_peer.ts

@@ -1,200 +0,0 @@
-import type { IdentifyResult } from "@libp2p/interface";
-import type {
-  IBaseProtocolCore,
-  IMetadata,
-  IRelay,
-  Waku
-} from "@waku/interfaces";
-import { Protocols } from "@waku/interfaces";
-import { Logger } from "@waku/utils";
-import { pEvent } from "p-event";
-const log = new Logger("wait-for-remote-peer");
-
-//TODO: move this function within the Waku class: https://github.com/waku-org/js-waku/issues/1761
-/**
- * Wait for a remote peer to be ready given the passed protocols.
- * Must be used after attempting to connect to nodes, using
- * {@link @waku/sdk!WakuNode.dial} or a bootstrap method with
- * {@link @waku/sdk!createLightNode}.
- *
- * If the passed protocols is a GossipSub protocol, then it resolves only once
- * a peer is in a mesh, to help ensure that other peers will send and receive
- * message to us.
- *
- * @param waku The Waku Node
- * @param protocols The protocols that need to be enabled by remote peers.
- * @param timeoutMs A timeout value in milliseconds..
- *
- * @returns A promise that **resolves** if all desired protocols are fulfilled by
- * remote nodes, **rejects** if the timeoutMs is reached.
- * @throws If passing a protocol that is not mounted
- * @default Wait for remote peers with protocols enabled locally and no time out is applied.
- */
-export async function waitForRemotePeer(
-  waku: Waku,
-  protocols?: Protocols[],
-  timeoutMs?: number
-): Promise<void> {
-  protocols = protocols ?? getEnabledProtocols(waku);
-
-  if (!waku.isStarted()) return Promise.reject("Waku node is not started");
-
-  const promises = [];
-
-  if (protocols.includes(Protocols.Relay)) {
-    if (!waku.relay)
-      throw new Error("Cannot wait for Relay peer: protocol not mounted");
-    promises.push(waitForGossipSubPeerInMesh(waku.relay));
-  }
-
-  if (protocols.includes(Protocols.Store)) {
-    if (!waku.store)
-      throw new Error("Cannot wait for Store peer: protocol not mounted");
-    promises.push(
-      waitForConnectedPeer(waku.store.protocol, waku.libp2p.services.metadata)
-    );
-  }
-
-  if (protocols.includes(Protocols.LightPush)) {
-    if (!waku.lightPush)
-      throw new Error("Cannot wait for LightPush peer: protocol not mounted");
-    promises.push(
-      waitForConnectedPeer(
-        waku.lightPush.protocol,
-        waku.libp2p.services.metadata
-      )
-    );
-  }
-
-  if (protocols.includes(Protocols.Filter)) {
-    if (!waku.filter)
-      throw new Error("Cannot wait for Filter peer: protocol not mounted");
-    promises.push(
-      waitForConnectedPeer(waku.filter.protocol, waku.libp2p.services.metadata)
-    );
-  }
-
-  if (timeoutMs) {
-    await rejectOnTimeout(
-      Promise.all(promises),
-      timeoutMs,
-      "Timed out waiting for a remote peer."
-    );
-  } else {
-    await Promise.all(promises);
-  }
-}
-
-//TODO: move this function within protocol SDK class: https://github.com/waku-org/js-waku/issues/1761
-/**
- * Wait for a peer with the given protocol to be connected.
- * If sharding is enabled on the node, it will also wait for the peer to be confirmed by the metadata service.
- */
-async function waitForConnectedPeer(
-  protocol: IBaseProtocolCore,
-  metadataService?: IMetadata
-): Promise<void> {
-  const codec = protocol.multicodec;
-  const peers = await protocol.connectedPeers();
-
-  if (peers.length) {
-    if (!metadataService) {
-      log.info(`${codec} peer found: `, peers[0].id.toString());
-      return;
-    }
-
-    // once a peer is connected, we need to confirm the metadata handshake with at least one of those peers if sharding is enabled
-    try {
-      await Promise.any(
-        peers.map((peer) => metadataService.confirmOrAttemptHandshake(peer.id))
-      );
-      return;
-    } catch (e) {
-      if ((e as any).code === "ERR_CONNECTION_BEING_CLOSED")
-        log.error(
-          `Connection with the peer was closed and possibly because it's on a different shard. Error: ${e}`
-        );
-
-      log.error(`Error waiting for handshake confirmation: ${e}`);
-    }
-  }
-
-  log.info(`Waiting for ${codec} peer`);
-
-  // else we'll just wait for the next peer to connect
-  await new Promise<void>((resolve) => {
-    const cb = (evt: CustomEvent<IdentifyResult>): void => {
-      if (evt.detail?.protocols?.includes(codec)) {
-        if (metadataService) {
-          metadataService
-            .confirmOrAttemptHandshake(evt.detail.peerId)
-            .then(() => {
-              protocol.removeLibp2pEventListener("peer:identify", cb);
-              resolve();
-            })
-            .catch((e) => {
-              if (e.code === "ERR_CONNECTION_BEING_CLOSED")
-                log.error(
-                  `Connection with the peer was closed and possibly because it's on a different shard. Error: ${e}`
-                );
-
-              log.error(`Error waiting for handshake confirmation: ${e}`);
-            });
-        } else {
-          protocol.removeLibp2pEventListener("peer:identify", cb);
-          resolve();
-        }
-      }
-    };
-    protocol.addLibp2pEventListener("peer:identify", cb);
-  });
-}
-
-/**
- * Wait for at least one peer with the given protocol to be connected and in the gossipsub
- * mesh for all pubsubTopics.
- */
-async function waitForGossipSubPeerInMesh(waku: IRelay): Promise<void> {
-  let peers = waku.getMeshPeers();
-  const pubsubTopics = waku.pubsubTopics;
-
-  for (const topic of pubsubTopics) {
-    while (peers.length == 0) {
-      await pEvent(waku.gossipSub, "gossipsub:heartbeat");
-      peers = waku.getMeshPeers(topic);
-    }
-  }
-}
-
-const awaitTimeout = (ms: number, rejectReason: string): Promise<void> =>
-  new Promise((_resolve, reject) => setTimeout(() => reject(rejectReason), ms));
-
-async function rejectOnTimeout<T>(
-  promise: Promise<T>,
-  timeoutMs: number,
-  rejectReason: string
-): Promise<void> {
-  await Promise.race([promise, awaitTimeout(timeoutMs, rejectReason)]);
-}
-
-function getEnabledProtocols(waku: Waku): Protocols[] {
-  const protocols = [];
-
-  if (waku.relay) {
-    protocols.push(Protocols.Relay);
-  }
-
-  if (waku.filter) {
-    protocols.push(Protocols.Filter);
-  }
-
-  if (waku.store) {
-    protocols.push(Protocols.Store);
-  }
-
-  if (waku.lightPush) {
-    protocols.push(Protocols.LightPush);
-  }
-
-  return protocols;
-}