setup the metadata protocol as a service

Author: danisharora099

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

@@ -1,6 +1,6 @@
 import type { PeerId } from "@libp2p/interface/peer-id";
 import { IncomingStreamData } from "@libp2p/interface/stream-handler";
-import type { IMetadata, Libp2p, ShardInfo } from "@waku/interfaces";
+import type { IMetadata, Libp2pComponents, ShardInfo } from "@waku/interfaces";
 import { proto_metadata } from "@waku/proto";
 import { Logger } from "@waku/utils";
 import all from "it-all";
@@ -16,10 +16,10 @@ export const MetadataCodec = "/vac/waku/metadata/1.0.0";
 
 class Metadata extends BaseProtocol {
   private readonly shardInfo: ShardInfo;
-  constructor(shardInfo: ShardInfo, libp2p: Libp2p) {
+  constructor(shardInfo: ShardInfo, libp2p: Libp2pComponents) {
     super(MetadataCodec, libp2p.components);
     this.shardInfo = shardInfo;
-    void libp2p.handle(MetadataCodec, (streamData) => {
+    void libp2p.registrar.handle(MetadataCodec, (streamData) => {
       void this.onRequest(streamData);
     });
   }
@@ -97,6 +97,6 @@ class Metadata extends BaseProtocol {
 
 export function wakuMetadata(
   shardInfo: ShardInfo
-): (libp2p: Libp2p) => IMetadata {
-  return (libp2p: Libp2p) => new Metadata(shardInfo, libp2p);
+): (components: Libp2pComponents) => IMetadata {
+  return (components: Libp2pComponents) => new Metadata(shardInfo, components);
 }

packages/interfaces/src/libp2p.ts

@@ -4,8 +4,11 @@ import type { Libp2pInit, Libp2pOptions } from "libp2p";
 import type { identifyService } from "libp2p/identify";
 import type { PingService } from "libp2p/ping";
 
+import { IMetadata } from ".";
+
 export type Libp2pServices = {
   ping: PingService;
+  metadata?: IMetadata;
   pubsub?: GossipSub;
   identify: ReturnType<ReturnType<typeof identifyService>>;
 };

packages/sdk/src/create.ts

@@ -8,6 +8,7 @@ import {
   DefaultUserAgent,
   wakuFilter,
   wakuLightPush,
+  wakuMetadata,
   WakuNode,
   WakuOptions,
   wakuStore
@@ -20,7 +21,8 @@ import type {
   Libp2pComponents,
   LightNode,
   ProtocolCreateOptions,
-  RelayNode
+  RelayNode,
+  ShardInfo
 } from "@waku/interfaces";
 import { wakuPeerExchangeDiscovery } from "@waku/peer-exchange";
 import { RelayCreateOptions, wakuGossipSub, wakuRelay } from "@waku/relay";
@@ -54,6 +56,7 @@ export async function createLightNode(
   }
 
   const libp2p = await defaultLibp2p(
+    options.shardInfo,
     undefined,
     libp2pOptions,
     options?.userAgent
@@ -90,6 +93,7 @@ export async function createRelayNode(
   }
 
   const libp2p = await defaultLibp2p(
+    options.shardInfo,
     wakuGossipSub(options),
     libp2pOptions,
     options?.userAgent
@@ -134,6 +138,7 @@ export async function createFullNode(
   }
 
   const libp2p = await defaultLibp2p(
+    options.shardInfo,
     wakuGossipSub(options),
     libp2pOptions,
     options?.userAgent
@@ -170,6 +175,7 @@ type PubsubService = {
 };
 
 export async function defaultLibp2p(
+  shardInfo?: ShardInfo,
   wakuGossipSub?: PubsubService["pubsub"],
   options?: Partial<CreateLibp2pOptions>,
   userAgent?: string
@@ -191,6 +197,8 @@ export async function defaultLibp2p(
     ? { pubsub: wakuGossipSub }
     : {};
 
+  const metadataService = shardInfo && wakuMetadata(shardInfo);
+
   return createLibp2p({
     connectionManager: {
       minConnections: 1
@@ -204,6 +212,7 @@ export async function defaultLibp2p(
         agentVersion: userAgent ?? DefaultUserAgent
       }),
       ping: pingService(),
+      metadata: metadataService,
       ...pubsubService,
       ...options?.services
     }

packages/tests/tests/metadata.spec.ts

@@ -1,4 +1,4 @@
-import { MetadataCodec, wakuMetadata } from "@waku/core";
+import { MetadataCodec } from "@waku/core";
 import type { LightNode, ShardInfo } from "@waku/interfaces";
 import { createLightNode } from "@waku/sdk";
 import { shardInfoToPubsubTopics } from "@waku/utils";
@@ -40,12 +40,12 @@ describe("Metadata Protocol", () => {
       const nwaku1Ma = await nwaku1.getMultiaddrWithId();
       const nwaku1PeerId = await nwaku1.getPeerId();
 
-      waku = await createLightNode();
+      waku = await createLightNode({ shardInfo });
       await waku.start();
-      const metadata = wakuMetadata(shardInfo)(waku.libp2p);
       await waku.libp2p.dialProtocol(nwaku1Ma, MetadataCodec);
 
-      const shardInfoRes = await metadata.query(nwaku1PeerId);
+      const shardInfoRes =
+        await waku.libp2p.services.metadata?.query(nwaku1PeerId);
       expect(shardInfoRes).to.not.be.undefined;
       expect(shardInfoRes?.clusterId).to.equal(shardInfo.clusterId);
       expect(shardInfoRes?.shards).to.deep.equal(shardInfo.shards);