From 3e14a43b66e6dd1a54514709a18ecc46c00a2555 Mon Sep 17 00:00:00 2001
From: status-im-auto
Date: Tue, 13 Dec 2022 02:54:25 +0000
Subject: [PATCH] Updates
---
classes/_waku_core.DecodedMessage.html | 22 ++---
classes/_waku_core.waku.WakuNode.html | 36 ++++----
.../_waku_dns_discovery.PeerDiscoveryDns.html | 16 ++--
classes/_waku_enr.ENR.html | 86 +++++++++----------
classes/_waku_enr.Secp256k1Keypair.html | 22 ++---
...aku_message_encryption.DecodedMessage.html | 12 +--
.../_waku_core.waku_store.PageDirection.html | 6 +-
enums/_waku_enr.KeypairType.html | 8 +-
enums/_waku_interfaces.PageDirection.html | 6 +-
enums/_waku_interfaces.Protocols.html | 12 +--
functions/_waku_byte_utils.bytesToHex.html | 2 +-
functions/_waku_byte_utils.bytesToUtf8.html | 2 +-
functions/_waku_byte_utils.concat.html | 2 +-
functions/_waku_byte_utils.hexToBytes.html | 2 +-
functions/_waku_byte_utils.utf8ToBytes.html | 2 +-
functions/_waku_core.createDecoder.html | 2 +-
functions/_waku_core.createEncoder.html | 2 +-
functions/_waku_core.waitForRemotePeer.html | 2 +-
.../_waku_core.waku_filter.wakuFilter.html | 2 +-
...ku_core.waku_light_push.wakuLightPush.html | 2 +-
.../_waku_core.waku_relay.wakuRelay.html | 2 +-
.../_waku_core.waku_store.createCursor.html | 2 +-
.../_waku_core.waku_store.isDefined.html | 2 +-
.../_waku_core.waku_store.wakuStore.html | 2 +-
functions/_waku_create.createLightNode.html | 2 +-
functions/_waku_create.createRelayNode.html | 2 +-
functions/_waku_create.defaultLibp2p.html | 2 +-
.../_waku_create.defaultPeerDiscovery.html | 2 +-
functions/_waku_enr.compressPublicKey.html | 2 +-
functions/_waku_enr.createKeypair.html | 2 +-
.../_waku_enr.createKeypairFromPeerId.html | 2 +-
.../_waku_enr.createPeerIdFromKeypair.html | 2 +-
functions/_waku_enr.decodeWaku2.html | 2 +-
functions/_waku_enr.encodeWaku2.html | 2 +-
functions/_waku_enr.keccak256.html | 2 +-
functions/_waku_enr.sign.html | 2 +-
functions/_waku_enr.verifySignature.html | 2 +-
...essage_encryption.ecies.createDecoder.html | 2 +-
...essage_encryption.ecies.createEncoder.html | 2 +-
...message_encryption.generatePrivateKey.html | 2 +-
...ssage_encryption.generateSymmetricKey.html | 2 +-
...ge_encryption.symmetric.createDecoder.html | 2 +-
...ge_encryption.symmetric.createEncoder.html | 2 +-
interfaces/_waku_core.waku.WakuOptions.html | 8 +-
.../_waku_core.waku_filter.CreateOptions.html | 4 +-
...aku_core.waku_filter.FilterComponents.html | 8 +-
...ku_core.waku_light_push.CreateOptions.html | 4 +-
...e.waku_light_push.LightPushComponents.html | 6 +-
.../_waku_core.waku_store.CreateOptions.html | 4 +-
.../_waku_core.waku_store.QueryOptions.html | 14 +--
..._waku_core.waku_store.StoreComponents.html | 6 +-
.../_waku_core.waku_store.TimeFilter.html | 6 +-
interfaces/_waku_create.CreateOptions.html | 10 +--
interfaces/_waku_create.Libp2pComponents.html | 34 ++++----
interfaces/_waku_enr.IKeypair.html | 14 +--
interfaces/_waku_enr.Waku2.html | 10 +--
interfaces/_waku_interfaces.FullNode.html | 22 ++---
.../_waku_interfaces.IDecodedMessage.html | 12 +--
interfaces/_waku_interfaces.IDecoder.html | 8 +-
interfaces/_waku_interfaces.IEncoder.html | 10 +--
interfaces/_waku_interfaces.IFilter.html | 8 +-
interfaces/_waku_interfaces.ILightPush.html | 8 +-
interfaces/_waku_interfaces.IMessage.html | 8 +-
.../_waku_interfaces.IPeerExchange.html | 8 +-
.../_waku_interfaces.IProtoMessage.html | 14 +--
.../_waku_interfaces.IRateLimitProof.html | 16 ++--
interfaces/_waku_interfaces.IRelay.html | 8 +-
interfaces/_waku_interfaces.IStore.html | 12 +--
interfaces/_waku_interfaces.Index.html | 10 +--
interfaces/_waku_interfaces.LightNode.html | 22 ++---
...aku_interfaces.PeerExchangeComponents.html | 8 +-
...ku_interfaces.PeerExchangeQueryParams.html | 4 +-
..._waku_interfaces.PeerExchangeResponse.html | 4 +-
interfaces/_waku_interfaces.PeerInfo.html | 4 +-
..._waku_interfaces.PointToPointProtocol.html | 6 +-
interfaces/_waku_interfaces.RelayNode.html | 22 ++---
interfaces/_waku_interfaces.SendResult.html | 4 +-
interfaces/_waku_interfaces.TimeFilter.html | 6 +-
interfaces/_waku_interfaces.Waku.html | 22 ++---
modules/_waku_byte_utils.html | 2 +-
modules/_waku_core.html | 2 +-
modules/_waku_core.waku.html | 2 +-
modules/_waku_core.waku_filter.html | 2 +-
modules/_waku_core.waku_light_push.html | 2 +-
modules/_waku_core.waku_relay.html | 2 +-
modules/_waku_core.waku_store.html | 2 +-
modules/_waku_create.html | 2 +-
modules/_waku_dns_discovery.html | 2 +-
modules/_waku_enr.html | 2 +-
modules/_waku_interfaces.html | 2 +-
modules/_waku_message_encryption.ecies.html | 2 +-
modules/_waku_message_encryption.html | 2 +-
.../_waku_message_encryption.symmetric.html | 2 +-
.../_waku_core.waku_filter.ContentFilter.html | 2 +-
..._core.waku_filter.UnsubscribeFunction.html | 2 +-
.../_waku_core.waku_relay.CreateOptions.html | 2 +-
types/_waku_core.waku_relay.Observer.html | 2 +-
types/_waku_enr.ENRKey.html | 2 +-
types/_waku_enr.ENRValue.html | 2 +-
types/_waku_enr.NodeId.html | 2 +-
types/_waku_enr.SequenceNumber.html | 2 +-
types/_waku_interfaces.Callback.html | 2 +-
types/_waku_interfaces.Cursor.html | 2 +-
types/_waku_interfaces.ProtocolOptions.html | 2 +-
types/_waku_interfaces.StoreQueryOptions.html | 2 +-
types/_waku_message_encryption.Signature.html | 2 +-
variables/_waku_core.DefaultPubSubTopic.html | 2 +-
variables/_waku_core.DefaultUserAgent.html | 2 +-
...re.waku.DefaultPingKeepAliveValueSecs.html | 2 +-
...e.waku.DefaultRelayKeepAliveValueSecs.html | 2 +-
.../_waku_core.waku_filter.FilterCodec.html | 2 +-
...u_core.waku_light_push.LightPushCodec.html | 2 +-
..._waku_core.waku_store.DefaultPageSize.html | 2 +-
.../_waku_core.waku_store.StoreCodec.html | 2 +-
variables/_waku_enr.ERR_INVALID_ID.html | 2 +-
variables/_waku_enr.ERR_NO_SIGNATURE.html | 2 +-
.../_waku_enr.ERR_TYPE_NOT_IMPLEMENTED.html | 2 +-
variables/_waku_enr.MAX_RECORD_SIZE.html | 2 +-
.../_waku_enr.MULTIADDR_LENGTH_SIZE.html | 2 +-
.../_waku_message_encryption.OneMillion.html | 2 +-
.../_waku_message_encryption.Version.html | 2 +-
121 files changed, 375 insertions(+), 375 deletions(-)
diff --git a/classes/_waku_core.DecodedMessage.html b/classes/_waku_core.DecodedMessage.html
index a7ade77a6d..b48c476509 100644
--- a/classes/_waku_core.DecodedMessage.html
+++ b/classes/_waku_core.DecodedMessage.html
@@ -25,7 +25,7 @@
+Defined in packages/core/src/lib/message/version_0.ts:18
@@ -64,14 +64,14 @@
proto: WakuMessage
+Defined in packages/core/src/lib/message/version_0.ts:19
Properties
Protected
proto
proto: WakuMessage
+Defined in packages/core/src/lib/message/version_0.ts:19
_raw Timestamp
@@ -89,7 +89,7 @@
Returns undefined | bigint
+Defined in packages/core/src/lib/message/version_0.ts:40
+Defined in packages/core/src/lib/message/version_0.ts:36
+Defined in packages/core/src/lib/message/version_0.ts:28
+Defined in packages/core/src/lib/message/version_0.ts:32
+Defined in packages/core/src/lib/message/version_0.ts:68
+Defined in packages/core/src/lib/message/version_0.ts:44
version
@@ -142,7 +142,7 @@
Returns number
+Defined in packages/core/src/lib/message/version_0.ts:63
+Defined in packages/core/src/lib/waku.ts:62
Optional
relay
relay?: IRelay
+Defined in packages/core/src/lib/waku.ts:56
Private
relay Keep Alive Timers
relay Keep Alive Timers: { [peer: string ]: ReturnType < typeof setInterval > ; }
@@ -178,13 +178,13 @@
[ peer: string ]: ReturnType < typeof setInterval >
+Defined in packages/core/src/lib/waku.ts:65
Optional
store
store?: IStore
+Defined in packages/core/src/lib/waku.ts:57
get Local Multiaddr WithID
@@ -220,7 +220,7 @@
Returns string
+Defined in packages/core/src/lib/waku.ts:207
+Defined in packages/core/src/lib/waku.ts:198
+Defined in packages/core/src/lib/waku.ts:189
Private
start Keep Alive
@@ -255,7 +255,7 @@
relayPeriodSecs: number
Returns void
+Defined in packages/core/src/lib/waku.ts:217
+Defined in packages/core/src/lib/waku.ts:193
Private
stop All Keep Alives
@@ -272,7 +272,7 @@
Returns void
+Defined in packages/core/src/lib/waku.ts:261
Private
stop Keep Alive
@@ -285,7 +285,7 @@
peerId: PeerId
Returns void
+Defined in packages/core/src/lib/waku.ts:247
Returns Promise < void >
+Defined in packages/dns-discovery/src/index.ts:54
stop
@@ -232,7 +232,7 @@
Returns void
+Defined in packages/dns-discovery/src/index.ts:72
Returns undefined | Waku2
+Defined in packages/enr/src/enr.ts:446
set waku2( waku2: undefined | Waku2 ) : void
Returns void
+Defined in packages/enr/src/enr.ts:456
Methods
@@ -408,7 +408,7 @@ ie, without a peer id.
Optional
privateKey: Uint8Array
Returns Promise < Uint8Array >
+Defined in packages/enr/src/enr.ts:509
encode To Values
@@ -421,7 +421,7 @@ ie, without a peer id.
Optional
privateKey: Uint8Array
Returns Promise < ( string | Uint8Array | number [] ) [] >
+Defined in packages/enr/src/enr.ts:486
encode Txt
@@ -434,7 +434,7 @@ ie, without a peer id.
Optional
privateKey: Uint8Array
Returns Promise < string >
+Defined in packages/enr/src/enr.ts:519
entries
@@ -514,7 +514,7 @@ use getFullMultiaddrs .
protocol: "tcp" | "udp" | "tcp6" | "udp6" | "udp4" | "tcp4"
Returns undefined | Multiaddr
+Defined in packages/enr/src/enr.ts:418
+Defined in packages/enr/src/enr.ts:433
get Location Multiaddr
@@ -537,7 +537,7 @@ use getFullMultiaddrs .
protocol: "tcp" | "udp" | "tcp6" | "udp6" | "udp4" | "tcp4"
Returns undefined | Multiaddr
+Defined in packages/enr/src/enr.ts:342
+Defined in packages/enr/src/enr.ts:152
set Location Multiaddr
Returns void
+Defined in packages/enr/src/enr.ts:386
sign
Returns Promise < Uint8Array >
+Defined in packages/enr/src/enr.ts:475
+Defined in packages/enr/src/enr.ts:465
Static
create
Returns Promise < ENR >
+Defined in packages/enr/src/enr.ts:55
Static
create From Peer Id
Returns Promise < ENR >
+Defined in packages/enr/src/enr.ts:89
Static
create V4
Returns Promise < ENR >
+Defined in packages/enr/src/enr.ts:74
Static
decode
Returns Promise < ENR >
+Defined in packages/enr/src/enr.ts:138
Static
decode From Values
Returns Promise < ENR >
+Defined in packages/enr/src/enr.ts:102
Static
decode Txt
Returns Promise < ENR >
+Defined in packages/enr/src/enr.ts:143
+Defined in packages/enr/src/keypair/secp256k1.ts:27
+Defined in packages/core/src/lib/store/history_rpc.ts:9
+Defined in packages/enr/src/keypair/types.ts:4
+Defined in packages/interfaces/src/store.ts:6
+Defined in packages/interfaces/src/protocols.ts:8
+Defined in packages/byte-utils/src/index.ts:20
+Defined in packages/byte-utils/src/index.ts:26
+Defined in packages/byte-utils/src/index.ts:36
+Defined in packages/byte-utils/src/index.ts:9
+Defined in packages/byte-utils/src/index.ts:31
Returns Decoder
+Defined in packages/core/src/lib/message/version_0.ts:162
Returns Encoder
+Defined in packages/core/src/lib/message/version_0.ts:106
Returns Promise < void >
+Defined in packages/core/src/lib/wait_for_remote_peer.ts:33
+Defined in packages/core/src/lib/filter/index.ts:309
+Defined in packages/core/src/lib/light_push/index.ts:152
+Defined in packages/core/src/lib/relay/index.ts:190
+Defined in packages/core/src/lib/store/index.ts:406
+Defined in packages/core/src/lib/store/index.ts:402
+Defined in packages/core/src/lib/store/index.ts:433
+Defined in packages/create/src/index.ts:70
+Defined in packages/create/src/index.ts:105
+Defined in packages/create/src/index.ts:174
+Defined in packages/create/src/index.ts:168
+Defined in packages/enr/src/crypto.ts:39
+Defined in packages/enr/src/keypair/index.ts:13
+Defined in packages/enr/src/keypair/index.ts:46
+Defined in packages/enr/src/keypair/index.ts:26
+Defined in packages/enr/src/waku2_codec.ts:22
+Defined in packages/enr/src/waku2_codec.ts:8
+Defined in packages/enr/src/crypto.ts:35
Returns Promise < Uint8Array >
+Defined in packages/enr/src/crypto.ts:21
+Defined in packages/enr/src/crypto.ts:50
Returns Decoder
+Defined in packages/message-encryption/src/ecies.ts:163
Returns Encoder
+Defined in packages/message-encryption/src/ecies.ts:83
+Defined in packages/message-encryption/src/crypto/index.ts:35
+Defined in packages/message-encryption/src/crypto/index.ts:42
Returns Decoder
+Defined in packages/message-encryption/src/symmetric.ts:161
Returns Encoder
+Defined in packages/message-encryption/src/symmetric.ts:81
+Defined in packages/core/src/lib/waku.ts:46
Optional
user Agent
user Agent?: string
@@ -64,7 +64,7 @@ relay to each peer after the set number of seconds. Set to 0 to disable.
Default DefaultUserAgent
+Defined in packages/core/src/lib/waku.ts:51
+Defined in packages/core/src/lib/filter/index.ts:55
+Defined in packages/core/src/lib/light_push/index.ts:48
+Defined in packages/core/src/lib/store/index.ts:55
+Defined in packages/core/src/lib/store/index.ts:83
Optional
page Size
page Size?: number
@@ -71,14 +71,14 @@ If undefined, the query will start from the beginning or end of the history, dep
Default DefaultPageSize
+Defined in packages/core/src/lib/store/index.ts:89
Optional
peer Id
peer Id?: PeerId
+Defined in packages/core/src/lib/store/index.ts:67
Optional
pub Sub Topic
pub Sub Topic?: string
@@ -86,14 +86,14 @@ If undefined, the query will start from the beginning or end of the history, dep
See Waku v2 Topic Usage Recommendations .
+Defined in packages/core/src/lib/store/index.ts:72
+Defined in packages/core/src/lib/store/index.ts:93
+Defined in packages/create/src/index.ts:42
+Defined in packages/create/src/index.ts:56
+Defined in packages/interfaces/src/message.ts:51
from Wire To Proto Obj
from
Wire
To
Proto
Obj
: ( ( bytes
: Uint8Array ) => Promise < undefined | IProtoMessage > )
@@ -80,7 +80,7 @@
bytes: Uint8Array
Returns Promise < undefined | IProtoMessage >
+Defined in packages/interfaces/src/message.ts:50
+Defined in packages/interfaces/src/message.ts:37
to Wire
to
Wire
: ( ( message
: IMessage ) => Promise < undefined | Uint8Array > )
@@ -81,7 +81,7 @@
Returns Promise < undefined | Uint8Array >
+Defined in packages/interfaces/src/message.ts:36
Returns Promise < ( ( ) => Promise < void > ) >
+Defined in packages/interfaces/src/filter.ts:9
+Defined in packages/interfaces/src/light_push.ts:9
Returns Promise < void >
+Defined in packages/interfaces/src/peer_exchange.ts:9
+Defined in packages/interfaces/src/relay.ts:17
Readonly
global Signature Policy
global Signature Policy: "StrictSign" | "StrictNoSign"
@@ -235,7 +235,7 @@ topic => peer id set
+Defined in packages/interfaces/src/relay.ts:12
Readonly
streams Inbound
streams Inbound: Map < string , InboundStream >
diff --git a/interfaces/_waku_interfaces.IStore.html b/interfaces/_waku_interfaces.IStore.html
index 4978e13212..97edca6f96 100644
--- a/interfaces/_waku_interfaces.IStore.html
+++ b/interfaces/_waku_interfaces.IStore.html
@@ -23,7 +23,7 @@
+Defined in packages/interfaces/src/store.ts:53
peers
peers: ( ( ) => Promise < Peer [] > )
@@ -58,7 +58,7 @@
Returns Promise < Peer [] >
+Defined in packages/interfaces/src/protocols.ts:16
query Callback On Promise
query
Callback
On
Promise
: ( < T > ( decoders
: IDecoder < T > [] , callback
: ( ( message
: Promise < undefined | T > ) => boolean | void | Promise < boolean | void > ) , options
?: StoreQueryOptions ) => Promise < void > )
@@ -96,7 +96,7 @@
Returns Promise < void >
+Defined in packages/interfaces/src/store.ts:59
query Generator
query
Generator
: ( < T > ( decoders
: IDecoder < T > [] , options
?: StoreQueryOptions ) => AsyncGenerator < Promise < undefined | T > [] , any , unknown > )
@@ -121,7 +121,7 @@
Returns AsyncGenerator < Promise < undefined | T > [] , any , unknown >
+Defined in packages/interfaces/src/store.ts:66
query Ordered Callback
query
Ordered
Callback
: ( < T > ( decoders
: IDecoder < T > [] , callback
: ( ( message
: T ) => boolean | void | Promise < boolean | void > ) , options
?: StoreQueryOptions ) => Promise < void > )
@@ -159,7 +159,7 @@
Returns Promise < void >
+Defined in packages/interfaces/src/store.ts:54
+Defined in packages/interfaces/src/protocols.ts:16
+Defined in packages/interfaces/src/waku.ts:25
+Defined in packages/core/src/index.ts:1
diff --git a/modules/_waku_core.waku.html b/modules/_waku_core.waku.html
index e073628982..2a2cba9b55 100644
--- a/modules/_waku_core.waku.html
+++ b/modules/_waku_core.waku.html
@@ -17,7 +17,7 @@
waku
Namespace waku
+Defined in packages/core/src/lib/waku.ts:1
diff --git a/modules/_waku_core.waku_filter.html b/modules/_waku_core.waku_filter.html
index cdf87f649a..5b65b89c74 100644
--- a/modules/_waku_core.waku_filter.html
+++ b/modules/_waku_core.waku_filter.html
@@ -17,7 +17,7 @@
waku_filter
Namespace waku_filter
+Defined in packages/core/src/lib/filter/index.ts:1
Index
diff --git a/modules/_waku_core.waku_light_push.html b/modules/_waku_core.waku_light_push.html
index e4cdf9cafe..650c3bc0a0 100644
--- a/modules/_waku_core.waku_light_push.html
+++ b/modules/_waku_core.waku_light_push.html
@@ -17,7 +17,7 @@
waku_light_push
Namespace waku_light_push
+Defined in packages/core/src/lib/light_push/index.ts:1
Index
diff --git a/modules/_waku_core.waku_relay.html b/modules/_waku_core.waku_relay.html
index 16ab976f7e..8f2e1b5daf 100644
--- a/modules/_waku_core.waku_relay.html
+++ b/modules/_waku_core.waku_relay.html
@@ -17,7 +17,7 @@
waku_relay
Namespace waku_relay
+Defined in packages/core/src/lib/relay/index.ts:1
Index
diff --git a/modules/_waku_core.waku_store.html b/modules/_waku_core.waku_store.html
index 3d29b0fe7e..bea3562cd3 100644
--- a/modules/_waku_core.waku_store.html
+++ b/modules/_waku_core.waku_store.html
@@ -17,7 +17,7 @@
waku_store
Namespace waku_store
+Defined in packages/core/src/lib/store/index.ts:1
Index
diff --git a/modules/_waku_create.html b/modules/_waku_create.html
index 5fda0ac94c..8ba7e9036e 100644
--- a/modules/_waku_create.html
+++ b/modules/_waku_create.html
@@ -16,7 +16,7 @@
@waku/create
Module @waku/create
+Defined in packages/create/src/index.ts:1
diff --git a/modules/_waku_dns_discovery.html b/modules/_waku_dns_discovery.html
index c9ef070cac..d4bd815bcf 100644
--- a/modules/_waku_dns_discovery.html
+++ b/modules/_waku_dns_discovery.html
@@ -16,7 +16,7 @@
@waku/dns-discovery
Module @waku/dns-discovery
+Defined in packages/dns-discovery/src/index.ts:1
diff --git a/modules/_waku_enr.html b/modules/_waku_enr.html
index 06706357b5..3ff1cb1bbc 100644
--- a/modules/_waku_enr.html
+++ b/modules/_waku_enr.html
@@ -16,7 +16,7 @@
@waku/enr
Module @waku/enr
+Defined in packages/enr/src/index.ts:1
diff --git a/modules/_waku_interfaces.html b/modules/_waku_interfaces.html
index 95a152f3b5..eb47e1b876 100644
--- a/modules/_waku_interfaces.html
+++ b/modules/_waku_interfaces.html
@@ -16,7 +16,7 @@
@waku/interfaces
Module @waku/interfaces
+Defined in packages/interfaces/src/index.ts:1
diff --git a/modules/_waku_message_encryption.ecies.html b/modules/_waku_message_encryption.ecies.html
index 575b21942e..8517e6526a 100644
--- a/modules/_waku_message_encryption.ecies.html
+++ b/modules/_waku_message_encryption.ecies.html
@@ -17,7 +17,7 @@
ecies
Namespace ecies
+Defined in packages/message-encryption/src/ecies.ts:1
diff --git a/modules/_waku_message_encryption.html b/modules/_waku_message_encryption.html
index 0d5b684f95..887967277b 100644
--- a/modules/_waku_message_encryption.html
+++ b/modules/_waku_message_encryption.html
@@ -16,7 +16,7 @@
@waku/message-encryption
Module @waku/message-encryption
+Defined in packages/message-encryption/src/index.ts:1
Set the
@@ -246,7 +246,7 @@ ie, without a peer id.multiaddrs
field on the ENR.multiaddrs: undefined | Multiaddr[]