@waku/core 0.0.5 → 0.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/core",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "TypeScript implementation of the Waku v2 protocol",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -9,25 +9,17 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
-    "./lib/peer_discovery_static_list": {
-      "types": "./dist/lib/peer_discovery_static_list.d.ts",
-      "import": "./dist/lib/peer_discovery_static_list.js"
-    },
     "./lib/predefined_bootstrap_nodes": {
       "types": "./dist/lib/predefined_bootstrap_nodes.d.ts",
       "import": "./dist/lib/predefined_bootstrap_nodes.js"
     },
-    "./lib/wait_for_remote_peer": {
-      "types": "./dist/lib/wait_for_remote_peer.d.ts",
-      "import": "./dist/lib/wait_for_remote_peer.js"
-    },
-    "./lib/waku_message/version_0": {
-      "types": "./dist/lib/waku_message/version_0.d.ts",
-      "import": "./dist/lib/waku_message/version_0.js"
+    "./lib/message/version_0": {
+      "types": "./dist/lib/message/version_0.d.ts",
+      "import": "./dist/lib/message/version_0.js"
     },
-    "./lib/waku_message/topic_only_message": {
-      "types": "./dist/lib/waku_message/topic_only_message.d.ts",
-      "import": "./dist/lib/waku_message/topic_only_message.js"
+    "./lib/message/topic_only_message": {
+      "types": "./dist/lib/message/topic_only_message.d.ts",
+      "import": "./dist/lib/message/topic_only_message.js"
     }
   },
   "typesVersions": {
@@ -57,7 +49,7 @@
   ],
   "scripts": {
     "build": "run-s build:**",
-    "build:esm": "tsc && node build-scripts/fix-imports.js",
+    "build:esm": "tsc",
     "build:bundle": "rollup --config rollup.config.js",
     "fix": "run-s fix:*",
     "fix:prettier": "prettier . --write",
@@ -75,39 +67,38 @@
     "test": "run-s test:*",
     "test:node": "TS_NODE_PROJECT=./tsconfig.dev.json mocha",
     "test:browser": "karma start karma.conf.cjs",
-    "proto": "rimraf src/proto/*.ts; protons src/proto/*.proto",
     "watch:build": "tsc -p tsconfig.json -w",
     "watch:test": "mocha --watch",
     "prepublish": "npm run build",
-    "deploy": "node ci/deploy.js",
     "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build"
   },
   "engines": {
     "node": ">=16"
   },
   "dependencies": {
-    "@waku/byte-utils": "*",
-    "@chainsafe/libp2p-gossipsub": "^4.1.1",
+    "@chainsafe/libp2p-gossipsub": "^5.2.1",
     "@libp2p/interface-connection": "^3.0.3",
     "@libp2p/interface-peer-discovery": "^1.0.0",
-    "@libp2p/interface-peer-id": "^1.0.2",
-    "@libp2p/interface-peer-info": "^1.0.1",
-    "@libp2p/interface-peer-store": "^1.0.0",
-    "@libp2p/interface-pubsub": "^2.0.1",
-    "@libp2p/interfaces": "^3.0.2",
+    "@libp2p/interface-peer-id": "^1.0.6",
+    "@libp2p/interface-peer-info": "^1.0.4",
+    "@libp2p/interface-peer-store": "^1.2.3",
+    "@libp2p/interface-pubsub": "^3.0.1",
+    "@libp2p/interface-registrar": "^2.0.4",
+    "@libp2p/interfaces": "^3.0.4",
     "@libp2p/peer-id": "^1.1.10",
     "@multiformats/multiaddr": "^11.0.6",
+    "@noble/hashes": "^1.1.3",
+    "@waku/byte-utils": "*",
     "@waku/interfaces": "*",
     "debug": "^4.3.4",
     "it-all": "^1.0.6",
     "it-length-prefixed": "^8.0.2",
     "it-pipe": "^2.0.4",
-    "libp2p": "0.39.5",
+    "libp2p": "0.40.0",
     "p-event": "^5.0.1",
-    "protons-runtime": "^3.1.0",
     "uint8arraylist": "^2.3.2",
     "uint8arrays": "^4.0.2",
-    "uuid": "^8.3.2"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^22.0.0",
@@ -124,7 +115,7 @@
     "@typescript-eslint/parser": "^5.8.1",
     "app-root-path": "^3.0.0",
     "chai": "^4.3.4",
-    "cspell": "^5.14.0",
+    "cspell": "^6.17.0",
     "eslint": "^8.6.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
@@ -147,7 +138,6 @@
     "portfinder": "^1.0.28",
     "prettier": "^2.1.1",
     "process": "^0.11.10",
-    "protons": "^5.1.0",
     "puppeteer": "^13.0.1",
     "rollup": "^2.75.0",
     "tail": "^2.2.0",
@@ -155,6 +145,14 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.6.3"
   },
+  "peerDependencies": {
+    "@multiformats/multiaddr": "^11.0.6"
+  },
+  "peerDependenciesMeta": {
+    "@multiformats/multiaddr": {
+      "optional": true
+    }
+  },
   "typedoc": {
     "entryPoint": "./src/index.ts"
   },
@@ -163,7 +161,6 @@
     "bundle",
     "src/*.ts",
     "src/lib/**/*.ts",
-    "src/proto/**/*.ts",
     "!**/*.spec.*",
     "!**/*.json",
     "CHANGELOG.md",

package/src/index.ts

@@ -1,23 +1,34 @@
-export { DefaultPubSubTopic } from "./lib/constants";
+export { DefaultPubSubTopic } from "./lib/constants.js";
+export { DefaultUserAgent } from "./lib/waku.js";
 
-export * as proto_message from "./proto/message";
-export * as proto_topic_only_message from "./proto/topic_only_message";
+export {
+  createEncoder,
+  createDecoder,
+  DecodedMessage,
+} from "./lib/message/version_0.js";
 
-export * as waku from "./lib/waku";
-export { WakuNode } from "./lib/waku";
+export * as waku from "./lib/waku.js";
+export { WakuNode } from "./lib/waku.js";
 
-export * as waku_filter from "./lib/waku_filter";
-export { WakuFilter } from "./lib/waku_filter";
+export * as waku_filter from "./lib/filter/index.js";
+export { wakuFilter } from "./lib/filter/index.js";
 
-export * as waku_light_push from "./lib/waku_light_push";
+export * as waku_light_push from "./lib/light_push/index.js";
 export {
-  WakuLightPush,
+  wakuLightPush,
   LightPushCodec,
   PushResponse,
-} from "./lib/waku_light_push";
+} from "./lib/light_push/index.js";
+
+export * as waku_relay from "./lib/relay/index.js";
+export { wakuRelay } from "./lib/relay/index.js";
 
