feat: reintroduce and deprecate named sharding, make autosharding default for all other cases

packages/core/src/lib/base_protocol.ts

@@ -5,8 +5,8 @@ import { Peer, PeerStore } from "@libp2p/interface/peer-store";
 import type {
   IBaseProtocol,
   Libp2pComponents,
-  PubsubTopic,
-  ShardingParams
+  ProtocolCreateOptions,
+  PubsubTopic
 } from "@waku/interfaces";
 import { DefaultPubsubTopic } from "@waku/interfaces";
 import { shardInfoToPubsubTopics } from "@waku/utils";
@@ -103,9 +103,12 @@ export class BaseProtocol implements IBaseProtocol {
     return filterPeers(allPeersForProtocol, numPeers, maxBootstrapPeers);
   }
 
-  initializePubsubTopic(shardInfo?: ShardingParams): PubsubTopic[] {
-    return shardInfo
-      ? shardInfoToPubsubTopics(shardInfo)
-      : [DefaultPubsubTopic];
+  initializePubsubTopic(options?: ProtocolCreateOptions): PubsubTopic[] {
+    return (
+      options?.pubsubTopics ??
+      (options?.shardInfo
+        ? shardInfoToPubsubTopics(options.shardInfo)
+        : [DefaultPubsubTopic])
+    );
   }
 }

packages/core/src/lib/filter/index.ts

