Optional options: Partial<ConnectionManagerOptions>Private dialPrivate dialPrivate keepPrivate libp2pPrivate onPrivate optionsStatic Private instancesPrivate getPrivate runPrivate shouldPrivate startPrivate startPrivate startStatic createOptional options: ConnectionManagerOptionsPrivate Readonly _errorPrivate Readonly dnsPrivate _searchStatic dnsOptional dnsClient: DnsClientOptional peerOptional signatureStatic Readonly RECORD_Inherited from RawEnr.id
Inherited from RawEnr.ip
Inherited from RawEnr.ip
Inherited from RawEnr.ip6
Inherited from RawEnr.ip6
dns4, dnsaddr, etc)..
Implementation of IEnr.multiaddrs
Inherited from RawEnr.multiaddrs
Set the multiaddrs field on the ENR.
Implementation of IEnr.multiaddrs
Inherited from RawEnr.multiaddrs
Implementation of IEnr.publicKey
Inherited from RawEnr.publicKey
Inherited from RawEnr.tcp
Inherited from RawEnr.tcp
Inherited from RawEnr.tcp6
Inherited from RawEnr.tcp6
Inherited from RawEnr.udp
Inherited from RawEnr.udp
Inherited from RawEnr.udp6
Inherited from RawEnr.udp6
Inherited from RawEnr.waku2
Set the waku2 field on the ENR.
Inherited from RawEnr.waku2
Implementation of IEnr.set
Static createOptional signature: Uint8ArraySet the waku2 field on the ENR.
Private queryPrivate Readonly startOptional userOptional pageOptional peerThe peer to query. If undefined, a pseudo-random peer is selected from the connected Waku Store peers.
Optional timeRetrieve messages with a timestamp within the provided values.
Optional opts: ProtocolOptionsOptional options: StoreQueryOptionsOptional options: StoreQueryOptionsReadonly gossip
API Documentation can also be generated locally:
-git clone https://github.com/waku-org/js-waku.git
cd js-waku
npm install
npm run doc
+git clone https://github.com/waku-org/js-waku.git
cd js-waku
npm install
npm run doc
diff --git a/modules/_waku_core.message.html b/modules/_waku_core.message.html
index ebe7198d9f..d9d9bd65c7 100644
--- a/modules/_waku_core.message.html
+++ b/modules/_waku_core.message.html
@@ -17,7 +17,7 @@
message
Namespace message
Symmetric encryption uses a unique key to encrypt and decrypt messages.
-import {
createDecoder,
createEncoder,
generateSymmetricKey,
} from "@waku/message-encryption/symmetric";
// Generate a random key
const key = generateSymmetricKey();
// To send messages, create an encoder
const encoder = createEncoder(contentTopic, key);
// For example
waku.lightPush.push(encoder, { payload });
// To receive messages, create a decoder
const decoder = createDecoder(contentTopic, key);
// For example
await waku.store.queryOrderedCallback([decoder], (msg) => {
// ...
});
+import {
createDecoder,
createEncoder,
generateSymmetricKey,
} from "@waku/message-encryption/symmetric";
// Generate a random key
const key = generateSymmetricKey();
// To send messages, create an encoder
const encoder = createEncoder(contentTopic, key);
// For example
waku.lightPush.push(encoder, { payload });
// To receive messages, create a decoder
const decoder = createDecoder(contentTopic, key);
// For example
await waku.store.queryOrderedCallback([decoder], (msg) => {
// ...
});
ECIES Encryption
ECIES encryption enables encryption for a public key and decryption using a private key.
-import {
createDecoder,
createEncoder,
generatePrivateKey,
getPublicKey,
} from "@waku/message-encryption/ecies";
// Generate a random private key
const privateKey = generatePrivateKey();
// Keep the private key secure, provide the public key to the sender
const publicKey = getPublicKey(privateKey);
// To send messages, create an encoder
const encoder = createEncoder(contentTopic, publicKey);
// For example
waku.lightPush.push(encoder, { payload });
// To receive messages, create a decoder
const decoder = createDecoder(contentTopic, privateKey);
// For example
await waku.store.queryOrderedCallback([decoder], (msg) => {
// ...
});
+import {
createDecoder,
createEncoder,
generatePrivateKey,
getPublicKey,
} from "@waku/message-encryption/ecies";
// Generate a random private key
const privateKey = generatePrivateKey();
// Keep the private key secure, provide the public key to the sender
const publicKey = getPublicKey(privateKey);
// To send messages, create an encoder
const encoder = createEncoder(contentTopic, publicKey);
// For example
waku.lightPush.push(encoder, { payload });
// To receive messages, create a decoder
const decoder = createDecoder(contentTopic, privateKey);
// For example
await waku.store.queryOrderedCallback([decoder], (msg) => {
// ...
});
Pings the given peer in order to obtain the operation latency
-Example