@waku/message-encryption 0.0.4 → 0.0.5

package/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.5] - 2022-12-15
+
+### Added
+
+- Add `@multiformats/multiaddr` as peer dependency.
+- New `createEncoder` and `createDecoder` functions so that the consumer does not deal with Encoder/Decoder classes.
+-
+
+### Changed
+
+- `Asymmetric` renamed to `ECIES` to follow RFC terminology.
+- Split `ECIES` and `symmetric` packages, all items are now export from two different paths: `@waku/message-encryption/ecies` and `@waku/message-encryption/symmetric`.
+- remove `asym` and `sym` prefix from exported items as they are now differentiated from their export path: `createEncoder`, `createDecoder`, `DecodedMessage`.
+- Remove usage for `Partial` with `Message` as `Message`'s field are all optional.
+
+## [0.0.4] - 2022-11-18
+
+### Added
+
+- Alpha version of `@waku/message-encryption`.
+
+[unreleased]: https://github.com/waku-org/js-waku/compare/@waku/message-encryption@0.0.5...HEAD
+[0.0.5]: https://github.com/waku-org/js-waku/compare/@waku/message-encryption@0.0.4...@waku/message-encryption@0.0.5
+[0.0.4]: https://github.com/waku-org/js-waku/compare/@waku/message-encryption@0.0.3...@waku/message-encryption@0.0.4
+[0.0.3]: https://github.com/waku-org/js-waku/compare/@waku/message-encryption@0.0.2...%40waku/message-encryption@0.0.3
+[0.0.2]: https://github.com/waku-org/js-waku/compare/@waku/message-encryption@0.0.1...%40waku/message-encryption@0.0.2
+[0.0.1]: https://github.com/status-im/js-waku/compare/a20b7809d61ff9a9732aba82b99bbe99f229b935...%40waku/message-encryption%400.0.2

package/README.md

@@ -0,0 +1,65 @@
+# `@waku/message-encryption`
+
+Provide Waku Message Version 1 payload encryption as defined in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
+
+## Symmetric Encryption
+
+Symmetric encryption uses a unique key to encrypt and decrypt messages.
+
+```typescript
+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.
+
+```typescript
+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) => {
+  // ...
+});
+```

package/bundle/ecies.js

@@ -0,0 +1 @@
+export { D as DecodedMessage, b as createDecoder, c as createEncoder, g as generatePrivateKey, a as getPublicKey } from './index-80756c1f.js';