diff --git a/classes/discovery.Bootstrap.html b/classes/discovery.Bootstrap.html index c7c4bca28e..898a298cfd 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

Class Bootstrap

Parse options and expose function to return bootstrap peer addresses.

-

Hierarchy

  • Bootstrap

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly getBootstrapPeers

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

Static DefaultMaxPeers

DefaultMaxPeers: number = 1

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly getBootstrapPeers

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

Static DefaultMaxPeers

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 ce12e3ec96..9d22c451c3 100644 --- a/classes/discovery.DnsNodeDiscovery.html +++ b/classes/discovery.DnsNodeDiscovery.html @@ -1,12 +1,12 @@ -DnsNodeDiscovery | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DnsNodeDiscovery

Hierarchy

  • DnsNodeDiscovery

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private Readonly _DNSTreeCache

_DNSTreeCache: {}

Type declaration

  • [key: string]: string

Private Readonly _errorTolerance

_errorTolerance: number = 10

Private Readonly dns

dns: DnsClient

Methods

Private _getTXTRecord

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

Static dnsOverHttp

Generated using TypeDoc

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

Class DnsOverHttps

Hierarchy

  • DnsOverHttps

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DnsOverHttps

Properties

endpoints

endpoints: Endpoints = ...

Methods

resolveTXT

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

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/discovery.ENRTree.html b/classes/discovery.ENRTree.html index 71641a4f1a..da334da5f2 100644 --- a/classes/discovery.ENRTree.html +++ b/classes/discovery.ENRTree.html @@ -1,10 +1,10 @@ -ENRTree | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ENRTree

Hierarchy

  • ENRTree

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Readonly BRANCH_PREFIX

BRANCH_PREFIX: "enrtree-branch:" = 'enrtree-branch:'

Static Readonly RECORD_PREFIX

RECORD_PREFIX: "enr:" = ENR.RECORD_PREFIX

Static Readonly ROOT_PREFIX

ROOT_PREFIX: "enrtree-root:" = 'enrtree-root:'

Static Readonly TREE_PREFIX

TREE_PREFIX: "enrtree:" = 'enrtree:'

Methods

Static parseAndVerifyRoot

  • parseAndVerifyRoot(root: string, publicKey: string): string

deleteDecryptionKey

  • 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

deleteObserver

getPeers

  • getPeers(): Set<string>

getPeers

  • getPeers(): Set<string>

send

send

start

  • start(): void

start

  • start(): void

  • Mounts the gossipsub protocol onto the libp2p node and subscribes to the default topic.

    -
    override

    Returns void

subscribe

  • subscribe(pubSubTopic: string): void

subscribe

  • 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 38bf336e79..5354a66120 100644 --- a/classes/waku_store.WakuStore.html +++ b/classes/waku_store.WakuStore.html @@ -1,23 +1,23 @@ WakuStore | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WakuStore

Implements the Waku v2 Store protocol.

-

Hierarchy

  • WakuStore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

decryptionKeys

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

libp2p

libp2p: Libp2p

pubSubTopic

pubSubTopic: string

Accessors

peers

  • get peers(): Peer[]

Hierarchy

  • WakuStore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

decryptionKeys

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

libp2p

libp2p: Libp2p

pubSubTopic

pubSubTopic: string

Accessors

peers

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

randomPeer

  • get randomPeer(): undefined | Peer

randomPeer

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

Methods

addDecryptionKey

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

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 }

    Returns void

deleteDecryptionKey

  • deleteDecryptionKey(key: string | Uint8Array): void

deleteDecryptionKey

  • deleteDecryptionKey(key: string | Uint8Array): void

  • 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

queryHistory

queryHistory

Optional enrUrl

enrUrl?: string

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

-

Optional maxPeers

maxPeers?: number
+

Optional maxPeers

maxPeers?: number

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

default

Bootstrap.DefaultMaxPeers

-

Optional peers

peers?: string[]
+

Optional peers

peers?: string[]

Multiaddrs of peers to connect to.

-

Methods

Optional getPeers

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

