diff --git a/classes/discovery.Bootstrap.html b/classes/discovery.Bootstrap.html index eef63f5235..9f2bd07e84 100644 --- a/classes/discovery.Bootstrap.html +++ b/classes/discovery.Bootstrap.html @@ -1,4 +1,4 @@ Bootstrap | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Bootstrap

Parse options and expose function to return bootstrap peer addresses.

throws

if an invalid combination of options is passed, see BootstrapOptions for details.

-

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.DnsOverHttps.html b/classes/discovery.DnsOverHttps.html index a393a70ca6..ebf9c9382a 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

Class DnsOverHttps

Hierarchy

  • DnsOverHttps

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

endpoints

endpoints: Endpoints = ...

Methods

resolveTXT

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

Private _search

  • Runs a recursive, randomized descent of the DNS tree to retrieve a single ENR record as an ENR. Returns null if parsing or DNS resolution fails.

    -

    Parameters

    Returns Promise<null | ENR>

getPeers

getPeers

Static dnsOverHttp

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<ENR[]>

Static dnsOverHttp

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/enr.ENR.html b/classes/enr.ENR.html index 653398f5ba..bce7231a3e 100644 --- a/classes/enr.ENR.html +++ b/classes/enr.ENR.html @@ -1,4 +1,4 @@ -ENR | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ENR

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

  • new ENR(kvs?: Record<string, Uint8Array>, seq?: bigint, signature?: null | Uint8Array): ENR

  • Parameters

    • kvs: Record<string, Uint8Array> = {}
    • seq: bigint = ...
    • signature: null | Uint8Array = null

    Returns ENR

Properties

Readonly [toStringTag]

[toStringTag]: string

Optional peerId

peerId?: PeerId

seq

seq: bigint

signature

signature: null | Uint8Array

Readonly size

size: number

Static Readonly RECORD_PREFIX

RECORD_PREFIX: "enr:" = "enr:"

Static Readonly [species]

[species]: MapConstructor

Accessors

id

  • get id(): string

ip

  • get ip(): undefined | string
  • set ip(ip: undefined | string): void

ip6

  • get ip6(): undefined | string
  • set ip6(ip: undefined | string): void

keypair

keypairType

