Properties Private ping Keep Alive Timersping Keep Alive Timers: {}
Type declaration [ peer: string ]: ReturnType < typeof setInterval > Private relay Keep Alive Timersrelay Keep Alive Timers: {}
Type declaration [ peer: string ]: ReturnType < typeof setInterval > Methods add Decryption Key add Decryption Key( key: string | Uint8Array , options?: { contentTopics?: string [] ; method?: DecryptionMethod } ) : void Parameters key: string | Uint8Array Optional options: { contentTopics?: string [] ; method?: DecryptionMethod } Optional content Topics?: string [] Returns void add Peer To Address Book add Peer To Address Book( peerId: string | PeerId , multiaddrs: Multiaddr [] | string [] ) : void Parameters peerId: string | PeerId multiaddrs: Multiaddr [] | string [] Returns void delete Decryption Key delete Decryption Key( key: string | Uint8Array ) : void dial dial( peer: string | Multiaddr | PeerId , protocols?: Protocols [] ) : Promise < { protocol: string ; stream: MuxedStream } > Parameters peer: string | Multiaddr | PeerId Optional protocols: Protocols [] Returns Promise < { protocol: string ; stream: MuxedStream } > get Local Multiaddr WithID get Local Multiaddr WithID( ) : string Private start Keep Alivestart Keep Alive( peerId: PeerId , pingPeriodSecs: number , relayPeriodSecs: number ) : void Parameters peerId: PeerId pingPeriodSecs: number relayPeriodSecs: number Returns void Private stop Keep Alivestop Keep Alive( peerId: PeerId ) : void wait For Remote Peer wait For Remote Peer( protocols?: Protocols [] ) : Promise < void > Parameters Returns Promise < void > Static createParameters Returns Promise < Waku > Legend Private property Private method Settings Theme OS Light Dark
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.