Class Waku

Hierarchy

Waku

Index

Constructors

constructor

Properties

Methods

Constructors

Private constructor

new Waku(options: waku.CreateOptions, libp2p: Libp2p, store: WakuStore, lightPush: WakuLightPush): Waku

- Defined in src/lib/waku.ts:112
Parameters
- options: waku.CreateOptions
- libp2p: Libp2p
- store: WakuStore
- lightPush: WakuLightPush
Returns Waku

Properties

libp2p

libp2p: Libp2p

lightPush

lightPush: WakuLightPush

Private pingKeepAliveTimers

pingKeepAliveTimers: {}

Type declaration

[peer: string]: ReturnType<typeof setInterval>

relay

relay: WakuRelay

Private relayKeepAliveTimers

relayKeepAliveTimers: {}

Type declaration

[peer: string]: ReturnType<typeof setInterval>

store

store: WakuStore

Methods

addDecryptionKey

addDecryptionKey(key: string | Uint8Array): void

- Defined in src/lib/waku.ts:273
Register a decryption key to attempt decryption of messages received via WakuRelay and WakuStore. This can either be a private key for asymmetric encryption or a symmetric key.

Strings must be in hex format.

Parameters
- key: string | Uint8Array
Returns void

addPeerToAddressBook

addPeerToAddressBook(peerId: string | PeerId, multiaddrs: string[] | Multiaddr[]): void

- Defined in src/lib/waku.ts:242
Add peer to address book, it will be auto-dialed in the background.

Parameters
- peerId: string | PeerId
- multiaddrs: string[] | Multiaddr[]
Returns void

deleteDecryptionKey

deleteDecryptionKey(key: string | Uint8Array): void

- Defined in src/lib/waku.ts:284
Delete a decryption key that was used to attempt decryption of messages received via WakuRelay or WakuStore.

Strings must be in hex format.

Parameters
- key: string | Uint8Array
Returns void

dial

dial(peer: string | Multiaddr | PeerId): Promise<{ protocol: string; stream: MuxedStream }>

- Defined in src/lib/waku.ts:232
Dials to the provided peer.

Parameters
- peer: string | Multiaddr | PeerId
  
  The peer to dial
Returns Promise<{ protocol: string; stream: MuxedStream }>

getLocalMultiaddrWithID

getLocalMultiaddrWithID(): string

- Defined in src/lib/waku.ts:293
Return the local multiaddr with peer id on which libp2p is listening.

throws
if libp2p is not listening on localhost

Returns string

Private startKeepAlive

startKeepAlive(peerId: PeerId, pingPeriodSecs: number, relayPeriodSecs: number): void

- Defined in src/lib/waku.ts:342
Parameters
- peerId: PeerId
- pingPeriodSecs: number
- relayPeriodSecs: number
Returns void

stop

stop(): Promise<void>

- Defined in src/lib/waku.ts:262
Returns Promise<void>

Private stopKeepAlive

stopKeepAlive(peerId: PeerId): void

- Defined in src/lib/waku.ts:367
Parameters
- peerId: PeerId
Returns void

waitForConnectedPeer

waitForConnectedPeer(): Promise<void>

- Defined in src/lib/waku.ts:308
Wait to be connected to a peer. Useful when using the CreateOptions.bootstrap with Waku.create. The Promise resolves only once we are connected to a Store peer, Relay peer and Light Push peer.

Returns Promise<void>

Static create

create(options?: waku.CreateOptions): Promise<Waku>

- Defined in src/lib/waku.ts:146
Create new waku node

Parameters
- Optional options: waku.CreateOptions
  
  Takes the same options than Libp2p.
Returns Promise<Waku>

Generated using TypeDoc