multiaddrs

  • get multiaddrs(): undefined | Multiaddr[]
  • set multiaddrs(multiaddrs: undefined | Multiaddr[]): void
  • +ENR | js-waku
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ENR

    Hierarchy

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Private constructor

    • new ENR(kvs?: Record<string, Uint8Array>, seq?: bigint, signature?: null | Uint8Array): ENR

    • Parameters

      • kvs: Record<string, Uint8Array> = {}
      • seq: bigint = ...
      • signature: null | Uint8Array = null

      Returns ENR

    Properties

    Readonly [toStringTag]

    [toStringTag]: string

    Optional peerId

    peerId?: PeerId

    seq

    seq: bigint

    signature

    signature: null | Uint8Array

    Readonly size

    size: number

    Static Readonly RECORD_PREFIX

    RECORD_PREFIX: "enr:" = "enr:"

    Static Readonly [species]

    [species]: MapConstructor

    Accessors

    id

    • get id(): string

    ip

    • get ip(): undefined | string
    • set ip(ip: undefined | string): void

    ip6

    • get ip6(): undefined | string
    • set ip6(ip: undefined | string): void

    keypair

    keypairType

    multiaddrs

    • get multiaddrs(): undefined | Multiaddr[]
    • set multiaddrs(multiaddrs: undefined | Multiaddr[]): void

    • Get the multiaddrs field from ENR.

      This field is used to store multiaddresses that cannot be stored with the current ENR pre-defined keys. These can be a multiaddresses that include encapsulation (e.g. wss) or do not use ip4 nor ip6 for the host @@ -6,7 +6,7 @@ address (e.g. dns4, dnsaddr, etc)..

      If the peer information only contains information that can be represented with the ENR pre-defined keys (ip, tcp, etc) then the usage of getLocationMultiaddr should be preferred.

      The multiaddresses stored in this field are expected to be location multiaddresses, ie, peer id less.

      -

      Returns undefined | Multiaddr[]

    • +

      Returns undefined | Multiaddr[]

    • Set the multiaddrs field on the ENR.

      This field is used to store multiaddresses that cannot be stored with the current ENR pre-defined keys. These can be a multiaddresses that include encapsulation (e.g. wss) or do not use ip4 nor ip6 for the host @@ -15,24 +15,24 @@ address (e.g. dns4, dnsaddr, etc)..

      (ip, tcp, etc) then the usage of setLocationMultiaddr should be preferred. The multiaddresses stored in this field must be location multiaddresses, ie, without a peer id.

      -

      Parameters

      • multiaddrs: undefined | Multiaddr[]

      Returns void

    nodeId

    • get nodeId(): undefined | string

    publicKey

    • get publicKey(): undefined | Uint8Array

    tcp

    • get tcp(): undefined | number
    • set tcp(port: undefined | number): void

    tcp6

    • get tcp6(): undefined | number
    • set tcp6(port: undefined | number): void

    udp

    • get udp(): undefined | number
    • set udp(port: undefined | number): void

    udp6

    • get udp6(): undefined | number
    • set udp6(port: undefined | number): void

    waku2

    • get waku2(): undefined | Waku2
    • set waku2(waku2: undefined | Waku2): void

    nodeId

    • get nodeId(): undefined | string

    publicKey

    • get publicKey(): undefined | Uint8Array

    tcp

    • get tcp(): undefined | number
    • set tcp(port: undefined | number): void

    tcp6

    • get tcp6(): undefined | number
    • set tcp6(port: undefined | number): void

    udp

    • get udp(): undefined | number
    • set udp(port: undefined | number): void

    udp6

    • get udp6(): undefined | number
    • set udp6(port: undefined | number): void

    waku2

    • get waku2(): undefined | Waku2
    • set waku2(waku2: undefined | Waku2): void

    Methods

    [iterator]

    • [iterator](): IterableIterator<[string, Uint8Array]>

    • Returns an iterable of entries in the map.

      -

      Returns IterableIterator<[string, Uint8Array]>

    clear

    • clear(): void

    • Returns void

    delete

    • delete(key: string): boolean

    • Parameters

      • key: string

      Returns boolean

    encode

    • encode(privateKey?: Uint8Array): Promise<Uint8Array>

    encodeToValues

    • encodeToValues(privateKey?: Uint8Array): Promise<(string | Uint8Array | number[])[]>

    • Parameters

      • Optional privateKey: Uint8Array

      Returns Promise<(string | Uint8Array | number[])[]>

    encodeTxt

    • encodeTxt(privateKey?: Uint8Array): Promise<string>

    entries

    • entries(): IterableIterator<[string, Uint8Array]>
    • +

      Returns IterableIterator<[string, Uint8Array]>

    clear

    • clear(): void

    • Returns void

    delete

    • delete(key: string): boolean

    • Parameters

      • key: string

      Returns boolean

    encode

    • encode(privateKey?: Uint8Array): Promise<Uint8Array>

    encodeToValues

    • encodeToValues(privateKey?: Uint8Array): Promise<(string | Uint8Array | number[])[]>

    • Parameters

      • Optional privateKey: Uint8Array

      Returns Promise<(string | Uint8Array | number[])[]>

    encodeTxt

    • encodeTxt(privateKey?: Uint8Array): Promise<string>

    entries

    • entries(): IterableIterator<[string, Uint8Array]>

    • Returns an iterable of key, value pairs for every entry in the map.

      -

      Returns IterableIterator<[string, Uint8Array]>

    forEach

    • forEach(callbackfn: (value: Uint8Array, key: string, map: Map<string, Uint8Array>) => void, thisArg?: any): void

    • Parameters

      • callbackfn: (value: Uint8Array, key: string, map: Map<string, Uint8Array>) => void
          • (value: Uint8Array, key: string, map: Map<string, Uint8Array>): void

          • Parameters

            • value: Uint8Array
            • key: string
            • map: Map<string, Uint8Array>

            Returns void

      • Optional thisArg: any

      Returns void

    get

    • get(key: string): undefined | Uint8Array

    • Parameters

      • key: string

      Returns undefined | Uint8Array

    getFullMultiaddr

    • getFullMultiaddr(protocol: "udp" | "udp4" | "udp6" | "tcp" | "tcp4" | "tcp6"): undefined | Multiaddr

    forEach

    • forEach(callbackfn: (value: Uint8Array, key: string, map: Map<string, Uint8Array>) => void, thisArg?: any): void

    • Parameters

      • callbackfn: (value: Uint8Array, key: string, map: Map<string, Uint8Array>) => void
          • (value: Uint8Array, key: string, map: Map<string, Uint8Array>): void

          • Parameters

            • value: Uint8Array
            • key: string
            • map: Map<string, Uint8Array>

            Returns void

      • Optional thisArg: any

      Returns void

    get

    • get(key: string): undefined | Uint8Array

    • Parameters

      • key: string

      Returns undefined | Uint8Array

    getFullMultiaddr

    • getFullMultiaddr(protocol: "udp" | "udp4" | "udp6" | "tcp" | "tcp4" | "tcp6"): undefined | Multiaddr

    • Returns the full multiaddr from the ENR fields matching the provided protocol parameter. To return full multiaddrs from the multiaddrs ENR field, use ENR.getFullMultiaddrs

      Parameters

      • protocol: "udp" | "udp4" | "udp6" | "tcp" | "tcp4" | "tcp6"
        -

      Returns undefined | Multiaddr

    getFullMultiaddrs

    • getFullMultiaddrs(): Multiaddr[]

    Returns undefined | Multiaddr

