remove allPeers and connectedPeers from BaseProtocolCore, update test…

…s, add getPeers for IWaku
waku-org · Oct 20, 2024 · 9bdc2af · 9bdc2af
1 parent e1813bc
commit 9bdc2af
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 87 deletions.
diff --git a/packages/core/src/lib/base_protocol.ts b/packages/core/src/lib/base_protocol.ts
@@ -5,7 +5,6 @@ import type {
   Libp2pComponents,
   PubsubTopic
 } from "@waku/interfaces";
-import { getPeersForProtocol } from "@waku/utils/libp2p";
 
 import { StreamManager } from "./stream_manager/index.js";
 
@@ -42,23 +41,4 @@ export class BaseProtocol implements IBaseProtocolCore {
   protected async getStream(peer: Peer): Promise<Stream> {
     return this.streamManager.getStream(peer);
   }
-
-  /**
-   * Returns known peers from the address book (`libp2p.peerStore`) that support
-   * the class protocol. Waku may or may not be currently connected to these
-   * peers.
-   */
-  public async allPeers(): Promise<Peer[]> {
-    return getPeersForProtocol(this.components.peerStore, [this.multicodec]);
-  }
-
-  public async connectedPeers(): Promise<Peer[]> {
-    const peers = await this.allPeers();
-    return peers.filter((peer) => {
-      const connections = this.components.connectionManager.getConnections(
-        peer.id
-      );
-      return connections.length > 0;
-    });
-  }
 }
