From 2f50a98cdbb65cfbb6d350066b84d1a5ca54d015 Mon Sep 17 00:00:00 2001 From: status-im-auto Date: Tue, 5 Apr 2022 07:34:09 +0000 Subject: [PATCH] Updates --- classes/discovery.Bootstrap.html | 2 +- classes/discovery.DnsNodeDiscovery.html | 8 ++++---- classes/discovery.DnsOverHttps.html | 4 ++-- classes/discovery.ENRTree.html | 6 +++--- classes/enr.AbstractKeypair.html | 2 +- classes/enr.ENR.html | 18 +++++++++--------- classes/waku.Waku.html | 14 +++++++------- classes/waku_light_push.WakuLightPush.html | 6 +++--- classes/waku_message.WakuMessage.html | 12 ++++++------ classes/waku_relay.WakuRelay.html | 18 +++++++++--------- classes/waku_store.WakuStore.html | 10 +++++----- enums/discovery.predefined.Fleet.html | 2 +- enums/enr.KeypairType.html | 2 +- enums/waku.Protocols.html | 2 +- enums/waku_message.DecryptionMethod.html | 2 +- enums/waku_store.PageDirection.html | 2 +- enums/waku_store.StoreCodecs.html | 2 +- interfaces/discovery.BootstrapOptions.html | 10 +++++----- interfaces/discovery.DnsClient.html | 2 +- interfaces/enr.IKeypair.html | 2 +- interfaces/enr.IKeypairClass.html | 2 +- interfaces/waku.CreateOptions.html | 12 ++++++------ interfaces/waku_light_push.CreateOptions.html | 2 +- interfaces/waku_light_push.PushOptions.html | 2 +- interfaces/waku_light_push.PushResponse.html | 2 +- interfaces/waku_message.Options.html | 8 ++++---- interfaces/waku_relay.GossipOptions.html | 2 +- interfaces/waku_store.CreateOptions.html | 2 +- interfaces/waku_store.QueryOptions.html | 14 +++++++------- interfaces/waku_store.TimeFilter.html | 2 +- modules.html | 8 ++++---- modules/discovery.html | 2 +- modules/discovery.predefined.html | 2 +- modules/enr.html | 4 ++-- modules/utils.html | 10 +++++----- modules/waku.html | 4 ++-- modules/waku_light_push.html | 2 +- modules/waku_relay.html | 2 +- modules/waku_store.html | 2 +- 39 files changed, 105 insertions(+), 105 deletions(-) diff --git a/classes/discovery.Bootstrap.html b/classes/discovery.Bootstrap.html index 264ebb7a5c..911f13346b 100644 --- a/classes/discovery.Bootstrap.html +++ b/classes/discovery.Bootstrap.html @@ -1,3 +1,3 @@ Bootstrap | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Parse options and expose function to return bootstrap peer addresses.

-

Hierarchy

  • Bootstrap

Index

Constructors

Properties

getBootstrapPeers: undefined | (() => Promise<Multiaddr[]>)
DefaultMaxPeers: number = 1

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

getBootstrapPeers: undefined | (() => Promise<Multiaddr[]>)
DefaultMaxPeers: number = 1

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/discovery.DnsNodeDiscovery.html b/classes/discovery.DnsNodeDiscovery.html index 144ed4212e..cfaba24ba0 100644 --- a/classes/discovery.DnsNodeDiscovery.html +++ b/classes/discovery.DnsNodeDiscovery.html @@ -1,13 +1,13 @@ -DnsNodeDiscovery | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DnsNodeDiscovery

Hierarchy

  • DnsNodeDiscovery

Index

Constructors

Properties

_DNSTreeCache: {}

Type declaration

  • [key: string]: string
_errorTolerance: number = 10

Methods

  • _getTXTRecord(subdomain: string, context: SearchContext): Promise<string>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/discovery.DnsOverHttps.html b/classes/discovery.DnsOverHttps.html index 7433a84e5f..165d7bf4a5 100644 --- a/classes/discovery.DnsOverHttps.html +++ b/classes/discovery.DnsOverHttps.html @@ -1,11 +1,11 @@ -DnsOverHttps | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • DnsOverHttps

Implements

Index

Constructors

Properties

Methods

Constructors

Properties

endpoints: Endpoints = ...