-export * as waku_relay from "./lib/waku_relay";
-export { WakuRelay } from "./lib/waku_relay";
+export * as waku_store from "./lib/store/index.js";
+export {
+  PageDirection,
+  wakuStore,
+  StoreCodec,
+  createCursor,
+} from "./lib/store/index.js";
 
-export * as waku_store from "./lib/waku_store";
-export { PageDirection, WakuStore, StoreCodec } from "./lib/waku_store";
+export { waitForRemotePeer } from "./lib/wait_for_remote_peer.js";

package/src/lib/{waku_filter → filter}/filter_rpc.ts

@@ -1,7 +1,6 @@
+import { proto_filter as proto } from "@waku/proto";
 import { v4 as uuid } from "uuid";
 
-import * as proto from "../../proto/filter";
-
 export type ContentFilter = {
   contentTopic: string;
 };

package/src/lib/{waku_filter → filter}/index.ts

@@ -1,39 +1,48 @@
 import type { Stream } from "@libp2p/interface-connection";
+import type { ConnectionManager } from "@libp2p/interface-connection-manager";
 import type { PeerId } from "@libp2p/interface-peer-id";
+import type { PeerStore } from "@libp2p/interface-peer-store";
 import type { Peer } from "@libp2p/interface-peer-store";
 import type { IncomingStreamData } from "@libp2p/interface-registrar";
+import type { Registrar } from "@libp2p/interface-registrar";
 import type {
   Callback,
-  DecodedMessage,
-  Decoder,
-  Filter,
-  Message,
+  IDecodedMessage,
+  IDecoder,
+  IFilter,
+  IMessage,
   ProtocolOptions,
 } from "@waku/interfaces";
