@waku/interfaces/src/metadata.ts

Definition of Waku interfaces

import type { PeerId } from "@libp2p/interface";

import { ThisOrThat } from "./misc.js";
import type { ClusterId, ShardInfo } from "./sharding.js";

export type MetadataQueryResult = ThisOrThat<"shardInfo", ShardInfo>;

export interface IMetadata {
  readonly multicodec: string;
  readonly clusterId: ClusterId;
  confirmOrAttemptHandshake(peerId: PeerId): Promise<MetadataQueryResult>;
  query(peerId: PeerId): Promise<MetadataQueryResult>;
}