Class Relay

constructor

• new Relay(params: RelayConstructorParams): Relay

  Parameters

  • params: RelayConstructorParams

  Returns Relay

ReadonlygossipSub

pubsubTopics

subscribe

Staticmulticodec

getActiveSubscriptions

• getActiveSubscriptions(): ActiveSubscriptions

  Returns ActiveSubscriptions

getMeshPeers

• getMeshPeers(topic?: string): string[]

  Parameters

  • Optionaltopic: string

  Returns string[]

send

• send(encoder: IEncoder, message: IMessage): Promise<LightPushSDKResult>

  Send Waku message.

  Parameters

  • encoder: IEncoder
  • message: IMessage

  Returns Promise<LightPushSDKResult>

start

• start(): Promise<void>

  Mounts the gossipsub protocol onto the libp2p node and subscribes to all the topics.

  Returns Promise<void>

stop

• stop(): Promise<void>

  Returns Promise<void>

subscribeWithUnsubscribe

• subscribeWithUnsubscribe<T extends IDecodedMessage>(
      decoders: IDecoder<T> | IDecoder<T>[],
      callback: Callback<T>,
  ): () => void

  Type Parameters

  • T extends IDecodedMessage

  Parameters

  • decoders: IDecoder<T> | IDecoder<T>[]
  • callback: Callback<T>

  Returns () => void

toSubscriptionIterator

• toSubscriptionIterator<T extends IDecodedMessage>(
      decoders: IDecoder<T> | IDecoder<T>[],
  ): Promise<IAsyncIterator<T>>

  Type Parameters

  • T extends IDecodedMessage

  Parameters

  • decoders: IDecoder<T> | IDecoder<T>[]

  Returns Promise<IAsyncIterator<T>>

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>