Methods

Optional getPeers

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

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/discovery.DnsClient.html b/interfaces/discovery.DnsClient.html index 7276c73bcc..2a524981ab 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

  • 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

  • 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 69f3b58881..23da609b8e 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

Methods

Properties

privateKey

privateKey: Buffer

publicKey

publicKey: Buffer

type

type: KeypairType

Methods

hasPrivateKey

  • hasPrivateKey(): boolean

privateKeyVerify

  • privateKeyVerify(): boolean

publicKeyVerify

  • publicKeyVerify(): boolean

sign

  • sign(msg: Buffer): Buffer

verify

  • verify(msg: Buffer, sig: Buffer): 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

Methods

Properties

privateKey

privateKey: Buffer

publicKey

publicKey: Buffer

type

type: KeypairType

Methods

hasPrivateKey

  • hasPrivateKey(): boolean

privateKeyVerify

  • privateKeyVerify(): boolean

publicKeyVerify

  • publicKeyVerify(): boolean

sign

  • sign(msg: Buffer): Buffer

verify

  • verify(msg: Buffer, sig: Buffer): boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/enr.IKeypairClass.html b/interfaces/enr.IKeypairClass.html index 250d6df68e..251fa53600 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

constructor

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

Methods

generate

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

constructor

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

Methods

generate

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/proto.ContentFilter.html b/interfaces/proto.ContentFilter.html index bf49019409..af0d43151c 100644 --- a/interfaces/proto.ContentFilter.html +++ b/interfaces/proto.ContentFilter.html @@ -1 +1 @@ -ContentFilter | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ContentFilter

Hierarchy

  • ContentFilter

Index

Properties

Properties

contentTopic

contentTopic: string

Generated using TypeDoc

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

Interface ContentFilter

Hierarchy

  • ContentFilter

Index

Properties

Properties

contentTopic

contentTopic: string

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/proto.HistoryQuery.html b/interfaces/proto.HistoryQuery.html index a308362a9d..38daf92814 100644 --- a/interfaces/proto.HistoryQuery.html +++ b/interfaces/proto.HistoryQuery.html @@ -1 +1 @@ -HistoryQuery | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HistoryQuery

Hierarchy

  • HistoryQuery

Index

Properties

Properties

contentFilters

contentFilters: proto.ContentFilter[]

Optional endTime

endTime?: number

Optional pagingInfo

pagingInfo?: proto.PagingInfo

Optional pubSubTopic

pubSubTopic?: string

Optional startTime

startTime?: number

Generated using TypeDoc

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

Interface HistoryQuery

Hierarchy

  • HistoryQuery

Index

Properties

Properties

contentFilters

contentFilters: proto.ContentFilter[]

Optional endTime

endTime?: number

Optional pagingInfo

pagingInfo?: proto.PagingInfo

Optional pubSubTopic

pubSubTopic?: string

Optional startTime

startTime?: number

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/proto.HistoryRPC.html b/interfaces/proto.HistoryRPC.html index 489095aa3c..a2236ae9f9 100644 --- a/interfaces/proto.HistoryRPC.html +++ b/interfaces/proto.HistoryRPC.html @@ -1 +1 @@ -HistoryRPC | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HistoryRPC

Hierarchy

  • HistoryRPC

Index

Properties

Properties

query

query: undefined | proto.HistoryQuery

requestId

requestId: string

response

response: undefined | proto.HistoryResponse

Generated using TypeDoc

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

Interface HistoryRPC

Hierarchy

  • HistoryRPC

Index

Properties

Properties

query

query: undefined | proto.HistoryQuery

requestId

requestId: string

response

response: undefined | proto.HistoryResponse

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/proto.HistoryResponse.html b/interfaces/proto.HistoryResponse.html index 74ce8309c0..b1fded182f 100644 --- a/interfaces/proto.HistoryResponse.html +++ b/interfaces/proto.HistoryResponse.html @@ -1 +1 @@ -HistoryResponse | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HistoryResponse

Hierarchy

  • HistoryResponse

Index

Properties

