feat: support creating node using application info or content topic

This commit adds SDK functions for creating a node by providing
an application/version or a list of content topics. The node is
configured to use autosharding.

packages/core/src/lib/waku.ts

@@ -8,7 +8,7 @@ import type {
   IStore,
   Libp2p,
   PubsubTopic,
-  ShardingParams,
+  ShardInfo,
   Waku
 } from "@waku/interfaces";
 import { DefaultPubsubTopic, Protocols } from "@waku/interfaces";
@@ -57,7 +57,7 @@ export class WakuNode implements Waku {
     options: WakuOptions,
     pubsubTopics: PubsubTopic[] = [],
     libp2p: Libp2p,
-    private pubsubShardInfo?: ShardingParams,
+    private pubsubShardInfo?: ShardInfo,
     store?: (libp2p: Libp2p) => IStore,
     lightPush?: (libp2p: Libp2p) => ILightPush,
     filter?: (libp2p: Libp2p) => IFilter,
@@ -110,7 +110,7 @@ export class WakuNode implements Waku {
     );
   }
 
-  get shardInfo(): ShardingParams | undefined {
+  get shardInfo(): ShardInfo | undefined {
     return this.pubsubShardInfo;
   }
 

packages/interfaces/src/waku.ts

@@ -2,10 +2,11 @@ import type { PeerId, Stream } from "@libp2p/interface";
 import type { Multiaddr } from "@multiformats/multiaddr";
 
 import { IConnectionManager } from "./connection_manager.js";
+import { ShardInfo } from "./enr.js";
 import type { IFilter } from "./filter.js";
 import type { Libp2p } from "./libp2p.js";
 import type { ILightPush } from "./light_push.js";
-import { Protocols, ShardingParams } from "./protocols.js";
+import { Protocols } from "./protocols.js";
 import type { IRelay } from "./relay.js";
 import type { IStore } from "./store.js";
 
@@ -16,7 +17,7 @@ export interface Waku {
   filter?: IFilter;
   lightPush?: ILightPush;
 
-  shardInfo?: ShardingParams;
+  shardInfo?: ShardInfo;
 
   connectionManager: IConnectionManager;
 

packages/sdk/src/create.ts

@@ -17,6 +17,8 @@ import {
 } from "@waku/core";
 import { enrTree, wakuDnsDiscovery } from "@waku/dns-discovery";
 import {
+  ApplicationInfo,
+  ContentTopicInfo,
   type CreateLibp2pOptions,
   type FullNode,
   type IMetadata,
@@ -39,20 +41,48 @@ const DEFAULT_NODE_REQUIREMENTS = {
 
 export { Libp2pComponents };
 
+export async function createNodeFromApplicationInfo(
+  applicationInfo: Partial<ApplicationInfo>,
+  options?: ProtocolCreateOptions & WakuOptions & Partial<RelayCreateOptions>
+): Promise<LightNode> {
+  options = options ?? {};
+  const shardInfo = ensureShardingConfigured(applicationInfo);
+  options.shardInfo = shardInfo.shardingParams;
+  return _createNode(shardInfo.shardInfo, options);
+}
+
+export async function createNodeFromContentTopics(
+  contentTopicInfo: Partial<ContentTopicInfo>,
+  options?: ProtocolCreateOptions & WakuOptions & Partial<RelayCreateOptions>
+): Promise<LightNode> {
+  options = options ?? {};
+  const shardInfo = ensureShardingConfigured(contentTopicInfo);
+  options.shardInfo = shardInfo.shardingParams;
+  return _createNode(shardInfo.shardInfo, options);
+}
+
 /**
  * Create a Waku node configured to use autosharding or static sharding.
  */
 export async function createNode(
   options?: ProtocolCreateOptions & WakuOptions & Partial<RelayCreateOptions>
 ): Promise<LightNode> {
   options = options ?? {};
-
   if (!options.shardInfo) {
     throw new Error("Shard info must be set");
   }
-
   const shardInfo = ensureShardingConfigured(options.shardInfo);
+  options.shardInfo = shardInfo.shardingParams;
+  return _createNode(shardInfo.shardInfo, options);
+}
 
+/**
+ * Create a Waku node configured to use autosharding or static sharding.
+ */
+export async function _createNode(
+  shardInfo: ShardInfo,
+  options: ProtocolCreateOptions & WakuOptions & Partial<RelayCreateOptions>
+): Promise<LightNode> {
   const libp2pOptions = options?.libp2p ?? {};
   const peerDiscovery = libp2pOptions.peerDiscovery ?? [];
   if (options?.defaultBootstrap) {
@@ -61,7 +91,7 @@ export async function createNode(
   }
 
   const libp2p = await defaultLibp2p(
-    shardInfo.shardInfo,
+    shardInfo,
     wakuGossipSub(options),
     libp2pOptions,
     options?.userAgent
@@ -75,7 +105,7 @@ export async function createNode(
     options ?? {},
     [],
     libp2p,
-    shardInfo.shardInfo,
+    shardInfo,
     store,
     lightPush,
     filter
@@ -118,7 +148,7 @@ export async function createLightNode(
     options ?? {},
     options.pubsubTopics,
     libp2p,
-    shardInfo?.shardingParams,
+    shardInfo?.shardInfo,
     store,
     lightPush,
     filter
@@ -170,7 +200,7 @@ export async function createFullNode(
     options ?? {},
     options.pubsubTopics,
     libp2p,
-    shardInfo?.shardingParams,
+    shardInfo?.shardInfo,
     store,
     lightPush,
     filter,

packages/sdk/src/relay/index.ts

@@ -44,7 +44,7 @@ export async function createRelayNode(
     options,
     options.pubsubTopics,
     libp2p,
-    shardInfo?.shardingParams,
+    shardInfo?.shardInfo,
     undefined,
     undefined,
     undefined,

packages/tests/tests/sharding/running_nodes.spec.ts

@@ -1,4 +1,5 @@
 import {
+  DEFAULT_CLUSTER_ID,
   LightNode,
   Protocols,
   ShardInfo,
@@ -7,6 +8,8 @@ import {
 import {
   createEncoder,
   createLightNode,
+  createNodeFromApplicationInfo,
+  createNodeFromContentTopics,
   utf8ToBytes,
   waitForRemotePeer
 } from "@waku/sdk";
@@ -166,4 +169,45 @@ describe("Autosharding: Running Nodes", () => {
     expect(request1.recipients.length).to.eq(1);
     expect(request2.recipients.length).to.eq(1);
   });
+
+  it("create node with application and version", async function () {
+    this.timeout(15_000);
+    waku = await createNodeFromApplicationInfo({
+      application: "myapp",
+      version: "1"
+    });
+    await waku.dial(await nwaku.getMultiaddrWithId());
+    await waitForRemotePeer(waku, [Protocols.LightPush]);
+
+    const encoder1 = createEncoder({
+      contentTopic: ContentTopic2,
+      pubsubTopicShardInfo: {
+        clusterId: DEFAULT_CLUSTER_ID,
+        shard: contentTopicToShardIndex(ContentTopic2)
+      }
+    });
+    await waku.lightPush.send(encoder1, {
+      payload: utf8ToBytes("Hello World")
+    });
+  });
+
+  it("create node with content topic", async function () {
+    this.timeout(15_000);
+    waku = await createNodeFromContentTopics({
+      contentTopics: [ContentTopic2]
+    });
+    await waku.dial(await nwaku.getMultiaddrWithId());
+    await waitForRemotePeer(waku, [Protocols.LightPush]);
+
+    const encoder1 = createEncoder({
+      contentTopic: ContentTopic2,
+      pubsubTopicShardInfo: {
+        clusterId: DEFAULT_CLUSTER_ID,
+        shard: contentTopicToShardIndex(ContentTopic2)
+      }
+    });
+    await waku.lightPush.send(encoder1, {
+      payload: utf8ToBytes("Hello World")
+    });
+  });
 });