diff --git a/packages/interfaces/src/protocols.ts b/packages/interfaces/src/protocols.ts
@@ -17,8 +17,6 @@ export enum Protocols {
 
 export type IBaseProtocolCore = {
   multicodec: string;
-  allPeers: () => Promise<Peer[]>;
-  connectedPeers: () => Promise<Peer[]>;
   addLibp2pEventListener: Libp2p["addEventListener"];
   removeLibp2pEventListener: Libp2p["removeEventListener"];
 };

diff --git a/packages/interfaces/src/waku.ts b/packages/interfaces/src/waku.ts
@@ -1,4 +1,4 @@
-import type { PeerId, Stream } from "@libp2p/interface";
+import type { Peer, PeerId, Stream } from "@libp2p/interface";
 import type { MultiaddrInput } from "@multiformats/multiaddr";
 
 import { IConnectionManager } from "./connection_manager.js";
@@ -121,6 +121,11 @@ export interface IWaku {
    * @returns {boolean} `true` if the node has working connection and `false` otherwise
    */
   isConnected(): boolean;
+
+  /**
+   * @returns {Peer[]} an array of all connected peers
+   */
+  getPeers(): Promise<Peer[]>;
 }
 
 export interface LightNode extends IWaku {

diff --git a/packages/sdk/src/waku/waku.ts b/packages/sdk/src/waku/waku.ts
@@ -1,5 +1,5 @@
 import type { Stream } from "@libp2p/interface";
-import { isPeerId, PeerId } from "@libp2p/interface";
+import { isPeerId, Peer, PeerId } from "@libp2p/interface";
 import { multiaddr, Multiaddr, MultiaddrInput } from "@multiformats/multiaddr";
 import { ConnectionManager, getHealthManager } from "@waku/core";
 import type {
@@ -186,6 +186,10 @@ export class WakuNode implements IWaku {
     await this.libp2p.stop();
   }
 
+  public async getPeers(): Promise<Peer[]> {
+    return this.connectionManager.getConnectedPeers();
+  }
+
   public async waitForPeers(
     protocols?: Protocols[],
     timeoutMs?: number

diff --git a/packages/tests/tests/metadata.spec.ts b/packages/tests/tests/metadata.spec.ts
@@ -253,7 +253,9 @@ describe("Metadata Protocol", function () {
 
     waku = await createLightNode({
       networkConfig: shardInfo,
-      pingKeepAlive: 1
+      connectionManager: {
+        pingKeepAlive: 1
+      }
     });
     await waku.start();
     await waku.libp2p.dialProtocol(nwaku1Ma, MetadataCodec);

diff --git a/packages/tests/tests/wait_for_remote_peer.node.spec.ts b/packages/tests/tests/wait_for_remote_peer.node.spec.ts
@@ -115,9 +115,7 @@ describe("Wait for remote peer", function () {
     await delay(1000);
     await waku2.waitForPeers([Protocols.Store]);
 
-    const peers = (await waku2.store.protocol.connectedPeers()).map((peer) =>
-      peer.id.toString()
-    );
+    const peers = (await waku2.getPeers()).map((peer) => peer.id.toString());
     const nimPeerId = multiAddrWithId.getPeerId();
 
     expect(nimPeerId).to.not.be.undefined;
@@ -145,9 +143,7 @@ describe("Wait for remote peer", function () {
     await waku2.dial(multiAddrWithId);
     await waitPromise;
 
-    const peers = (await waku2.store.protocol.connectedPeers()).map((peer) =>
-      peer.id.toString()
-    );
+    const peers = (await waku2.getPeers()).map((peer) => peer.id.toString());
 
     const nimPeerId = multiAddrWithId.getPeerId();
 
@@ -174,9 +170,7 @@ describe("Wait for remote peer", function () {
     await waku2.dial(multiAddrWithId);
     await waku2.waitForPeers([Protocols.LightPush]);
 
-    const peers = (await waku2.lightPush.protocol.connectedPeers()).map(
-      (peer) => peer.id.toString()
-    );
+    const peers = (await waku2.getPeers()).map((peer) => peer.id.toString());
 
     const nimPeerId = multiAddrWithId.getPeerId();
 
@@ -203,24 +197,23 @@ describe("Wait for remote peer", function () {
     await waku2.dial(multiAddrWithId);
     await waku2.waitForPeers([Protocols.Filter]);
 
-    const peers = (await waku2.filter.protocol.connectedPeers()).map((peer) =>
-      peer.id.toString()
-    );
+    const peers = (await waku2.getPeers()).map((peer) => peer.id.toString());
 
     const nimPeerId = multiAddrWithId.getPeerId();
 
     expect(nimPeerId).to.not.be.undefined;
     expect(peers.includes(nimPeerId as string)).to.be.true;
   });
 
+  // TODO: re-enable store once https://github.com/waku-org/js-waku/issues/2162 is fixed
   it("Light Node - default protocols", async function () {
     this.timeout(20_000);
     nwaku = new ServiceNode(makeLogFileName(this));
     await nwaku.start({
       filter: true,
       lightpush: true,
-      relay: false,
-      store: true
+      relay: false
+      // store: true
     });
     const multiAddrWithId = await nwaku.getMultiaddrWithId();
 
@@ -232,26 +225,16 @@ describe("Wait for remote peer", function () {
     await waku2.dial(multiAddrWithId);
     await waku2.waitForPeers([
       Protocols.Filter,
-      Protocols.Store,
+      // Protocols.Store,
       Protocols.LightPush
     ]);
 
-    const filterPeers = (await waku2.filter.protocol.connectedPeers()).map(
-      (peer) => peer.id.toString()
-    );
-    const storePeers = (await waku2.store.protocol.connectedPeers()).map(
-      (peer) => peer.id.toString()
-    );
-    const lightPushPeers = (
-      await waku2.lightPush.protocol.connectedPeers()
-    ).map((peer) => peer.id.toString());
+    const peers = (await waku2.getPeers()).map((peer) => peer.id.toString());
 
     const nimPeerId = multiAddrWithId.getPeerId();
 
     expect(nimPeerId).to.not.be.undefined;
-    expect(filterPeers.includes(nimPeerId as string)).to.be.true;
-    expect(storePeers.includes(nimPeerId as string)).to.be.true;
-    expect(lightPushPeers.includes(nimPeerId as string)).to.be.true;
+    expect(peers.includes(nimPeerId as string)).to.be.true;
   });
 
   it("Privacy Node - default protocol", async function () {

diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -9,10 +9,6 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
-    "./libp2p": {
-      "types": "./dist/libp2p/index.d.ts",
-      "import": "./dist/libp2p/index.js"
-    },
     "./bytes": {
       "types": "./dist/bytes/index.d.ts",
       "import": "./dist/bytes/index.js"

diff --git a/packages/utils/src/libp2p/index.ts b/packages/utils/src/libp2p/index.ts