Properties

error

error: HistoryResponse_Error

messages

messages: proto.WakuMessage[]

pagingInfo

pagingInfo: undefined | proto.PagingInfo

Generated using TypeDoc

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

Interface HistoryResponse

Hierarchy

  • HistoryResponse

Index

Properties

Properties

error

error: HistoryResponse_Error

messages

messages: proto.WakuMessage[]

pagingInfo

pagingInfo: undefined | proto.PagingInfo

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/proto.Index.html b/interfaces/proto.Index.html index abf0bda6ce..4dabac2087 100644 --- a/interfaces/proto.Index.html +++ b/interfaces/proto.Index.html @@ -1 +1 @@ -Index | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Index

Hierarchy

  • Index

Index

Properties

Properties

digest

digest: Uint8Array

receivedTime

receivedTime: number

senderTime

senderTime: number

Generated using TypeDoc

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

Interface Index

Hierarchy

  • Index

Index

Properties

Properties

digest

digest: Uint8Array

receivedTime

receivedTime: number

senderTime

senderTime: number

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/proto.PagingInfo.html b/interfaces/proto.PagingInfo.html index dc60c0b7cd..cd4b7d01a3 100644 --- a/interfaces/proto.PagingInfo.html +++ b/interfaces/proto.PagingInfo.html @@ -1 +1 @@ -PagingInfo | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PagingInfo

Hierarchy

  • PagingInfo

Index

Properties

Properties

cursor

cursor: undefined | proto.Index

direction

direction: PagingInfo_Direction

pageSize

pageSize: number

Generated using TypeDoc

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

Interface PagingInfo

Hierarchy

  • PagingInfo

Index

Properties

Properties

cursor

cursor: undefined | proto.Index

direction

direction: PagingInfo_Direction

pageSize

pageSize: number

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/proto.WakuMessage.html b/interfaces/proto.WakuMessage.html index 8a7c99492b..2daca8ea33 100644 --- a/interfaces/proto.WakuMessage.html +++ b/interfaces/proto.WakuMessage.html @@ -1 +1 @@ -WakuMessage | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WakuMessage

Hierarchy

  • WakuMessage

Index

Properties

Properties

Optional contentTopic

contentTopic?: string

Optional payload

payload?: Uint8Array

Optional timestamp

timestamp?: number

Optional version

version?: number

Generated using TypeDoc

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

Interface WakuMessage

Hierarchy

  • WakuMessage

Index

Properties

Properties

Optional contentTopic

contentTopic?: string

Optional payload

payload?: Uint8Array

Optional timestamp

timestamp?: number

Optional version

version?: number

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/waku.CreateOptions.html b/interfaces/waku.CreateOptions.html index 90c48efce5..0fdcc12351 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

Properties

Optional bootstrap

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

Interface CreateOptions

Hierarchy

  • CreateOptions

Index

Properties

Properties

Optional bootstrap

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.

-

Optional decryptionKeys

decryptionKeys?: (string | Uint8Array)[]

Optional libp2p

libp2p?: Omit<Libp2pOptions & CreateOptions, "modules"> & { modules?: Partial<Libp2pModules> }
+

Optional decryptionKeys

decryptionKeys?: (string | Uint8Array)[]

Optional libp2p

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.

-

Optional pingKeepAlive

pingKeepAlive?: number
+

Optional pingKeepAlive

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

-

Optional pubSubTopic

pubSubTopic?: string
+

Optional pubSubTopic

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

-

Optional relayKeepAlive

relayKeepAlive?: number
+

Optional relayKeepAlive

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

-

Optional staticNoiseKey

staticNoiseKey?: Buffer
+

Optional staticNoiseKey

staticNoiseKey?: Buffer

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 9363f16bc7..433334ebae 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

Interface CreateOptions

Hierarchy

  • CreateOptions

Index

Properties

Properties

Optional pubSubTopic

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

Interface CreateOptions

Hierarchy

  • CreateOptions

Index

Properties

Properties

Optional pubSubTopic

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 3fe1d6992b..e0c336fbbf 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