+import {
+  getPeersForProtocol,
+  selectConnection,
+  selectPeerForProtocol,
+  selectRandomPeer,
+} from "@waku/libp2p-utils";
+import { WakuMessage as WakuMessageProto } from "@waku/proto";
 import debug from "debug";
 import all from "it-all";
 import * as lp from "it-length-prefixed";
 import { pipe } from "it-pipe";
-import type { Libp2p } from "libp2p";
 
-import { WakuMessage as WakuMessageProto } from "../../proto/message";
-import { DefaultPubSubTopic } from "../constants";
-import { groupByContentTopic } from "../group_by";
-import { selectConnection } from "../select_connection";
-import {
-  getPeersForProtocol,
-  selectPeerForProtocol,
-  selectRandomPeer,
-} from "../select_peer";
-import { toProtoMessage } from "../to_proto_message";
+import { DefaultPubSubTopic } from "../constants.js";
+import { groupByContentTopic } from "../group_by.js";
+import { toProtoMessage } from "../to_proto_message.js";
+
+import { ContentFilter, FilterRPC } from "./filter_rpc.js";
 
-import { ContentFilter, FilterRPC } from "./filter_rpc";
 export { ContentFilter };
 
 export const FilterCodec = "/vac/waku/filter/2.0.0-beta1";
 
 const log = debug("waku:filter");
 
