@waku/core 0.0.26 → 0.0.28-434be7b.0

package/package.json

@@ -1,127 +1 @@
-{
-  "name": "@waku/core",
-  "version": "0.0.26",
-  "description": "TypeScript implementation of the Waku v2 protocol",
-  "types": "./dist/index.d.ts",
-  "module": "./dist/index.js",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    },
-    "./lib/predefined_bootstrap_nodes": {
-      "types": "./dist/lib/predefined_bootstrap_nodes.d.ts",
-      "import": "./dist/lib/predefined_bootstrap_nodes.js"
-    },
-    "./lib/message/version_0": {
-      "types": "./dist/lib/message/version_0.d.ts",
-      "import": "./dist/lib/message/version_0.js"
-    },
-    "./lib/base_protocol": {
-      "types": "./dist/lib/base_protocol.d.ts",
-      "import": "./dist/lib/base_protocol.js"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      "lib/*": [
-        "dist/lib/*"
-      ],
-      "constants/*": [
-        "dist/constants/*"
-      ]
-    }
-  },
-  "type": "module",
-  "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/core#readme",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/waku-org/js-waku.git"
-  },
-  "bugs": {
-    "url": "https://github.com/waku-org/js-waku/issues"
-  },
-  "license": "MIT OR Apache-2.0",
-  "keywords": [
-    "waku",
-    "decentralised",
-    "communication",
-    "web3",
-    "ethereum",
-    "dapps"
-  ],
-  "scripts": {
-    "build": "run-s build:**",
-    "build:esm": "tsc",
-    "build:bundle": "rollup --config rollup.config.js",
-    "fix": "run-s fix:*",
-    "fix:lint": "eslint src *.js --fix",
-    "check": "run-s check:*",
-    "check:tsc": "tsc -p tsconfig.dev.json",
-    "check:lint": "eslint src *.js",
-    "check:spelling": "cspell \"{README.md,src/**/*.ts}\"",
-    "test": "NODE_ENV=test run-s test:*",
-    "test:node": "NODE_ENV=test TS_NODE_PROJECT=./tsconfig.dev.json mocha",
-    "test:browser": "NODE_ENV=test karma start karma.conf.cjs",
-    "watch:build": "tsc -p tsconfig.json -w",
-    "watch:test": "mocha --watch",
-    "prepublish": "npm run build",
-    "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build"
-  },
-  "engines": {
-    "node": ">=18"
-  },
-  "dependencies": {
-    "@noble/hashes": "^1.3.2",
-    "@waku/enr": "^0.0.20",
-    "@waku/interfaces": "0.0.21",
-    "@waku/proto": "0.0.6",
-    "@waku/utils": "0.0.14",
-    "debug": "^4.3.4",
-    "it-all": "^3.0.4",
-    "it-length-prefixed": "^9.0.1",
-    "it-pipe": "^3.0.1",
-    "p-event": "^6.0.0",
-    "uint8arraylist": "^2.4.3",
-    "uuid": "^9.0.0"
-  },
-  "devDependencies": {
-    "@multiformats/multiaddr": "^12.0.0",
-    "@rollup/plugin-commonjs": "^25.0.7",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@types/chai": "^4.3.11",
-    "@types/debug": "^4.1.12",
-    "@types/mocha": "^10.0.1",
-    "@types/uuid": "^9.0.7",
-    "@waku/build-utils": "*",
-    "chai": "^4.3.10",
-    "cspell": "^7.3.2",
-    "fast-check": "^3.14.0",
-    "ignore-loader": "^0.1.2",
-    "isomorphic-fetch": "^3.0.0",
-    "mocha": "^10.2.0",
-    "npm-run-all": "^4.1.5",
-    "process": "^0.11.10",
-    "rollup": "^4.6.0"
-  },
-  "peerDependencies": {
-    "@multiformats/multiaddr": "^12.0.0",
-    "libp2p": "^0.46.3"
-  },
-  "peerDependenciesMeta": {
-    "@multiformats/multiaddr": {
-      "optional": true
-    }
-  },
-  "files": [
-    "dist",
-    "bundle",
-    "src/**/*.ts",
-    "!**/*.spec.*",
-    "!**/*.json",
-    "CHANGELOG.md",
-    "LICENSE",
-    "README.md"
-  ]
-}
+{"name":"@waku/core","version":"0.0.28-434be7b.0","description":"TypeScript implementation of the Waku v2 protocol","types":"./dist/index.d.ts","module":"./dist/index.js","react-native":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","react-native":"./dist/index.js"},"./lib/predefined_bootstrap_nodes":{"types":"./dist/lib/predefined_bootstrap_nodes.d.ts","import":"./dist/lib/predefined_bootstrap_nodes.js","react-native":"./dist/lib/predefined_bootstrap_nodes.js"},"./lib/message/version_0":{"types":"./dist/lib/message/version_0.d.ts","import":"./dist/lib/message/version_0.js","react-native":"./dist/lib/message/version_0.js"},"./lib/base_protocol":{"types":"./dist/lib/base_protocol.d.ts","import":"./dist/lib/base_protocol.js","react-native":"./dist/lib/base_protocol.js"}},"typesVersions":{"*":{"lib/*":["dist/lib/*"],"constants/*":["dist/constants/*"]}},"type":"module","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/core#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","decentralised","communication","web3","ethereum","dapps"],"scripts":{"build":"run-s build:**","build:esm":"tsc","build:bundle":"rollup --config rollup.config.js","fix":"run-s fix:*","fix:lint":"eslint src *.js --fix","check":"run-s check:*","check:tsc":"tsc -p tsconfig.dev.json","check:lint":"eslint src *.js","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","test":"NODE_ENV=test run-s test:*","test:node":"NODE_ENV=test TS_NODE_PROJECT=./tsconfig.dev.json mocha","test:browser":"NODE_ENV=test karma start karma.conf.cjs","watch:build":"tsc -p tsconfig.json -w","watch:test":"mocha --watch","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=18"},"dependencies":{"@libp2p/ping":"^1.0.12","@noble/hashes":"^1.3.2","@waku/enr":"0.0.22-434be7b.0","@waku/interfaces":"0.0.23-434be7b.0","@waku/message-hash":"0.1.12-434be7b.0","@waku/proto":"0.0.7-434be7b.0","@waku/utils":"0.0.16-434be7b.0","debug":"^4.3.4","it-all":"^3.0.4","it-length-prefixed":"^9.0.4","it-pipe":"^3.0.1","p-event":"^6.0.0","uint8arraylist":"^2.4.3","uuid":"^9.0.0"},"devDependencies":{"@multiformats/multiaddr":"^12.0.0","@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^4.3.11","@types/debug":"^4.1.12","@types/mocha":"^10.0.6","@types/uuid":"^9.0.8","@waku/build-utils":"*","chai":"^4.3.10","cspell":"^8.3.2","fast-check":"^3.15.1","ignore-loader":"^0.1.2","isomorphic-fetch":"^3.0.0","mocha":"^10.3.0","npm-run-all":"^4.1.5","process":"^0.11.10","rollup":"^4.12.0"},"peerDependencies":{"@multiformats/multiaddr":"^12.0.0","libp2p":"^1.1.2","@waku/enr":"0.0.22-434be7b.0","@waku/interfaces":"0.0.23-434be7b.0","@waku/message-hash":"0.1.12-434be7b.0","@waku/proto":"0.0.7-434be7b.0","@waku/utils":"0.0.16-434be7b.0"},"peerDependenciesMeta":{"@multiformats/multiaddr":{"optional":true},"@waku/interfaces":{"optional":true}},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"]}

package/src/index.ts

@@ -1,4 +1,3 @@
-export { DefaultUserAgent } from "./lib/waku.js";
 export { createEncoder, createDecoder } from "./lib/message/version_0.js";
 export type {
   Encoder,
@@ -7,15 +6,11 @@ export type {
 } from "./lib/message/version_0.js";
 export * as message from "./lib/message/index.js";
 
-export * as waku from "./lib/waku.js";
-export { WakuNode, WakuOptions } from "./lib/waku.js";
-
 export * as waku_filter from "./lib/filter/index.js";
 export { wakuFilter, FilterCodecs } from "./lib/filter/index.js";
 
 export * as waku_light_push from "./lib/light_push/index.js";
-export { LightPushCodec } from "./lib/light_push/index.js";
-export { wakuLightPush } from "./lib/light_push/index.js";
+export { LightPushCodec, LightPushCore } from "./lib/light_push/index.js";
 
 export * as waku_store from "./lib/store/index.js";
 

package/src/lib/base_protocol.ts

@@ -1,36 +1,36 @@
 import type { Libp2p } from "@libp2p/interface";
-import type { Stream } from "@libp2p/interface/connection";
-import type { PeerId } from "@libp2p/interface/peer-id";
-import { Peer, PeerStore } from "@libp2p/interface/peer-store";
+import type { Peer, PeerStore, Stream } from "@libp2p/interface";
 import type {
-  IBaseProtocol,
+  IBaseProtocolCore,
   Libp2pComponents,
   ProtocolCreateOptions,
   PubsubTopic
 } from "@waku/interfaces";
-import { DefaultPubsubTopic } from "@waku/interfaces";
-import { shardInfoToPubsubTopics } from "@waku/utils";
+import { ensureShardingConfigured, Logger } from "@waku/utils";
 import {
-  getConnectedPeersForProtocol,
+  getConnectedPeersForProtocolAndShard,
   getPeersForProtocol,
-  selectPeerForProtocol
+  sortPeersByLatency
 } from "@waku/utils/libp2p";
 
-import { filterPeers } from "./filterPeers.js";
+import { filterPeersByDiscovery } from "./filterPeers.js";
 import { StreamManager } from "./stream_manager.js";
 
 /**
  * A class with predefined helpers, to be used as a base to implement Waku
  * Protocols.
  */
-export class BaseProtocol implements IBaseProtocol {
+export class BaseProtocol implements IBaseProtocolCore {
   public readonly addLibp2pEventListener: Libp2p["addEventListener"];
   public readonly removeLibp2pEventListener: Libp2p["removeEventListener"];
   protected streamManager: StreamManager;
 
   constructor(
     public multicodec: string,
-    private components: Libp2pComponents
+    private components: Libp2pComponents,
+    private log: Logger,
+    public readonly pubsubTopics: PubsubTopic[],
+    private options?: ProtocolCreateOptions
   ) {
     this.addLibp2pEventListener = components.events.addEventListener.bind(
       components.events
@@ -60,27 +60,28 @@ export class BaseProtocol implements IBaseProtocol {
    * the class protocol. Waku may or may not be currently connected to these
    * peers.
    */
-  public async peers(): Promise<Peer[]> {
+  public async allPeers(): Promise<Peer[]> {
     return getPeersForProtocol(this.peerStore, [this.multicodec]);
   }
 
-  protected async getPeer(peerId?: PeerId): Promise<Peer> {
-    const { peer } = await selectPeerForProtocol(
-      this.peerStore,
-      [this.multicodec],
-      peerId
-    );
-    return peer;
+  public async connectedPeers(): Promise<Peer[]> {
+    const peers = await this.allPeers();
+    return peers.filter((peer) => {
+      return (
+        this.components.connectionManager.getConnections(peer.id).length > 0
+      );
+    });
   }
 
   /**
-   * Retrieves a list of connected peers based on the specified criteria.
+   * Retrieves a list of connected peers that support the protocol. The list is sorted by latency.
    *
    * @param numPeers - The total number of peers to retrieve. If 0, all peers are returned.
    * @param maxBootstrapPeers - The maximum number of bootstrap peers to retrieve.
-   * @returns A Promise that resolves to an array of peers based on the specified criteria.
-   */
-  protected async getPeers(
+
+  * @returns A list of peers that support the protocol sorted by latency.
+  */
+  async getPeers(
     {
       numPeers,
       maxBootstrapPeers
@@ -92,23 +93,42 @@ export class BaseProtocol implements IBaseProtocol {
       numPeers: 0
     }
   ): Promise<Peer[]> {
-    // Retrieve all connected peers that support the protocol
-    const allPeersForProtocol = await getConnectedPeersForProtocol(
-      this.components.connectionManager.getConnections(),
+    // Retrieve all connected peers that support the protocol & shard (if configured)
+    const connectedPeersForProtocolAndShard =
+      await getConnectedPeersForProtocolAndShard(
+        this.components.connectionManager.getConnections(),
+        this.peerStore,
+        [this.multicodec],
+        this.options?.shardInfo
+          ? ensureShardingConfigured(this.options.shardInfo).shardInfo
+          : undefined
+      );
+
+    // Filter the peers based on discovery & number of peers requested
+    const filteredPeers = filterPeersByDiscovery(
+      connectedPeersForProtocolAndShard,
+      numPeers,
+      maxBootstrapPeers
+    );
+
+    // Sort the peers by latency
+    const sortedFilteredPeers = await sortPeersByLatency(
       this.peerStore,
-      [this.multicodec]
+      filteredPeers
     );
 
-    // Filter the peers based on the specified criteria
-    return filterPeers(allPeersForProtocol, numPeers, maxBootstrapPeers);
-  }
+    if (sortedFilteredPeers.length === 0) {
+      this.log.warn(
+        "No peers found. Ensure you have a connection to the network."
+      );
+    }
 
-  initializePubsubTopic(options?: ProtocolCreateOptions): PubsubTopic[] {
-    return (
-      options?.pubsubTopics ??
-      (options?.shardInfo
-        ? shardInfoToPubsubTopics(options.shardInfo)
-        : [DefaultPubsubTopic])
-    );
+    if (sortedFilteredPeers.length < numPeers) {
+      this.log.warn(
+        `Only ${sortedFilteredPeers.length} peers found. Requested ${numPeers}.`
+      );
+    }
+
+    return sortedFilteredPeers;
   }
 }

package/src/lib/connection_manager.ts

@@ -1,9 +1,5 @@
-import type { PeerId } from "@libp2p/interface/peer-id";
-import type { PeerInfo } from "@libp2p/interface/peer-info";
-import type { Peer } from "@libp2p/interface/peer-store";
-import type { PeerStore } from "@libp2p/interface/peer-store";
-import { CustomEvent, EventEmitter } from "@libp2p/interfaces/events";
-import { decodeRelayShard } from "@waku/enr";
+import type { Peer, PeerId, PeerInfo, PeerStore } from "@libp2p/interface";
+import { CustomEvent, TypedEventEmitter } from "@libp2p/interface";
 import {
   ConnectionManagerOptions,
   EConnectionStateEvents,
@@ -18,7 +14,7 @@ import {
   ShardInfo
 } from "@waku/interfaces";
 import { Libp2p, Tags } from "@waku/interfaces";
-import { shardInfoToPubsubTopics } from "@waku/utils";
+import { decodeRelayShard, shardInfoToPubsubTopics } from "@waku/utils";
 import { Logger } from "@waku/utils";
 
 import { KeepAliveManager } from "./keep_alive_manager.js";
@@ -30,7 +26,7 @@ export const DEFAULT_MAX_DIAL_ATTEMPTS_FOR_PEER = 3;
 export const DEFAULT_MAX_PARALLEL_DIALS = 3;
 
 export class ConnectionManager
-  extends EventEmitter<IPeersByDiscoveryEvents & IConnectionStateEvents>
+  extends TypedEventEmitter<IPeersByDiscoveryEvents & IConnectionStateEvents>
   implements IConnectionManager
 {
   private static instances = new Map<string, ConnectionManager>();
@@ -101,8 +97,11 @@ export class ConnectionManager
 
     const peersDiscoveredByBootstrap: Peer[] = [];
     const peersDiscoveredByPeerExchange: Peer[] = [];
+    const peersDiscoveredByLocal: Peer[] = [];
+
     const peersConnectedByBootstrap: Peer[] = [];
     const peersConnectedByPeerExchange: Peer[] = [];
+    const peersConnectedByLocal: Peer[] = [];
 
     for (const peer of peersDiscovered) {
       const tags = await this.getTagNamesForPeer(peer.id);
@@ -111,6 +110,8 @@ export class ConnectionManager
         peersDiscoveredByBootstrap.push(peer);
       } else if (tags.includes(Tags.PEER_EXCHANGE)) {
         peersDiscoveredByPeerExchange.push(peer);
+      } else if (tags.includes(Tags.LOCAL)) {
+        peersDiscoveredByLocal.push(peer);
       }
     }
 
@@ -122,17 +123,21 @@ export class ConnectionManager
         peersConnectedByBootstrap.push(peer);
       } else if (tags.includes(Tags.PEER_EXCHANGE)) {
         peersConnectedByPeerExchange.push(peer);
+      } else if (tags.includes(Tags.LOCAL)) {
+        peersConnectedByLocal.push(peer);
       }
     }
 
     return {
       DISCOVERED: {
         [Tags.BOOTSTRAP]: peersDiscoveredByBootstrap,
-        [Tags.PEER_EXCHANGE]: peersDiscoveredByPeerExchange
+        [Tags.PEER_EXCHANGE]: peersDiscoveredByPeerExchange,
+        [Tags.LOCAL]: peersDiscoveredByLocal
       },
       CONNECTED: {
         [Tags.BOOTSTRAP]: peersConnectedByBootstrap,
-        [Tags.PEER_EXCHANGE]: peersConnectedByPeerExchange
+        [Tags.PEER_EXCHANGE]: peersConnectedByPeerExchange,
+        [Tags.LOCAL]: peersConnectedByLocal
       }
     };
   }
@@ -380,6 +385,8 @@ export class ConnectionManager
     },
     "peer:connect": (evt: CustomEvent<PeerId>): void => {
       void (async () => {
+        log.info(`Connected to peer ${evt.detail.toString()}`);
+
         const peerId = evt.detail;
 
         this.keepAliveManager.start(