@waku/message-encryption 0.0.21 → 0.0.23-a42b7be.0

package/dist/symmetric.js

@@ -1,18 +1,21 @@
+import { DefaultPubSubTopic } from "@waku/core";
 import { Decoder as DecoderV0 } from "@waku/core/lib/message/version_0";
 import { WakuMessage } from "@waku/proto";
-import debug from "debug";
+import { Logger } from "@waku/utils";
 import { DecodedMessage } from "./decoded_message.js";
 import { decryptSymmetric, encryptSymmetric, postCipher, preCipher } from "./waku_payload.js";
 import { generateSymmetricKey, OneMillion, Version } from "./index.js";
 export { generateSymmetricKey };
-const log = debug("waku:message-encryption:symmetric");
+const log = new Logger("message-encryption:symmetric");
 class Encoder {
+    pubsubTopic;
     contentTopic;
     symKey;
     sigPrivKey;
     ephemeral;
     metaSetter;
-    constructor(contentTopic, symKey, sigPrivKey, ephemeral = false, metaSetter) {
+    constructor(pubsubTopic, contentTopic, symKey, sigPrivKey, ephemeral = false, metaSetter) {
+        this.pubsubTopic = pubsubTopic;
         this.contentTopic = contentTopic;
         this.symKey = symKey;
         this.sigPrivKey = sigPrivKey;
@@ -54,26 +57,25 @@ class Encoder {
  *
  * 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({ contentTopic, symKey, sigPrivKey, ephemeral = false, metaSetter }) {
-    return new Encoder(contentTopic, symKey, sigPrivKey, ephemeral, metaSetter);
+export function createEncoder({ pubsubTopic = DefaultPubSubTopic, contentTopic, symKey, sigPrivKey, ephemeral = false, metaSetter }) {
+    return new Encoder(pubsubTopic, contentTopic, symKey, sigPrivKey, ephemeral, metaSetter);
 }
 class Decoder extends DecoderV0 {
     symKey;
-    constructor(contentTopic, symKey) {
-        super(contentTopic);
+    constructor(pubsubTopic, contentTopic, symKey) {
+        super(pubsubTopic, contentTopic);
         this.symKey = symKey;
     }
-    async fromProtoObj(pubSubTopic, protoMessage) {
+    async fromProtoObj(pubsubTopic, protoMessage) {
         const cipherPayload = protoMessage.payload;
         if (protoMessage.version !== Version) {
-            log("Failed to decrypt due to incorrect version, expected:", Version, ", actual:", protoMessage.version);
+            log.error("Failed to decrypt due to incorrect version, expected:", Version, ", actual:", protoMessage.version);
             return;
         }
         let payload;
@@ -81,20 +83,20 @@ class Decoder extends DecoderV0 {
             payload = await decryptSymmetric(cipherPayload, this.symKey);
         }
         catch (e) {
-            log(`Failed to decrypt message using asymmetric decryption for contentTopic: ${this.contentTopic}`, e);
+            log.error(`Failed to decrypt message using asymmetric decryption for contentTopic: ${this.contentTopic}`, e);
             return;
         }
         if (!payload) {
-            log(`Failed to decrypt payload for contentTopic ${this.contentTopic}`);
+            log.error(`Failed to decrypt payload for contentTopic ${this.contentTopic}`);
             return;
         }
         const res = postCipher(payload);
         if (!res) {
-            log(`Failed to decode payload for contentTopic ${this.contentTopic}`);
+            log.error(`Failed to decode payload for contentTopic ${this.contentTopic}`);
             return;
         }
-        log("Message decrypted", protoMessage);
-        return new DecodedMessage(pubSubTopic, protoMessage, res.payload, res.sig?.signature, res.sig?.publicKey);
+        log.info("Message decrypted", protoMessage);
+        return new DecodedMessage(pubsubTopic, protoMessage, res.payload, res.sig?.signature, res.sig?.publicKey);
     }
 }
 /**
@@ -103,14 +105,13 @@ class Decoder extends DecoderV0 {
  *
  * 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.
  * @param symKey The symmetric key used to decrypt the message.
  */
-export function createDecoder(contentTopic, symKey) {
-    return new Decoder(contentTopic, symKey);
+export function createDecoder(contentTopic, symKey, pubsubTopic = DefaultPubSubTopic) {
+    return new Decoder(pubsubTopic, contentTopic, symKey);
 }
 //# sourceMappingURL=symmetric.js.map

package/dist/symmetric.js.map

@@ -1 +1 @@
-{"version":3,"file":"symmetric.js","sourceRoot":"","sources":["../src/symmetric.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,kCAAkC,CAAC;AASxE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,UAAU,EACV,SAAS,EACV,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAEvE,OAAO,EAAE,oBAAoB,EAAE,CAAC;AAGhC,MAAM,GAAG,GAAG,KAAK,CAAC,mCAAmC,CAAC,CAAC;AAEvD,MAAM,OAAO;IAEF;IACC;IACA;IACD;IACA;IALT,YACS,YAAoB,EACnB,MAAkB,EAClB,UAAuB,EACxB,YAAqB,KAAK,EAC1B,UAAwB;QAJxB,iBAAY,GAAZ,YAAY,CAAQ;QACnB,WAAM,GAAN,MAAM,CAAY;QAClB,eAAU,GAAV,UAAU,CAAa;QACxB,cAAS,GAAT,SAAS,CAAiB;QAC1B,eAAU,GAAV,UAAU,CAAc;QAE/B,IAAI,CAAC,YAAY,IAAI,YAAY,KAAK,EAAE,EAAE;YACxC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACpD;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAiB;QAC5B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,YAAY;YAAE,OAAO;QAE1B,OAAO,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAiB;QAChC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC;QAClD,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE1E,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAErE,MAAM,YAAY,GAAG;YACnB,OAAO;YACP,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,GAAG,UAAU;YACnD,IAAI,EAAE,SAAS;YACf,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;QAEF,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC3C,OAAO,EAAE,GAAG,YAAY,EAAE,IAAI,EAAE,CAAC;SAClC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AASD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAAC,EAC5B,YAAY,EACZ,MAAM,EACN,UAAU,EACV,SAAS,GAAG,KAAK,EACjB,UAAU,EACK;IACf,OAAO,IAAI,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AAC9E,CAAC;AAED,MAAM,OAAQ,SAAQ,SAAS;IAGnB;IAFV,YACE,YAAoB,EACZ,MAAkB;QAE1B,KAAK,CAAC,YAAY,CAAC,CAAC;QAFZ,WAAM,GAAN,MAAM,CAAY;IAG5B,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,WAAmB,EACnB,YAA2B;QAE3B,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC;QAE3C,IAAI,YAAY,CAAC,OAAO,KAAK,OAAO,EAAE;YACpC,GAAG,CACD,uDAAuD,EACvD,OAAO,EACP,WAAW,EACX,YAAY,CAAC,OAAO,CACrB,CAAC;YACF,OAAO;SACR;QAED,IAAI,OAAO,CAAC;QAEZ,IAAI;YACF,OAAO,GAAG,MAAM,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SAC9D;QAAC,OAAO,CAAC,EAAE;YACV,GAAG,CACD,2EAA2E,IAAI,CAAC,YAAY,EAAE,EAC9F,CAAC,CACF,CAAC;YACF,OAAO;SACR;QAED,IAAI,CAAC,OAAO,EAAE;YACZ,GAAG,CAAC,8CAA8C,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YACvE,OAAO;SACR;QAED,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhC,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,CAAC,6CAA6C,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YACtE,OAAO;SACR;QAED,GAAG,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;QACvC,OAAO,IAAI,cAAc,CACvB,WAAW,EACX,YAAY,EACZ,GAAG,CAAC,OAAO,EACX,GAAG,CAAC,GAAG,EAAE,SAAS,EAClB,GAAG,CAAC,GAAG,EAAE,SAAS,CACnB,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAC3B,YAAoB,EACpB,MAAkB;IAElB,OAAO,IAAI,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAC3C,CAAC"}
+{"version":3,"file":"symmetric.js","sourceRoot":"","sources":["../src/symmetric.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAUxE,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,UAAU,EACV,SAAS,EACV,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAEvE,OAAO,EAAE,oBAAoB,EAAE,CAAC;AAGhC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,8BAA8B,CAAC,CAAC;AAEvD,MAAM,OAAO;IAEF;IACA;IACC;IACA;IACD;IACA;IANT,YACS,WAAwB,EACxB,YAAoB,EACnB,MAAkB,EAClB,UAAuB,EACxB,YAAqB,KAAK,EAC1B,UAAwB;QALxB,gBAAW,GAAX,WAAW,CAAa;QACxB,iBAAY,GAAZ,YAAY,CAAQ;QACnB,WAAM,GAAN,MAAM,CAAY;QAClB,eAAU,GAAV,UAAU,CAAa;QACxB,cAAS,GAAT,SAAS,CAAiB;QAC1B,eAAU,GAAV,UAAU,CAAc;QAE/B,IAAI,CAAC,YAAY,IAAI,YAAY,KAAK,EAAE,EAAE;YACxC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;SACpD;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAiB;QAC5B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,CAAC,YAAY;YAAE,OAAO;QAE1B,OAAO,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAiB;QAChC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC;QAClD,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE1E,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,eAAe,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAErE,MAAM,YAAY,GAAG;YACnB,OAAO;YACP,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,GAAG,UAAU;YACnD,IAAI,EAAE,SAAS;YACf,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;QAEF,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC3C,OAAO,EAAE,GAAG,YAAY,EAAE,IAAI,EAAE,CAAC;SAClC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AASD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,aAAa,CAAC,EAC5B,WAAW,GAAG,kBAAkB,EAChC,YAAY,EACZ,MAAM,EACN,UAAU,EACV,SAAS,GAAG,KAAK,EACjB,UAAU,EACK;IACf,OAAO,IAAI,OAAO,CAChB,WAAW,EACX,YAAY,EACZ,MAAM,EACN,UAAU,EACV,SAAS,EACT,UAAU,CACX,CAAC;AACJ,CAAC;AAED,MAAM,OAAQ,SAAQ,SAAS;IAInB;IAHV,YACE,WAAwB,EACxB,YAAoB,EACZ,MAAkB;QAE1B,KAAK,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAFzB,WAAM,GAAN,MAAM,CAAY;IAG5B,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,WAAmB,EACnB,YAA2B;QAE3B,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC;QAE3C,IAAI,YAAY,CAAC,OAAO,KAAK,OAAO,EAAE;YACpC,GAAG,CAAC,KAAK,CACP,uDAAuD,EACvD,OAAO,EACP,WAAW,EACX,YAAY,CAAC,OAAO,CACrB,CAAC;YACF,OAAO;SACR;QAED,IAAI,OAAO,CAAC;QAEZ,IAAI;YACF,OAAO,GAAG,MAAM,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SAC9D;QAAC,OAAO,CAAC,EAAE;YACV,GAAG,CAAC,KAAK,CACP,2EAA2E,IAAI,CAAC,YAAY,EAAE,EAC9F,CAAC,CACF,CAAC;YACF,OAAO;SACR;QAED,IAAI,CAAC,OAAO,EAAE;YACZ,GAAG,CAAC,KAAK,CACP,8CAA8C,IAAI,CAAC,YAAY,EAAE,CAClE,CAAC;YACF,OAAO;SACR;QAED,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhC,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,CAAC,KAAK,CACP,6CAA6C,IAAI,CAAC,YAAY,EAAE,CACjE,CAAC;YACF,OAAO;SACR;QAED,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;QAC5C,OAAO,IAAI,cAAc,CACvB,WAAW,EACX,YAAY,EACZ,GAAG,CAAC,OAAO,EACX,GAAG,CAAC,GAAG,EAAE,SAAS,EAClB,GAAG,CAAC,GAAG,EAAE,SAAS,CACnB,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,aAAa,CAC3B,YAAoB,EACpB,MAAkB,EAClB,cAA2B,kBAAkB;IAE7C,OAAO,IAAI,OAAO,CAAC,WAAW,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;AACxD,CAAC"}

package/package.json

@@ -1,117 +1 @@
-{
-  "name": "@waku/message-encryption",
-  "version": "0.0.21",
-  "description": "Waku Message Payload Encryption",
-  "types": "./dist/index.d.ts",
-  "module": "./dist/index.js",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    },
-    "./ecies": {
-      "types": "./dist/ecies.d.ts",
-      "import": "./dist/ecies.js"
-    },
-    "./symmetric": {
-      "types": "./dist/symmetric.d.ts",
-      "import": "./dist/symmetric.js"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      "*": [
-        "*",
-        "dist/*",
-        "dist/*/index"
-      ]
-    }
-  },
-  "type": "module",
-  "author": "Waku Team",
-  "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/message-encryption#readme",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/waku-org/js-waku.git"
-  },
-  "bugs": {
-    "url": "https://github.com/waku-org/js-waku/issues"
-  },
-  "license": "MIT OR Apache-2.0",
-  "keywords": [
-    "waku",
-    "decentralized",
-    "secure",
-    "communication",
-    "web3",
-    "ethereum",
-    "dapps",
-    "privacy"
-  ],
-  "scripts": {
-    "build": "run-s build:**",
-    "build:esm": "tsc",
-    "build:bundle": "rollup --config rollup.config.js",
-    "fix": "run-s fix:*",
-    "fix:lint": "eslint src *.js --fix",
-    "check": "run-s check:*",
-    "check:lint": "eslint src *.js",
-    "check:spelling": "cspell \"{README.md,src/**/*.ts}\"",
-    "check:tsc": "tsc -p tsconfig.dev.json",
-    "test": "run-s test:*",
-    "test:node": "TS_NODE_PROJECT=./tsconfig.dev.json mocha",
-    "test:browser": "karma start karma.conf.cjs",
-    "prepublish": "npm run build",
-    "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build"
-  },
-  "engines": {
-    "node": ">=16"
-  },
-  "browser": {
-    "crypto": false
-  },
-  "dependencies": {
-    "@noble/secp256k1": "^1.7.1",
-    "@waku/core": "0.0.23",
-    "@waku/interfaces": "0.0.18",
-    "@waku/proto": "0.0.5",
-    "@waku/utils": "0.0.11",
-    "debug": "^4.3.4",
-    "js-sha3": "^0.8.0"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^25.0.4",
-    "@rollup/plugin-json": "^6.0.0",
-    "@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": "^7.3.2",
-    "fast-check": "^3.12.0",
-    "karma": "^6.4.1",
-    "karma-chrome-launcher": "^3.2.0",
-    "karma-mocha": "^2.0.1",
-    "karma-webpack": "^5.0.0",
-    "mocha": "^10.2.0",
-    "npm-run-all": "^4.1.5",
-    "process": "^0.11.10",
-    "puppeteer": "^21.1.1",
-    "rollup": "^3.29.0",
-    "ts-loader": "^9.4.2",
-    "typescript": "^5.0.4"
-  },
-  "typedoc": {
-    "entryPoint": "./src/index.ts"
-  },
-  "files": [
-    "dist",
-    "bundle",
-    "src/**/*.ts",
-    "!**/*.spec.*",
-    "!**/*.json",
-    "CHANGELOG.md",
-    "LICENSE",
-    "README.md"
-  ]
-}
+{"name":"@waku/message-encryption","version":"0.0.23-a42b7be.0","description":"Waku Message Payload Encryption","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./ecies":{"types":"./dist/ecies.d.ts","import":"./dist/ecies.js"},"./symmetric":{"types":"./dist/symmetric.d.ts","import":"./dist/symmetric.js"}},"typesVersions":{"*":{"*":["*","dist/*","dist/*/index"]}},"type":"module","author":"Waku Team","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/message-encryption#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","decentralized","secure","communication","web3","ethereum","dapps","privacy"],"scripts":{"build":"run-s build:**","build:esm":"tsc","build:bundle":"rollup --config rollup.config.js","fix":"run-s fix:*","fix:lint":"eslint src *.js --fix","check":"run-s check:*","check:lint":"eslint src *.js","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","check:tsc":"tsc -p tsconfig.dev.json","test":"run-s test:*","test:node":"TS_NODE_PROJECT=./tsconfig.dev.json mocha","test:browser":"karma start karma.conf.cjs","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=18"},"browser":{"crypto":false},"dependencies":{"@noble/secp256k1":"^1.7.1","@waku/core":"0.0.25-a42b7be.0","@waku/interfaces":"0.0.20-a42b7be.0","@waku/proto":"0.0.6-a42b7be.0","@waku/utils":"0.0.13-a42b7be.0","debug":"^4.3.4","js-sha3":"^0.9.2"},"devDependencies":{"@rollup/plugin-commonjs":"^25.0.4","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^4.3.5","@types/mocha":"^10.0.1","@waku/build-utils":"*","chai":"^4.3.7","cspell":"^7.3.2","fast-check":"^3.13.1","mocha":"^10.2.0","npm-run-all":"^4.1.5","process":"^0.11.10","rollup":"^3.29.2"},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"]}

package/src/decoded_message.ts

@@ -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,5 +1,6 @@
+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,
@@ -8,7 +9,7 @@ import type {
   IProtoMessage
 } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
-import debug from "debug";
+import { Logger } from "@waku/utils";
 
 import { DecodedMessage } from "./decoded_message.js";
 import {
@@ -28,10 +29,11 @@ import {
 export { generatePrivateKey, getPublicKey };
 export type { Encoder, Decoder, DecodedMessage };
 
-const log = debug("waku:message-encryption:ecies");
+const log = new Logger("message-encryption:ecies");
 
 class Encoder implements IEncoder {
   constructor(
+    public pubsubTopic: PubSubTopic,
     public contentTopic: string,
     private publicKey: Uint8Array,
     private sigPrivKey?: Uint8Array,
@@ -88,13 +90,14 @@ 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,
@@ -102,6 +105,7 @@ export function createEncoder({
   metaSetter
 }: EncoderOptions): Encoder {
   return new Encoder(
+    pubsubTopic,
     contentTopic,
     publicKey,
     sigPrivKey,
@@ -112,20 +116,21 @@ export function createEncoder({
 
 class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
   constructor(
+    pubsubTopic: PubSubTopic,
     contentTopic: string,
     private privateKey: Uint8Array
   ) {
-    super(contentTopic);
+    super(pubsubTopic, contentTopic);
   }
 
   async fromProtoObj(
-    pubSubTopic: string,
+    pubsubTopic: string,
     protoMessage: IProtoMessage
   ): Promise<DecodedMessage | undefined> {
     const cipherPayload = protoMessage.payload;
 
     if (protoMessage.version !== Version) {
-      log(
+      log.error(
         "Failed to decrypt due to incorrect version, expected:",
         Version,
         ", actual:",
@@ -139,7 +144,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
     try {
       payload = await decryptAsymmetric(cipherPayload, this.privateKey);
     } catch (e) {
-      log(
+      log.error(
         `Failed to decrypt message using asymmetric decryption for contentTopic: ${this.contentTopic}`,
         e
       );
@@ -147,20 +152,24 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
     }
 
     if (!payload) {
-      log(`Failed to decrypt payload for contentTopic ${this.contentTopic}`);
+      log.error(
+        `Failed to decrypt payload for contentTopic ${this.contentTopic}`
+      );
       return;
     }
 
     const res = postCipher(payload);
 
     if (!res) {
-      log(`Failed to decode payload for contentTopic ${this.contentTopic}`);
+      log.error(
+        `Failed to decode payload for contentTopic ${this.contentTopic}`
+      );
       return;
     }
 
-    log("Message decrypted", protoMessage);
+    log.info("Message decrypted", protoMessage);
     return new DecodedMessage(
-      pubSubTopic,
+      pubsubTopic,
       protoMessage,
       res.payload,
       res.sig?.signature,
@@ -175,8 +184,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.
@@ -184,7 +192,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/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,
@@ -5,10 +6,11 @@ import type {
   IEncoder,
   IMessage,
   IMetaSetter,
-  IProtoMessage
+  IProtoMessage,
+  PubSubTopic
 } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
-import debug from "debug";
+import { Logger } from "@waku/utils";
 
 import { DecodedMessage } from "./decoded_message.js";
 import {
@@ -23,10 +25,11 @@ import { generateSymmetricKey, OneMillion, Version } from "./index.js";
 export { generateSymmetricKey };
 export type { DecodedMessage, Encoder, Decoder };
 
-const log = debug("waku:message-encryption:symmetric");
+const log = new Logger("message-encryption:symmetric");
 
 class Encoder implements IEncoder {
   constructor(
+    public pubsubTopic: PubSubTopic,
     public contentTopic: string,
     private symKey: Uint8Array,
     private sigPrivKey?: Uint8Array,
@@ -83,39 +86,47 @@ 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
 }: 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(
+    pubsubTopic: PubSubTopic,
     contentTopic: string,
     private symKey: Uint8Array
   ) {
-    super(contentTopic);
+    super(pubsubTopic, contentTopic);
   }
 
   async fromProtoObj(
-    pubSubTopic: string,
+    pubsubTopic: string,
     protoMessage: IProtoMessage
   ): Promise<DecodedMessage | undefined> {
     const cipherPayload = protoMessage.payload;
 
     if (protoMessage.version !== Version) {
-      log(
+      log.error(
         "Failed to decrypt due to incorrect version, expected:",
         Version,
         ", actual:",
@@ -129,7 +140,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
     try {
       payload = await decryptSymmetric(cipherPayload, this.symKey);
     } catch (e) {
-      log(
+      log.error(
         `Failed to decrypt message using asymmetric decryption for contentTopic: ${this.contentTopic}`,
         e
       );
@@ -137,20 +148,24 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
     }
 
     if (!payload) {
-      log(`Failed to decrypt payload for contentTopic ${this.contentTopic}`);
+      log.error(
+        `Failed to decrypt payload for contentTopic ${this.contentTopic}`
+      );
       return;
     }
 
     const res = postCipher(payload);
 
     if (!res) {
-      log(`Failed to decode payload for contentTopic ${this.contentTopic}`);
+      log.error(
+        `Failed to decode payload for contentTopic ${this.contentTopic}`
+      );
       return;
     }
 
-    log("Message decrypted", protoMessage);
+    log.info("Message decrypted", protoMessage);
     return new DecodedMessage(
-      pubSubTopic,
+      pubsubTopic,
       protoMessage,
       res.payload,
       res.sig?.signature,
@@ -165,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.
@@ -174,7 +188,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);
 }