Class Relay

Implements the Waku v2 Relay protocol. Throws if libp2p.pubsub does not support Waku Relay

Implements

IRelay

Index

Constructors

Properties

defaultDecoder gossipSub observers pubsubTopics subscribe multicodec

Methods

getActiveSubscriptions getMeshPeers gossipSubSubscribe isRelayPubsub processIncomingMessage removeObservers send start subscribeToAllTopics subscribeWithUnsubscribe toSubscriptionIterator waitForPeers

Constructors

constructor

new Relay(params): Relay
Parameters
- params: RelayConstructorParams
Returns Relay
- Defined in relay.ts:67

Properties

`Private` defaultDecoder

defaultDecoder: IDecoder<IDecodedMessage>

`Readonly` gossipSub

gossipSub: GossipSub

`Private` observers

observers: Map<string, Map<string, Set<unknown>>>

observers called when receiving new message. Observers under key "" are always called.

`Readonly` pubsubTopics

pubsubTopics: Set<string>

subscribe

subscribe: (<T>(decoders, callback) => (() => void)) = ...

Type declaration

- <T>(decoders, callback): (() => void)
- Type Parameters
  - T extends IDecodedMessage
  Parameters
  - decoders: IDecoder<T> | IDecoder<T>[]
  - callback: Callback<T>
  Returns (() => void)
  - - (): void
    - Returns void

`Static` multicodec

multicodec: string = ...

Methods

getActiveSubscriptions

getActiveSubscriptions(): ActiveSubscriptions
Returns ActiveSubscriptions
- Defined in relay.ts:219

getMeshPeers

getMeshPeers(topic?): string[]
Parameters
- Optional topic: string
Returns string[]
Implementation of IRelay.getMeshPeers
- Defined in relay.ts:227

`Private` gossipSubSubscribe

gossipSubSubscribe(pubsubTopic): void
Subscribe to a pubsub topic and start emitting Waku messages to observers.
Parameters
- pubsubTopic: string
Returns void
- Defined in relay.ts:295

`Private` isRelayPubsub

isRelayPubsub(pubsub): boolean
Parameters
- pubsub: undefined | PubSub<PubSubEvents>
Returns boolean
- Defined in relay.ts:312

`Private` processIncomingMessage

processIncomingMessage<T>(pubsubTopic, bytes): Promise<void>
Type Parameters
- T extends IDecodedMessage
Parameters
- pubsubTopic: string
- bytes: Uint8Array
Returns Promise<void>
- Defined in relay.ts:238

`Private` removeObservers

removeObservers<T>(observers): void
Type Parameters
- T extends IDecodedMessage
Parameters
- observers: [string, Observer<T>][]
Returns void
- Defined in relay.ts:196

send

send(encoder, message): Promise<SDKProtocolResult>
Send Waku message.
Parameters
- encoder: IEncoder
- message: IMessage
Returns Promise<SDKProtocolResult>
Implementation of IRelay.send
- Defined in relay.ts:122

start

start(): Promise<void>
Mounts the gossipsub protocol onto the libp2p node and subscribes to all the topics.

Returns Promise<void>
Implementation of IRelay.start
- Defined in relay.ts:94

`Private` subscribeToAllTopics

subscribeToAllTopics(): void
Returns void
- Defined in relay.ts:232

subscribeWithUnsubscribe

subscribeWithUnsubscribe<T>(decoders, callback): (() => void)
Type Parameters
- T extends IDecodedMessage
Parameters
- decoders: IDecoder<T> | IDecoder<T>[]
- callback: Callback<T>
Returns (() => void)
- - (): void
  - Returns void
Implementation of IRelay.subscribeWithUnsubscribe
- Defined in relay.ts:171

toSubscriptionIterator

toSubscriptionIterator<T>(decoders): Promise<IAsyncIterator<T>>
Type Parameters
- T extends IDecodedMessage
Parameters
- decoders: IDecoder<T> | IDecoder<T>[]
Returns Promise<IAsyncIterator<T>>
Implementation of IRelay.toSubscriptionIterator
- Defined in relay.ts:213

waitForPeers

waitForPeers(): Promise<void>
Wait for at least one peer with the given protocol to be connected and in the gossipsub mesh for all pubsubTopics.

Returns Promise<void>
Implementation of IRelay.waitForPeers
- Defined in relay.ts:107