@waku/rln 0.0.1 → 0.0.2-c41b319.0

package/dist/zerokit.js

@@ -0,0 +1,119 @@
+import * as zerokitRLN from "@waku/zerokit-rln-wasm";
+import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from "./contract/constants.js";
+import { IdentityCredential } from "./identity.js";
+import { Proof, proofToBytes } from "./proof.js";
+import { concatenate, dateToEpoch, epochIntToBytes, writeUIntLE } from "./utils/index.js";
+export class Zerokit {
+    zkRLN;
+    witnessCalculator;
+    constructor(zkRLN, witnessCalculator) {
+        this.zkRLN = zkRLN;
+        this.witnessCalculator = witnessCalculator;
+    }
+    generateIdentityCredentials() {
+        const memKeys = zerokitRLN.generateExtendedMembershipKey(this.zkRLN); // TODO: rename this function in zerokit rln-wasm
+        return IdentityCredential.fromBytes(memKeys);
+    }
+    generateSeededIdentityCredential(seed) {
+        const stringEncoder = new TextEncoder();
+        const seedBytes = stringEncoder.encode(seed);
+        // TODO: rename this function in zerokit rln-wasm
+        const memKeys = zerokitRLN.generateSeededExtendedMembershipKey(this.zkRLN, seedBytes);
+        return IdentityCredential.fromBytes(memKeys);
+    }
+    insertMember(idCommitment) {
+        zerokitRLN.insertMember(this.zkRLN, idCommitment);
+    }
+    insertMembers(index, ...idCommitments) {
+        // serializes a seq of IDCommitments to a byte seq
+        // the order of serialization is |id_commitment_len<8>|id_commitment<var>|
+        const idCommitmentLen = writeUIntLE(new Uint8Array(8), idCommitments.length, 0, 8);
+        const idCommitmentBytes = concatenate(idCommitmentLen, ...idCommitments);
+        zerokitRLN.setLeavesFrom(this.zkRLN, index, idCommitmentBytes);
+    }
+    deleteMember(index) {
+        zerokitRLN.deleteLeaf(this.zkRLN, index);
+    }
+    getMerkleRoot() {
+        return zerokitRLN.getRoot(this.zkRLN);
+    }
+    serializeMessage(uint8Msg, memIndex, epoch, idKey, rateLimit = DEFAULT_RATE_LIMIT) {
+        // calculate message length
+        const msgLen = writeUIntLE(new Uint8Array(8), uint8Msg.length, 0, 8);
+        const memIndexBytes = writeUIntLE(new Uint8Array(8), memIndex, 0, 8);
+        const rateLimitBytes = writeUIntLE(new Uint8Array(8), rateLimit, 0, 8);
+        // [ id_key<32> | id_index<8> | epoch<32> | signal_len<8> | signal<var> | rate_limit<8> ]
+        return concatenate(idKey, memIndexBytes, epoch, msgLen, uint8Msg, rateLimitBytes);
+    }
+    async generateRLNProof(msg, index, epoch, idSecretHash, rateLimit = DEFAULT_RATE_LIMIT) {
+        if (epoch === undefined) {
+            epoch = epochIntToBytes(dateToEpoch(new Date()));
+        }
+        else if (epoch instanceof Date) {
+            epoch = epochIntToBytes(dateToEpoch(epoch));
+        }
+        if (epoch.length !== 32)
+            throw new Error("invalid epoch");
+        if (idSecretHash.length !== 32)
+            throw new Error("invalid id secret hash");
+        if (index < 0)
+            throw new Error("index must be >= 0");
+        if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
+            rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
+            throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`);
+        }
+        const serialized_msg = this.serializeMessage(msg, index, epoch, idSecretHash, rateLimit);
+        const rlnWitness = zerokitRLN.getSerializedRLNWitness(this.zkRLN, serialized_msg);
+        const inputs = zerokitRLN.RLNWitnessToJson(this.zkRLN, rlnWitness);
+        const calculatedWitness = await this.witnessCalculator.calculateWitness(inputs, false);
+        const proofBytes = zerokitRLN.generate_rln_proof_with_witness(this.zkRLN, calculatedWitness, rlnWitness);
+        return new Proof(proofBytes);
+    }
+    verifyRLNProof(proof, msg, rateLimit) {
+        let pBytes;
+        if (proof instanceof Uint8Array) {
+            pBytes = proof;
+        }
+        else {
+            pBytes = proofToBytes(proof);
+        }
+        // calculate message length
+        const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
+        const rateLimitBytes = rateLimit
+            ? writeUIntLE(new Uint8Array(8), rateLimit, 0, 8)
+            : new Uint8Array(8); // Zero if not specified
+        return zerokitRLN.verifyRLNProof(this.zkRLN, concatenate(pBytes, msgLen, msg, rateLimitBytes));
+    }
+    verifyWithRoots(proof, msg, roots, rateLimit) {
+        let pBytes;
+        if (proof instanceof Uint8Array) {
+            pBytes = proof;
+        }
+        else {
+            pBytes = proofToBytes(proof);
+        }
+        // calculate message length
+        const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
+        const rateLimitBytes = rateLimit
+            ? writeUIntLE(new Uint8Array(8), rateLimit, 0, 8)
+            : new Uint8Array(8); // Zero if not specified
+        const rootsBytes = concatenate(...roots);
+        return zerokitRLN.verifyWithRoots(this.zkRLN, concatenate(pBytes, msgLen, msg, rateLimitBytes), rootsBytes);
+    }
+    verifyWithNoRoot(proof, msg, rateLimit) {
+        let pBytes;
+        if (proof instanceof Uint8Array) {
+            pBytes = proof;
+        }
+        else {
+            pBytes = proofToBytes(proof);
+        }
+        // calculate message length
+        const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
+        const rateLimitBytes = rateLimit
+            ? writeUIntLE(new Uint8Array(8), rateLimit, 0, 8)
+            : new Uint8Array(8); // Zero if not specified
+        return zerokitRLN.verifyWithRoots(this.zkRLN, concatenate(pBytes, msgLen, msg, rateLimitBytes), new Uint8Array());
+    }
+}
+//# sourceMappingURL=zerokit.js.map

package/dist/zerokit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zerokit.js","sourceRoot":"","sources":["../src/zerokit.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AAErD,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAEjD,OAAO,EACL,WAAW,EACX,WAAW,EACX,eAAe,EACf,WAAW,EACZ,MAAM,kBAAkB,CAAC;AAE1B,MAAM,OAAO,OAAO;IAEC;IACA;IAFnB,YACmB,KAAa,EACb,iBAAoC;QADpC,UAAK,GAAL,KAAK,CAAQ;QACb,sBAAiB,GAAjB,iBAAiB,CAAmB;IACpD,CAAC;IAEG,2BAA2B;QAChC,MAAM,OAAO,GAAG,UAAU,CAAC,6BAA6B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,iDAAiD;QACvH,OAAO,kBAAkB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAEM,gCAAgC,CAAC,IAAY;QAClD,MAAM,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC;QACxC,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7C,iDAAiD;QACjD,MAAM,OAAO,GAAG,UAAU,CAAC,mCAAmC,CAC5D,IAAI,CAAC,KAAK,EACV,SAAS,CACV,CAAC;QACF,OAAO,kBAAkB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAEM,YAAY,CAAC,YAAwB;QAC1C,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IACpD,CAAC;IAEM,aAAa,CAClB,KAAa,EACb,GAAG,aAAgC;QAEnC,kDAAkD;QAClD,0EAA0E;QAC1E,MAAM,eAAe,GAAG,WAAW,CACjC,IAAI,UAAU,CAAC,CAAC,CAAC,EACjB,aAAa,CAAC,MAAM,EACpB,CAAC,EACD,CAAC,CACF,CAAC;QACF,MAAM,iBAAiB,GAAG,WAAW,CAAC,eAAe,EAAE,GAAG,aAAa,CAAC,CAAC;QACzE,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC;IACjE,CAAC;IAEM,YAAY,CAAC,KAAa;QAC/B,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAEM,aAAa;QAClB,OAAO,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC;IAEM,gBAAgB,CACrB,QAAoB,EACpB,QAAgB,EAChB,KAAiB,EACjB,KAAiB,EACjB,YAAoB,kBAAkB;QAEtC,2BAA2B;QAC3B,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACrE,MAAM,aAAa,GAAG,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACrE,MAAM,cAAc,GAAG,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAEvE,yFAAyF;QACzF,OAAO,WAAW,CAChB,KAAK,EACL,aAAa,EACb,KAAK,EACL,MAAM,EACN,QAAQ,EACR,cAAc,CACf,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAC3B,GAAe,EACf,KAAa,EACb,KAAoC,EACpC,YAAwB,EACxB,YAAoB,kBAAkB;QAEtC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,KAAK,GAAG,eAAe,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;QACnD,CAAC;aAAM,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YACjC,KAAK,GAAG,eAAe,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QAC1D,IAAI,YAAY,CAAC,MAAM,KAAK,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC1E,IAAI,KAAK,GAAG,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACrD,IACE,SAAS,GAAG,iBAAiB,CAAC,QAAQ;YACtC,SAAS,GAAG,iBAAiB,CAAC,QAAQ,EACtC,CAAC;YACD,MAAM,IAAI,KAAK,CACb,8BAA8B,iBAAiB,CAAC,QAAQ,QAAQ,iBAAiB,CAAC,QAAQ,EAAE,CAC7F,CAAC;QACJ,CAAC;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAC1C,GAAG,EACH,KAAK,EACL,KAAK,EACL,YAAY,EACZ,SAAS,CACV,CAAC;QACF,MAAM,UAAU,GAAG,UAAU,CAAC,uBAAuB,CACnD,IAAI,CAAC,KAAK,EACV,cAAc,CACf,CAAC;QACF,MAAM,MAAM,GAAG,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACnE,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CACrE,MAAM,EACN,KAAK,CACN,CAAC;QAEF,MAAM,UAAU,GAAG,UAAU,CAAC,+BAA+B,CAC3D,IAAI,CAAC,KAAK,EACV,iBAAiB,EACjB,UAAU,CACX,CAAC;QAEF,OAAO,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC;IAEM,cAAc,CACnB,KAAmC,EACnC,GAAe,EACf,SAAkB;QAElB,IAAI,MAAkB,CAAC;QACvB,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,MAAM,GAAG,KAAK,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QAED,2BAA2B;QAC3B,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAChE,MAAM,cAAc,GAAG,SAAS;YAC9B,CAAC,CAAC,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;YACjD,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB;QAE/C,OAAO,UAAU,CAAC,cAAc,CAC9B,IAAI,CAAC,KAAK,EACV,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,CAAC,CACjD,CAAC;IACJ,CAAC;IAEM,eAAe,CACpB,KAAmC,EACnC,GAAe,EACf,KAAwB,EACxB,SAAkB;QAElB,IAAI,MAAkB,CAAC;QACvB,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,MAAM,GAAG,KAAK,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QACD,2BAA2B;QAC3B,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAChE,MAAM,cAAc,GAAG,SAAS;YAC9B,CAAC,CAAC,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;YACjD,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB;QAE/C,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC;QAEzC,OAAO,UAAU,CAAC,eAAe,CAC/B,IAAI,CAAC,KAAK,EACV,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,CAAC,EAChD,UAAU,CACX,CAAC;IACJ,CAAC;IAEM,gBAAgB,CACrB,KAAmC,EACnC,GAAe,EACf,SAAkB;QAElB,IAAI,MAAkB,CAAC;QACvB,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,MAAM,GAAG,KAAK,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QAED,2BAA2B;QAC3B,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAChE,MAAM,cAAc,GAAG,SAAS;YAC9B,CAAC,CAAC,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;YACjD,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB;QAE/C,OAAO,UAAU,CAAC,eAAe,CAC/B,IAAI,CAAC,KAAK,EACV,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,CAAC,EAChD,IAAI,UAAU,EAAE,CACjB,CAAC;IACJ,CAAC;CACF"}

package/package.json

@@ -1,126 +1 @@
-{
-  "name": "@waku/rln",
-  "version": "0.0.1",
-  "description": "Rate Limit Nullifier for js-waku",
-  "types": "./dist/index.d.ts",
-  "module": "./dist/index.js",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    }
-  },
-  "type": "module",
-  "repository": "https://github.com/waku-org/js-rln",
-  "license": "MIT OR Apache-2.0",
-  "keywords": [
-    "waku",
-    "decentralised",
-    "communication",
-    "web3",
-    "ethereum",
-    "dapps"
-  ],
-  "scripts": {
-    "prepare": "husky install",
-    "build": "run-s build:**",
-    "build:tsc": "tsc",
-    "build:bundle": "rollup --config rollup.config.js",
-    "size": "npm run build && size-limit",
-    "fix": "run-s fix:*",
-    "fix:prettier": "prettier \"src/**/*.ts\" \"./*.json\" \"*.*js\" \".github/**/*.yml\" --write",
-    "fix:lint": "eslint src --ext .ts --ext .cjs --fix",
-    "test": "run-s test:*",
-    "test:lint": "eslint src --ext .ts",
-    "test:prettier": "prettier \"src/**/*.ts\" \"./*.json\" \"*.*js\" \".github/**/*.yml\" --list-different",
-    "test:spelling": "cspell \"{*.md,.github/*.md,src/**/*.ts}\"",
-    "test:tsc": "tsc -p tsconfig.dev.json",
-    "test:node": "TS_NODE_PROJECT=./tsconfig.dev.json mocha",
-    "test:browser": "karma start karma.conf.cjs",
-    "watch:build": "tsc -p tsconfig.json -w",
-    "watch:test": "mocha --watch",
-    "prepublish": "npm run build",
-    "reset-hard": "git clean -dfx && git reset --hard && npm i && npm run build"
-  },
-  "browser": {
-    "crypto": false
-  },
-  "engines": {
-    "node": ">=16"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^22.0.2",
-    "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.3.0",
-    "@rollup/plugin-wasm": "^5.2.0",
-    "@size-limit/preset-big-lib": "^8.0.0",
-    "@types/app-root-path": "^1.2.4",
-    "@types/chai": "^4.2.15",
-    "@types/debug": "^4.1.7",
-    "@types/mocha": "^9.1.0",
-    "@types/node": "^17.0.6",
-    "@types/tail": "^2.0.0",
-    "@types/uuid": "^8.3.0",
-    "@typescript-eslint/eslint-plugin": "^5.8.1",
-    "@typescript-eslint/parser": "^5.8.1",
-    "app-root-path": "^3.0.0",
-    "chai": "^4.3.4",
-    "cspell": "^5.14.0",
-    "eslint": "^8.6.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-functional": "^4.0.2",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-prettier": "^4.0.0",
-    "fast-check": "^2.14.0",
-    "gh-pages": "^3.2.3",
-    "husky": "^7.0.4",
-    "ignore-loader": "^0.1.2",
-    "isomorphic-fetch": "^3.0.0",
-    "jsdom": "^19.0.0",
-    "jsdom-global": "^3.0.2",
-    "karma": "^6.3.12",
-    "karma-chrome-launcher": "^3.1.0",
-    "karma-mocha": "^2.0.1",
-    "karma-webpack": "^5.0.0",
-    "lint-staged": "^13.0.3",
-    "mocha": "^9.1.3",
-    "npm-run-all": "^4.1.5",
-    "p-timeout": "^4.1.0",
-    "prettier": "^2.1.1",
-    "process": "^0.11.10",
-    "puppeteer": "^13.0.1",
-    "rollup": "^2.75.0",
-    "rollup-plugin-copy": "^3.4.0",
-    "size-limit": "^8.0.0",
-    "tail": "^2.2.0",
-    "ts-loader": "^9.3.1",
-    "ts-node": "^10.9.1",
-    "typedoc": "^0.23.10",
-    "typescript": "^4.5.5"
-  },
-  "files": [
-    "dist",
-    "bundle",
-    "src/*.ts",
-    "src/lib/**/*.ts",
-    "src/proto/**/*.ts",
-    "!**/*.spec.*",
-    "!**/*.json",
-    "CHANGELOG.md",
-    "LICENSE",
-    "README.md"
-  ],
-  "lint-staged": {
-    "*.ts": [
-      "eslint --fix"
-    ],
-    "*.{ts,md,json,conf*.*js}": [
-      "prettier --write"
-    ]
-  }
-}
+{"name":"@waku/rln","version":"0.0.2-c41b319.0","description":"RLN (Rate Limiting Nullifier) implementation for Waku","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"type":"module","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/rln#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","rln","rate-limiting","privacy","web3"],"scripts":{"build":"run-s build:**","build:copy":"mkdir -p dist/resources && cp -r src/resources/* dist/resources/","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:tsc":"tsc -p tsconfig.dev.json","check:lint":"eslint \"src/!(resources)/**/*.{ts,js}\" *.js","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","test":"NODE_ENV=test run-s test:*","test:browser":"karma start karma.conf.cjs","watch:build":"tsc -p tsconfig.json -w","watch:test":"mocha --watch","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=20"},"devDependencies":{"@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^5.0.1","@types/chai-spies":"^1.0.6","@types/deep-equal-in-any-order":"^1.0.4","@types/lodash":"^4.17.15","@types/sinon":"^17.0.3","@waku/build-utils":"^1.0.0","@waku/message-encryption":"0.0.32-c41b319.0","chai":"^5.1.2","chai-as-promised":"^8.0.1","chai-spies":"^1.1.0","chai-subset":"^1.6.0","deep-equal-in-any-order":"^2.0.6","fast-check":"^3.23.2","rollup-plugin-copy":"^3.5.0","sinon":"^19.0.2"},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"],"dependencies":{"@chainsafe/bls-keystore":"3.0.0","@ethersproject/bytes":"^5.7.0","@ethersproject/keccak256":"^5.7.0","@iden3/js-crypto":"^1.3.0","@stablelib/chacha":"^2.0.1","@waku/core":"0.0.34-c41b319.0","@waku/utils":"0.0.22-c41b319.0","@waku/zerokit-rln-wasm":"^0.0.13","ethereum-cryptography":"^3.1.0","ethers":"^5.7.2","lodash":"^4.17.21","uuid":"^11.0.5"}}

package/src/codec.ts

@@ -0,0 +1,134 @@
+import type {
+  IDecodedMessage,
+  IDecoder,
+  IEncoder,
+  IMessage,
+  IProtoMessage,
+  IRateLimitProof
+} from "@waku/interfaces";
+import { Logger } from "@waku/utils";
+
+import type { IdentityCredential } from "./identity.js";
+import { RlnMessage, toRLNSignal } from "./message.js";
+import { RLNInstance } from "./rln.js";
+
+const log = new Logger("waku:rln:encoder");
+
+export class RLNEncoder implements IEncoder {
+  private readonly idSecretHash: Uint8Array;
+
+  public constructor(
+    private readonly encoder: IEncoder,
+    private readonly rlnInstance: RLNInstance,
+    private readonly index: number,
+    identityCredential: IdentityCredential
+  ) {
+    if (index < 0) throw new Error("Invalid membership index");
+    this.idSecretHash = identityCredential.IDSecretHash;
+  }
+
+  public async toWire(message: IMessage): Promise<Uint8Array | undefined> {
+    message.rateLimitProof = await this.generateProof(message);
+    log.info("Proof generated", message.rateLimitProof);
+    return this.encoder.toWire(message);
+  }
+
+  public async toProtoObj(
+    message: IMessage
+  ): Promise<IProtoMessage | undefined> {
+    const protoMessage = await this.encoder.toProtoObj(message);
+    if (!protoMessage) return;
+
+    protoMessage.contentTopic = this.contentTopic;
+    protoMessage.rateLimitProof = await this.generateProof(message);
+    log.info("Proof generated", protoMessage.rateLimitProof);
+    return protoMessage;
+  }
+
+  private async generateProof(message: IMessage): Promise<IRateLimitProof> {
+    const signal = toRLNSignal(this.contentTopic, message);
+    const proof = await this.rlnInstance.zerokit.generateRLNProof(
+      signal,
+      this.index,
+      message.timestamp,
+      this.idSecretHash
+    );
+    return proof;
+  }
+
+  public get pubsubTopic(): string {
+    return this.encoder.pubsubTopic;
+  }
+
+  public get contentTopic(): string {
+    return this.encoder.contentTopic;
+  }
+
+  public get ephemeral(): boolean {
+    return this.encoder.ephemeral;
+  }
+}
+
+type RLNEncoderOptions = {
+  encoder: IEncoder;
+  rlnInstance: RLNInstance;
+  index: number;
+  credential: IdentityCredential;
+};
+
+export const createRLNEncoder = (options: RLNEncoderOptions): RLNEncoder => {
+  return new RLNEncoder(
+    options.encoder,
+    options.rlnInstance,
+    options.index,
+    options.credential
+  );
+};
+
+export class RLNDecoder<T extends IDecodedMessage>
+  implements IDecoder<RlnMessage<T>>
+{
+  public constructor(
+    private readonly rlnInstance: RLNInstance,
+    private readonly decoder: IDecoder<T>
+  ) {}
+
+  public get pubsubTopic(): string {
+    return this.decoder.pubsubTopic;
+  }
+
+  public get contentTopic(): string {
+    return this.decoder.contentTopic;
+  }
+
+  public fromWireToProtoObj(
+    bytes: Uint8Array
+  ): Promise<IProtoMessage | undefined> {
+    const protoMessage = this.decoder.fromWireToProtoObj(bytes);
+    log.info("Message decoded", protoMessage);
+    return Promise.resolve(protoMessage);
+  }
+
+  public async fromProtoObj(
+    pubsubTopic: string,
+    proto: IProtoMessage
+  ): Promise<RlnMessage<T> | undefined> {
+    const msg: T | undefined = await this.decoder.fromProtoObj(
+      pubsubTopic,
+      proto
+    );
+    if (!msg) return;
+    return new RlnMessage(this.rlnInstance, msg, proto.rateLimitProof);
+  }
+}
+
+type RLNDecoderOptions<T extends IDecodedMessage> = {
+  decoder: IDecoder<T>;
+  rlnInstance: RLNInstance;
+};
+
+export const createRLNDecoder = <T extends IDecodedMessage>(
+  options: RLNDecoderOptions<T>
+): RLNDecoder<T> => {
+  return new RLNDecoder(options.rlnInstance, options.decoder);
+};