Implements client side of the Waku v2 Filter protocol.

Note this currently only works in NodeJS when the Waku node is listening on a port, see:

Hierarchy

  • WakuFilter

Constructors

Properties

decryptionKeys: Map<Uint8Array, { contentTopics?: string[]; method?: DecryptionMethod }>
libp2p: Libp2p
pubSubTopic: string
subscriptions: Map<string, FilterCallback>

Methods

  • Register a decryption key to attempt decryption of messages received in any subsequent subscribe call. This can either be a private key for asymmetric encryption or a symmetric key. WakuStore will attempt to decrypt messages using both methods.

    Strings must be in hex format.

    Parameters

    • key: string | Uint8Array
    • Optional options: { contentTopics?: string[]; method?: DecryptionMethod }

    Returns void

  • Delete a decryption key so that it cannot be used in future subscribe calls

    Strings must be in hex format.

    Parameters

    • key: string | Uint8Array

    Returns void

Generated using TypeDoc