@waku/rln 0.0.6 → 0.0.8-378ad04

package/dist/rln.js

@@ -1,20 +1,8 @@
 import init, * as zerokitRLN from "@waku/zerokit-rln-wasm";
-import * as resources from "./resources.js";
+import { writeUIntLE } from "./byte_utils.js";
+import { dateToEpoch, epochIntToBytes } from "./epoch.js";
+import verificationKey from "./resources/verification_key.js";
 import * as wc from "./witness_calculator.js";
-/**
- * Convert a base64 string into uint8Array
- * @param base64
- * @returns Uint8Array
- */
-function base64ToUint8Array(base64) {
-    const binary_string = window.atob(base64);
-    const len = binary_string.length;
-    const bytes = new Uint8Array(len);
-    for (let i = 0; i < len; i++) {
-        bytes[i] = binary_string.charCodeAt(i);
-    }
-    return bytes;
-}
 /**
  * Concatenate Uint8Arrays
  * @param input
@@ -33,10 +21,18 @@ function concatenate(...input) {
     }
     return result;
 }
+const stringEncoder = new TextEncoder();
 const DEPTH = 20;
-const VERIFICATION_KEY = base64ToUint8Array(resources.verification_key);
-const ZKEY = base64ToUint8Array(resources.zkey);
-const CIRCUIT = base64ToUint8Array(resources.circuit);
+async function loadWitnessCalculator() {
+    const url = new URL("./resources/rln.wasm", import.meta.url);
+    const response = await fetch(url);
+    return await wc.builder(new Uint8Array(await response.arrayBuffer()), false);
+}
+async function loadZkey() {
+    const url = new URL("./resources/rln_final.zkey", import.meta.url);
+    const response = await fetch(url);
+    return new Uint8Array(await response.arrayBuffer());
+}
 /**
  * Create an instance of RLN
  * @returns RLNInstance
@@ -44,43 +40,22 @@ const CIRCUIT = base64ToUint8Array(resources.circuit);
 export async function create() {
     await init();
     zerokitRLN.init_panic_hook();
-    const witnessCalculator = await wc.builder(CIRCUIT, false);
-    const zkRLN = zerokitRLN.newRLN(DEPTH, ZKEY, VERIFICATION_KEY);
+    const witnessCalculator = await loadWitnessCalculator();
+    const zkey = await loadZkey();
+    const vkey = stringEncoder.encode(JSON.stringify(verificationKey));
+    const zkRLN = zerokitRLN.newRLN(DEPTH, zkey, vkey);
     return new RLNInstance(zkRLN, witnessCalculator);
 }
 export class MembershipKey {
-    constructor(memKeys) {
-        this.IDKey = memKeys.subarray(0, 32);
-        this.IDCommitment = memKeys.subarray(32);
+    constructor(IDKey, IDCommitment) {
+        this.IDKey = IDKey;
+        this.IDCommitment = IDCommitment;
     }
-}
-// Adapted from https://github.com/feross/buffer
-function checkInt(buf, value, offset, ext, max, min) {
-    if (value > max || value < min)
-        throw new RangeError('"value" argument is out of bounds');
-    if (offset + ext > buf.length)
-        throw new RangeError("Index out of range");
-}
-const writeUIntLE = function writeUIntLE(buf, value, offset, byteLength, noAssert) {
-    value = +value;
-    offset = offset >>> 0;
-    byteLength = byteLength >>> 0;
-    if (!noAssert) {
-        const maxBytes = Math.pow(2, 8 * byteLength) - 1;
-        checkInt(buf, value, offset, byteLength, maxBytes, 0);
-    }
-    let mul = 1;
-    let i = 0;
-    buf[offset] = value & 0xff;
-    while (++i < byteLength && (mul *= 0x100)) {
-        buf[offset + i] = (value / mul) & 0xff;
+    static fromBytes(memKeys) {
+        const idKey = memKeys.subarray(0, 32);
+        const idCommitment = memKeys.subarray(32);
+        return new MembershipKey(idKey, idCommitment);
     }
-    return buf;
-};
-const DefaultEpochUnitSeconds = 10; // the rln-relay epoch length in seconds
-export function toEpoch(timestamp, epochUnitSeconds = DefaultEpochUnitSeconds) {
-    const unix = Math.floor(timestamp.getTime() / 1000 / epochUnitSeconds);
-    return writeUIntLE(new Uint8Array(32), unix, 0, 8);
 }
 const proofOffset = 128;
 const rootOffset = proofOffset + 32;
@@ -89,7 +64,7 @@ const shareXOffset = epochOffset + 32;
 const shareYOffset = shareXOffset + 32;
 const nullifierOffset = shareYOffset + 32;
 const rlnIdentifierOffset = nullifierOffset + 32;
-export class RateLimitProof {
+export class Proof {
     constructor(proofBytes) {
         if (proofBytes.length < rlnIdentifierOffset)
             throw "invalid proof";
@@ -102,9 +77,9 @@ export class RateLimitProof {
         this.nullifier = proofBytes.subarray(shareYOffset, nullifierOffset);
         this.rlnIdentifier = proofBytes.subarray(nullifierOffset, rlnIdentifierOffset);
     }
-    toBytes() {
-        return concatenate(this.proof, this.merkleRoot, this.epoch, this.shareX, this.shareY, this.nullifier, this.rlnIdentifier);
-    }
+}
+function proofToBytes(p) {
+    return concatenate(p.proof, p.merkleRoot, p.epoch, p.shareX, p.shareY, p.nullifier, p.rlnIdentifier);
 }
 export class RLNInstance {
     constructor(zkRLN, witnessCalculator) {
@@ -113,7 +88,7 @@ export class RLNInstance {
     }
     generateMembershipKey() {
         const memKeys = zerokitRLN.generateMembershipKey(this.zkRLN);
-        return new MembershipKey(memKeys);
+        return MembershipKey.fromBytes(memKeys);
     }
     insertMember(idCommitment) {
         zerokitRLN.insertMember(this.zkRLN, idCommitment);
@@ -128,10 +103,10 @@ export class RLNInstance {
     }
     async generateProof(msg, index, epoch, idKey) {
         if (epoch == undefined) {
-            epoch = toEpoch(new Date());
+            epoch = epochIntToBytes(dateToEpoch(new Date()));
         }
         else if (epoch instanceof Date) {
-            epoch = toEpoch(epoch);
+            epoch = epochIntToBytes(dateToEpoch(epoch));
         }
         if (epoch.length != 32)
             throw "invalid epoch";
@@ -144,13 +119,17 @@ export class RLNInstance {
         const inputs = zerokitRLN.RLNWitnessToJson(this.zkRLN, rlnWitness);
         const calculatedWitness = await this.witnessCalculator.calculateWitness(inputs, false); // no sanity check being used in zerokit
         const proofBytes = zerokitRLN.generate_rln_proof_with_witness(this.zkRLN, calculatedWitness, rlnWitness);
-        return new RateLimitProof(proofBytes);
+        return new Proof(proofBytes);
     }
     verifyProof(proof) {
-        if (proof instanceof RateLimitProof) {
-            proof = proof.toBytes();
+        let pBytes;
+        if (proof instanceof Uint8Array) {
+            pBytes = proof;
+        }
+        else {
+            pBytes = proofToBytes(proof);
         }
-        return zerokitRLN.verifyProof(this.zkRLN, proof);
+        return zerokitRLN.verifyProof(this.zkRLN, pBytes);
     }
 }
 //# sourceMappingURL=rln.js.map

package/dist/rln.js.map

@@ -1 +1 @@
-{"version":3,"file":"rln.js","sourceRoot":"","sources":["../src/rln.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,EAAE,KAAK,UAAU,MAAM,wBAAwB,CAAC;AAE3D,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAE9C;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,MAAc;IACxC,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,GAAG,GAAG,aAAa,CAAC,MAAM,CAAC;IACjC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;QAC5B,KAAK,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;KACxC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,GAAG,KAAmB;IACzC,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE;QACvB,WAAW,IAAI,GAAG,CAAC,MAAM,CAAC;KAC3B;IACD,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;IAC3C,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE;QACvB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACxB,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC;KACtB;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,KAAK,GAAG,EAAE,CAAC;AACjB,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;AACxE,MAAM,IAAI,GAAG,kBAAkB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAChD,MAAM,OAAO,GAAG,kBAAkB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAEtD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,MAAM,IAAI,EAAE,CAAC;IACb,UAAU,CAAC,eAAe,EAAE,CAAC;IAE7B,MAAM,iBAAiB,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC3D,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC;IAC/D,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,OAAO,aAAa;IAIxB,YAAY,OAAmB;QAC7B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;CACF;AAED,gDAAgD;AAEhD,SAAS,QAAQ,CACf,GAAe,EACf,KAAa,EACb,MAAc,EACd,GAAW,EACX,GAAW,EACX,GAAW;IAEX,IAAI,KAAK,GAAG,GAAG,IAAI,KAAK,GAAG,GAAG;QAC5B,MAAM,IAAI,UAAU,CAAC,mCAAmC,CAAC,CAAC;IAC5D,IAAI,MAAM,GAAG,GAAG,GAAG,GAAG,CAAC,MAAM;QAAE,MAAM,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAC5E,CAAC;AAED,MAAM,WAAW,GAAG,SAAS,WAAW,CACtC,GAAe,EACf,KAAa,EACb,MAAc,EACd,UAAkB,EAClB,QAAkB;IAElB,KAAK,GAAG,CAAC,KAAK,CAAC;IACf,MAAM,GAAG,MAAM,KAAK,CAAC,CAAC;IACtB,UAAU,GAAG,UAAU,KAAK,CAAC,CAAC;IAC9B,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;QACjD,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;KACvD;IAED,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,GAAG,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC;IAC3B,OAAO,EAAE,CAAC,GAAG,UAAU,IAAI,CAAC,GAAG,IAAI,KAAK,CAAC,EAAE;QACzC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC;KACxC;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,EAAE,CAAC,CAAC,wCAAwC;AAE5E,MAAM,UAAU,OAAO,CACrB,SAAe,EACf,mBAA2B,uBAAuB;IAElD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,gBAAgB,CAAC,CAAC;IACvE,OAAO,WAAW,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,WAAW,GAAG,GAAG,CAAC;AACxB,MAAM,UAAU,GAAG,WAAW,GAAG,EAAE,CAAC;AACpC,MAAM,WAAW,GAAG,UAAU,GAAG,EAAE,CAAC;AACpC,MAAM,YAAY,GAAG,WAAW,GAAG,EAAE,CAAC;AACtC,MAAM,YAAY,GAAG,YAAY,GAAG,EAAE,CAAC;AACvC,MAAM,eAAe,GAAG,YAAY,GAAG,EAAE,CAAC;AAC1C,MAAM,mBAAmB,GAAG,eAAe,GAAG,EAAE,CAAC;AAEjD,MAAM,OAAO,cAAc;IASzB,YAAY,UAAsB;QAChC,IAAI,UAAU,CAAC,MAAM,GAAG,mBAAmB;YAAE,MAAM,eAAe,CAAC;QACnE,wHAAwH;QACxH,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QACpE,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,QAAQ,CACtC,eAAe,EACf,mBAAmB,CACpB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO,WAAW,CAChB,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,aAAa,CACnB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,WAAW;IACtB,YAAoB,KAAa,EAAU,iBAAsB;QAA7C,UAAK,GAAL,KAAK,CAAQ;QAAU,sBAAiB,GAAjB,iBAAiB,CAAK;IAAG,CAAC;IAErE,qBAAqB;QACnB,MAAM,OAAO,GAAG,UAAU,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7D,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,YAAY,CAAC,YAAwB;QACnC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IACpD,CAAC;IAED,gBAAgB,CACd,QAAoB,EACpB,QAAgB,EAChB,KAAiB,EACjB,KAAiB;QAEjB,2BAA2B;QAC3B,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAErE,+BAA+B;QAC/B,MAAM,aAAa,GAAG,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAErE,yEAAyE;QACzE,OAAO,WAAW,CAAC,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,GAAe,EACf,KAAa,EACb,KAAoC,EACpC,KAAiB;QAEjB,IAAI,KAAK,IAAI,SAAS,EAAE;YACtB,KAAK,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;SAC7B;aAAM,IAAI,KAAK,YAAY,IAAI,EAAE;YAChC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;SACxB;QAED,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE;YAAE,MAAM,eAAe,CAAC;QAC9C,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE;YAAE,MAAM,gBAAgB,CAAC;QAC/C,IAAI,KAAK,GAAG,CAAC;YAAE,MAAM,oBAAoB,CAAC;QAE1C,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QACvE,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,CAAC,wCAAwC;QAE3C,MAAM,UAAU,GAAG,UAAU,CAAC,+BAA+B,CAC3D,IAAI,CAAC,KAAK,EACV,iBAAiB,EACjB,UAAU,CACX,CAAC;QAEF,OAAO,IAAI,cAAc,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED,WAAW,CAAC,KAAkC;QAC5C,IAAI,KAAK,YAAY,cAAc,EAAE;YACnC,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;SACzB;QACD,OAAO,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;CACF"}
+{"version":3,"file":"rln.js","sourceRoot":"","sources":["../src/rln.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,EAAE,KAAK,UAAU,MAAM,wBAAwB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAG9C;;;;GAIG;AACH,SAAS,WAAW,CAAC,GAAG,KAAmB;IACzC,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE;QACvB,WAAW,IAAI,GAAG,CAAC,MAAM,CAAC;KAC3B;IACD,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;IAC3C,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE;QACvB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACxB,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC;KACtB;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC;AAExC,MAAM,KAAK,GAAG,EAAE,CAAC;AAEjB,KAAK,UAAU,qBAAqB;IAClC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,sBAAsB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;AAC/E,CAAC;AAED,KAAK,UAAU,QAAQ;IACrB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,4BAA4B,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;AACtD,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,MAAM,IAAI,EAAE,CAAC;IACb,UAAU,CAAC,eAAe,EAAE,CAAC;IAC7B,MAAM,iBAAiB,GAAG,MAAM,qBAAqB,EAAE,CAAC;IACxD,MAAM,IAAI,GAAG,MAAM,QAAQ,EAAE,CAAC;IAC9B,MAAM,IAAI,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IACnE,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACnD,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,OAAO,aAAa;IACxB,YACkB,KAAiB,EACjB,YAAwB;QADxB,UAAK,GAAL,KAAK,CAAY;QACjB,iBAAY,GAAZ,YAAY,CAAY;IACvC,CAAC;IAEJ,MAAM,CAAC,SAAS,CAAC,OAAmB;QAClC,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACtC,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC1C,OAAO,IAAI,aAAa,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAChD,CAAC;CACF;AAED,MAAM,WAAW,GAAG,GAAG,CAAC;AACxB,MAAM,UAAU,GAAG,WAAW,GAAG,EAAE,CAAC;AACpC,MAAM,WAAW,GAAG,UAAU,GAAG,EAAE,CAAC;AACpC,MAAM,YAAY,GAAG,WAAW,GAAG,EAAE,CAAC;AACtC,MAAM,YAAY,GAAG,YAAY,GAAG,EAAE,CAAC;AACvC,MAAM,eAAe,GAAG,YAAY,GAAG,EAAE,CAAC;AAC1C,MAAM,mBAAmB,GAAG,eAAe,GAAG,EAAE,CAAC;AAEjD,MAAM,OAAO,KAAK;IAShB,YAAY,UAAsB;QAChC,IAAI,UAAU,CAAC,MAAM,GAAG,mBAAmB;YAAE,MAAM,eAAe,CAAC;QACnE,wHAAwH;QACxH,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QACpE,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,QAAQ,CACtC,eAAe,EACf,mBAAmB,CACpB,CAAC;IACJ,CAAC;CACF;AAED,SAAS,YAAY,CAAC,CAAiB;IACrC,OAAO,WAAW,CAChB,CAAC,CAAC,KAAK,EACP,CAAC,CAAC,UAAU,EACZ,CAAC,CAAC,KAAK,EACP,CAAC,CAAC,MAAM,EACR,CAAC,CAAC,MAAM,EACR,CAAC,CAAC,SAAS,EACX,CAAC,CAAC,aAAa,CAChB,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,WAAW;IACtB,YACU,KAAa,EACb,iBAAoC;QADpC,UAAK,GAAL,KAAK,CAAQ;QACb,sBAAiB,GAAjB,iBAAiB,CAAmB;IAC3C,CAAC;IAEJ,qBAAqB;QACnB,MAAM,OAAO,GAAG,UAAU,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,YAAY,CAAC,YAAwB;QACnC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IACpD,CAAC;IAED,gBAAgB,CACd,QAAoB,EACpB,QAAgB,EAChB,KAAiB,EACjB,KAAiB;QAEjB,2BAA2B;QAC3B,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAErE,+BAA+B;QAC/B,MAAM,aAAa,GAAG,WAAW,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAErE,yEAAyE;QACzE,OAAO,WAAW,CAAC,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,GAAe,EACf,KAAa,EACb,KAAoC,EACpC,KAAiB;QAEjB,IAAI,KAAK,IAAI,SAAS,EAAE;YACtB,KAAK,GAAG,eAAe,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;SAClD;aAAM,IAAI,KAAK,YAAY,IAAI,EAAE;YAChC,KAAK,GAAG,eAAe,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;SAC7C;QAED,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE;YAAE,MAAM,eAAe,CAAC;QAC9C,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE;YAAE,MAAM,gBAAgB,CAAC;QAC/C,IAAI,KAAK,GAAG,CAAC;YAAE,MAAM,oBAAoB,CAAC;QAE1C,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QACvE,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,CAAC,wCAAwC;QAE3C,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;IAED,WAAW,CAAC,KAAkC;QAC5C,IAAI,MAAkB,CAAC;QACvB,IAAI,KAAK,YAAY,UAAU,EAAE;YAC/B,MAAM,GAAG,KAAK,CAAC;SAChB;aAAM;YACL,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;SAC9B;QACD,OAAO,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/rln",
-  "version": "0.0.6",
+  "version": "0.0.8-378ad04",
   "description": "Rate Limit Nullifier for js-waku",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -34,7 +34,7 @@
     "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",
+    "test:tsc": "tsc -p tsconfig.dev.json",
     "test:browser": "karma start karma.conf.cjs",
     "watch:build": "tsc -p tsconfig.json -w",
     "watch:test": "mocha --watch",
@@ -66,6 +66,7 @@
     "@types/uuid": "^8.3.0",
     "@typescript-eslint/eslint-plugin": "^5.8.1",
     "@typescript-eslint/parser": "^5.8.1",
+    "@web/rollup-plugin-import-meta-assets": "^1.0.7",
     "app-root-path": "^3.0.0",
     "chai": "^4.3.4",
     "cspell": "^5.14.0",
@@ -75,11 +76,12 @@
     "eslint-plugin-functional": "^4.0.2",
     "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-prettier": "^4.0.0",
-    "fast-check": "^2.14.0",
+    "fast-check": "^2.25.0",
     "gh-pages": "^3.2.3",
     "husky": "^7.0.4",
     "ignore-loader": "^0.1.2",
     "isomorphic-fetch": "^3.0.0",
+    "js-waku": "^0.29.0-29436ea",
     "jsdom": "^19.0.0",
     "jsdom-global": "^3.0.2",
     "karma": "^6.3.12",
@@ -123,6 +125,6 @@
     ]
   },
   "dependencies": {
-    "@waku/zerokit-rln-wasm": "^0.0.1"
+    "@waku/zerokit-rln-wasm": "^0.0.2"
   }
 }

package/src/byte_utils.ts

@@ -0,0 +1,39 @@
+// Adapted from https://github.com/feross/buffer
+
+function checkInt(
+  buf: Uint8Array,
+  value: number,
+  offset: number,
+  ext: number,
+  max: number,
+  min: number
+): void {
+  if (value > max || value < min)
+    throw new RangeError('"value" argument is out of bounds');
+  if (offset + ext > buf.length) throw new RangeError("Index out of range");
+}
+
+export function writeUIntLE(
+  buf: Uint8Array,
+  value: number,
+  offset: number,
+  byteLength: number,
+  noAssert?: boolean
+): Uint8Array {
+  value = +value;
+  offset = offset >>> 0;
+  byteLength = byteLength >>> 0;
+  if (!noAssert) {
+    const maxBytes = Math.pow(2, 8 * byteLength) - 1;
+    checkInt(buf, value, offset, byteLength, maxBytes, 0);
+  }
+
+  let mul = 1;
+  let i = 0;
+  buf[offset] = value & 0xff;
+  while (++i < byteLength && (mul *= 0x100)) {
+    buf[offset + i] = (value / mul) & 0xff;
+  }
+
+  return buf;
+}

package/src/codec.ts

@@ -0,0 +1,88 @@
+import debug from "debug";
+import { utils } from "js-waku";
+import {
+  Decoder,
+  Encoder,
+  Message,
+  ProtoMessage,
+  RateLimitProof,
+} from "js-waku/lib/interfaces";
+
+import { RlnMessage } from "./message.js";
+import { MembershipKey, RLNInstance } from "./rln.js";
+
+const log = debug("waku:message:rln-encoder");
+
+export class RLNEncoder implements Encoder {
+  public contentTopic: string;
+  private readonly idKey: Uint8Array;
+
+  constructor(
+    private encoder: Encoder,
+    private rlnInstance: RLNInstance,
+    private index: number,
+    membershipKey: MembershipKey
+  ) {
+    if (index < 0) throw "invalid membership index";
+    this.idKey = membershipKey.IDKey;
+    this.contentTopic = encoder.contentTopic;
+  }
+
+  async toWire(message: Partial<Message>): Promise<Uint8Array | undefined> {
+    message.rateLimitProof = await this.generateProof(message);
+
+    return this.encoder.toWire(message);
+  }
+
+  async toProtoObj(
+    message: Partial<Message>
+  ): Promise<ProtoMessage | undefined> {
+    const protoMessage = await this.encoder.toProtoObj(message);
+    if (!protoMessage) return;
+
+    protoMessage.rateLimitProof = await this.generateProof(message);
+
+    return protoMessage;
+  }
+
+  private async generateProof(
+    message: Partial<Message>
+  ): Promise<RateLimitProof> {
+    const signal = toRLNSignal(message);
+
+    console.time("proof_gen_timer");
+    const proof = await this.rlnInstance.generateProof(
+      signal,
+      this.index,
+      message.timestamp,
+      this.idKey
+    );
+    console.timeEnd("proof_gen_timer");
+    return proof;
+  }
+}
+
+export class RLNDecoder<T extends Message> implements Decoder<RlnMessage<T>> {
+  constructor(private rlnInstance: RLNInstance, private decoder: Decoder<T>) {}
+
+  get contentTopic(): string {
+    return this.decoder.contentTopic;
+  }
+
+  fromWireToProtoObj(bytes: Uint8Array): Promise<ProtoMessage | undefined> {
+    const protoMessage = this.decoder.fromWireToProtoObj(bytes);
+    log("Message decoded", protoMessage);
+    return Promise.resolve(protoMessage);
+  }
+
+  async fromProtoObj(proto: ProtoMessage): Promise<RlnMessage<T> | undefined> {
+    const msg: T | undefined = await this.decoder.fromProtoObj(proto);
+    if (!msg) return;
+    return new RlnMessage(this.rlnInstance, msg, proto.rateLimitProof);
+  }
+}
+
+function toRLNSignal(msg: Partial<Message>): Uint8Array {
+  const contentTopicBytes = utils.utf8ToBytes(msg.contentTopic ?? "");
+  return new Uint8Array([...(msg.payload ?? []), ...contentTopicBytes]);
+}

package/src/epoch.ts

@@ -0,0 +1,21 @@
+const DefaultEpochUnitSeconds = 10; // the rln-relay epoch length in seconds
+
+export function dateToEpoch(
+  timestamp: Date,
+  epochUnitSeconds: number = DefaultEpochUnitSeconds
+): number {
+  const time = timestamp.getTime();
+  return Math.floor(time / 1000 / epochUnitSeconds);
+}
+
+export function epochIntToBytes(epoch: number): Uint8Array {
+  const bytes = new Uint8Array(32);
+  const db = new DataView(bytes.buffer);
+  db.setUint32(0, epoch, true);
+  return bytes;
+}
+
+export function epochBytesToInt(bytes: Uint8Array): number {
+  const dv = new DataView(bytes.buffer);
+  return dv.getUint32(0, true);
+}

package/src/index.ts

@@ -1,4 +1,6 @@
-import type { MembershipKey, RateLimitProof, RLNInstance } from "./rln.js";
+import { RLNDecoder, RLNEncoder } from "./codec.js";
+import type { Proof, RLNInstance } from "./rln.js";
+import { MembershipKey } from "./rln.js";
 
 // reexport the create function, dynamically imported from rln.ts
 export async function create(): Promise<RLNInstance> {
@@ -9,4 +11,4 @@ export async function create(): Promise<RLNInstance> {
   return await rlnModule.create();
 }
 
-export { RLNInstance, MembershipKey, RateLimitProof };
+export { RLNInstance, MembershipKey, Proof, RLNEncoder, RLNDecoder };

package/src/message.ts

@@ -0,0 +1,37 @@
+import { Message, RateLimitProof } from "js-waku/lib/interfaces";
+
+import { epochBytesToInt } from "./epoch.js";
+import { RLNInstance } from "./rln.js";
+
+export class RlnMessage<T extends Message> implements Message {
+  constructor(
+    public rlnInstance: RLNInstance,
+    public msg: T,
+    public rateLimitProof: RateLimitProof | undefined
+  ) {}
+
+  public verify(): boolean | undefined {
+    return this.rateLimitProof
+      ? this.rlnInstance.verifyProof(this.rateLimitProof)
+      : undefined;
+  }
+
+  get payload(): Uint8Array | undefined {
+    return this.msg.payload;
+  }
+
+  get contentTopic(): string | undefined {
+    return this.msg.contentTopic;
+  }
+
+  get timestamp(): Date | undefined {
+    return this.msg.timestamp;
+  }
+
+  get epoch(): number | undefined {
+    const bytes = this.msg.rateLimitProof?.epoch;
+    if (!bytes) return;
+
+    return epochBytesToInt(bytes);
+  }
+}

package/src/rln.ts

@@ -1,22 +1,11 @@
 import init, * as zerokitRLN from "@waku/zerokit-rln-wasm";
+import { RateLimitProof } from "js-waku/lib/interfaces";
 
-import * as resources from "./resources.js";
+import { writeUIntLE } from "./byte_utils.js";
+import { dateToEpoch, epochIntToBytes } from "./epoch.js";
+import verificationKey from "./resources/verification_key.js";
 import * as wc from "./witness_calculator.js";
-
-/**
- * Convert a base64 string into uint8Array
- * @param base64
- * @returns Uint8Array
- */
-function base64ToUint8Array(base64: string): Uint8Array {
-  const binary_string = window.atob(base64);
-  const len = binary_string.length;
-  const bytes = new Uint8Array(len);
-  for (let i = 0; i < len; i++) {
-    bytes[i] = binary_string.charCodeAt(i);
-  }
-  return bytes;
-}
+import { WitnessCalculator } from "./witness_calculator.js";
 
 /**
  * Concatenate Uint8Arrays
@@ -37,10 +26,21 @@ function concatenate(...input: Uint8Array[]): Uint8Array {
   return result;
 }
 
+const stringEncoder = new TextEncoder();
+
 const DEPTH = 20;
-const VERIFICATION_KEY = base64ToUint8Array(resources.verification_key);
-const ZKEY = base64ToUint8Array(resources.zkey);
-const CIRCUIT = base64ToUint8Array(resources.circuit);
+
+async function loadWitnessCalculator(): Promise<WitnessCalculator> {
+  const url = new URL("./resources/rln.wasm", import.meta.url);
+  const response = await fetch(url);
+  return await wc.builder(new Uint8Array(await response.arrayBuffer()), false);
+}
+
+async function loadZkey(): Promise<Uint8Array> {
+  const url = new URL("./resources/rln_final.zkey", import.meta.url);
+  const response = await fetch(url);
+  return new Uint8Array(await response.arrayBuffer());
+}
 
 /**
  * Create an instance of RLN
@@ -49,72 +49,26 @@ const CIRCUIT = base64ToUint8Array(resources.circuit);
 export async function create(): Promise<RLNInstance> {
   await init();
   zerokitRLN.init_panic_hook();
-
-  const witnessCalculator = await wc.builder(CIRCUIT, false);
-  const zkRLN = zerokitRLN.newRLN(DEPTH, ZKEY, VERIFICATION_KEY);
+  const witnessCalculator = await loadWitnessCalculator();
+  const zkey = await loadZkey();
+  const vkey = stringEncoder.encode(JSON.stringify(verificationKey));
+  const zkRLN = zerokitRLN.newRLN(DEPTH, zkey, vkey);
   return new RLNInstance(zkRLN, witnessCalculator);
 }
 
 export class MembershipKey {
-  readonly IDKey: Uint8Array;
-  readonly IDCommitment: Uint8Array;
-
-  constructor(memKeys: Uint8Array) {
-    this.IDKey = memKeys.subarray(0, 32);
-    this.IDCommitment = memKeys.subarray(32);
+  constructor(
+    public readonly IDKey: Uint8Array,
+    public readonly IDCommitment: Uint8Array
+  ) {}
+
+  static fromBytes(memKeys: Uint8Array): MembershipKey {
+    const idKey = memKeys.subarray(0, 32);
+    const idCommitment = memKeys.subarray(32);
+    return new MembershipKey(idKey, idCommitment);
   }
 }
 
-// Adapted from https://github.com/feross/buffer
-
-function checkInt(
-  buf: Uint8Array,
-  value: number,
-  offset: number,
-  ext: number,
-  max: number,
-  min: number
-): void {
-  if (value > max || value < min)
-    throw new RangeError('"value" argument is out of bounds');
-  if (offset + ext > buf.length) throw new RangeError("Index out of range");
-}
-
-const writeUIntLE = function writeUIntLE(
-  buf: Uint8Array,
-  value: number,
-  offset: number,
-  byteLength: number,
-  noAssert?: boolean
-): Uint8Array {
-  value = +value;
-  offset = offset >>> 0;
-  byteLength = byteLength >>> 0;
-  if (!noAssert) {
-    const maxBytes = Math.pow(2, 8 * byteLength) - 1;
-    checkInt(buf, value, offset, byteLength, maxBytes, 0);
-  }
-
-  let mul = 1;
-  let i = 0;
-  buf[offset] = value & 0xff;
-  while (++i < byteLength && (mul *= 0x100)) {
-    buf[offset + i] = (value / mul) & 0xff;
-  }
-
-  return buf;
-};
-
-const DefaultEpochUnitSeconds = 10; // the rln-relay epoch length in seconds
-
-export function toEpoch(
-  timestamp: Date,
-  epochUnitSeconds: number = DefaultEpochUnitSeconds
-): Uint8Array {
-  const unix = Math.floor(timestamp.getTime() / 1000 / epochUnitSeconds);
-  return writeUIntLE(new Uint8Array(32), unix, 0, 8);
-}
-
 const proofOffset = 128;
 const rootOffset = proofOffset + 32;
 const epochOffset = rootOffset + 32;
@@ -123,7 +77,7 @@ const shareYOffset = shareXOffset + 32;
 const nullifierOffset = shareYOffset + 32;
 const rlnIdentifierOffset = nullifierOffset + 32;
 
-export class RateLimitProof {
+export class Proof implements RateLimitProof {
   readonly proof: Uint8Array;
   readonly merkleRoot: Uint8Array;
   readonly epoch: Uint8Array;
@@ -146,26 +100,29 @@ export class RateLimitProof {
       rlnIdentifierOffset
     );
   }
+}
 
-  toBytes(): Uint8Array {
-    return concatenate(
-      this.proof,
-      this.merkleRoot,
-      this.epoch,
-      this.shareX,
-      this.shareY,
-      this.nullifier,
-      this.rlnIdentifier
-    );
-  }
+function proofToBytes(p: RateLimitProof): Uint8Array {
+  return concatenate(
+    p.proof,
+    p.merkleRoot,
+    p.epoch,
+    p.shareX,
+    p.shareY,
+    p.nullifier,
+    p.rlnIdentifier
+  );
 }
 
 export class RLNInstance {
-  constructor(private zkRLN: number, private witnessCalculator: any) {}
+  constructor(
+    private zkRLN: number,
+    private witnessCalculator: WitnessCalculator
+  ) {}
 
   generateMembershipKey(): MembershipKey {
     const memKeys = zerokitRLN.generateMembershipKey(this.zkRLN);
-    return new MembershipKey(memKeys);
+    return MembershipKey.fromBytes(memKeys);
   }
 
   insertMember(idCommitment: Uint8Array): void {
@@ -195,9 +152,9 @@ export class RLNInstance {
     idKey: Uint8Array
   ): Promise<RateLimitProof> {
     if (epoch == undefined) {
-      epoch = toEpoch(new Date());
+      epoch = epochIntToBytes(dateToEpoch(new Date()));
     } else if (epoch instanceof Date) {
-      epoch = toEpoch(epoch);
+      epoch = epochIntToBytes(dateToEpoch(epoch));
     }
 
     if (epoch.length != 32) throw "invalid epoch";
@@ -221,13 +178,16 @@ export class RLNInstance {
       rlnWitness
     );
 
-    return new RateLimitProof(proofBytes);
+    return new Proof(proofBytes);
   }
 
   verifyProof(proof: RateLimitProof | Uint8Array): boolean {
-    if (proof instanceof RateLimitProof) {
-      proof = proof.toBytes();
+    let pBytes: Uint8Array;
+    if (proof instanceof Uint8Array) {
+      pBytes = proof;
+    } else {
+      pBytes = proofToBytes(proof);
     }
-    return zerokitRLN.verifyProof(this.zkRLN, proof);
+    return zerokitRLN.verifyProof(this.zkRLN, pBytes);
   }
 }