chore: changing default pubsub topic to its static sharding version (#…

…2083) * changing default pubsub topic to its static sharding version * keeping RFC's Waku Message test vectors * reverting change in changelog * setting pubsub topic when creating nwaku node * adding shardInfo to runMultipleNodes call * adding shardInfo to runMultipleNodes call in lightpush tests * add pubsub topics to nwaku.start * get rid of it.only that remained * fixing compliance tests * setting clusterId to 0 * removing unnecessary fix * adding shardInfo when creating nodes * fixing wait for remote peer tests * fixing peer exchange test * refactor * removing unnecessary variable * feat: create default shard info, update tests (#2085) * feat: create default shard info, update tests * add link * fix tests * remoe only * up tests * up test --------- Co-authored-by: Sasha <[email protected]>
waku-org · Jul 25, 2024 · 08fc2d1 · 08fc2d1
1 parent 04bd518
commit 08fc2d1
Show file tree

Hide file tree

Showing 24 changed files with 189 additions and 120 deletions.
diff --git a/packages/discovery/src/dns/constants.ts b/packages/discovery/src/dns/constants.ts
@@ -3,14 +3,11 @@ import type { NodeCapabilityCount } from "@waku/interfaces";
 /**
  * The ENR tree for the different fleets.
  * SANDBOX and TEST fleets are for The Waku Network.
- * DEPRECATED_DEFAULT_PUBSUB is the fleet of nodes supporting the now deprecated DefaultPubsubTopic.
  */
 export const enrTree = {
   SANDBOX:
     "enrtree://AIRVQ5DDA4FFWLRBCHJWUWOO6X6S4ZTZ5B667LQ6AJU6PEYDLRD5O@sandbox.waku.nodes.status.im",
-  TEST: "enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im",
-  DEPRECATED_DEFAULT_PUBSUB:
-    "enrtree://ANEDLO25QVUGJOUTQFRYKWX6P4Z4GKVESBMHML7DZ6YK4LGS5FC5O@prod.wakuv2.nodes.status.im"
+  TEST: "enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im"
 };
 
 export const DEFAULT_BOOTSTRAP_TAG_NAME = "bootstrap";

diff --git a/packages/interfaces/src/constants.ts b/packages/interfaces/src/constants.ts
@@ -1,9 +1,14 @@
-/**
- * DefaultPubsubTopic is the default gossipsub topic to use for Waku.
- */
-export const DefaultPubsubTopic = "/waku/2/default-waku/proto";
+import { ShardInfo } from "./enr";
 
 /**
  * The default cluster ID for The Waku Network
  */
 export const DEFAULT_CLUSTER_ID = 1;