getFullMultiaddrs

  • getFullMultiaddrs(): Multiaddr[]

  • Returns the full multiaddrs from the multiaddrs ENR field.

    -

    Returns Multiaddr[]

getLocationMultiaddr

  • getLocationMultiaddr(protocol: "udp" | "udp4" | "udp6" | "tcp" | "tcp4" | "tcp6"): undefined | Multiaddr

  • Parameters

    • protocol: "udp" | "udp4" | "udp6" | "tcp" | "tcp4" | "tcp6"

    Returns undefined | Multiaddr

has

  • has(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

keys

  • keys(): IterableIterator<string>
  • +

    Returns Multiaddr[]

getLocationMultiaddr

  • getLocationMultiaddr(protocol: "udp" | "udp4" | "udp6" | "tcp" | "tcp4" | "tcp6"): undefined | Multiaddr

  • Parameters

    • protocol: "udp" | "udp4" | "udp6" | "tcp" | "tcp4" | "tcp6"

    Returns undefined | Multiaddr

has

  • has(key: string): boolean

  • Parameters

    • key: string

    Returns boolean

keys

  • keys(): IterableIterator<string>

  • Returns an iterable of keys in the map

    -

    Returns IterableIterator<string>

set

  • set(k: string, v: Uint8Array): ENR

setLocationMultiaddr

  • setLocationMultiaddr(multiaddr: Multiaddr): void

sign

  • sign(data: Uint8Array, privateKey: Uint8Array): Promise<Uint8Array>

values

  • values(): IterableIterator<Uint8Array>
  • +

    Returns IterableIterator<string>

set

  • set(k: string, v: Uint8Array): ENR

setLocationMultiaddr

  • setLocationMultiaddr(multiaddr: Multiaddr): void

sign

  • sign(data: Uint8Array, privateKey: Uint8Array): Promise<Uint8Array>

values

  • values(): IterableIterator<Uint8Array>

  • Returns an iterable of values in the map

    -

    Returns IterableIterator<Uint8Array>

verify

  • verify(data: Uint8Array, signature: Uint8Array): boolean

Static create

  • create(kvs?: Record<string, Uint8Array>, seq?: bigint, signature?: null | Uint8Array): Promise<ENR>

  • Parameters

    • kvs: Record<string, Uint8Array> = {}
    • seq: bigint = ...
    • signature: null | Uint8Array = null

    Returns Promise<ENR>

Static createFromPeerId

  • createFromPeerId(peerId: PeerId, kvs?: Record<string, Uint8Array>): Promise<ENR>

Static createV4

  • createV4(publicKey: Uint8Array, kvs?: Record<string, Uint8Array>): Promise<ENR>

Static decode

  • decode(encoded: Uint8Array): Promise<ENR>

Static decodeFromValues

  • decodeFromValues(decoded: Uint8Array[]): Promise<ENR>

Static decodeTxt

  • decodeTxt(encoded: string): Promise<ENR>

Generated using TypeDoc

\ No newline at end of file +

Returns IterableIterator<Uint8Array>

verify

Static create

Static createFromPeerId

Static createV4

Static decode

Static decodeFromValues

Static decodeTxt

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/enr.Secp256k1Keypair.html b/classes/enr.Secp256k1Keypair.html index 06be41ceab..42d50fe07a 100644 --- a/classes/enr.Secp256k1Keypair.html +++ b/classes/enr.Secp256k1Keypair.html @@ -1 +1 @@ -Secp256k1Keypair | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Secp256k1Keypair

Hierarchy

  • Secp256k1Keypair

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Secp256k1Keypair(privateKey?: Uint8Array, publicKey?: Uint8Array): Secp256k1Keypair

Properties

Optional _privateKey

_privateKey?: Uint8Array

Optional Readonly _publicKey

_publicKey?: Uint8Array

Readonly type

type: KeypairType

Accessors

privateKey

  • get privateKey(): Uint8Array

publicKey

  • get publicKey(): Uint8Array

Methods

hasPrivateKey

  • hasPrivateKey(): boolean

privateKeyVerify

  • privateKeyVerify(key?: undefined | Uint8Array): boolean

publicKeyVerify

  • publicKeyVerify(key?: undefined | Uint8Array): boolean

Static generate

Generated using TypeDoc

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

Class Secp256k1Keypair

Hierarchy

  • Secp256k1Keypair

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Secp256k1Keypair(privateKey?: Uint8Array, publicKey?: Uint8Array): Secp256k1Keypair

Properties

Optional _privateKey

_privateKey?: Uint8Array

Optional Readonly _publicKey

_publicKey?: Uint8Array

Readonly type

type: KeypairType

Accessors

privateKey

  • get privateKey(): Uint8Array

publicKey

  • get publicKey(): Uint8Array

Methods

hasPrivateKey

  • hasPrivateKey(): boolean

privateKeyVerify

  • privateKeyVerify(key?: undefined | Uint8Array): boolean

publicKeyVerify

  • publicKeyVerify(key?: undefined | Uint8Array): boolean

Static generate

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/waku.Waku.html b/classes/waku.Waku.html index 563d176a8b..6788a4036a 100644 --- a/classes/waku.Waku.html +++ b/classes/waku.Waku.html @@ -1,24 +1,24 @@ -Waku | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Waku

Hierarchy

  • Waku

Index

Constructors

Properties

Methods

Constructors

Private constructor

Properties

filter

filter: WakuFilter

libp2p

libp2p: Libp2p

lightPush

lightPush: WakuLightPush

Private pingKeepAliveTimers

pingKeepAliveTimers: {}

Type declaration

  • [peer: string]: ReturnType<typeof setInterval>

relay

relay: WakuRelay

Private relayKeepAliveTimers

relayKeepAliveTimers: {}

Type declaration

  • [peer: string]: ReturnType<typeof setInterval>

store

store: WakuStore

Methods

addDecryptionKey

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

getLocalMultiaddrWithID

  • getLocalMultiaddrWithID(): string

  • Return the local multiaddr with peer id on which libp2p is listening.

    throws

    if libp2p is not listening on localhost.

    -

    Returns string

Private startKeepAlive

  • startKeepAlive(peerId: PeerId, pingPeriodSecs: number, relayPeriodSecs: number): void

  • Parameters

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

    Returns void

stop

  • stop(): Promise<void>

Private stopKeepAlive

  • stopKeepAlive(peerId: PeerId): void

waitForRemotePeer

  • waitForRemotePeer(protocols?: Protocols[], timeoutMs?: number): Promise<void>

Private startKeepAlive

  • startKeepAlive(peerId: PeerId, pingPeriodSecs: number, relayPeriodSecs: number): void

  • Parameters

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

    Returns void

stop

  • stop(): Promise<void>

Private stopKeepAlive

  • stopKeepAlive(peerId: PeerId): void

waitForRemotePeer

  • waitForRemotePeer(protocols?: Protocols[], timeoutMs?: number): Promise<void>

Returns Promise<void>

A promise that resolves if all desired protocols are fulfilled by remote nodes, rejects if the timeoutMs is reached.

-

Static create

Static create

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 19db8d00d8..b1135dbb9a 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

Class WakuLightPush

Implements the Waku v2 Light Push protocol.

-

Hierarchy

  • WakuLightPush

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

libp2p

libp2p: Libp2p

pubSubTopic

pubSubTopic: string

Accessors

peers

  • get peers(): AsyncIterable<Peer>

Hierarchy

  • WakuLightPush

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

libp2p

libp2p: Libp2p

pubSubTopic

pubSubTopic: string

Accessors

peers

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

randomPeer

  • get randomPeer(): Promise<undefined | Peer>

randomPeer

  • 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

push

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<undefined | Peer>

Methods

push

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/waku_message.WakuMessage.html b/classes/waku_message.WakuMessage.html index 46a0f59020..56a45e8cf5 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

Class WakuMessage

Hierarchy

  • WakuMessage

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

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

Properties

proto

proto: WakuMessage

Accessors

contentTopic

  • get contentTopic(): undefined | string

payload

  • get payload(): undefined | Uint8Array

payloadAsUtf8

  • get payloadAsUtf8(): string

signature

  • get signature(): undefined | Uint8Array

Hierarchy

  • Gossipsub
    • WakuRelay

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

decryptionKeys

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

heartbeat

heartbeat: RelayHeartbeat

observers

observers: {}
+

Hierarchy

  • Gossipsub
    • WakuRelay

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

decryptionKeys

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

heartbeat

heartbeat: RelayHeartbeat

observers

observers: {}

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

-

Type declaration

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

pubSubTopic

pubSubTopic: string

Methods

addDecryptionKey

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

pubSubTopic

pubSubTopic: string

Methods

addDecryptionKey

  • 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

  • addObserver(callback: (message: WakuMessage) => void, contentTopics?: string[]): void

addObserver

  • 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

  • deleteDecryptionKey(key: string | Uint8Array): void

Returns void

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(callback: (message: WakuMessage) => void, contentTopics?: string[]): void

deleteObserver

  • 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

  • getPeers(): Set<string>

getPeers

  • getPeers(): Set<string>

send

send

start

  • start(): Promise<void>

start

  • start(): Promise<void>

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

    -
    override

    Returns Promise<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 c12b5f0a2c..054b21244d 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

Class WakuStore

Implements the Waku v2 Store protocol.

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

-

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(): AsyncIterable<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(): 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>

randomPeer

  • get randomPeer(): Promise<undefined | Peer>

randomPeer

  • 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

  • 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

  • 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

queryHistory

queryHistory

Optional enrUrl

enrUrl?: string

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

wantedNodeCapabilityCount MUST be passed when using this option.

-

Optional maxPeers

maxPeers?: number
+

Optional maxPeers

maxPeers?: number

The maximum of peers to connect to as part of the bootstrap process. This only applies if peers or getPeers is used.

default

Bootstrap.DefaultMaxPeers

-

Optional peers

peers?: Multiaddr[] | string[]
+

Optional peers

peers?: Multiaddr[] | string[]

Multiaddrs of peers to connect to.

-

Optional wantedNodeCapabilityCount

wantedNodeCapabilityCount?: Partial<NodeCapabilityCount>
+

Optional wantedNodeCapabilityCount

wantedNodeCapabilityCount?: Partial<NodeCapabilityCount>

Specifies what node capabilities (protocol) must be returned. This only applies when enrUrl is passed (EIP-1459 DNS Discovery).

-

Methods

Optional getPeers

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

Methods

Optional getPeers

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

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/discovery.dns.DnsClient.html b/interfaces/discovery.dns.DnsClient.html index 13e972ef93..1d226d0665 100644 --- a/interfaces/discovery.dns.DnsClient.html +++ b/interfaces/discovery.dns.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/discovery.dns.NodeCapabilityCount.html b/interfaces/discovery.dns.NodeCapabilityCount.html index e30587f4c1..6611de6405 100644 --- a/interfaces/discovery.dns.NodeCapabilityCount.html +++ b/interfaces/discovery.dns.NodeCapabilityCount.html @@ -1 +1 @@ -NodeCapabilityCount | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NodeCapabilityCount

Hierarchy

  • NodeCapabilityCount

Index

Properties

Properties

filter

filter: number

lightPush

lightPush: number

relay

relay: number

store

store: number

Generated using TypeDoc

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

Interface NodeCapabilityCount

Hierarchy

  • NodeCapabilityCount

Index

Properties

Properties

filter

filter: number

lightPush

lightPush: number

relay

relay: number

store

store: number

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/enr.IKeypair.html b/interfaces/enr.IKeypair.html index 6ba441dcf9..69181bef70 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

Implemented by

Index

Properties

Methods

Properties

privateKey

privateKey: Uint8Array

publicKey

publicKey: Uint8Array

type

type: KeypairType

Methods

hasPrivateKey

  • hasPrivateKey(): boolean

privateKeyVerify

  • privateKeyVerify(): boolean

publicKeyVerify

  • publicKeyVerify(): boolean

Generated using TypeDoc

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

Interface IKeypair

Hierarchy

  • IKeypair

Implemented by

Index

Properties

Methods

Properties

privateKey

privateKey: Uint8Array

publicKey

publicKey: Uint8Array

type

type: KeypairType

Methods

hasPrivateKey

  • hasPrivateKey(): boolean

privateKeyVerify

  • privateKeyVerify(): boolean

publicKeyVerify

  • publicKeyVerify(): boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/enr.Waku2.html b/interfaces/enr.Waku2.html index 191f972fbb..008497701e 100644 --- a/interfaces/enr.Waku2.html +++ b/interfaces/enr.Waku2.html @@ -1 +1 @@ -Waku2 | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Waku2

Hierarchy

  • Waku2

Index

Properties

Properties

filter

filter: boolean

lightPush

lightPush: boolean

relay

relay: boolean

store

store: boolean

Generated using TypeDoc

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

Interface Waku2

Hierarchy

  • Waku2

Index

Properties

Properties

filter

filter: boolean

lightPush

lightPush: boolean

relay

relay: boolean

store

store: boolean

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/waku.CreateOptions.html b/interfaces/waku.CreateOptions.html index 5ace9ec683..2559871b7d 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?: Uint8Array
+

Optional staticNoiseKey

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 143dafd619..87a232604c 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 66df2870b4..a3f36c8560 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 1df914d2e5..fecdb3f841 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 d638044ef3..252a5f1899 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 697c86af07..864603347b 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 7476f78e0c..844f3a6783 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 4d918ed9af..dca9f0a56c 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