feat: better create protocol options

packages/sdk/src/create/create.ts

@@ -0,0 +1,27 @@
+import type { LightNode } from "@waku/interfaces";
+
+import { CreateWakuNodeOptions, WakuNode } from "../waku.js";
+
+import { createLibp2pNode } from "./libp2p.js";
+import { buildCreateOptions, buildWakuNodeOptions } from "./options.js";
+
+/**
+ * Create a Waku node that uses Waku Light Push, Filter and Store to send and
+ * receive messages, enabling low resource consumption.
+ * Uses Waku Filter V2 by default.
+ */
+export async function createLightNode(
+  options: CreateWakuNodeOptions = {}
+): Promise<LightNode> {
+  const createOptions = buildCreateOptions(options);
+  const libp2p = await createLibp2pNode(createOptions);
+  const wakuNodeOptions = buildWakuNodeOptions(createOptions);
+
+  const protocols = {
+    store: true,
+    lightpush: true,
+    filter: true
+  };
+
+  return new WakuNode(wakuNodeOptions, libp2p, protocols) as LightNode;
+}

packages/sdk/src/create/index.ts

@@ -0,0 +1,2 @@
+export { createLightNode } from "./create.js";
+export { defaultLibp2p } from "./libp2p.js";

packages/sdk/src/utils/libp2p.ts → packages/sdk/src/create/libp2p.ts

@@ -86,30 +86,19 @@
       ...pubsubService,
       ...options?.services
     }
   }) as any as Libp2p; // TODO: make libp2p include it;
 }
 
 export async function createLibp2pAndUpdateOptions(
   options: CreateWakuNodeOptions
 ): Promise<Libp2p> {
-  logWhichShardInfoIsUsed(options);
-
-  if (options.contentTopics) {
-    options.shardInfo = { contentTopics: options.contentTopics };
-  }
-
-  const shardInfo = options.shardInfo
-    ? ensureShardingConfigured(options.shardInfo)
-    : undefined;
-
-  options.pubsubTopics = shardInfo?.pubsubTopics ??
-    options.pubsubTopics ?? [DefaultPubsubTopic];
+  const shardInfo = configureNetworkOptions(options);
 
   const libp2pOptions = options?.libp2p ?? {};
   const peerDiscovery = libp2pOptions.peerDiscovery ?? [];
 
   if (options?.defaultBootstrap) {
-    peerDiscovery.push(...defaultPeerDiscoveries(options.pubsubTopics));
+    peerDiscovery.push(...defaultPeerDiscoveries(options.pubsubTopics!));
   }
 
   if (options?.bootstrapPeers) {
@@ -119,7 +108,7 @@
   libp2pOptions.peerDiscovery = peerDiscovery;
 
   const libp2p = await defaultLibp2p(
-    shardInfo?.shardInfo,
+    shardInfo,
     wakuGossipSub(options),
     libp2pOptions,
     options?.userAgent
@@ -128,6 +117,37 @@
   return libp2p;
 }
 
+function configureNetworkOptions(
+  options: CreateWakuNodeOptions
+): ShardInfo | undefined {
+  const flags = [
+    options.contentTopics,
+    options.pubsubTopics,
+    options.shardInfo
+  ].filter((v) => !!v);
+
+  if (flags.length > 1) {
+    throw Error(
+      "Too many network configurations provided. Pass only one of: pubsubTopic, contentTopics or shardInfo."
+    );
+  }
+
+  logWhichShardInfoIsUsed(options);
+
+  if (options.contentTopics) {
+    options.shardInfo = { contentTopics: options.contentTopics };
+  }
+
+  const shardInfo = options.shardInfo
+    ? ensureShardingConfigured(options.shardInfo)
+    : undefined;
+
+  options.pubsubTopics = shardInfo?.pubsubTopics ??
+    options.pubsubTopics ?? [DefaultPubsubTopic];
+
+  return shardInfo?.shardInfo;
+}
+
 function logWhichShardInfoIsUsed(options: CreateWakuNodeOptions): void {
   if (options.pubsubTopics) {
     logger.info("Using pubsubTopics array to bootstrap the node.");

packages/sdk/src/index.ts

@@ -7,11 +7,10 @@ export {
 
 export { utf8ToBytes, bytesToUtf8 } from "@waku/utils/bytes";
 
-export { defaultLibp2p } from "./utils/libp2p.js";
 export * from "./utils/content_topic.js";
 export * from "./waku.js";
 
-export { createLightNode } from "./light-node/index.js";
+export { createLightNode, defaultLibp2p } from "./create/index.js";
 export { wakuLightPush } from "./protocols/light_push.js";
 export { wakuFilter } from "./protocols/filter.js";
 export { wakuStore } from "./protocols/store.js";

packages/sdk/src/relay-node/index.ts

@@ -1,7 +1,7 @@
 import { type FullNode, type RelayNode } from "@waku/interfaces";
 import { RelayCreateOptions } from "@waku/relay";
 
-import { createLibp2pAndUpdateOptions } from "../utils/libp2p.js";
+import { createLibp2pAndUpdateOptions } from "../create/libp2p.js";
 import { CreateWakuNodeOptions, WakuNode, WakuOptions } from "../waku.js";
 
 /**

packages/sdk/src/utils/content_topic.ts

@@ -12,7 +12,7 @@ import {
   shardInfoToPubsubTopics
 } from "@waku/utils";
 
-import { createLightNode } from "../light-node/index.js";
+import { createLightNode } from "../create/index.js";
 
 interface CreateTopicOptions {
   waku?: LightNode;

packages/tests/tests/filter/utils.ts

@@ -92,11 +92,15 @@ export async function runMultipleNodes(
     staticNoiseKey: NOISE_KEY_1,
     libp2p: {
       addresses: { listen: ["/ip4/0.0.0.0/tcp/0/ws"] }
-    },
-    pubsubTopics,
-    shardInfo
+    }
   };
 
+  if (shardInfo) {
+    waku_options.shardInfo = shardInfo;
+  } else {
+    waku_options.pubsubTopics = pubsubTopics;
+  }
+
   log.info("Starting js waku node with :", JSON.stringify(waku_options));
   let waku: LightNode | undefined;
   try {