@waku/message-encryption 0.0.20 → 0.0.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/message-encryption",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "description": "Waku Message Payload Encryption",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -65,51 +65,34 @@
     "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "browser": {
     "crypto": false
   },
   "dependencies": {
     "@noble/secp256k1": "^1.7.1",
-    "@waku/core": "0.0.22",
-    "@waku/interfaces": "0.0.17",
+    "@waku/core": "0.0.24",
+    "@waku/interfaces": "0.0.19",
     "@waku/proto": "0.0.5",
-    "@waku/utils": "0.0.10",
+    "@waku/utils": "0.0.12",
     "debug": "^4.3.4",
-    "js-sha3": "^0.8.0"
+    "js-sha3": "^0.9.2"
   },
   "devDependencies": {
-    "@libp2p/interface-connection": "^5.1.1",
-    "@libp2p/interface-connection-manager": "^3.0.1",
-    "@libp2p/interface-libp2p": "^3.2.0",
-    "@libp2p/interface-peer-id": "^2.0.2",
-    "@libp2p/interface-peer-store": "^2.0.4",
-    "@libp2p/interface-registrar": "^2.0.12",
-    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-commonjs": "^25.0.4",
     "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.0.2",
-    "@types/chai": "^4.3.4",
+    "@rollup/plugin-node-resolve": "^15.1.0",
+    "@types/chai": "^4.3.5",
     "@types/mocha": "^10.0.1",
     "@waku/build-utils": "*",
     "chai": "^4.3.7",
-    "cspell": "^6.31.1",
-    "fast-check": "^3.8.1",
-    "karma": "^6.4.1",
-    "karma-chrome-launcher": "^3.2.0",
-    "karma-mocha": "^2.0.1",
-    "karma-webpack": "^5.0.0",
+    "cspell": "^7.3.2",
+    "fast-check": "^3.13.1",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.8.8",
     "process": "^0.11.10",
-    "puppeteer": "^20.4.0",
-    "rollup": "^3.21.3",
-    "ts-loader": "^9.4.2",
-    "typescript": "^5.0.4"
-  },
-  "typedoc": {
-    "entryPoint": "./src/index.ts"
+    "rollup": "^3.29.2"
   },
   "files": [
     "dist",

package/src/constants.ts

@@ -2,9 +2,9 @@ export const Symmetric = {
   keySize: 32,
   ivSize: 12,
   tagSize: 16,
-  algorithm: { name: "AES-GCM", length: 128 },
+  algorithm: { name: "AES-GCM", length: 128 }
 };
 
 export const Asymmetric = {
-  keySize: 32,
+  keySize: 32
 };

package/src/crypto/index.ts

@@ -9,7 +9,7 @@ import { Asymmetric, Symmetric } from "../constants.js";
 declare const self: Record<string, any> | undefined;
 const crypto: { node?: any; web?: any } = {
   node: nodeCrypto,
-  web: typeof self === "object" && "crypto" in self ? self.crypto : undefined,
+  web: typeof self === "object" && "crypto" in self ? self.crypto : undefined
 };
 
 export function getSubtle(): SubtleCrypto {
@@ -63,7 +63,7 @@ export async function sign(
 ): Promise<Uint8Array> {
   const [signature, recoveryId] = await secp.sign(message, privateKey, {
     recovered: true,
-    der: false,
+    der: false
   });
   return concat(
     [signature, new Uint8Array([recoveryId])],

package/src/decoded_message.ts

@@ -1,6 +1,6 @@
 import {
   DecodedMessage as DecodedMessageV0,
-  proto,
+  proto
 } from "@waku/core/lib/message/version_0";
 import type { IDecodedMessage } from "@waku/interfaces";
 
@@ -11,13 +11,13 @@ export class DecodedMessage
   private readonly _decodedPayload: Uint8Array;
 
   constructor(
-    pubSubTopic: string,
+    pubsubTopic: string,
     proto: proto.WakuMessage,
     decodedPayload: Uint8Array,
     public signature?: Uint8Array,
     public signaturePublicKey?: Uint8Array
   ) {
-    super(pubSubTopic, proto);
+    super(pubsubTopic, proto);
     this._decodedPayload = decodedPayload;
   }
 

package/src/ecies.ts

@@ -1,11 +1,12 @@
+import { DefaultPubSubTopic } from "@waku/core";
 import { Decoder as DecoderV0 } from "@waku/core/lib/message/version_0";
-import { IMetaSetter } from "@waku/interfaces";
+import { IMetaSetter, PubSubTopic } from "@waku/interfaces";
 import type {
   EncoderOptions as BaseEncoderOptions,
   IDecoder,
   IEncoder,
   IMessage,
-  IProtoMessage,
+  IProtoMessage
 } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
 import debug from "debug";
@@ -15,14 +16,14 @@ import {
   decryptAsymmetric,
   encryptAsymmetric,
   postCipher,
-  preCipher,
+  preCipher
 } from "./waku_payload.js";
 
 import {
   generatePrivateKey,
   getPublicKey,
   OneMillion,
-  Version,
+  Version
 } from "./index.js";
 
 export { generatePrivateKey, getPublicKey };
@@ -32,6 +33,7 @@ const log = debug("waku:message-encryption:ecies");
 
 class Encoder implements IEncoder {
   constructor(
+    public pubsubTopic: PubSubTopic,
     public contentTopic: string,
     private publicKey: Uint8Array,
     private sigPrivKey?: Uint8Array,
@@ -63,7 +65,7 @@ class Encoder implements IEncoder {
       timestamp: BigInt(timestamp.valueOf()) * OneMillion,
       meta: undefined,
       rateLimitProof: message.rateLimitProof,
-      ephemeral: this.ephemeral,
+      ephemeral: this.ephemeral
     };
 
     if (this.metaSetter) {
@@ -88,20 +90,22 @@ export interface EncoderOptions extends BaseEncoderOptions {
  *
  * An encoder is used to encode messages in the [`14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
  * format to be sent over the Waku network. The resulting encoder can then be
- * pass to { @link @waku/interfaces.LightPush.push } or
- * { @link @waku/interfaces.Relay.send } to automatically encrypt
+ * pass to { @link @waku/interfaces!ISender.send } or
+ * { @link @waku/interfaces!ISender.send } to automatically encrypt
  * and encode outgoing messages.
  * The payload can optionally be signed with the given private key as defined
  * in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
  */
 export function createEncoder({
+  pubsubTopic = DefaultPubSubTopic,
   contentTopic,
   publicKey,
   sigPrivKey,
   ephemeral = false,
-  metaSetter,
+  metaSetter
 }: EncoderOptions): Encoder {
   return new Encoder(
+    pubsubTopic,
     contentTopic,
     publicKey,
     sigPrivKey,
@@ -111,12 +115,16 @@ export function createEncoder({
 }
 
 class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
-  constructor(contentTopic: string, private privateKey: Uint8Array) {
-    super(contentTopic);
+  constructor(
+    pubsubTopic: PubSubTopic,
+    contentTopic: string,
+    private privateKey: Uint8Array
+  ) {
+    super(pubsubTopic, contentTopic);
   }
 
   async fromProtoObj(
-    pubSubTopic: string,
+    pubsubTopic: string,
     protoMessage: IProtoMessage
   ): Promise<DecodedMessage | undefined> {
     const cipherPayload = protoMessage.payload;
@@ -157,7 +165,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 
     log("Message decrypted", protoMessage);
     return new DecodedMessage(
-      pubSubTopic,
+      pubsubTopic,
       protoMessage,
       res.payload,
       res.sig?.signature,
@@ -172,8 +180,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
  *
  * A decoder is used to decode messages from the [14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
  * format when received from the Waku network. The resulting decoder can then be
- * pass to { @link @waku/interfaces.Filter.subscribe } or
- * { @link @waku/interfaces.Relay.subscribe } to automatically decrypt and
+ * pass to { @link @waku/interfaces!IReceiver.subscribe } to automatically decrypt and
  * decode incoming messages.
  *
  * @param contentTopic The resulting decoder will only decode messages with this content topic.
@@ -181,7 +188,8 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
  */
 export function createDecoder(
   contentTopic: string,
-  privateKey: Uint8Array
+  privateKey: Uint8Array,
+  pubsubTopic: PubSubTopic = DefaultPubSubTopic
 ): Decoder {
-  return new Decoder(contentTopic, privateKey);
+  return new Decoder(pubsubTopic, contentTopic, privateKey);
 }

package/src/index.ts

@@ -1,7 +1,7 @@
 import {
   generatePrivateKey,
   generateSymmetricKey,
-  getPublicKey,
+  getPublicKey
 } from "./crypto/index.js";
 import { DecodedMessage } from "./decoded_message.js";
 

package/src/symmetric.ts

@@ -1,3 +1,4 @@
+import { DefaultPubSubTopic } from "@waku/core";
 import { Decoder as DecoderV0 } from "@waku/core/lib/message/version_0";
 import type {
   EncoderOptions as BaseEncoderOptions,
@@ -6,6 +7,7 @@ import type {
   IMessage,
   IMetaSetter,
   IProtoMessage,
+  PubSubTopic
 } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
 import debug from "debug";
@@ -15,7 +17,7 @@ import {
   decryptSymmetric,
   encryptSymmetric,
   postCipher,
-  preCipher,
+  preCipher
 } from "./waku_payload.js";
 
 import { generateSymmetricKey, OneMillion, Version } from "./index.js";
@@ -27,6 +29,7 @@ const log = debug("waku:message-encryption:symmetric");
 
 class Encoder implements IEncoder {
   constructor(
+    public pubsubTopic: PubSubTopic,
     public contentTopic: string,
     private symKey: Uint8Array,
     private sigPrivKey?: Uint8Array,
@@ -58,7 +61,7 @@ class Encoder implements IEncoder {
       timestamp: BigInt(timestamp.valueOf()) * OneMillion,
       meta: undefined,
       rateLimitProof: message.rateLimitProof,
-      ephemeral: this.ephemeral,
+      ephemeral: this.ephemeral
     };
 
     if (this.metaSetter) {
@@ -83,30 +86,41 @@ export interface EncoderOptions extends BaseEncoderOptions {
  *
  * An encoder is used to encode messages in the [`14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
  * format to be sent over the Waku network. The resulting encoder can then be
- * pass to { @link @waku/interfaces.LightPush.push } or
- * { @link @waku/interfaces.Relay.send } to automatically encrypt
+ * pass to { @link @waku/interfaces!ISender.send } to automatically encrypt
  * and encode outgoing messages.
  *
  * The payload can optionally be signed with the given private key as defined
  * in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
  */
 export function createEncoder({
+  pubsubTopic = DefaultPubSubTopic,
   contentTopic,
   symKey,
   sigPrivKey,
   ephemeral = false,
-  metaSetter,
+  metaSetter
 }: EncoderOptions): Encoder {
-  return new Encoder(contentTopic, symKey, sigPrivKey, ephemeral, metaSetter);
+  return new Encoder(
+    pubsubTopic,
+    contentTopic,
+    symKey,
+    sigPrivKey,
+    ephemeral,
+    metaSetter
+  );
 }
 
 class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
-  constructor(contentTopic: string, private symKey: Uint8Array) {
-    super(contentTopic);
+  constructor(
+    pubsubTopic: PubSubTopic,
+    contentTopic: string,
+    private symKey: Uint8Array
+  ) {
+    super(pubsubTopic, contentTopic);
   }
 
   async fromProtoObj(
-    pubSubTopic: string,
+    pubsubTopic: string,
     protoMessage: IProtoMessage
   ): Promise<DecodedMessage | undefined> {
     const cipherPayload = protoMessage.payload;
@@ -147,7 +161,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 
     log("Message decrypted", protoMessage);
     return new DecodedMessage(
-      pubSubTopic,
+      pubsubTopic,
       protoMessage,
       res.payload,
       res.sig?.signature,
@@ -162,8 +176,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
  *
  * A decoder is used to decode messages from the [14/WAKU2-MESSAGE](https://rfc.vac.dev/spec/14/)
  * format when received from the Waku network. The resulting decoder can then be
- * pass to { @link @waku/interfaces.Filter.subscribe } or
- * { @link @waku/interfaces.Relay.subscribe } to automatically decrypt and
+ * pass to { @link @waku/interfaces!IReceiver.subscribe } to automatically decrypt and
  * decode incoming messages.
  *
  * @param contentTopic The resulting decoder will only decode messages with this content topic.
@@ -171,7 +184,8 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
  */
 export function createDecoder(
   contentTopic: string,
-  symKey: Uint8Array
+  symKey: Uint8Array,
+  pubsubTopic: PubSubTopic = DefaultPubSubTopic
 ): Decoder {
-  return new Decoder(contentTopic, symKey);
+  return new Decoder(pubsubTopic, contentTopic, symKey);
 }