@@ -281,7 +281,7 @@ class Filter extends BaseProtocol implements IReceiver {
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
     super(FilterCodecs.SUBSCRIBE, libp2p.components);
 
-    this.pubsubTopics = this.initializePubsubTopic(options?.shardInfo);
+    this.pubsubTopics = this.initializePubsubTopic(options);
 
     libp2p.handle(FilterCodecs.PUSH, this.onRequest.bind(this)).catch((e) => {
       log.error("Failed to register ", FilterCodecs.PUSH, e);
@@ -291,11 +291,12 @@ class Filter extends BaseProtocol implements IReceiver {
   }
 
   async createSubscription(
-    pubsubTopicShardInfo?: SingleShardInfo
+    pubsubTopicShardInfo: SingleShardInfo | PubsubTopic = DefaultPubsubTopic
   ): Promise<Subscription> {
-    const pubsubTopic = pubsubTopicShardInfo
-      ? singleShardInfoToPubsubTopic(pubsubTopicShardInfo)
-      : DefaultPubsubTopic;
+    const pubsubTopic =
+      typeof pubsubTopicShardInfo == "string"
+        ? pubsubTopicShardInfo
+        : singleShardInfoToPubsubTopic(pubsubTopicShardInfo);
 
     ensurePubsubTopicIsConfigured(pubsubTopic, this.pubsubTopics);
 

packages/core/src/lib/light_push/index.ts

@@ -49,7 +49,7 @@ class LightPush extends BaseProtocol implements ILightPush {
 
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
     super(LightPushCodec, libp2p.components);
-    this.pubsubTopics = this.initializePubsubTopic(options?.shardInfo);
+    this.pubsubTopics = this.initializePubsubTopic(options);
   }
 
   private async preparePushMessage(

packages/core/src/lib/message/version_0.ts

@@ -118,6 +118,7 @@ export class Encoder implements IEncoder {
  * messages.
  */
 export function createEncoder({
+  pubsubTopic,
   pubsubTopicShardInfo,
   contentTopic,
   ephemeral,
@@ -126,7 +127,7 @@ export function createEncoder({
   return new Encoder(
     contentTopic,
     ephemeral,
-    determinePubsubTopic(contentTopic, pubsubTopicShardInfo),
+    determinePubsubTopic(contentTopic, pubsubTopic ?? pubsubTopicShardInfo),
     metaSetter
   );
 }
@@ -186,7 +187,7 @@ export class Decoder implements IDecoder<DecodedMessage> {
  */
 export function createDecoder(
   contentTopic: string,
-  pubsubTopicShardInfo?: SingleShardInfo
+  pubsubTopicShardInfo?: SingleShardInfo | PubsubTopic
 ): Decoder {
   return new Decoder(
     determinePubsubTopic(contentTopic, pubsubTopicShardInfo),

packages/core/src/lib/store/index.ts

@@ -79,7 +79,7 @@ class Store extends BaseProtocol implements IStore {
 
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
     super(StoreCodec, libp2p.components);
-    this.pubsubTopics = this.initializePubsubTopic(options?.shardInfo);
+    this.pubsubTopics = this.initializePubsubTopic(options);
   }
 
   /**

packages/core/src/lib/waku.ts

@@ -55,6 +55,7 @@ export class WakuNode implements Waku {
 
   constructor(
     options: WakuOptions,
+    pubsubTopics: PubsubTopic[] = [],
     libp2p: Libp2p,
     pubsubShardInfo?: ShardingParams,
     store?: (libp2p: Libp2p) => IStore,
@@ -63,7 +64,8 @@ export class WakuNode implements Waku {
     relay?: (libp2p: Libp2p) => IRelay
   ) {
     if (!pubsubShardInfo) {
-      this.pubsubTopics = [DefaultPubsubTopic];
+      this.pubsubTopics =
+        pubsubTopics.length > 0 ? pubsubTopics : [DefaultPubsubTopic];
     } else {
       this.pubsubTopics = shardInfoToPubsubTopics(pubsubShardInfo);
     }

packages/interfaces/src/filter.ts

@@ -1,7 +1,7 @@
 import type { PeerId } from "@libp2p/interface/peer-id";
 
 import type { IDecodedMessage, IDecoder, SingleShardInfo } from "./message.js";
-import type { ContentTopic } from "./misc.js";
+import type { ContentTopic, PubsubTopic } from "./misc.js";
 import type { Callback, IBaseProtocol } from "./protocols.js";
 import type { IReceiver } from "./receiver.js";
 
@@ -25,7 +25,7 @@ export interface IFilterSubscription {
 export type IFilter = IReceiver &
   IBaseProtocol & {
     createSubscription(
-      pubsubTopicShardInfo?: SingleShardInfo,
+      pubsubTopicShardInfo?: SingleShardInfo | PubsubTopic,
       peerId?: PeerId
     ): Promise<IFilterSubscription>;
   };

packages/interfaces/src/message.ts

@@ -46,6 +46,10 @@ export interface IMetaSetter {
 }
 
 export interface EncoderOptions {
+  /**
+   * @deprecated
+   */
+  pubsubTopic?: PubsubTopic;
   pubsubTopicShardInfo?: SingleShardInfo;
   /** The content topic to set on outgoing messages. */
   contentTopic: string;

packages/interfaces/src/protocols.ts

@@ -5,6 +5,7 @@ import type { Peer, PeerStore } from "@libp2p/interface/peer-store";
 import type { ShardInfo } from "./enr.js";
 import type { CreateLibp2pOptions } from "./libp2p.js";
 import type { IDecodedMessage } from "./message.js";
+import { PubsubTopic } from "./misc.js";
 
 export enum Protocols {
   Relay = "relay",
@@ -26,9 +27,20 @@ export type ContentTopicInfo = {
   contentTopics: string[];
 };
 
-export type ShardingParams = ShardInfo | ContentTopicInfo;
+export type ApplicationInfo = {
+  clusterId: number;
+  application: string;
+  version: string;
+};
+
+export type ShardingParams = ShardInfo | ContentTopicInfo | ApplicationInfo;
 
 export type ProtocolCreateOptions = {
+  /**
+   * @deprecated
+   * Waku will stop supporting named sharding. Only static sharding and autosharding will be supported moving forward.
+   */
+  pubsubTopics?: PubsubTopic[];
   /**
    * Waku supports usage of multiple pubsub topics. This is achieved through static sharding for now, and auto-sharding in the future.
    * The format to specify a shard is:

packages/message-encryption/src/ecies.ts

@@ -1,13 +1,14 @@
 import { Decoder as DecoderV0 } from "@waku/core/lib/message/version_0";
-import type {
-  EncoderOptions as BaseEncoderOptions,
-  IDecoder,
-  IEncoder,
-  IMessage,
-  IMetaSetter,
-  IProtoMessage,
-  PubsubTopic,
-  SingleShardInfo
+import {
+  type EncoderOptions as BaseEncoderOptions,
+  DefaultPubsubTopic,
+  type IDecoder,
+  type IEncoder,
+  type IMessage,
+  type IMetaSetter,
+  type IProtoMessage,
+  type PubsubTopic,
+  type SingleShardInfo
 } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
 import { determinePubsubTopic, Logger } from "@waku/utils";
@@ -79,6 +80,10 @@ class Encoder implements IEncoder {
 }
 
 export interface EncoderOptions extends BaseEncoderOptions {
+  /**
+   * @deprecated
+   */
+  pubsubTopic?: PubsubTopic;
   /** The public key to encrypt the payload for. */
   publicKey: Uint8Array;
   /**  An optional private key to be used to sign the payload before encryption. */
@@ -98,6 +103,7 @@ export interface EncoderOptions extends BaseEncoderOptions {
  * in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
  */
 export function createEncoder({
+  pubsubTopic,
   pubsubTopicShardInfo,
   contentTopic,
   publicKey,
@@ -106,7 +112,7 @@ export function createEncoder({
   metaSetter
 }: EncoderOptions): Encoder {
   return new Encoder(
-    determinePubsubTopic(contentTopic, pubsubTopicShardInfo),
+    determinePubsubTopic(contentTopic, pubsubTopic ?? pubsubTopicShardInfo),
     contentTopic,
     publicKey,
     sigPrivKey,
@@ -194,7 +200,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 export function createDecoder(
   contentTopic: string,
   privateKey: Uint8Array,
-  pubsubTopicShardInfo?: SingleShardInfo
+  pubsubTopicShardInfo: SingleShardInfo | PubsubTopic = DefaultPubsubTopic
 ): Decoder {
   return new Decoder(
     determinePubsubTopic(contentTopic, pubsubTopicShardInfo),

packages/message-encryption/src/symmetric.ts

@@ -1,13 +1,14 @@
 import { Decoder as DecoderV0 } from "@waku/core/lib/message/version_0";
-import type {
-  EncoderOptions as BaseEncoderOptions,
-  IDecoder,
-  IEncoder,
-  IMessage,
-  IMetaSetter,
-  IProtoMessage,
-  PubsubTopic,
-  SingleShardInfo
+import {
+  type EncoderOptions as BaseEncoderOptions,
+  DefaultPubsubTopic,
+  type IDecoder,
+  type IEncoder,
+  type IMessage,
+  type IMetaSetter,
+  type IProtoMessage,
+  type PubsubTopic,
+  type SingleShardInfo
 } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
 import { determinePubsubTopic, Logger } from "@waku/utils";
@@ -98,6 +99,7 @@ export interface EncoderOptions extends BaseEncoderOptions {
  * in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
  */
 export function createEncoder({
+  pubsubTopic = DefaultPubsubTopic,
   pubsubTopicShardInfo,
   contentTopic,
   symKey,
@@ -106,7 +108,7 @@ export function createEncoder({
   metaSetter
 }: EncoderOptions): Encoder {
   return new Encoder(
-    determinePubsubTopic(contentTopic, pubsubTopicShardInfo),
+    determinePubsubTopic(contentTopic, pubsubTopic ?? pubsubTopicShardInfo),
     contentTopic,
     symKey,
     sigPrivKey,
@@ -194,7 +196,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 export function createDecoder(
   contentTopic: string,
   symKey: Uint8Array,
-  pubsubTopicShardInfo?: SingleShardInfo
+  pubsubTopicShardInfo: SingleShardInfo | PubsubTopic = DefaultPubsubTopic
 ): Decoder {
   return new Decoder(
     determinePubsubTopic(contentTopic, pubsubTopicShardInfo),

packages/relay/src/index.ts

@@ -9,10 +9,10 @@ import { SignaturePolicy } from "@chainsafe/libp2p-gossipsub/types";
 import type { PeerId } from "@libp2p/interface/peer-id";
 import type { PubSub as Libp2pPubsub } from "@libp2p/interface/pubsub";
 import { sha256 } from "@noble/hashes/sha256";
-import { DefaultPubsubTopic } from "@waku/interfaces";
 import {
   ActiveSubscriptions,
   Callback,
+  DefaultPubsubTopic,
   IAsyncIterator,
   IDecodedMessage,
   IDecoder,
@@ -72,9 +72,11 @@ class Relay implements IRelay {
     }
 
     this.gossipSub = libp2p.services.pubsub as GossipSub;
-    this.pubsubTopics = options?.shardInfo
-      ? new Set(shardInfoToPubsubTopics(options.shardInfo))
-      : new Set([DefaultPubsubTopic]);
+    this.pubsubTopics = new Set(
+      options?.shardInfo
+        ? shardInfoToPubsubTopics(options.shardInfo)
+        : options?.pubsubTopics ?? [DefaultPubsubTopic]
+    );
 
     if (this.gossipSub.isStarted()) {
       this.subscribeToAllTopics();