Interface IRelayAPI

Interface representing the Relay API, providing control and information about the GossipSub protocol.

Property

The GossipSub instance used for managing pub/sub behavior.

Property

Function to start the relay, returning a Promise that resolves when initialization is complete.

Property

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.

Hierarchy

  • IRelayAPI

Properties

getMeshPeers gossipSub start

Properties

getMeshPeers

getMeshPeers: ((topic?: string) => string[])

Type declaration

    • (topic?: string): string[]

    • Parameters

      • Optional topic: string

      Returns string[]

Readonly gossipSub

gossipSub: GossipSub

start

start: (() => Promise<void>)

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc