js-waku/packages/message-encryption
fryorcraken.eth da1b18d995
feat: export `Decoder`, `Encoder` and `DecodedMessage` types from root
Fixes #1010
2023-03-08 09:52:27 +11:00
..
src feat: export `Decoder`, `Encoder` and `DecodedMessage` types from root 2023-03-08 09:52:27 +11:00
.eslintrc.cjs chore: init message-encryption package 2022-11-04 11:25:53 +11:00
.mocharc.json chore: remove usage of jsdom 2023-02-10 19:44:59 +11:00
.prettierignore chore: init message-encryption package 2022-11-04 11:25:53 +11:00
CHANGELOG.md chore: update note in CHANGELOG and add missing (#1178) 2023-02-14 01:11:40 +01:00
README.md doc: add readme for @waku/message-encryption 2022-12-05 15:14:51 +11:00
karma.conf.cjs chore: init message-encryption package 2022-11-04 11:25:53 +11:00
package.json chore(deps)(deps-dev): bump fast-check from 3.6.3 to 3.7.0 2023-03-07 16:10:09 +00:00
rollup.config.js chore: rename build-utils to avoid potential conflict 2023-03-07 16:44:57 +11:00
tsconfig.dev.json chore: merge tsconfig 2022-12-02 15:54:30 +11:00
tsconfig.json chore: merge tsconfig 2022-12-02 15:54:30 +11:00

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) => {
  // ...
});