Methods

  • resolveTXT(domain: string): Promise<string[]>
  • startKeepAlive(peerId: PeerId, pingPeriodSecs: number, relayPeriodSecs: number): void
  • Parameters

    • peerId: PeerId
    • pingPeriodSecs: number
    • relayPeriodSecs: number

    Returns void

  • stop(): Promise<void>
  • stopKeepAlive(peerId: PeerId): void
  • waitForRemotePeer(protocols?: Protocols[]): Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/waku_light_push.WakuLightPush.html b/classes/waku_light_push.WakuLightPush.html index 1026f83c3e..c3d336b205 100644 --- a/classes/waku_light_push.WakuLightPush.html +++ b/classes/waku_light_push.WakuLightPush.html @@ -1,10 +1,10 @@ WakuLightPush | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Implements the Waku v2 Light Push protocol.

-

Hierarchy

  • WakuLightPush

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

libp2p: Libp2p
pubSubTopic: string

Accessors

  • get peers(): AsyncIterable<Peer>

Hierarchy

  • WakuLightPush

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

libp2p: Libp2p
pubSubTopic: string

Accessors

  • get peers(): AsyncIterable<Peer>
  • Returns known peers from the address book (libp2p.peerStore) that support light push protocol. Waku may or may not be currently connected to these peers.

    -

    Returns AsyncIterable<Peer>

  • get randomPeer(): Promise<undefined | Peer>
  • get randomPeer(): Promise<undefined | Peer>
  • Returns a random peer that supports light push protocol from the address book (libp2p.peerStore). Waku may or may not be currently connected to this peer.

    -

    Returns Promise<undefined | Peer>

Methods

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<undefined | Peer>

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/waku_message.WakuMessage.html b/classes/waku_message.WakuMessage.html index 9835603074..4c92113f22 100644 --- a/classes/waku_message.WakuMessage.html +++ b/classes/waku_message.WakuMessage.html @@ -1,24 +1,24 @@ -WakuMessage | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • WakuMessage

Index

Constructors

  • new WakuMessage(proto: WakuMessage, _signaturePublicKey?: Uint8Array, _signature?: Uint8Array): WakuMessage

Properties

proto: WakuMessage

Accessors

  • get contentTopic(): undefined | string
  • get payload(): undefined | Uint8Array
  • get payloadAsUtf8(): string
  • get signature(): undefined | Uint8Array

Hierarchy

  • Gossipsub
    • WakuRelay

Index

Constructors

Properties

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

Hierarchy

  • Gossipsub
    • WakuRelay

Index

Constructors

Properties

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

observers called when receiving new message. Observers under key "" are always called.

-

Type declaration

  • [contentTopic: string]: Set<(message: WakuMessage) => void>
pubSubTopic: string

Methods

  • addDecryptionKey(key: string | Uint8Array, options?: { contentTopics?: string[]; method?: DecryptionMethod }): void
pubSubTopic: string

Methods

  • addDecryptionKey(key: string | Uint8Array, options?: { contentTopics?: string[]; method?: DecryptionMethod }): void
  • Register a decryption key to attempt decryption of received messages. This can either be a private key for asymmetric encryption or a symmetric key. WakuRelay 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

  • addObserver(callback: (message: WakuMessage) => void, contentTopics?: string[]): void
  • addObserver(callback: (message: WakuMessage) => void, contentTopics?: string[]): void
  • Register an observer of new messages received via waku relay

    Parameters

    • callback: (message: WakuMessage) => void

      called when a new message is received via waku relay

    • contentTopics: string[] = []

      Content Topics for which the callback with be called, all of them if undefined, [] or ["",..] is passed.

      -

    Returns void

  • deleteDecryptionKey(key: string | Uint8Array): void

Returns void

  • deleteDecryptionKey(key: string | Uint8Array): void
  • Delete a decryption key that was used to attempt decryption of received messages.

    Strings must be in hex format.

    -

    Parameters

    • key: string | Uint8Array

    Returns void

  • deleteObserver(callback: (message: WakuMessage) => void, contentTopics?: string[]): void
  • deleteObserver(callback: (message: WakuMessage) => void, contentTopics?: string[]): void
  • Remove an observer of new messages received via waku relay. Useful to ensure the same observer is not registered several time (e.g when loading React components)

    -

    Parameters

    Returns void

  • getPeers(): Set<string>
  • getPeers(): Set<string>
  • start(): Promise<void>
  • start(): Promise<void>
  • Mounts the gossipsub protocol onto the libp2p node and subscribes to the default topic.

    -
    override

    Returns Promise<void>

  • subscribe(pubSubTopic: string): void
  • subscribe(pubSubTopic: string): void
  • Subscribe to a pubsub topic and start emitting Waku messages to observers.

    override

    Parameters

    • pubSubTopic: string

    Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/waku_store.WakuStore.html b/classes/waku_store.WakuStore.html index 987bd7001c..77ed757a75 100644 --- a/classes/waku_store.WakuStore.html +++ b/classes/waku_store.WakuStore.html @@ -1,25 +1,25 @@ WakuStore | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Implements the Waku v2 Store protocol.

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

