mirror of
https://github.com/logos-messaging/js-waku.git
synced 2026-01-04 23:03:07 +00:00
75fcca4cd9
* fix comment of default number of peers * export default number of peers from base protocol sdk * rename to light_push, move class to separate file * move waitForRemotePeer to sdk package * add todo to move waitForGossipSubPeerInMesh into @waku/relay * clean up waitForRemotePeer, split metadata await from event and optimise, decouple from protocol implementations * simplify and rename ILightPush interface * use only connected peers in light push based on connections instead of peer renewal mechanism * improve readability of result processing in light push * fix check & update tests * address tests, add new test cases, fix racing condition in StreamManager * use libp2p.getPeers * feat: confirm metadata and protocols needed in waitForRemotePeer * rely on passed protocols and fallback to mounted * add I prefix to Waku interface * implement waku.connect method * add docs to IWaku interface * remove export and usage of waitForRemotePeer * move wait for remote peer related to Realy out of @waku/sdk * change tests to use new API * fix linting * update size limit * rename .connect to .waitForPeer * export waitForRemotePeer and mark as deprecated * feat: add mocha tests to @waku/sdk and cover waitForRemotePeer (#2163) * feat: add mocha tests to @waku/sdk and cover waitForRemotePeer * add waitForRemote UTs * remove junk * feat: expose peerId and protocols from WakuNode (#2166) * chore: expose peerId and protocols from WakuNode * remove unused method * move to private method * rename to waitForPeers * up test
24 lines
1.0 KiB
TypeScript
24 lines
1.0 KiB
TypeScript
import type { GossipSub } from "@chainsafe/libp2p-gossipsub";
|
|
import type { PeerIdStr, TopicStr } from "@chainsafe/libp2p-gossipsub/types";
|
|
|
|
import type { PubsubTopic } from "./misc.js";
|
|
import type { 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>;
|
|
waitForPeers: () => Promise<void>;
|
|
getMeshPeers: (topic?: TopicStr) => PeerIdStr[];
|
|
}
|
|
|
|
export type IRelay = IRelayAPI & ISender & IReceiver;
|