Interface PushOptions

Hierarchy

  • PushOptions

Index

Properties

Properties

Optional peerId

peerId?: PeerId

Optional pubSubTopic

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

Interface PushOptions

Hierarchy

  • PushOptions

Index

Properties

Properties

Optional peerId

peerId?: PeerId

Optional pubSubTopic

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 26b771ff94..9dc09282f3 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

Interface PushResponse

Hierarchy

  • PushResponse

Index

Properties

Properties

info

info: string

isSuccess

isSuccess: boolean

Legend

  • Property

Settings

Theme

Generated using TypeDoc

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

Interface PushResponse

Hierarchy

  • PushResponse

Index

Properties

Properties

info

info: string

isSuccess

isSuccess: boolean

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 a82a852bc5..1c3cd9dec7 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

Interface Options

Hierarchy

  • Options

Index

Properties

Properties

Optional encPublicKey

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

Interface Options

Hierarchy

  • Options

Index

Properties

Properties

Optional encPublicKey

encPublicKey?: string | Uint8Array

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

throws

if both encPublicKey and symKey are passed

-

Optional sigPrivKey

sigPrivKey?: Uint8Array
+

Optional sigPrivKey

sigPrivKey?: Uint8Array

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

-

Optional symKey

symKey?: string | Uint8Array
+

Optional symKey

symKey?: string | Uint8Array

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

throws

if both encPublicKey and symKey are passed

-

Optional timestamp

timestamp?: Date
+

Optional timestamp

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 08392495bb..a5b361ff62 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

Properties

D

D: number

Dhi

Dhi: number

Dlazy

Dlazy: number

Dlo

Dlo: number

Dout

Dout: number

Dscore

Dscore: number

directPeers

directPeers: AddrInfo[]

doPX

doPX: boolean

emitSelf

emitSelf: boolean

fallbackToFloodsub

fallbackToFloodsub: boolean

floodPublish

floodPublish: boolean

gossipIncoming

gossipIncoming: boolean

messageCache

messageCache: MessageCache

msgIdFn

msgIdFn: MessageIdFunction

scoreParams

scoreParams: Partial<PeerScoreParams>

scoreThresholds

scoreThresholds: Partial<PeerScoreThresholds>

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • GossipOptions

Index

Properties

Properties

D

D: number

Dhi

Dhi: number

Dlazy

Dlazy: number

Dlo

Dlo: number

Dout

Dout: number

Dscore

Dscore: number

directPeers

directPeers: AddrInfo[]

doPX

doPX: boolean

emitSelf

emitSelf: boolean

fallbackToFloodsub

fallbackToFloodsub: boolean

floodPublish

floodPublish: boolean

gossipIncoming

gossipIncoming: boolean

messageCache

messageCache: MessageCache

msgIdFn

msgIdFn: MessageIdFunction

scoreParams

scoreParams: Partial<PeerScoreParams>

scoreThresholds

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 335df9bf40..3b95d8826d 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

Optional pubSubTopic

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

Interface CreateOptions

Hierarchy

  • CreateOptions

Index

Properties

Properties

Optional pubSubTopic

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 5f62a09cfc..42ee4d4624 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

Methods

Properties

Optional decryptionKeys

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

Interface QueryOptions

Hierarchy

  • QueryOptions

Index

Properties

Methods

Properties

Optional decryptionKeys

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.

-

Optional pageDirection

pageDirection?: PageDirection
+

Optional 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

-

Optional pageSize

pageSize?: number
+

Optional pageSize

pageSize?: number

The number of message per page.

default

DefaultPageSize

-

Optional peerId

peerId?: PeerId
+

Optional peerId

peerId?: PeerId

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

-

Optional pubSubTopic

pubSubTopic?: string
+

Optional pubSubTopic

pubSubTopic?: string

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

-

Optional timeFilter

timeFilter?: TimeFilter
+

Optional timeFilter

timeFilter?: TimeFilter

Retrieve messages with a timestamp within the provided values.

-

Methods

Optional callback

Methods

Optional callback