-

Hierarchy

  • WakuStore

Index

Constructors

Properties

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

Accessors

  • get peers(): AsyncIterable<Peer>

Hierarchy

  • WakuStore

Index

Constructors

Properties

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

Accessors

  • get peers(): AsyncIterable<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 AsyncIterable<Peer>

  • get randomPeer(): Promise<undefined | Peer>
  • get 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>

Methods

  • addDecryptionKey(key: string | Uint8Array, options?: { contentTopics?: string[]; method?: DecryptionMethod }): void

Methods

  • 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 }

    Returns void

  • deleteDecryptionKey(key: string | Uint8Array): void
  • 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

enrUrl?: string

An EIP-1459 ENR Tree URL. For example: "enrtree://AOFTICU2XWDULNLZGRMQS4RIZPAZEHYMV4FYHAPW563HNRAOERP7C@test.nodes.vac.dev"

-
maxPeers?: number
+
maxPeers?: number

The maximum of peers to connect to as part of the bootstrap process.

default

Bootstrap.DefaultMaxPeers

-
peers?: Multiaddr[] | string[]
+
peers?: Multiaddr[] | string[]

Multiaddrs of peers to connect to.

-

Methods

  • getPeers(): Promise<Multiaddr[] | string[]>

Methods

  • getPeers(): Promise<Multiaddr[] | string[]>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/discovery.DnsClient.html b/interfaces/discovery.DnsClient.html index 5e59d2744c..95045a7a17 100644 --- a/interfaces/discovery.DnsClient.html +++ b/interfaces/discovery.DnsClient.html @@ -1 +1 @@ -DnsClient | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DnsClient

Hierarchy

  • DnsClient

Implemented by

Index

Methods

Methods

  • resolveTXT(domain: string): Promise<string[]>

Generated using TypeDoc

\ No newline at end of file +DnsClient | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DnsClient

Hierarchy

  • DnsClient

Implemented by

Index

Methods

Methods

  • resolveTXT(domain: string): Promise<string[]>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/enr.IKeypair.html b/interfaces/enr.IKeypair.html index d1bf28c021..65176e96e8 100644 --- a/interfaces/enr.IKeypair.html +++ b/interfaces/enr.IKeypair.html @@ -1 +1 @@ -IKeypair | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKeypair

Hierarchy

  • IKeypair

Index

Properties

privateKey: Uint8Array
publicKey: Uint8Array

Methods

  • hasPrivateKey(): boolean
  • privateKeyVerify(): boolean
  • publicKeyVerify(): boolean
  • sign(msg: Uint8Array): Uint8Array
  • verify(msg: Uint8Array, sig: Uint8Array): boolean

Generated using TypeDoc

\ No newline at end of file +IKeypair | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKeypair

Hierarchy

  • IKeypair

Index

Properties

privateKey: Uint8Array
publicKey: Uint8Array

Methods

  • hasPrivateKey(): boolean
  • privateKeyVerify(): boolean
  • publicKeyVerify(): boolean
  • sign(msg: Uint8Array): Uint8Array
  • verify(msg: Uint8Array, sig: Uint8Array): boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/enr.IKeypairClass.html b/interfaces/enr.IKeypairClass.html index 19cd55cd2e..623cb1b124 100644 --- a/interfaces/enr.IKeypairClass.html +++ b/interfaces/enr.IKeypairClass.html @@ -1 +1 @@ -IKeypairClass | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKeypairClass

Hierarchy

  • IKeypairClass

Index

Constructors

Methods

Constructors

  • new IKeypairClass(privateKey?: Uint8Array, publicKey?: Uint8Array): IKeypair

Methods

Generated using TypeDoc

\ No newline at end of file +IKeypairClass | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKeypairClass

Hierarchy

  • IKeypairClass

Index

Constructors

Methods

