Class WakuStore

Implements the Waku v2 Store protocol.

The Waku Store protocol can be used to retrieved historical messages.

Hierarchy

WakuStore

Index

Constructors

Properties

decryptionKeys libp2p pubSubTopic

Methods

addDecryptionKey deleteDecryptionKey peers queryHistory randomPeer

Constructors

constructor

new WakuStore(libp2p: Libp2p, options?: waku_store.CreateOptions): WakuStore
Parameters
- libp2p: Libp2p
- Optional options: waku_store.CreateOptions
Returns WakuStore
- Defined in src/lib/waku_store/index.ts:113

Properties

decryptionKeys

decryptionKeys: Map<Uint8Array, { contentTopics?: string[]; method?: DecryptionMethod }>

libp2p

libp2p: Libp2p

pubSubTopic

pubSubTopic: string

Methods

addDecryptionKey

addDecryptionKey(key: string | Uint8Array, options?: { contentTopics?: string[]; method?: DecryptionMethod }): void
Register a decryption key to attempt decryption of messages received in any subsequent queryHistory 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 }
  - Optional contentTopics?: string[]
  - Optional method?: DecryptionMethod
Returns void
- Defined in src/lib/waku_store/index.ts:288

deleteDecryptionKey

deleteDecryptionKey(key: string | Uint8Array): void
cursorV2Beta4 Delete a decryption key that was used to attempt decryption of messages received in subsequent queryHistory calls.

Strings must be in hex format.
Parameters
- key: string | Uint8Array
Returns void
- Defined in src/lib/waku_store/index.ts:301

peers

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

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

queryHistory

queryHistory(contentTopics: string[], options?: QueryOptions): Promise<waku_message.WakuMessage[]>
Do a query to a Waku Store to retrieve historical/missed messages.

Throws
If not able to reach a Waku Store peer to query or if an error is encountered when processing the reply.
Parameters
- contentTopics: string[]
  
  The content topics to pass to the query, leave empty to retrieve all messages.
- Optional options: QueryOptions
  
  Optional parameters.
Returns Promise<waku_message.WakuMessage[]>
- Defined in src/lib/waku_store/index.ts:129

randomPeer

randomPeer(): Promise<undefined | Peer>
Returns a random peer that supports store 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_store/index.ts:323

Generated using TypeDoc