js-waku/packages/interfaces/src/protocols.ts

import type { PeerId } from "@libp2p/interface-peer-id";
import type { Peer, PeerStore } from "@libp2p/interface-peer-store";

import type { IMessage } from "./message.js";

export enum Protocols {
  Relay = "relay",
  Store = "store",
  LightPush = "lightpush",
  Filter = "filter",
  PeerExchange = "peer-exchange",
}

export interface PointToPointProtocol {
  multicodec: string;
  peerStore: PeerStore;
  peers: () => Promise<Peer[]>;
}

export type ProtocolOptions = {
  pubSubTopic?: string;
  /**
   * Optionally specify an PeerId for the protocol request. If not included, will use a random peer.
   */
  peerId?: PeerId;
};

export type Callback<T extends IMessage> = (msg: T) => void | Promise<void>;

export interface SendResult {
  recipients: PeerId[];
}