Constructors

  • new IKeypairClass(privateKey?: Uint8Array, publicKey?: Uint8Array): IKeypair

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/waku.CreateOptions.html b/interfaces/waku.CreateOptions.html index 507799e00a..6208919ae7 100644 --- a/interfaces/waku.CreateOptions.html +++ b/interfaces/waku.CreateOptions.html @@ -1,19 +1,19 @@ -CreateOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateOptions

Hierarchy

  • CreateOptions

Index

Properties

bootstrap?: BootstrapOptions
+CreateOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateOptions

Hierarchy

  • CreateOptions

Index

Properties

bootstrap?: BootstrapOptions

Use libp2p-bootstrap to discover and connect to new nodes.

See BootstrapOptions for available parameters.

Note: It overrides any other peerDiscovery modules that may have been set via CreateOptions.libp2p.

-
decryptionKeys?: (string | Uint8Array)[]
libp2p?: Omit<Libp2pOptions & CreateOptions, "modules"> & { modules?: Partial<Libp2pModules> }
+
decryptionKeys?: (string | Uint8Array)[]
libp2p?: Omit<Libp2pOptions & CreateOptions, "modules"> & { modules?: Partial<Libp2pModules> }

You can pass options to the Libp2p instance used by Waku using the CreateOptions.libp2p property. This property is the same type than the one passed to Libp2p.create apart that we made the modules property optional and partial, allowing its omission and letting Waku set good defaults. Notes that some values are overridden by Waku to ensure it implements the Waku protocol.

-
pingKeepAlive?: number
+
pingKeepAlive?: number

Set keep alive frequency in seconds: Waku will send a /ipfs/ping/1.0.0 request to each peer after the set number of seconds. Set to 0 to disable.

default

DefaultPingKeepAliveValueSecs

-
pubSubTopic?: string
+
pubSubTopic?: string

The PubSub Topic to use. Defaults to DefaultPubSubTopic.

One and only one pubsub topic is used by Waku. This is used by:

    @@ -24,11 +24,11 @@ request to each peer after the set number of seconds. Set to 0 to disable.

    The usage of the default pubsub topic is recommended. See Waku v2 Topic Usage Recommendations for details.

default

DefaultPubSubTopic

-
relayKeepAlive?: number
+
relayKeepAlive?: number

Set keep alive frequency in seconds: Waku will send a ping message over relay to each peer after the set number of seconds. Set to 0 to disable.

default

DefaultRelayKeepAliveValueSecs

-
staticNoiseKey?: Uint8Array
+
staticNoiseKey?: Uint8Array

Byte array used as key for the noise protocol used for connection encryption by Libp2p.create This is only used for test purposes to not run out of entropy during CI runs.

diff --git a/interfaces/waku_light_push.CreateOptions.html b/interfaces/waku_light_push.CreateOptions.html index 616c554c5d..be690dc724 100644 --- a/interfaces/waku_light_push.CreateOptions.html +++ b/interfaces/waku_light_push.CreateOptions.html @@ -1,4 +1,4 @@ -CreateOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • CreateOptions

Index

Properties

Properties

pubSubTopic?: string
+CreateOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • CreateOptions

Index

Properties

Properties

pubSubTopic?: string

The PubSub Topic to use. Defaults to DefaultPubSubTopic.

The usage of the default pubsub topic is recommended. See Waku v2 Topic Usage Recommendations for details.

diff --git a/interfaces/waku_light_push.PushOptions.html b/interfaces/waku_light_push.PushOptions.html index 31018f34c5..e1ce498878 100644 --- a/interfaces/waku_light_push.PushOptions.html +++ b/interfaces/waku_light_push.PushOptions.html @@ -1 +1 @@ -PushOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PushOptions

Index

Properties

peerId?: PeerId
pubSubTopic?: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +PushOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PushOptions

Index

Properties

peerId?: PeerId
pubSubTopic?: string

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/waku_light_push.PushResponse.html b/interfaces/waku_light_push.PushResponse.html index d2a168e535..0b0a0bd0be 100644 --- a/interfaces/waku_light_push.PushResponse.html +++ b/interfaces/waku_light_push.PushResponse.html @@ -1 +1 @@ -PushResponse | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +PushResponse | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/waku_message.Options.html b/interfaces/waku_message.Options.html index 92c17a5f61..367fdea3ea 100644 --- a/interfaces/waku_message.Options.html +++ b/interfaces/waku_message.Options.html @@ -1,12 +1,12 @@ -Options | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Options

Index

Properties

encPublicKey?: string | Uint8Array
+Options | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Options

