Class WakuLightPush

Implements the Waku v2 Light Push protocol.

Hierarchy

WakuLightPush

Index

Constructors

Properties

libp2p pubSubTopic

Methods

peers push randomPeer

Constructors

constructor

new WakuLightPush(libp2p: Libp2p, options?: waku_light_push.CreateOptions): WakuLightPush
Parameters
- libp2p: Libp2p
- Optional options: waku_light_push.CreateOptions
Returns WakuLightPush
- Defined in src/lib/waku_light_push/index.ts:50

Properties

libp2p

libp2p: Libp2p

pubSubTopic

pubSubTopic: string

Methods

peers

peers(): Promise<Peer[]>
Returns known peers from the address book (libp2p.peerStore) that support light push protocol. Waku may or may not be currently connected to these peers.

Returns Promise<Peer[]>
- Defined in src/lib/waku_light_push/index.ts:125

push

push(encoder: Encoder, message: Message, opts?: PushOptions): Promise<SendResult>
Parameters
- encoder: Encoder
- message: Message
- Optional opts: PushOptions
Returns Promise<SendResult>
- Defined in src/lib/waku_light_push/index.ts:54

randomPeer

randomPeer(): Promise<undefined | Peer>
Returns a random peer that supports light push protocol from the address book (libp2p.peerStore). Waku may or may not be currently connected to this peer.

Returns Promise<undefined | Peer>
- Defined in src/lib/waku_light_push/index.ts:134

Generated using TypeDoc