@waku/core 0.0.23 → 0.0.24

package/src/lib/light_push/index.ts

@@ -1,3 +1,4 @@
+import type { Stream } from "@libp2p/interface/connection";
 import type { PeerId } from "@libp2p/interface/peer-id";
 import {
   IEncoder,
@@ -5,11 +6,12 @@ import {
   IMessage,
   Libp2p,
   ProtocolCreateOptions,
+  PubSubTopic,
   SendError,
   SendResult
 } from "@waku/interfaces";
 import { PushResponse } from "@waku/proto";
-import { isSizeValid } from "@waku/utils";
+import { ensurePubsubTopicIsConfigured, isSizeValid } from "@waku/utils";
 import debug from "debug";
 import all from "it-all";
 import * as lp from "it-length-prefixed";
@@ -40,18 +42,18 @@ type PreparePushMessageResult =
  * Implements the [Waku v2 Light Push protocol](https://rfc.vac.dev/spec/19/).
  */
 class LightPush extends BaseProtocol implements ILightPush {
-  options: ProtocolCreateOptions;
+  private readonly pubsubTopics: PubSubTopic[];
   private readonly NUM_PEERS_PROTOCOL = 1;
 
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
     super(LightPushCodec, libp2p.components);
-    this.options = options || {};
+    this.pubsubTopics = options?.pubsubTopics ?? [DefaultPubSubTopic];
   }
 
   private async preparePushMessage(
     encoder: IEncoder,
     message: IMessage,
-    pubSubTopic: string
+    pubsubTopic: string
   ): Promise<PreparePushMessageResult> {
     try {
       if (!isSizeValid(message.payload)) {
@@ -68,7 +70,7 @@ class LightPush extends BaseProtocol implements ILightPush {
         };
       }
 
-      const query = PushRpc.createRequest(protoMessage, pubSubTopic);
+      const query = PushRpc.createRequest(protoMessage, pubsubTopic);
       return { query, error: null };
     } catch (error) {
       log("Failed to prepare push message", error);
@@ -81,13 +83,15 @@ class LightPush extends BaseProtocol implements ILightPush {
   }
 
   async send(encoder: IEncoder, message: IMessage): Promise<SendResult> {
-    const { pubSubTopic = DefaultPubSubTopic } = this.options;
+    const { pubsubTopic } = encoder;
+    ensurePubsubTopicIsConfigured(pubsubTopic, this.pubsubTopics);
+
     const recipients: PeerId[] = [];
 
     const { query, error: preparationError } = await this.preparePushMessage(
       encoder,
       message,
-      pubSubTopic
+      pubsubTopic
     );
 
     if (preparationError || !query) {
@@ -97,48 +101,69 @@ class LightPush extends BaseProtocol implements ILightPush {
       };
     }
 
+    //TODO: get a relevant peer for the topic/shard
     const peers = await this.getPeers({
       maxBootstrapPeers: 1,
       numPeers: this.NUM_PEERS_PROTOCOL
     });
 
+    if (!peers.length) {
+      return {
+        recipients,
+        errors: [SendError.NO_PEER_AVAILABLE]
+      };
+    }
+
     const promises = peers.map(async (peer) => {
-      let error: SendError | undefined;
-      const stream = await this.getStream(peer);
+      let stream: Stream | undefined;
+      try {
+        stream = await this.getStream(peer);
+      } catch (err) {
+        log(`Failed to get a stream for remote peer${peer.id.toString()}`, err);
+        return { recipients, error: SendError.REMOTE_PEER_FAULT };
+      }
 
+      let res: Uint8ArrayList[] | undefined;
       try {
-        const res = await pipe(
+        res = await pipe(
           [query.encode()],
           lp.encode,
           stream,
           lp.decode,
           async (source) => await all(source)
         );
-        try {
-          const bytes = new Uint8ArrayList();
-          res.forEach((chunk) => {
-            bytes.append(chunk);
-          });
-
-          const response = PushRpc.decode(bytes).response;
-
-          if (response?.isSuccess) {
-            recipients.some((recipient) => recipient.equals(peer.id)) ||
-              recipients.push(peer.id);
-          } else {
-            log("No response in PushRPC");
-            error = SendError.NO_RPC_RESPONSE;
-          }
-        } catch (err) {
-          log("Failed to decode push reply", err);
-          error = SendError.DECODE_FAILED;
-        }
       } catch (err) {
         log("Failed to send waku light push request", err);
-        error = SendError.GENERIC_FAIL;
+        return { recipients, error: SendError.GENERIC_FAIL };
       }
 
-      return { recipients, error };
+      const bytes = new Uint8ArrayList();
+      res.forEach((chunk) => {
+        bytes.append(chunk);
+      });
+
+      let response: PushResponse | undefined;
+      try {
+        response = PushRpc.decode(bytes).response;
+      } catch (err) {
+        log("Failed to decode push reply", err);
+        return { recipients, error: SendError.DECODE_FAILED };
+      }
+
+      if (!response) {
+        log("Remote peer fault: No response in PushRPC");
+        return { recipients, error: SendError.REMOTE_PEER_FAULT };
+      }
+
+      if (!response.isSuccess) {
+        log("Remote peer rejected the message: ", response.info);
+        return { recipients, error: SendError.REMOTE_PEER_REJECTED };
+      }
+
+      recipients.some((recipient) => recipient.equals(peer.id)) ||
+        recipients.push(peer.id);
+
+      return { recipients };
     });
 
     const results = await Promise.allSettled(promises);

package/src/lib/light_push/push_rpc.ts

@@ -7,13 +7,13 @@ export class PushRpc {
 
   static createRequest(
     message: proto.WakuMessage,
-    pubSubTopic: string
+    pubsubTopic: string
   ): PushRpc {
     return new PushRpc({
       requestId: uuid(),
       request: {
         message: message,
-        pubsubTopic: pubSubTopic
+        pubsubTopic: pubsubTopic
       },
       response: undefined
     });

package/src/lib/message/version_0.ts

@@ -6,11 +6,14 @@ import type {
   IMessage,
   IMetaSetter,
   IProtoMessage,
-  IRateLimitProof
+  IRateLimitProof,
+  PubSubTopic
 } from "@waku/interfaces";
 import { proto_message as proto } from "@waku/proto";
 import debug from "debug";
 
+import { DefaultPubSubTopic } from "../constants.js";
+
 const log = debug("waku:message:version-0");
 const OneMillion = BigInt(1_000_000);
 
@@ -19,7 +22,7 @@ export { proto };
 
 export class DecodedMessage implements IDecodedMessage {
   constructor(
-    public pubSubTopic: string,
+    public pubsubTopic: string,
     protected proto: proto.WakuMessage
   ) {}
 
@@ -73,6 +76,7 @@ export class Encoder implements IEncoder {
   constructor(
     public contentTopic: string,
     public ephemeral: boolean = false,
+    public pubsubTopic: PubSubTopic,
     public metaSetter?: IMetaSetter
   ) {
     if (!contentTopic || contentTopic === "") {
@@ -109,22 +113,25 @@ export class Encoder implements IEncoder {
 /**
  * Creates an encoder that encode messages without Waku level encryption or signature.
  *
- * An encoder is used to encode messages in the [`14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
+ * An encoder is used to encode messages in the [14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
  * format to be sent over the Waku network. The resulting encoder can then be
- * pass to { @link @waku/interfaces.LightPush.push } or
- * { @link @waku/interfaces.Relay.send } to automatically encode outgoing
+ * pass to { @link @waku/interfaces!ISender.send } to automatically encode outgoing
  * messages.
  */
 export function createEncoder({
+  pubsubTopic = DefaultPubSubTopic,
   contentTopic,
   ephemeral,
   metaSetter
 }: EncoderOptions): Encoder {
-  return new Encoder(contentTopic, ephemeral, metaSetter);
+  return new Encoder(contentTopic, ephemeral, pubsubTopic, metaSetter);
 }
 
 export class Decoder implements IDecoder<DecodedMessage> {
-  constructor(public contentTopic: string) {
+  constructor(
+    public pubsubTopic: PubSubTopic,
+    public contentTopic: string
+  ) {
     if (!contentTopic || contentTopic === "") {
       throw new Error("Content topic must be specified");
     }
@@ -145,7 +152,7 @@ export class Decoder implements IDecoder<DecodedMessage> {
   }
 
   async fromProtoObj(
-    pubSubTopic: string,
+    pubsubTopic: string,
     proto: IProtoMessage
   ): Promise<DecodedMessage | undefined> {
     // https://rfc.vac.dev/spec/14/
@@ -160,7 +167,7 @@ export class Decoder implements IDecoder<DecodedMessage> {
       return Promise.resolve(undefined);
     }
 
-    return new DecodedMessage(pubSubTopic, proto);
+    return new DecodedMessage(pubsubTopic, proto);
   }
 }
 
@@ -169,12 +176,14 @@ export class Decoder implements IDecoder<DecodedMessage> {
  *
  * A decoder is used to decode messages from the [14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
  * format when received from the Waku network. The resulting decoder can then be
- * pass to { @link @waku/interfaces.Filter.subscribe } or
- * { @link @waku/interfaces.Relay.subscribe } to automatically decode incoming
+ * pass to { @link @waku/interfaces!IReceiver.subscribe } to automatically decode incoming
  * messages.
  *
  * @param contentTopic The resulting decoder will only decode messages with this content topic.
  */
-export function createDecoder(contentTopic: string): Decoder {
-  return new Decoder(contentTopic);
+export function createDecoder(
+  contentTopic: string,
+  pubsubTopic: PubSubTopic = DefaultPubSubTopic
+): Decoder {
+  return new Decoder(pubsubTopic, contentTopic);
 }

package/src/lib/store/history_rpc.ts

@@ -11,7 +11,7 @@ export enum PageDirection {
 
 export interface Params {
   contentTopics: string[];
-  pubSubTopic: string;
+  pubsubTopic: string;
   pageDirection: PageDirection;
   pageSize: number;
   startTime?: Date;
@@ -59,7 +59,7 @@ export class HistoryRpc {
     return new HistoryRpc({
       requestId: uuid(),
       query: {
-        pubsubTopic: params.pubSubTopic,
+        pubsubTopic: params.pubsubTopic,
         contentFilters,
         pagingInfo,
         startTime,

package/src/lib/store/index.ts

@@ -6,10 +6,11 @@ import {
   IDecoder,
   IStore,
   Libp2p,
-  ProtocolCreateOptions
+  ProtocolCreateOptions,
+  PubSubTopic
 } from "@waku/interfaces";
 import { proto_store as proto } from "@waku/proto";
-import { isDefined } from "@waku/utils";
+import { ensurePubsubTopicIsConfigured, isDefined } from "@waku/utils";
 import { concat, utf8ToBytes } from "@waku/utils/bytes";
 import debug from "debug";
 import all from "it-all";
@@ -74,12 +75,12 @@ export interface QueryOptions {
  * The Waku Store protocol can be used to retrieved historical messages.
  */
 class Store extends BaseProtocol implements IStore {
-  options: ProtocolCreateOptions;
+  private readonly pubsubTopics: PubSubTopic[];
   private readonly NUM_PEERS_PROTOCOL = 1;
 
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
     super(StoreCodec, libp2p.components);
-    this.options = options ?? {};
+    this.pubsubTopics = options?.pubsubTopics ?? [DefaultPubSubTopic];
   }
 
   /**
@@ -206,12 +207,20 @@ class Store extends BaseProtocol implements IStore {
    * @throws If not able to reach a Waku Store peer to query,
    * or if an error is encountered when processing the reply,
    * or if two decoders with the same content topic are passed.
+   *
+   * This API only supports querying a single pubsub topic at a time.
+   * If multiple decoders are provided, they must all have the same pubsub topic.
+   * @throws If multiple decoders with different pubsub topics are provided.
+   * @throws If no decoders are provided.
+   * @throws If no decoders are found for the provided pubsub topic.
    */
   async *queryGenerator<T extends IDecodedMessage>(
     decoders: IDecoder<T>[],
     options?: QueryOptions
   ): AsyncGenerator<Promise<T | undefined>[]> {
-    const { pubSubTopic = DefaultPubSubTopic } = this.options;
+    if (decoders.length === 0) {
+      throw new Error("No decoders provided");
+    }
 
     let startTime, endTime;
 
@@ -220,6 +229,33 @@ class Store extends BaseProtocol implements IStore {
       endTime = options.timeFilter.endTime;
     }
 
+    // convert array to set to remove duplicates
+    const uniquePubSubTopicsInQuery = Array.from(
+      new Set(decoders.map((decoder) => decoder.pubsubTopic))
+    );
+
+    // If multiple pubsub topics are provided, throw an error
+    if (uniquePubSubTopicsInQuery.length > 1) {
+      throw new Error(
+        "API does not support querying multiple pubsub topics at once"
+      );
+    }
+
+    // we can be certain that there is only one pubsub topic in the query
+    const pubSubTopicForQuery = uniquePubSubTopicsInQuery[0];
+
+    ensurePubsubTopicIsConfigured(pubSubTopicForQuery, this.pubsubTopics);
+
+    // check that the pubsubTopic from the Cursor and Decoder match
+    if (
+      options?.cursor?.pubsubTopic &&
+      options.cursor.pubsubTopic !== pubSubTopicForQuery
+    ) {
+      throw new Error(
+        `Cursor pubsub topic (${options?.cursor?.pubsubTopic}) does not match decoder pubsub topic (${pubSubTopicForQuery})`
+      );
+    }
+
     const decodersAsMap = new Map();
     decoders.forEach((dec) => {
       if (decodersAsMap.has(dec.contentTopic)) {
@@ -230,11 +266,17 @@ class Store extends BaseProtocol implements IStore {
       decodersAsMap.set(dec.contentTopic, dec);
     });
 
-    const contentTopics = decoders.map((dec) => dec.contentTopic);
+    const contentTopics = decoders
+      .filter((decoder) => decoder.pubsubTopic === pubSubTopicForQuery)
+      .map((dec) => dec.contentTopic);
+
+    if (contentTopics.length === 0) {
+      throw new Error("No decoders found for topic " + pubSubTopicForQuery);
+    }
 
     const queryOpts = Object.assign(
       {
-        pubSubTopic: pubSubTopic,
+        pubsubTopic: pubSubTopicForQuery,
         pageDirection: PageDirection.BACKWARD,
         pageSize: DefaultPageSize
       },
@@ -285,7 +327,7 @@ async function* paginate<T extends IDecodedMessage>(
 
     log(
       "Querying store peer",
-      `for (${queryOpts.pubSubTopic})`,
+      `for (${queryOpts.pubsubTopic})`,
       queryOpts.contentTopics
     );
 
@@ -332,7 +374,7 @@ async function* paginate<T extends IDecodedMessage>(
         const decoder = decoders.get(contentTopic);
         if (decoder) {
           return decoder.fromProtoObj(
-            queryOpts.pubSubTopic,
+            queryOpts.pubsubTopic,
             toProtoMessage(protoMsg)
           );
         }
@@ -365,10 +407,7 @@ async function* paginate<T extends IDecodedMessage>(
   }
 }
 
-export async function createCursor(
-  message: IDecodedMessage,
-  pubsubTopic: string = DefaultPubSubTopic
-): Promise<Cursor> {
+export async function createCursor(message: IDecodedMessage): Promise<Cursor> {
   if (
     !message ||
     !message.timestamp ||
@@ -386,7 +425,7 @@ export async function createCursor(
 
   return {
     digest,
-    pubsubTopic,
+    pubsubTopic: message.pubsubTopic,
     senderTime: messageTime,
     receiverTime: messageTime
   };

package/src/lib/stream_manager.ts

@@ -6,8 +6,8 @@ import { selectConnection } from "@waku/utils/libp2p";
 import debug from "debug";
 
 export class StreamManager {
-  private streamPool: Map<string, Promise<Stream>>;
-  private log: debug.Debugger;
+  private streamPool: Map<string, Promise<Stream | void>>;
+  private readonly log: debug.Debugger;
 
   constructor(
     public multicodec: string,
@@ -38,7 +38,7 @@ export class StreamManager {
 
     const stream = await streamPromise;
 
-    if (stream.status === "closed") {
+    if (!stream || stream.status === "closed") {
       return this.newStream(peer); // fallback by creating a new stream on the spot
     }
 
@@ -55,7 +55,10 @@ export class StreamManager {
   }
 
   private prepareNewStream(peer: Peer): void {
-    const streamPromise = this.newStream(peer);
+    const streamPromise = this.newStream(peer).catch(() => {
+      // No error thrown as this call is not triggered by the user
+      this.log(`Failed to prepare a new stream for ${peer.id.toString()}`);
+    });
     this.streamPool.set(peer.id.toString(), streamPromise);
   }
 

package/src/lib/wait_for_remote_peer.ts

@@ -9,8 +9,8 @@ const log = debug("waku:wait-for-remote-peer");
 /**
  * Wait for a remote peer to be ready given the passed protocols.
  * Must be used after attempting to connect to nodes, using
- * {@link @waku/core.WakuNode.dial} or a bootstrap method with
- * {@link @waku/sdk.createLightNode}.
+ * {@link @waku/core!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
@@ -96,15 +96,18 @@ async function waitForConnectedPeer(protocol: IBaseProtocol): Promise<void> {
 }
 
 /**
- * Wait for a peer with the given protocol to be connected and in the gossipsub
- * mesh.
+ * 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;
 
-  while (peers.length == 0) {
-    await pEvent(waku.gossipSub, "gossipsub:heartbeat");
-    peers = waku.getMeshPeers();
+  for (const topic of pubsubTopics) {
+    while (peers.length == 0) {
+      await pEvent(waku.gossipSub, "gossipsub:heartbeat");
+      peers = waku.getMeshPeers(topic);
+    }
   }
 }
 

package/src/lib/waku.ts

@@ -7,6 +7,7 @@ import type {
   IRelay,
   IStore,
   Libp2p,
+  PubSubTopic,
   Waku
 } from "@waku/interfaces";
 import { Protocols } from "@waku/interfaces";
@@ -14,7 +15,7 @@ import debug from "debug";
 
 import { ConnectionManager } from "./connection_manager.js";
 
-export const DefaultPingKeepAliveValueSecs = 0;
+export const DefaultPingKeepAliveValueSecs = 5 * 60;
 export const DefaultRelayKeepAliveValueSecs = 5 * 60;
 export const DefaultUserAgent = "js-waku";
 
@@ -52,6 +53,7 @@ export class WakuNode implements Waku {
 
   constructor(
     options: WakuOptions,
+    public readonly pubsubTopics: PubSubTopic[],
     libp2p: Libp2p,
     store?: (libp2p: Libp2p) => IStore,
     lightPush?: (libp2p: Libp2p) => ILightPush,
@@ -86,6 +88,7 @@ export class WakuNode implements Waku {
       peerId,
       libp2p,
       { pingKeepAlive, relayKeepAlive },
+      pubsubTopics,
       this.relay
     );
 

package/dist/lib/push_or_init_map.d.ts

@@ -1 +0,0 @@
-export declare function pushOrInitMapSet<K, V>(map: Map<K, Set<V>>, key: K, newValue: V): void;

package/dist/lib/push_or_init_map.js

@@ -1,9 +0,0 @@
-export function pushOrInitMapSet(map, key, newValue) {
-    let arr = map.get(key);
-    if (typeof arr === "undefined") {
-        map.set(key, new Set());
-        arr = map.get(key);
-    }
-    arr.add(newValue);
-}
-//# sourceMappingURL=push_or_init_map.js.map

package/dist/lib/push_or_init_map.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"push_or_init_map.js","sourceRoot":"","sources":["../../src/lib/push_or_init_map.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,gBAAgB,CAC9B,GAAmB,EACnB,GAAM,EACN,QAAW;IAEX,IAAI,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,IAAI,OAAO,GAAG,KAAK,WAAW,EAAE;QAC9B,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QACxB,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAW,CAAC;KAC9B;IAED,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACpB,CAAC"}

package/src/lib/push_or_init_map.ts

@@ -1,13 +0,0 @@
-export function pushOrInitMapSet<K, V>(
-  map: Map<K, Set<V>>,
-  key: K,
-  newValue: V
-): void {
-  let arr = map.get(key);
-  if (typeof arr === "undefined") {
-    map.set(key, new Set());
-    arr = map.get(key) as Set<V>;
-  }
-
-  arr.add(newValue);
-}