Index

Properties

encPublicKey?: string | Uint8Array

Public Key to use to encrypt the messages using ECIES (Asymmetric Encryption).

throws

if both encPublicKey and symKey are passed

-
sigPrivKey?: Uint8Array
+
sigPrivKey?: Uint8Array

Private key to use to sign the message, either encPublicKey or symKey must be provided as only encrypted messages are signed.

-
symKey?: string | Uint8Array
+
symKey?: string | Uint8Array

Key to use to encrypt the messages using AES (Symmetric Encryption).

throws

if both encPublicKey and symKey are passed

-
timestamp?: Date
+
timestamp?: Date

Timestamp to set on the message, defaults to now if not passed.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/waku_relay.GossipOptions.html b/interfaces/waku_relay.GossipOptions.html index 7611417c10..46ab289bfb 100644 --- a/interfaces/waku_relay.GossipOptions.html +++ b/interfaces/waku_relay.GossipOptions.html @@ -1,3 +1,3 @@ GossipOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GossipOptions

See constructor libp2p-gossipsub API.

-

Hierarchy

  • GossipOptions

Index

Properties

D: number
Dhi: number
Dlazy: number
Dlo: number
Dout: number
Dscore: number
directPeers: AddrInfo[]
doPX: boolean
emitSelf: boolean
fallbackToFloodsub: boolean
floodPublish: boolean
gossipIncoming: boolean
messageCache: MessageCache
msgIdFn: MessageIdFunction
scoreParams: Partial<PeerScoreParams>
scoreThresholds: Partial<PeerScoreThresholds>

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • GossipOptions

Index

Properties

D: number
Dhi: number
Dlazy: number
Dlo: number
Dout: number
Dscore: number
directPeers: AddrInfo[]
doPX: boolean
emitSelf: boolean
fallbackToFloodsub: boolean
floodPublish: boolean
gossipIncoming: boolean
messageCache: MessageCache
msgIdFn: MessageIdFunction
scoreParams: Partial<PeerScoreParams>
scoreThresholds: Partial<PeerScoreThresholds>

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/waku_store.CreateOptions.html b/interfaces/waku_store.CreateOptions.html index 59ba79cedf..0124ade456 100644 --- a/interfaces/waku_store.CreateOptions.html +++ b/interfaces/waku_store.CreateOptions.html @@ -1,4 +1,4 @@ -CreateOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateOptions

Hierarchy

  • CreateOptions

Index

Properties

Properties

pubSubTopic?: string
+CreateOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateOptions

Hierarchy

  • CreateOptions

Index

Properties

Properties

pubSubTopic?: string

The PubSub Topic to use. Defaults to DefaultPubSubTopic.

The usage of the default pubsub topic is recommended. See Waku v2 Topic Usage Recommendations for details.

diff --git a/interfaces/waku_store.QueryOptions.html b/interfaces/waku_store.QueryOptions.html index b0ed18042a..38086fb2f1 100644 --- a/interfaces/waku_store.QueryOptions.html +++ b/interfaces/waku_store.QueryOptions.html @@ -1,8 +1,8 @@ -QueryOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryOptions

Hierarchy

  • QueryOptions

Index

Properties

decryptionKeys?: (string | Uint8Array)[]
+QueryOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryOptions

Hierarchy

  • QueryOptions

Index

Properties

decryptionKeys?: (string | Uint8Array)[]

Keys that will be used to decrypt messages.

It can be Asymmetric Private Keys and Symmetric Keys in the same array, all keys will be tried with both methods.

-
pageDirection?: PageDirection
+
pageDirection?: PageDirection

The direction in which pages are retrieved:

  • PageDirection.BACKWARD: Most recent page first.
  • @@ -11,17 +11,17 @@ all keys will be tried with both methods.

Note: This does not affect the ordering of messages with the page (oldest message is always first).

default

PageDirection.BACKWARD

-
pageSize?: number
+
pageSize?: number

The number of message per page.

default

DefaultPageSize

-
peerId?: PeerId
+
peerId?: PeerId

The peer to query. If undefined, a pseudo-random peer is selected from the connected Waku Store peers.

-
pubSubTopic?: string
+
pubSubTopic?: string

The pubsub topic to pass to the query. See Waku v2 Topic Usage Recommendations.

-
timeFilter?: TimeFilter
+
timeFilter?: TimeFilter

Retrieve messages with a timestamp within the provided values.

-

Methods

Methods