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 { Libp2pOptions } from "libp2p";

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

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

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

export type ProtocolCreateOptions = {
  /**
   * The PubSub Topic to use. Defaults to {@link @waku/core.DefaultPubSubTopic }.
   *
   * One and only one pubsub topic is used by Waku. This is used by:
   * - WakuRelay to receive, route and send messages,
   * - WakuLightPush to send messages,
   * - WakuStore to retrieve messages.
   *
   * The usage of the default pubsub topic is recommended.
   * See [Waku v2 Topic Usage Recommendations](https://rfc.vac.dev/spec/23/) for details.
   *
   */
  pubSubTopic?: string;
  /**
   * You can pass options to the `Libp2p` instance used by {@link @waku/core.WakuNode} using the `libp2p` property.
   * This property is the same type as the one passed to [`Libp2p.create`](https://github.com/libp2p/js-libp2p/blob/master/doc/API.md#create)
   * apart that we made the `modules` property optional and partial,
   * allowing its omission and letting Waku set good defaults.
   * Notes that some values are overridden by {@link @waku/core.WakuNode} to ensure it implements the Waku protocol.
   */
  libp2p?: Partial<Libp2pOptions>;
  /**
   * Byte array used as key for the noise protocol used for connection encryption
   * by [`Libp2p.create`](https://github.com/libp2p/js-libp2p/blob/master/doc/API.md#create)
   * This is only used for test purposes to not run out of entropy during CI runs.
   */
  staticNoiseKey?: Uint8Array;
  /**
   * Use recommended bootstrap method to discovery and connect to new nodes.
   */
  defaultBootstrap?: boolean;
  /**
   * FilterV2 has been set to default
   * Use this flag to enable the previous version of the filter protocol
   * See [Improved Filter protocol specifications](https://github.com/vacp2p/rfc/pull/562)
   */
  useFilterV1?: boolean;
};

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

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

export enum SendError {
  GENERIC_FAIL = "Generic error",
  ENCODE_FAILED = "Failed to encode",
  DECODE_FAILED = "Failed to decode",
  SIZE_TOO_BIG = "Size is too big",
  NO_RPC_RESPONSE = "No RPC response",
}

export interface SendResult {
  error?: SendError;
  recipients: PeerId[];
}