+export interface FilterComponents {
+  peerStore: PeerStore;
+  registrar: Registrar;
+  connectionManager: ConnectionManager;
+}
+
 export interface CreateOptions {
   /**
    * The PubSub Topic to use. Defaults to {@link DefaultPubSubTopic}.
@@ -55,19 +64,19 @@ export type UnsubscribeFunction = () => Promise<void>;
  * - https://github.com/status-im/go-waku/issues/245
  * - https://github.com/status-im/nwaku/issues/948
  */
-export class WakuFilter implements Filter {
+class Filter implements IFilter {
   pubSubTopic: string;
   private subscriptions: Map<string, Callback<any>>;
   private decoders: Map<
     string, // content topic
-    Set<Decoder<any>>
+    Set<IDecoder<any>>
   >;
 
-  constructor(public libp2p: Libp2p, options?: CreateOptions) {
+  constructor(public components: FilterComponents, options?: CreateOptions) {
     this.subscriptions = new Map();
     this.decoders = new Map();
     this.pubSubTopic = options?.pubSubTopic ?? DefaultPubSubTopic;
-    this.libp2p
+    this.components.registrar
       .handle(FilterCodec, this.onRequest.bind(this))
       .catch((e) => log("Failed to register filter protocol", e));
   }
@@ -78,8 +87,8 @@ export class WakuFilter implements Filter {
    * @param opts The FilterSubscriptionOpts used to narrow which messages are returned, and which peer to connect to.
    * @returns Unsubscribe function that can be used to end the subscription.
    */
-  async subscribe<T extends DecodedMessage>(
-    decoders: Decoder<T>[],
+  async subscribe<T extends IDecodedMessage>(
+    decoders: IDecoder<T>[],
     callback: Callback<T>,
     opts?: ProtocolOptions
   ): Promise<UnsubscribeFunction> {
@@ -139,6 +148,10 @@ export class WakuFilter implements Filter {
     };
   }
 
+  get peerStore(): PeerStore {
+    return this.components.peerStore;
+  }
+
   private onRequest(streamData: IncomingStreamData): void {
     log("Receiving message push");
     try {
@@ -185,7 +198,7 @@ export class WakuFilter implements Filter {
         return;
       }
 
-      let msg: Message | undefined;
+      let msg: IMessage | undefined;
       // We don't want to wait for decoding failure, just attempt to decode
       // all messages and do the call back on the one that works
       // noinspection ES6MissingAwait
@@ -212,8 +225,8 @@ export class WakuFilter implements Filter {
     this.subscriptions.delete(requestId);
   }
 
-  private addDecoders<T extends DecodedMessage>(
-    decoders: Map<string, Array<Decoder<T>>>
+  private addDecoders<T extends IDecodedMessage>(
+    decoders: Map<string, Array<IDecoder<T>>>
   ): void {
     decoders.forEach((decoders, contentTopic) => {
       const currDecs = this.decoders.get(contentTopic);
@@ -225,8 +238,8 @@ export class WakuFilter implements Filter {
     });
   }
 
-  private deleteDecoders<T extends DecodedMessage>(
-    decoders: Map<string, Array<Decoder<T>>>
+  private deleteDecoders<T extends IDecodedMessage>(
+    decoders: Map<string, Array<IDecoder<T>>>
   ): void {
     decoders.forEach((decoders, contentTopic) => {
       const currDecs = this.decoders.get(contentTopic);
@@ -261,7 +274,9 @@ export class WakuFilter implements Filter {
   }
 
   private async newStream(peer: Peer): Promise<Stream> {
-    const connections = this.libp2p.connectionManager.getConnections(peer.id);
+    const connections = this.components.connectionManager.getConnections(
+      peer.id
+    );
     const connection = selectConnection(connections);
     if (!connection) {
       throw new Error("Failed to get a connection to the peer");
@@ -272,7 +287,7 @@ export class WakuFilter implements Filter {
 
   private async getPeer(peerId?: PeerId): Promise<Peer> {
     const res = await selectPeerForProtocol(
-      this.libp2p.peerStore,
+      this.components.peerStore,
       [FilterCodec],
       peerId
     );
@@ -283,10 +298,16 @@ export class WakuFilter implements Filter {
   }
 
   async peers(): Promise<Peer[]> {
-    return getPeersForProtocol(this.libp2p.peerStore, [FilterCodec]);
+    return getPeersForProtocol(this.components.peerStore, [FilterCodec]);
   }
 
   async randomPeer(): Promise<Peer | undefined> {
     return selectRandomPeer(await this.peers());
   }
 }
+
+export function wakuFilter(
+  init: Partial<CreateOptions> = {}
+): (components: FilterComponents) => IFilter {
+  return (components: FilterComponents) => new Filter(components, init);
+}

package/src/lib/{waku_light_push → light_push}/index.ts

@@ -1,34 +1,41 @@
+import { ConnectionManager } from "@libp2p/interface-connection-manager";
 import type { PeerId } from "@libp2p/interface-peer-id";
 import type { Peer } from "@libp2p/interface-peer-store";
+import type { PeerStore } from "@libp2p/interface-peer-store";
 import type {
-  Encoder,
-  Message,
+  IEncoder,
+  ILightPush,
+  IMessage,
   ProtocolOptions,
   SendResult,
 } from "@waku/interfaces";
+import {
+  getPeersForProtocol,
+  selectConnection,
+  selectPeerForProtocol,
+  selectRandomPeer,
+} from "@waku/libp2p-utils";
+import { PushResponse } from "@waku/proto";
 import debug from "debug";
 import all from "it-all";
 import * as lp from "it-length-prefixed";
 import { pipe } from "it-pipe";
-import { Libp2p } from "libp2p";
 import { Uint8ArrayList } from "uint8arraylist";
 
-import { PushResponse } from "../../proto/light_push";
-import { DefaultPubSubTopic } from "../constants";
-import { selectConnection } from "../select_connection";
-import {
-  getPeersForProtocol,
-  selectPeerForProtocol,
-  selectRandomPeer,
-} from "../select_peer";
+import { DefaultPubSubTopic } from "../constants.js";
 
-import { PushRPC } from "./push_rpc";
+import { PushRPC } from "./push_rpc.js";
 
 const log = debug("waku:light-push");
 
 export const LightPushCodec = "/vac/waku/lightpush/2.0.0-beta1";
 export { PushResponse };
 
+export interface LightPushComponents {
+  peerStore: PeerStore;
+  connectionManager: ConnectionManager;
+}
+
 export interface CreateOptions {
   /**
    * The PubSub Topic to use. Defaults to {@link DefaultPubSubTopic}.
@@ -44,22 +51,22 @@ export interface CreateOptions {
 /**
  * Implements the [Waku v2 Light Push protocol](https://rfc.vac.dev/spec/19/).
  */
-export class WakuLightPush {
+class LightPush implements ILightPush {
   pubSubTopic: string;
 
-  constructor(public libp2p: Libp2p, options?: CreateOptions) {
+  constructor(public components: LightPushComponents, options?: CreateOptions) {
     this.pubSubTopic = options?.pubSubTopic ?? DefaultPubSubTopic;
   }
 
   async push(
-    encoder: Encoder,
-    message: Partial<Message>,
+    encoder: IEncoder,
+    message: IMessage,
     opts?: ProtocolOptions
   ): Promise<SendResult> {
     const pubSubTopic = opts?.pubSubTopic ? opts.pubSubTopic : this.pubSubTopic;
 
     const res = await selectPeerForProtocol(
-      this.libp2p.peerStore,
+      this.components.peerStore,
       [LightPushCodec],
       opts?.peerId
     );
@@ -69,7 +76,9 @@ export class WakuLightPush {
     }
     const { peer } = res;
 
-    const connections = this.libp2p.connectionManager.getConnections(peer.id);
+    const connections = this.components.connectionManager.getConnections(
+      peer.id
+    );
     const connection = selectConnection(connections);
 
     if (!connection) throw "Failed to get a connection to the peer";
@@ -123,7 +132,7 @@ export class WakuLightPush {
    * peers.
    */
   async peers(): Promise<Peer[]> {
-    return getPeersForProtocol(this.libp2p.peerStore, [LightPushCodec]);
+    return getPeersForProtocol(this.components.peerStore, [LightPushCodec]);
   }
 
   /**
@@ -134,4 +143,14 @@ export class WakuLightPush {
   async randomPeer(): Promise<Peer | undefined> {
     return selectRandomPeer(await this.peers());
   }
+
+  get peerStore(): PeerStore {
+    return this.components.peerStore;
+  }
+}
+
+export function wakuLightPush(
+  init: Partial<CreateOptions> = {}
+): (components: LightPushComponents) => ILightPush {
+  return (components: LightPushComponents) => new LightPush(components, init);
 }

package/src/lib/{waku_light_push → light_push}/push_rpc.ts

@@ -1,8 +1,7 @@
+import { proto_lightpush as proto } from "@waku/proto";
 import type { Uint8ArrayList } from "uint8arraylist";
 import { v4 as uuid } from "uuid";
 
-import * as proto from "../../proto/light_push";
-
 export class PushRPC {
   public constructor(public proto: proto.PushRPC) {}
 

package/src/lib/{waku_message → message}/topic_only_message.ts

@@ -1,14 +1,18 @@
-import type { Decoder, Message, ProtoMessage } from "@waku/interfaces";
+import type {
+  IDecodedMessage,
+  IDecoder,
+  IProtoMessage,
+} from "@waku/interfaces";
+import { proto_topic_only_message as proto } from "@waku/proto";
 import debug from "debug";
 
-import * as proto from "../../proto/topic_only_message";
-
 const log = debug("waku:message:topic-only");
 
-export class TopicOnlyMessage implements Message {
+export class TopicOnlyMessage implements IDecodedMessage {
   public payload: undefined;
   public rateLimitProof: undefined;
   public timestamp: undefined;
+  public ephemeral: undefined;
 
   constructor(private proto: proto.TopicOnlyMessage) {}
 
@@ -17,10 +21,10 @@ export class TopicOnlyMessage implements Message {
   }
 }
 
-export class TopicOnlyDecoder implements Decoder<TopicOnlyMessage> {
+export class TopicOnlyDecoder implements IDecoder<TopicOnlyMessage> {
   public contentTopic = "";
 
-  fromWireToProtoObj(bytes: Uint8Array): Promise<ProtoMessage | undefined> {
+  fromWireToProtoObj(bytes: Uint8Array): Promise<IProtoMessage | undefined> {
     const protoMessage = proto.TopicOnlyMessage.decode(bytes);
     log("Message decoded", protoMessage);
     return Promise.resolve({
@@ -29,11 +33,12 @@ export class TopicOnlyDecoder implements Decoder<TopicOnlyMessage> {
       rateLimitProof: undefined,
       timestamp: undefined,
       version: undefined,
+      ephemeral: undefined,
     });
   }
 
   async fromProtoObj(
-    proto: ProtoMessage
+    proto: IProtoMessage
   ): Promise<TopicOnlyMessage | undefined> {
     return new TopicOnlyMessage(proto);
   }