mirror of
https://github.com/logos-messaging/js-waku.git
synced 2026-01-11 10:13:13 +00:00
9fe04d85f3
* chore: change all references of pubSubTopic to pubsubTopic * change references of pubSubTopics to pubsubTopics * flag words in cspell
23 lines
989 B
TypeScript
23 lines
989 B
TypeScript
import type { GossipSub } from "@chainsafe/libp2p-gossipsub";
|
|
import type { PeerIdStr, TopicStr } from "@chainsafe/libp2p-gossipsub/types";
|
|
|
|
import { PubSubTopic } from "./misc.js";
|
|
import { IReceiver } from "./receiver.js";
|
|
import type { ISender } from "./sender.js";
|
|
|
|
/**
|
|
* Interface representing the Relay API, providing control and information about the GossipSub protocol.
|
|
*
|
|
* @property gossipSub - The GossipSub instance used for managing pub/sub behavior.
|
|
* @property start - Function to start the relay, returning a Promise that resolves when initialization is complete.
|
|
* @property getMeshPeers - Function to retrieve the mesh peers for a given topic or all topics if none is specified. Returns an array of peer IDs as strings.
|
|
*/
|
|
export interface IRelayAPI {
|
|
readonly pubsubTopics: Set<PubSubTopic>;
|
|
readonly gossipSub: GossipSub;
|
|
start: () => Promise<void>;
|
|
getMeshPeers: (topic?: TopicStr) => PeerIdStr[];
|
|
}
|
|
|
|
export type IRelay = IRelayAPI & ISender & IReceiver;
|