Class WakuNode

Hierarchy

WakuNode

Implements

Waku

Index

Constructors

Properties

filter? libp2p lightPush? pingKeepAliveTimers relay? relayKeepAliveTimers store?

Methods

addDecryptionKey addPeerToAddressBook deleteDecryptionKey dial getLocalMultiaddrWithID isStarted start startKeepAlive stop stopAllKeepAlives stopKeepAlive

Constructors

constructor

new WakuNode(options: WakuOptions, libp2p: Libp2p, store?: WakuStore, lightPush?: WakuLightPush, filter?: WakuFilter): WakuNode
Parameters
- options: WakuOptions
- libp2p: Libp2p
- Optional store: WakuStore
- Optional lightPush: WakuLightPush
- Optional filter: WakuFilter
Returns WakuNode
- Defined in src/lib/waku.ts:63

Properties

`Optional` filter

filter?: WakuFilter

libp2p

libp2p: Libp2p

`Optional` lightPush

lightPush?: WakuLightPush

`Private` pingKeepAliveTimers

pingKeepAliveTimers: { [peer: string]: ReturnType<typeof setInterval> }

Type declaration

[peer: string]: ReturnType<typeof setInterval>

`Optional` relay

relay?: WakuRelay

`Private` relayKeepAliveTimers

relayKeepAliveTimers: { [peer: string]: ReturnType<typeof setInterval> }

Type declaration

[peer: string]: ReturnType<typeof setInterval>

`Optional` store

store?: WakuStore

Methods

addDecryptionKey

addDecryptionKey(key: string | Uint8Array, options?: { contentTopics?: string[]; method?: DecryptionMethod }): void
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
- Optional options: { contentTopics?: string[]; method?: DecryptionMethod }
  - Optional contentTopics?: string[]
  - Optional method?: DecryptionMethod
Returns void
Implementation of Waku.addDecryptionKey
- Defined in src/lib/waku.ts:186

addPeerToAddressBook

addPeerToAddressBook(peerId: string | PeerId, multiaddrs: Multiaddr[] | string[]): void
Add peer to address book, it will be auto-dialed in the background.
Parameters
- peerId: string | PeerId
- multiaddrs: Multiaddr[] | string[]
Returns void
Implementation of Waku.addPeerToAddressBook
- Defined in src/lib/waku.ts:146

deleteDecryptionKey

deleteDecryptionKey(key: string | Uint8Array): void
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
Implementation of Waku.deleteDecryptionKey
- Defined in src/lib/waku.ts:201

dial

dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>
Dials to the provided peer.
Parameters
- peer: PeerId | Multiaddr
  
  The peer to dial
- Optional protocols: Protocols[]
  
  Waku protocols we expect from the peer; Default to Relay
Returns Promise<Stream>
Implementation of Waku.dial
- Defined in src/lib/waku.ts:118

getLocalMultiaddrWithID

getLocalMultiaddrWithID(): string
Return the local multiaddr with peer id on which libp2p is listening.

Throws
if libp2p is not listening on localhost.

Returns string
- Defined in src/lib/waku.ts:212

isStarted

isStarted(): boolean
Returns boolean
Implementation of Waku.isStarted
- Defined in src/lib/waku.ts:175

start

start(): Promise<void>
Returns Promise<void>
Implementation of Waku.start
- Defined in src/lib/waku.ts:166

`Private` startKeepAlive

startKeepAlive(peerId: PeerId, pingPeriodSecs: number, relayPeriodSecs: number): void
Parameters
- peerId: PeerId
- pingPeriodSecs: number
- relayPeriodSecs: number
Returns void
- Defined in src/lib/waku.ts:222

stop

stop(): Promise<void>
Returns Promise<void>
Implementation of Waku.stop
- Defined in src/lib/waku.ts:170

`Private` stopAllKeepAlives

stopAllKeepAlives(): void
Returns void
- Defined in src/lib/waku.ts:265

`Private` stopKeepAlive

stopKeepAlive(peerId: PeerId): void
Parameters
- peerId: PeerId
Returns void
- Defined in src/lib/waku.ts:251

Generated using TypeDoc