@waku/core 0.0.26-678635e.0 → 0.0.26

package/src/lib/filter/index.ts

@@ -13,13 +13,16 @@ import type {
   Libp2p,
   PeerIdStr,
   ProtocolCreateOptions,
-  PubSubTopic,
+  PubsubTopic,
+  SingleShardInfo,
   Unsubscribe
 } from "@waku/interfaces";
+import { DefaultPubsubTopic } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
 import {
   ensurePubsubTopicIsConfigured,
   groupByContentTopic,
+  singleShardInfoToPubsubTopic,
   toAsyncIterator
 } from "@waku/utils";
 import { Logger } from "@waku/utils";
@@ -28,7 +31,6 @@ import * as lp from "it-length-prefixed";
 import { pipe } from "it-pipe";
 
 import { BaseProtocol } from "../base_protocol.js";
-import { DefaultPubSubTopic } from "../constants.js";
 
 import {
   FilterPushRpc,
@@ -50,7 +52,7 @@ export const FilterCodecs = {
 
 class Subscription {
   private readonly peer: Peer;
-  private readonly pubsubTopic: PubSubTopic;
+  private readonly pubsubTopic: PubsubTopic;
   private newStream: (peer: Peer) => Promise<Stream>;
 
   private subscriptionCallbacks: Map<
@@ -59,7 +61,7 @@ class Subscription {
   >;
 
   constructor(
-    pubsubTopic: PubSubTopic,
+    pubsubTopic: PubsubTopic,
     remotePeer: Peer,
     newStream: (peer: Peer) => Promise<Stream>
   ) {
@@ -256,19 +258,19 @@ class Subscription {
 }
 
 class Filter extends BaseProtocol implements IReceiver {
-  private readonly pubsubTopics: PubSubTopic[] = [];
+  private readonly pubsubTopics: PubsubTopic[] = [];
   private activeSubscriptions = new Map<string, Subscription>();
   private readonly NUM_PEERS_PROTOCOL = 1;
 
   private getActiveSubscription(
-    pubsubTopic: PubSubTopic,
+    pubsubTopic: PubsubTopic,
     peerIdStr: PeerIdStr
   ): Subscription | undefined {
     return this.activeSubscriptions.get(`${pubsubTopic}_${peerIdStr}`);
   }
 
   private setActiveSubscription(
-    pubsubTopic: PubSubTopic,
+    pubsubTopic: PubsubTopic,
     peerIdStr: PeerIdStr,
     subscription: Subscription
   ): Subscription {
@@ -279,7 +281,7 @@ class Filter extends BaseProtocol implements IReceiver {
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
     super(FilterCodecs.SUBSCRIBE, libp2p.components);
 
-    this.pubsubTopics = options?.pubsubTopics || [DefaultPubSubTopic];
+    this.pubsubTopics = this.initializePubsubTopic(options);
 
     libp2p.handle(FilterCodecs.PUSH, this.onRequest.bind(this)).catch((e) => {
       log.error("Failed to register ", FilterCodecs.PUSH, e);
@@ -289,8 +291,13 @@ class Filter extends BaseProtocol implements IReceiver {
   }
 
   async createSubscription(
-    pubsubTopic: string = DefaultPubSubTopic
+    pubsubTopicShardInfo: SingleShardInfo | PubsubTopic = DefaultPubsubTopic
   ): Promise<Subscription> {
+    const pubsubTopic =
+      typeof pubsubTopicShardInfo == "string"
+        ? pubsubTopicShardInfo
+        : singleShardInfoToPubsubTopic(pubsubTopicShardInfo);
+
     ensurePubsubTopicIsConfigured(pubsubTopic, this.pubsubTopics);
 
     //TODO: get a relevant peer for the topic/shard
@@ -367,7 +374,7 @@ class Filter extends BaseProtocol implements IReceiver {
           }
 
           if (!pubsubTopic) {
-            log.error("PubSub topic missing from push message");
+            log.error("Pubsub topic missing from push message");
             return;
           }
 
@@ -408,7 +415,7 @@ export function wakuFilter(
 
 async function pushMessage<T extends IDecodedMessage>(
   subscriptionCallback: SubscriptionCallback<T>,
-  pubsubTopic: PubSubTopic,
+  pubsubTopic: PubsubTopic,
   message: WakuMessage
 ): Promise<void> {
   const { decoders, callback } = subscriptionCallback;

package/src/lib/keep_alive_manager.ts

@@ -2,7 +2,7 @@ import type { PeerId } from "@libp2p/interface/peer-id";
 import type { PeerStore } from "@libp2p/interface/peer-store";
 import type { IRelay, PeerIdStr } from "@waku/interfaces";
 import type { KeepAliveOptions } from "@waku/interfaces";
-import { Logger } from "@waku/utils";
+import { Logger, pubsubTopicToSingleShardInfo } from "@waku/utils";
 import { utf8ToBytes } from "@waku/utils/bytes";
 import type { PingService } from "libp2p/ping";
 
@@ -111,19 +111,25 @@ export class KeepAliveManager {
     this.relayKeepAliveTimers.clear();
   }
 
+  public connectionsExist(): boolean {
+    return (
+      this.pingKeepAliveTimers.size > 0 || this.relayKeepAliveTimers.size > 0
+    );
+  }
+
   private scheduleRelayPings(
     relay: IRelay,
     relayPeriodSecs: number,
     peerIdStr: PeerIdStr
   ): NodeJS.Timeout[] {
-    // send a ping message to each PubSubTopic the peer is part of
+    // send a ping message to each PubsubTopic the peer is part of
     const intervals: NodeJS.Timeout[] = [];
     for (const topic of relay.pubsubTopics) {
       const meshPeers = relay.getMeshPeers(topic);
       if (!meshPeers.includes(peerIdStr)) continue;
 
       const encoder = createEncoder({
-        pubsubTopic: topic,
+        pubsubTopicShardInfo: pubsubTopicToSingleShardInfo(topic),
         contentTopic: RelayPingContentTopic,
         ephemeral: true
       });

package/src/lib/light_push/index.ts

@@ -6,7 +6,7 @@ import {
   IMessage,
   Libp2p,
   ProtocolCreateOptions,
-  PubSubTopic,
+  PubsubTopic,
   SendError,
   SendResult
 } from "@waku/interfaces";
@@ -22,7 +22,6 @@ import { pipe } from "it-pipe";
 import { Uint8ArrayList } from "uint8arraylist";
 
 import { BaseProtocol } from "../base_protocol.js";
-import { DefaultPubSubTopic } from "../constants.js";
 
 import { PushRpc } from "./push_rpc.js";
 
@@ -45,12 +44,12 @@ type PreparePushMessageResult =
  * Implements the [Waku v2 Light Push protocol](https://rfc.vac.dev/spec/19/).
  */
 class LightPush extends BaseProtocol implements ILightPush {
-  private readonly pubsubTopics: PubSubTopic[];
+  private readonly pubsubTopics: PubsubTopic[];
   private readonly NUM_PEERS_PROTOCOL = 1;
 
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
     super(LightPushCodec, libp2p.components);
-    this.pubsubTopics = options?.pubsubTopics ?? [DefaultPubSubTopic];
+    this.pubsubTopics = this.initializePubsubTopic(options);
   }
 
   private async preparePushMessage(

package/src/lib/message/version_0.ts

@@ -7,12 +7,11 @@ import type {
   IMetaSetter,
   IProtoMessage,
   IRateLimitProof,
-  PubSubTopic
+  PubsubTopic,
+  SingleShardInfo
 } from "@waku/interfaces";
 import { proto_message as proto } from "@waku/proto";
-import { Logger } from "@waku/utils";
-
-import { DefaultPubSubTopic } from "../constants.js";
+import { determinePubsubTopic, Logger } from "@waku/utils";
 
 const log = new Logger("message:version-0");
 const OneMillion = BigInt(1_000_000);
@@ -76,7 +75,7 @@ export class Encoder implements IEncoder {
   constructor(
     public contentTopic: string,
     public ephemeral: boolean = false,
-    public pubsubTopic: PubSubTopic,
+    public pubsubTopic: PubsubTopic,
     public metaSetter?: IMetaSetter
   ) {
     if (!contentTopic || contentTopic === "") {
@@ -119,17 +118,23 @@ export class Encoder implements IEncoder {
  * messages.
  */
 export function createEncoder({
-  pubsubTopic = DefaultPubSubTopic,
+  pubsubTopic,
+  pubsubTopicShardInfo,
   contentTopic,
   ephemeral,
   metaSetter
 }: EncoderOptions): Encoder {
-  return new Encoder(contentTopic, ephemeral, pubsubTopic, metaSetter);
+  return new Encoder(
+    contentTopic,
+    ephemeral,
+    determinePubsubTopic(contentTopic, pubsubTopic ?? pubsubTopicShardInfo),
+    metaSetter
+  );
 }
 
 export class Decoder implements IDecoder<DecodedMessage> {
   constructor(
-    public pubsubTopic: PubSubTopic,
+    public pubsubTopic: PubsubTopic,
     public contentTopic: string
   ) {
     if (!contentTopic || contentTopic === "") {
@@ -182,7 +187,10 @@ export class Decoder implements IDecoder<DecodedMessage> {
  */
 export function createDecoder(
   contentTopic: string,
-  pubsubTopic: PubSubTopic = DefaultPubSubTopic
+  pubsubTopicShardInfo?: SingleShardInfo | PubsubTopic
 ): Decoder {
-  return new Decoder(pubsubTopic, contentTopic);
+  return new Decoder(
+    determinePubsubTopic(contentTopic, pubsubTopicShardInfo),
+    contentTopic
+  );
 }

package/src/lib/metadata/index.ts

@@ -0,0 +1,110 @@
+import type { PeerId } from "@libp2p/interface/peer-id";
+import { IncomingStreamData } from "@libp2p/interface/stream-handler";
+import { encodeRelayShard } from "@waku/enr";
+import type {
+  IMetadata,
+  Libp2pComponents,
+  ShardInfo,
+  ShardingParams
+} from "@waku/interfaces";
+import { proto_metadata } from "@waku/proto";
+import { Logger } from "@waku/utils";
+import all from "it-all";
+import * as lp from "it-length-prefixed";
+import { pipe } from "it-pipe";
+import { Uint8ArrayList } from "uint8arraylist";
+
+import { BaseProtocol } from "../base_protocol.js";
+
+const log = new Logger("metadata");
+
+export const MetadataCodec = "/vac/waku/metadata/1.0.0";
+
+class Metadata extends BaseProtocol {
+  private readonly shardInfo: ShardingParams;
+  private libp2pComponents: Libp2pComponents;
+  constructor(shardInfo: ShardingParams, libp2p: Libp2pComponents) {
+    super(MetadataCodec, libp2p.components);
+    this.libp2pComponents = libp2p;
+    this.shardInfo = shardInfo;
+    void libp2p.registrar.handle(MetadataCodec, (streamData) => {
+      void this.onRequest(streamData);
+    });
+  }
+
+  /**
+   * Handle an incoming metadata request
+   */
+  private async onRequest(streamData: IncomingStreamData): Promise<void> {
+    try {
+      const { stream, connection } = streamData;
+      const encodedShardInfo = proto_metadata.WakuMetadataResponse.encode(
+        this.shardInfo
+      );
+
+      const encodedResponse = await pipe(
+        [encodedShardInfo],
+        lp.encode,
+        stream,
+        lp.decode,
+        async (source) => await all(source)
+      );
+
+      const remoteShardInfoResponse =
+        this.decodeMetadataResponse(encodedResponse);
+
+      // add or update the shardInfo to peer store
+      await this.libp2pComponents.peerStore.merge(connection.remotePeer, {
+        metadata: {
+          shardInfo: encodeRelayShard(remoteShardInfoResponse)
+        }
+      });
+    } catch (error) {
+      log.error("Error handling metadata request", error);
+    }
+  }
+
+  /**
+   * Make a metadata query to a peer
+   */
+  async query(peerId: PeerId): Promise<ShardInfo> {
+    const request = proto_metadata.WakuMetadataRequest.encode(this.shardInfo);
+
+    const peer = await this.getPeer(peerId);
+
+    const stream = await this.getStream(peer);
+
+    const encodedResponse = await pipe(
+      [request],
+      lp.encode,
+      stream,
+      lp.decode,
+      async (source) => await all(source)
+    );
+
+    const decodedResponse = this.decodeMetadataResponse(encodedResponse);
+
+    return decodedResponse;
+  }
+
+  private decodeMetadataResponse(encodedResponse: Uint8ArrayList[]): ShardInfo {
+    const bytes = new Uint8ArrayList();
+
+    encodedResponse.forEach((chunk) => {
+      bytes.append(chunk);
+    });
+    const response = proto_metadata.WakuMetadataResponse.decode(
+      bytes
+    ) as ShardInfo;
+
+    if (!response) log.error("Error decoding metadata response");
+
+    return response;
+  }
+}
+
+export function wakuMetadata(
+  shardInfo: ShardingParams
+): (components: Libp2pComponents) => IMetadata {
+  return (components: Libp2pComponents) => new Metadata(shardInfo, components);
+}

package/src/lib/store/index.ts

@@ -7,7 +7,7 @@ import {
   IStore,
   Libp2p,
   ProtocolCreateOptions,
-  PubSubTopic
+  PubsubTopic
 } from "@waku/interfaces";
 import { proto_store as proto } from "@waku/proto";
 import { ensurePubsubTopicIsConfigured, isDefined } from "@waku/utils";
@@ -19,7 +19,6 @@ import { pipe } from "it-pipe";
 import { Uint8ArrayList } from "uint8arraylist";
 
 import { BaseProtocol } from "../base_protocol.js";
-import { DefaultPubSubTopic } from "../constants.js";
 import { toProtoMessage } from "../to_proto_message.js";
 
 import { HistoryRpc, PageDirection, Params } from "./history_rpc.js";
@@ -75,12 +74,12 @@ export interface QueryOptions {
  * The Waku Store protocol can be used to retrieved historical messages.
  */
 class Store extends BaseProtocol implements IStore {
-  private readonly pubsubTopics: PubSubTopic[];
+  private readonly pubsubTopics: PubsubTopic[];
   private readonly NUM_PEERS_PROTOCOL = 1;
 
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
     super(StoreCodec, libp2p.components);
-    this.pubsubTopics = options?.pubsubTopics ?? [DefaultPubSubTopic];
+    this.pubsubTopics = this.initializePubsubTopic(options);
   }
 
   /**
@@ -230,29 +229,29 @@ class Store extends BaseProtocol implements IStore {
     }
 
     // convert array to set to remove duplicates
-    const uniquePubSubTopicsInQuery = Array.from(
+    const uniquePubsubTopicsInQuery = Array.from(
       new Set(decoders.map((decoder) => decoder.pubsubTopic))
     );
 
     // If multiple pubsub topics are provided, throw an error
-    if (uniquePubSubTopicsInQuery.length > 1) {
+    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];
+    const pubsubTopicForQuery = uniquePubsubTopicsInQuery[0];
 
-    ensurePubsubTopicIsConfigured(pubSubTopicForQuery, this.pubsubTopics);
+    ensurePubsubTopicIsConfigured(pubsubTopicForQuery, this.pubsubTopics);
 
     // check that the pubsubTopic from the Cursor and Decoder match
     if (
       options?.cursor?.pubsubTopic &&
-      options.cursor.pubsubTopic !== pubSubTopicForQuery
+      options.cursor.pubsubTopic !== pubsubTopicForQuery
     ) {
       throw new Error(
-        `Cursor pubsub topic (${options?.cursor?.pubsubTopic}) does not match decoder pubsub topic (${pubSubTopicForQuery})`
+        `Cursor pubsub topic (${options?.cursor?.pubsubTopic}) does not match decoder pubsub topic (${pubsubTopicForQuery})`
       );
     }
 
@@ -267,16 +266,16 @@ class Store extends BaseProtocol implements IStore {
     });
 
     const contentTopics = decoders
-      .filter((decoder) => decoder.pubsubTopic === pubSubTopicForQuery)
+      .filter((decoder) => decoder.pubsubTopic === pubsubTopicForQuery)
       .map((dec) => dec.contentTopic);
 
     if (contentTopics.length === 0) {
-      throw new Error("No decoders found for topic " + pubSubTopicForQuery);
+      throw new Error("No decoders found for topic " + pubsubTopicForQuery);
     }
 
     const queryOpts = Object.assign(
       {
-        pubsubTopic: pubSubTopicForQuery,
+        pubsubTopic: pubsubTopicForQuery,
         pageDirection: PageDirection.BACKWARD,
         pageSize: DefaultPageSize
       },

package/src/lib/waku.ts

@@ -7,11 +7,12 @@ import type {
   IRelay,
   IStore,
   Libp2p,
-  PubSubTopic,
+  PubsubTopic,
+  ShardingParams,
   Waku
 } from "@waku/interfaces";
-import { Protocols } from "@waku/interfaces";
-import { Logger } from "@waku/utils";
+import { DefaultPubsubTopic, Protocols } from "@waku/interfaces";
+import { Logger, shardInfoToPubsubTopics } from "@waku/utils";
 
 import { ConnectionManager } from "./connection_manager.js";
 
@@ -50,16 +51,25 @@ export class WakuNode implements Waku {
   public filter?: IFilter;
   public lightPush?: ILightPush;
   public connectionManager: ConnectionManager;
+  public readonly pubsubTopics: PubsubTopic[];
 
   constructor(
     options: WakuOptions,
-    public readonly pubsubTopics: PubSubTopic[],
+    pubsubTopics: PubsubTopic[] = [],
     libp2p: Libp2p,
+    pubsubShardInfo?: ShardingParams,
     store?: (libp2p: Libp2p) => IStore,
     lightPush?: (libp2p: Libp2p) => ILightPush,
     filter?: (libp2p: Libp2p) => IFilter,
     relay?: (libp2p: Libp2p) => IRelay
   ) {
+    if (!pubsubShardInfo) {
+      this.pubsubTopics =
+        pubsubTopics.length > 0 ? pubsubTopics : [DefaultPubsubTopic];
+    } else {
+      this.pubsubTopics = shardInfoToPubsubTopics(pubsubShardInfo);
+    }
+
     this.libp2p = libp2p;
 
     if (store) {
@@ -88,7 +98,7 @@ export class WakuNode implements Waku {
       peerId,
       libp2p,
       { pingKeepAlive, relayKeepAlive },
-      pubsubTopics,
+      this.pubsubTopics,
       this.relay
     );
 
@@ -178,6 +188,10 @@ export class WakuNode implements Waku {
     return this.libp2p.isStarted();
   }
 
+  isConnected(): boolean {
+    return this.connectionManager.isConnected();
+  }
+
   /**
    * Return the local multiaddr with peer id on which libp2p is listening.
    *