+
+/**
+ * DefaultShardInfo is default configuration for The Waku Network.
+ */
+export const DefaultShardInfo: ShardInfo = {
+  clusterId: DEFAULT_CLUSTER_ID,
+  shards: [0, 1, 2, 3, 4, 5, 6, 7, 8]
+};
diff --git a/packages/interfaces/src/protocols.ts b/packages/interfaces/src/protocols.ts
@@ -73,31 +73,35 @@ export type ProtocolUseOptions = {
 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:
-   * clusterId: number, shards: number[]
-   * To learn more about the sharding specifications implemented, see [Relay Sharding](https://rfc.vac.dev/spec/51/).
-   * The Pubsub Topic to use. Defaults to {@link @waku/core!DefaultPubsubTopic }.
+   * Should be used ONLY if some other than The Waku Network is in use.
+   *
+   * See [Waku v2 Topic Usage Recommendations](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/23/topics.md#pubsub-topics) for details.
    *
-   * If no pubsub topic is specified, the default pubsub topic is used.
-   * The set of pubsub topics that are used to initialize the Waku node, will need to be used by the protocols as well
-   * You cannot currently add or remove pubsub topics after initialization.
    * This is used by:
    * - WakuRelay to receive, route and send messages,
    * - WakuLightPush to send messages,
    * - WakuStore to retrieve messages.
-   * See [Waku v2 Topic Usage Recommendations](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/23/topics.md) for details.
    *
+   * If no pubsub topic is specified, the default pubsub topic will be determined from DefaultShardInfo.
+   *
+   * You cannot add or remove pubsub topics after initialization of the node.
+   */
+  pubsubTopics?: PubsubTopic[];
+  /**
+   * ShardInfo is used to determine which network is in use.
+   * Defaults to {@link @waku/interfaces!DefaultShardInfo}.
+   * Default value is configured for The Waku Network
+   *
+   * The format to specify a shard is:
+   * clusterId: number, shards: number[]
+   * To learn more about the sharding specification, see [Relay Sharding](https://rfc.vac.dev/spec/51/).
    */
   shardInfo?: Partial<ShardingParams>;
   /**
-   * Content topics are used to determine pubsubTopics
-   * If not provided pubsubTopics will be determined based on shardInfo
-   * See [Waku v2 Topic Usage Recommendations](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/23/topics.md) for details.
+   * Content topics are used to determine network in use.
+   * See [Waku v2 Topic Usage Recommendations](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/23/topics.md#content-topics) for details.
+   *
+   * You cannot add or remove content topics after initialization of the node.
    */
   contentTopics?: string[];
   /**

diff --git a/packages/message-encryption/src/symmetric.ts b/packages/message-encryption/src/symmetric.ts
@@ -1,7 +1,6 @@
 import { Decoder as DecoderV0 } from "@waku/core/lib/message/version_0";
 import {
   type EncoderOptions as BaseEncoderOptions,
-  DefaultPubsubTopic,
   type IDecoder,
   type IEncoder,
   type IMessage,
@@ -101,7 +100,7 @@ export interface EncoderOptions extends BaseEncoderOptions {
  * in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
  */
 export function createEncoder({
-  pubsubTopic = DefaultPubsubTopic,
+  pubsubTopic,
   pubsubTopicShardInfo,
   contentTopic,
   symKey,
@@ -198,7 +197,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 export function createDecoder(
   contentTopic: string,
   symKey: Uint8Array,
-  pubsubTopicShardInfo: SingleShardInfo | PubsubTopic = DefaultPubsubTopic
+  pubsubTopicShardInfo?: SingleShardInfo | PubsubTopic
 ): Decoder {
   return new Decoder(
     determinePubsubTopic(contentTopic, pubsubTopicShardInfo),

diff --git a/packages/relay/src/index.ts b/packages/relay/src/index.ts
@@ -11,7 +11,6 @@ import { sha256 } from "@noble/hashes/sha256";
 import {
   ActiveSubscriptions,
   Callback,
-  DefaultPubsubTopic,
   IAsyncIterator,
   IDecodedMessage,
   IDecoder,
@@ -75,9 +74,8 @@ class Relay implements IRelay {
 
     this.observers = new Map();
 
-    // Default PubsubTopic decoder
     // TODO: User might want to decide what decoder should be used (e.g. for RLN)
-    this.defaultDecoder = new TopicOnlyDecoder();
+    this.defaultDecoder = new TopicOnlyDecoder(pubsubTopics[0]);
   }
 
   /**
@@ -204,8 +202,9 @@ class Relay implements IRelay {
     return map;
   }
 
-  public getMeshPeers(topic: TopicStr = DefaultPubsubTopic): PeerIdStr[] {
-    return this.gossipSub.getMeshPeers(topic);
+  public getMeshPeers(topic?: TopicStr): PeerIdStr[] {
+    // if no TopicStr is provided - returns empty array
+    return this.gossipSub.getMeshPeers(topic || "");
   }
 
   private subscribeToAllTopics(): void {

diff --git a/packages/relay/src/topic_only_message.ts b/packages/relay/src/topic_only_message.ts
@@ -1,8 +1,8 @@
-import { DefaultPubsubTopic } from "@waku/interfaces";
 import type {
   IDecodedMessage,
   IDecoder,
-  IProtoMessage
+  IProtoMessage,
+  PubsubTopic
 } from "@waku/interfaces";
 import { TopicOnlyMessage as ProtoTopicOnlyMessage } from "@waku/proto";
 
@@ -23,10 +23,13 @@ export class TopicOnlyMessage implements IDecodedMessage {
   }
 }
 
+// This decoder is used only for reading `contentTopic` from the WakuMessage
 export class TopicOnlyDecoder implements IDecoder<TopicOnlyMessage> {
-  public pubsubTopic = DefaultPubsubTopic;
   public contentTopic = "";
 
+  // pubsubTopic is ignored
+  public constructor(public pubsubTopic: PubsubTopic) {}
+
   public fromWireToProtoObj(
     bytes: Uint8Array
   ): Promise<IProtoMessage | undefined> {

diff --git a/packages/sdk/src/create/discovery.ts b/packages/sdk/src/create/discovery.ts
@@ -5,11 +5,7 @@ import {
   wakuLocalPeerCacheDiscovery,
   wakuPeerExchangeDiscovery
 } from "@waku/discovery";
-import {
-  DefaultPubsubTopic,
-  type Libp2pComponents,
-  PubsubTopic
-} from "@waku/interfaces";
+import { type Libp2pComponents, PubsubTopic } from "@waku/interfaces";
 
 const DEFAULT_NODE_REQUIREMENTS = {
   lightPush: 1,
@@ -20,10 +16,7 @@ const DEFAULT_NODE_REQUIREMENTS = {
 export function defaultPeerDiscoveries(
   pubsubTopics: PubsubTopic[]
 ): ((components: Libp2pComponents) => PeerDiscovery)[] {
-  const isDefaultPubsubTopic = pubsubTopics.includes(DefaultPubsubTopic);
-  const dnsEnrTrees = isDefaultPubsubTopic
-    ? [enrTree["DEPRECATED_DEFAULT_PUBSUB"]]
-    : [enrTree["SANDBOX"], enrTree["TEST"]];
+  const dnsEnrTrees = [enrTree["SANDBOX"], enrTree["TEST"]];
 
   const discoveries = [
     wakuDnsDiscovery(dnsEnrTrees, DEFAULT_NODE_REQUIREMENTS),

diff --git a/packages/sdk/src/create/libp2p.ts b/packages/sdk/src/create/libp2p.ts
@@ -9,7 +9,7 @@ import { all as filterAll, wss } from "@libp2p/websockets/filters";
 import { wakuMetadata } from "@waku/core";
 import {
   type CreateLibp2pOptions,
-  DefaultPubsubTopic,
+  DefaultShardInfo,
   type IMetadata,
   type Libp2p,
   type Libp2pComponents,
@@ -138,12 +138,15 @@ function configureNetworkOptions(
     options.shardInfo = { contentTopics: options.contentTopics };
   }
 
+  if (!options.shardInfo) {
+    options.shardInfo = DefaultShardInfo;
+  }
+
   const shardInfo = options.shardInfo
     ? ensureShardingConfigured(options.shardInfo)
     : undefined;
 
-  options.pubsubTopics = shardInfo?.pubsubTopics ??
-    options.pubsubTopics ?? [DefaultPubsubTopic];
+  options.pubsubTopics = options.pubsubTopics ?? shardInfo?.pubsubTopics;
 
   return shardInfo?.shardInfo;
 }

diff --git a/packages/tests/src/constants.ts b/packages/tests/src/constants.ts
@@ -5,6 +5,8 @@
  * @module
  */
 
+import { PubsubTopic, ShardInfo, SingleShardInfo } from "@waku/interfaces";
+
 export const NOISE_KEY_1 = new Uint8Array(
   ((): number[] => {
     const b = [];
@@ -65,3 +67,13 @@ export const MOCHA_HOOK_MAX_TIMEOUT = 50_000;
 
 export const SEPOLIA_RPC_URL =
   process.env.SEPOLIA_RPC_URL || "https://sepolia.gateway.tenderly.co";
+
+export const DefaultTestPubsubTopic: PubsubTopic = "/waku/2/rs/0/0";
+export const DefaultTestShardInfo: ShardInfo = {
+  clusterId: 0,
+  shards: [0]
+};
+export const DefaultTestSingleShardInfo: SingleShardInfo = {
+  clusterId: 0,
+  shard: 0
+};
diff --git a/packages/tests/src/lib/index.ts b/packages/tests/src/lib/index.ts
@@ -1,12 +1,9 @@
 import { DecodedMessage } from "@waku/core";
-import {
-  DefaultPubsubTopic,
-  PubsubTopic,
-  ShardingParams
-} from "@waku/interfaces";
+import { PubsubTopic, ShardingParams } from "@waku/interfaces";
 import { ensureShardingConfigured, Logger } from "@waku/utils";
 import { expect } from "chai";
 
+import { DefaultTestPubsubTopic } from "../constants";
 import { Args, MessageRpcQuery, MessageRpcResponse } from "../types";
 import { delay, makeLogFileName } from "../utils/index.js";
 
@@ -105,7 +102,7 @@ export class ServiceNodesFleet {
 
   public async sendRelayMessage(
     message: MessageRpcQuery,
-    pubsubTopic: string = DefaultPubsubTopic
+    pubsubTopic: string = DefaultTestPubsubTopic
   ): Promise<boolean> {
     const relayMessagePromises: Promise<boolean>[] = this.nodes.map((node) =>
       node.sendMessage(message, pubsubTopic)
@@ -221,7 +218,7 @@ class MultipleNodesMessageCollector {
     }
   ): Promise<boolean> {
     const startTime = Date.now();
-    const pubsubTopic = options?.pubsubTopic || DefaultPubsubTopic;
+    const pubsubTopic = options?.pubsubTopic || DefaultTestPubsubTopic;
     const timeoutDuration = options?.timeoutDuration || 400;
     const exact = options?.exact || false;
 

diff --git a/packages/tests/src/lib/message_collector.ts b/packages/tests/src/lib/message_collector.ts
@@ -1,10 +1,10 @@
 import { DecodedMessage } from "@waku/core";
-import { DefaultPubsubTopic } from "@waku/interfaces";
 import { Logger } from "@waku/utils";
 import { bytesToUtf8, utf8ToBytes } from "@waku/utils/bytes";
 import { AssertionError, expect } from "chai";
 import { equals } from "uint8arrays/equals";
 
+import { DefaultTestPubsubTopic } from "../constants.js";
 import { MessageRpcResponse } from "../types.js";
 import { base64ToUtf8 } from "../utils/base64_utf8.js";
 import { delay } from "../utils/delay.js";
@@ -269,6 +269,8 @@ export class MessageCollector {
   }
 
   private getPubsubTopicToUse(pubsubTopic: string | undefined): string {
-    return pubsubTopic || this.nwaku?.pubsubTopics?.[0] || DefaultPubsubTopic;
+    return (
+      pubsubTopic || this.nwaku?.pubsubTopics?.[0] || DefaultTestPubsubTopic
+    );
   }
 }
diff --git a/packages/tests/src/lib/service_node.ts b/packages/tests/src/lib/service_node.ts
@@ -1,12 +1,12 @@
 import type { PeerId } from "@libp2p/interface";
 import { peerIdFromString } from "@libp2p/peer-id";
 import { Multiaddr, multiaddr } from "@multiformats/multiaddr";
-import { DefaultPubsubTopic } from "@waku/interfaces";
 import { isDefined } from "@waku/utils";
 import { Logger } from "@waku/utils";
 import pRetry from "p-retry";
 import portfinder from "portfinder";
 
+import { DefaultTestPubsubTopic } from "../constants.js";
 import {
   Args,
   LogLevel,
@@ -245,7 +245,7 @@ export class ServiceNode {
   }
 
   public async ensureSubscriptions(
-    pubsubTopics: string[] = [DefaultPubsubTopic]
+    pubsubTopics: string[] = [DefaultTestPubsubTopic]
   ): Promise<boolean> {
     return this.restCall<boolean>(
       "/relay/v1/subscriptions",
@@ -257,7 +257,7 @@ export class ServiceNode {
 
   public async messages(pubsubTopic?: string): Promise<MessageRpcResponse[]> {
     return this.restCall<MessageRpcResponse[]>(
-      `/relay/v1/messages/${encodeURIComponent(pubsubTopic || this?.args?.pubsubTopic?.[0] || DefaultPubsubTopic)}`,
+      `/relay/v1/messages/${encodeURIComponent(pubsubTopic || this?.args?.pubsubTopic?.[0] || DefaultTestPubsubTopic)}`,
       "GET",
       null,
       async (response) => {
@@ -291,7 +291,7 @@ export class ServiceNode {
     }
 
     return this.restCall<boolean>(
-      `/relay/v1/messages/${encodeURIComponent(pubsubTopic || this.args?.pubsubTopic?.[0] || DefaultPubsubTopic)}`,
+      `/relay/v1/messages/${encodeURIComponent(pubsubTopic || this.args?.pubsubTopic?.[0] || DefaultTestPubsubTopic)}`,
       "POST",
       message,
       async (response) => response.status === 200
@@ -411,7 +411,8 @@ export function defaultArgs(): Args {
     rest: true,
     restAdmin: true,
     websocketSupport: true,
-    logLevel: LogLevel.Trace
+    logLevel: LogLevel.Trace,
+    pubsubTopic: ["/waku/2/rs/0/0"]
   };
 }
 

diff --git a/packages/tests/tests/connection-mananger/connection_state.spec.ts b/packages/tests/tests/connection-mananger/connection_state.spec.ts
@@ -7,6 +7,7 @@ import { expect } from "chai";
 import {
   afterEachCustom,
   beforeEachCustom,
+  DefaultTestShardInfo,
   delay,
   NOISE_KEY_1
 } from "../../src/index.js";
@@ -28,7 +29,7 @@ describe("Connection state", function () {
   let nwaku2PeerId: Multiaddr;
 
   beforeEachCustom(this, async () => {
-    waku = await createLightNode({ shardInfo: { shards: [0] } });
+    waku = await createLightNode({ shardInfo: DefaultTestShardInfo });
     nwaku1 = new ServiceNode(makeLogFileName(this.ctx) + "1");
     nwaku2 = new ServiceNode(makeLogFileName(this.ctx) + "2");
     await nwaku1.start({ filter: true });
@@ -89,10 +90,12 @@ describe("Connection state", function () {
 
   it("`waku:online` between 2 js-waku relay nodes", async function () {
     const waku1 = await createRelayNode({
-      staticNoiseKey: NOISE_KEY_1
+      staticNoiseKey: NOISE_KEY_1,
+      shardInfo: DefaultTestShardInfo
     });
     const waku2 = await createRelayNode({
-      libp2p: { addresses: { listen: ["/ip4/0.0.0.0/tcp/0/ws"] } }
+      libp2p: { addresses: { listen: ["/ip4/0.0.0.0/tcp/0/ws"] } },
+      shardInfo: DefaultTestShardInfo
     });
 
     let eventCount1 = 0;