mirror of https://github.com/waku-org/js-waku.git
d9e4bcbe3f
* add Firefox and Webkit to karma testing * try adding install to CI * add display var * try container prop * try FirefoxHeadless * set env var differently * apply for all configs * use root karma config * fix relative link in karma config * add log * return as before * fix path pattern * move karma to the root * try moving tsconfig * return ts config * use container for playwright * add FF for firefox and chrome * use command for playwright * add retries * remove retries |
||
---|---|---|
.. | ||
src | ||
.eslintrc.cjs | ||
.mocharc.json | ||
CHANGELOG.md | ||
README.md | ||
karma.conf.cjs | ||
package.json | ||
rollup.config.js | ||
tsconfig.dev.json | ||
tsconfig.json | ||
typedoc.json |
README.md
@waku/message-encryption
Provide Waku Message Version 1 payload encryption as defined in 26/WAKU2-PAYLOAD.
Symmetric Encryption
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) => {
// ...
});
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) => {
// ...
});