@waku/rln 0.1.6-b7e9b08.0 → 0.1.6-c8b7131.0

package/bundle/packages/rln/dist/identity.js

@@ -1,5 +1,4 @@
-import { buildBigIntFromUint8Array } from './utils/bytes.js';
-import './utils/epoch.js';
+import { BytesUtils } from './utils/bytes.js';
 
 class IdentityCredential {
     IDTrapdoor;
@@ -7,12 +6,16 @@ class IdentityCredential {
     IDSecretHash;
     IDCommitment;
     IDCommitmentBigInt;
-    constructor(IDTrapdoor, IDNullifier, IDSecretHash, IDCommitment, IDCommitmentBigInt) {
+    /**
+     * All variables are in little-endian format
+     */
+    constructor(IDTrapdoor, IDNullifier, IDSecretHash, IDCommitment) {
         this.IDTrapdoor = IDTrapdoor;
         this.IDNullifier = IDNullifier;
         this.IDSecretHash = IDSecretHash;
         this.IDCommitment = IDCommitment;
-        this.IDCommitmentBigInt = IDCommitmentBigInt;
+        this.IDCommitmentBigInt =
+            BytesUtils.buildBigIntFromUint8ArrayBE(IDCommitment);
     }
     static fromBytes(memKeys) {
         if (memKeys.length < 128) {
@@ -22,8 +25,7 @@ class IdentityCredential {
         const idNullifier = memKeys.subarray(32, 64);
         const idSecretHash = memKeys.subarray(64, 96);
         const idCommitment = memKeys.subarray(96, 128);
-        const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment, 32);
-        return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment, idCommitmentBigInt);
+        return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment);
     }
 }
 

package/bundle/packages/rln/dist/keystore/keystore.js

@@ -1,7 +1,7 @@
 import '../../../../node_modules/@chainsafe/bls-keystore/lib/index.js';
-import '../../../utils/node_modules/@waku/interfaces/dist/protocols.js';
-import '../../../utils/node_modules/@waku/interfaces/dist/connection_manager.js';
-import '../../../utils/node_modules/@waku/interfaces/dist/health_indicator.js';
+import '../../../interfaces/dist/protocols.js';
+import '../../../interfaces/dist/connection_manager.js';
+import '../../../interfaces/dist/health_indicator.js';
 import '../../../../node_modules/multiformats/dist/src/bases/base10.js';
 import '../../../../node_modules/multiformats/dist/src/bases/base16.js';
 import '../../../../node_modules/multiformats/dist/src/bases/base2.js';
@@ -17,11 +17,11 @@ import { Logger } from '../../../utils/dist/logger/index.js';
 import { sha256 } from '../../../../node_modules/ethereum-cryptography/esm/sha256.js';
 import { bytesToUtf8 } from '../../../../node_modules/ethereum-cryptography/esm/utils.js';
 import _ from '../../../../node_modules/lodash/lodash.js';
-import { buildBigIntFromUint8Array } from '../utils/bytes.js';
+import { BytesUtils } from '../utils/bytes.js';
 import { keccak256Checksum, decryptEipKeystore } from './cipher.js';
 import { isKeystoreValid, isCredentialValid } from './schema_validator.js';
 import { __exports as lib } from '../../../../_virtual/index.js';
-import v4 from '../../../../node_modules/uuid/dist/esm-browser/v4.js';
+import v4 from '../../node_modules/uuid/dist/esm-browser/v4.js';
 import { bytesToHex, utf8ToBytes } from '../../../../node_modules/@noble/hashes/esm/utils.js';
 
 const log = new Logger("waku:rln:keystore");
@@ -164,14 +164,17 @@ class Keystore {
         try {
             const str = bytesToUtf8(bytes);
             const obj = JSON.parse(str);
-            // TODO: add runtime validation of nwaku credentials
+            const idCommitmentLE = Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idCommitment", []));
+            const idTrapdoorLE = Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idTrapdoor", []));
+            const idNullifierLE = Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idNullifier", []));
+            const idSecretHashLE = Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idSecretHash", []));
             return {
                 identity: {
-                    IDCommitment: Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idCommitment", [])),
-                    IDTrapdoor: Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idTrapdoor", [])),
-                    IDNullifier: Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idNullifier", [])),
-                    IDCommitmentBigInt: buildBigIntFromUint8Array(Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idCommitment", []))),
-                    IDSecretHash: Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idSecretHash", []))
+                    IDCommitment: idCommitmentLE,
+                    IDTrapdoor: idTrapdoorLE,
+                    IDNullifier: idNullifierLE,
+                    IDSecretHash: idSecretHashLE,
+                    IDCommitmentBigInt: BytesUtils.buildBigIntFromUint8ArrayBE(idCommitmentLE)
                 },
                 membership: {
                     treeIndex: _.get(obj, "treeIndex"),
@@ -207,13 +210,14 @@ class Keystore {
     }
     // follows nwaku implementation
     // https://github.com/waku-org/nwaku/blob/f05528d4be3d3c876a8b07f9bb7dfaae8aa8ec6e/waku/waku_keystore/protocol_types.nim#L98
+    // IdentityCredential is stored in Big Endian format => switch to Little Endian
     static fromIdentityToBytes(options) {
         return utf8ToBytes(JSON.stringify({
             treeIndex: options.membership.treeIndex,
             identityCredential: {
-                idCommitment: Array.from(options.identity.IDCommitment),
-                idNullifier: Array.from(options.identity.IDNullifier),
-                idSecretHash: Array.from(options.identity.IDSecretHash),
+                idCommitment: Array.from(BytesUtils.switchEndianness(options.identity.IDCommitment)),
+                idNullifier: Array.from(BytesUtils.switchEndianness(options.identity.IDNullifier)),
+                idSecretHash: Array.from(BytesUtils.switchEndianness(options.identity.IDSecretHash)),
                 idTrapdoor: Array.from(options.identity.IDTrapdoor)
             },
             membershipContract: {

package/bundle/packages/rln/dist/message.js

@@ -1,4 +1,14 @@
+import { Version } from '../../core/dist/lib/message/version_0.js';
+import '../../core/dist/lib/filter/filter.js';
+import '../../core/dist/lib/light_push/light_push.js';
+import '../../core/dist/lib/store/store.js';
+import '../../core/dist/lib/connection_manager/connection_manager.js';
+import '../../interfaces/dist/protocols.js';
+import '../../interfaces/dist/connection_manager.js';
+import '../../interfaces/dist/health_indicator.js';
 import { utf8ToBytes } from '../../utils/dist/bytes/index.js';
+import '../../../node_modules/debug/src/browser.js';
+import '../../core/dist/lib/metadata/metadata.js';
 import { epochBytesToInt } from './utils/epoch.js';
 
 function toRLNSignal(contentTopic, msg) {
@@ -10,6 +20,7 @@ class RlnMessage {
     msg;
     rateLimitProof;
     pubsubTopic = "";
+    version = Version;
     constructor(rlnInstance, msg, rateLimitProof) {
         this.rlnInstance = rlnInstance;
         this.msg = msg;

package/bundle/packages/rln/dist/proof.js

@@ -1,4 +1,4 @@
-import { concatenate } from './utils/bytes.js';
+import { BytesUtils } from './utils/bytes.js';
 import { poseidonHash } from './utils/hash.js';
 import './utils/epoch.js';
 
@@ -48,7 +48,7 @@ class Proof {
     }
 }
 function proofToBytes(p) {
-    return concatenate(p.proof, p.merkleRoot, p.epoch, p.shareX, p.shareY, p.nullifier, p.rlnIdentifier);
+    return BytesUtils.concatenate(p.proof, p.merkleRoot, p.epoch, p.shareX, p.shareY, p.nullifier, p.rlnIdentifier);
 }
 
 export { Proof, proofToBytes };

package/bundle/packages/rln/dist/rln.js

@@ -3,9 +3,9 @@ import '../../core/dist/lib/filter/filter.js';
 import '../../core/dist/lib/light_push/light_push.js';
 import '../../core/dist/lib/store/store.js';
 import '../../core/dist/lib/connection_manager/connection_manager.js';
-import '../../utils/node_modules/@waku/interfaces/dist/protocols.js';
-import '../../utils/node_modules/@waku/interfaces/dist/connection_manager.js';
-import '../../utils/node_modules/@waku/interfaces/dist/health_indicator.js';
+import '../../interfaces/dist/protocols.js';
+import '../../interfaces/dist/connection_manager.js';
+import '../../interfaces/dist/health_indicator.js';
 import '../../../node_modules/multiformats/dist/src/bases/base10.js';
 import '../../../node_modules/multiformats/dist/src/bases/base16.js';
 import '../../../node_modules/multiformats/dist/src/bases/base2.js';

package/bundle/packages/rln/dist/utils/bytes.js

@@ -1,65 +1,110 @@
-/**
- * Concatenate Uint8Arrays
- * @param input
- * @returns concatenation of all Uint8Array received as input
- */
-function concatenate(...input) {
-    let totalLength = 0;
-    for (const arr of input) {
-        totalLength += arr.length;
+class BytesUtils {
+    /**
+     * Switches endianness of a byte array
+     */
+    static switchEndianness(bytes) {
+        return new Uint8Array(bytes.reverse());
     }
-    const result = new Uint8Array(totalLength);
-    let offset = 0;
-    for (const arr of input) {
-        result.set(arr, offset);
-        offset += arr.length;
+    /**
+     * Builds a BigInt from a big-endian Uint8Array
+     * @param bytes The big-endian bytes to convert
+     * @returns The resulting BigInt in big-endian format
+     */
+    static buildBigIntFromUint8ArrayBE(bytes) {
+        let result = 0n;
+        for (let i = 0; i < bytes.length; i++) {
+            result = (result << 8n) + BigInt(bytes[i]);
+        }
+        return result;
     }
-    return result;
-}
-// 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");
-}
-function writeUIntLE(buf, value, offset, byteLength, noAssert) {
-    value = +value;
-    offset = offset >>> 0;
-    byteLength = byteLength >>> 0;
-    {
-        const maxBytes = Math.pow(2, 8 * byteLength) - 1;
-        checkInt(buf, value, offset, byteLength, maxBytes, 0);
+    /**
+     * Switches endianness of a bigint value
+     * @param value The bigint value to switch endianness for
+     * @returns The bigint value with reversed endianness
+     */
+    static switchEndiannessBigInt(value) {
+        // Convert bigint to byte array
+        const bytes = [];
+        let tempValue = value;
+        while (tempValue > 0n) {
+            bytes.push(Number(tempValue & 0xffn));
+            tempValue >>= 8n;
+        }
+        // Reverse bytes and convert back to bigint
+        return bytes
+            .reverse()
+            .reduce((acc, byte) => (acc << 8n) + BigInt(byte), 0n);
     }
-    let mul = 1;
-    let i = 0;
-    buf[offset] = value & 0xff;
-    while (++i < byteLength && (mul *= 0x100)) {
-        buf[offset + i] = (value / mul) & 0xff;
+    /**
+     * Converts a big-endian bigint to a 32-byte big-endian Uint8Array
+     * @param value The big-endian bigint to convert
+     * @returns A 32-byte big-endian Uint8Array
+     */
+    static bigIntToUint8Array32BE(value) {
+        const bytes = new Uint8Array(32);
+        for (let i = 31; i >= 0; i--) {
+            bytes[i] = Number(value & 0xffn);
+            value >>= 8n;
+        }
+        return bytes;
     }
-    return buf;
-}
-/**
- * Transforms Uint8Array into BigInt
- * @param array: Uint8Array
- * @returns BigInt
- */
-function buildBigIntFromUint8Array(array, byteOffset = 0) {
-    const dataView = new DataView(array.buffer);
-    return dataView.getBigUint64(byteOffset, true);
-}
-/**
- * Fills with zeros to set length
- * @param array little endian Uint8Array
- * @param length amount to pad
- * @returns little endian Uint8Array padded with zeros to set length
- */
-function zeroPadLE(array, length) {
-    const result = new Uint8Array(length);
-    for (let i = 0; i < length; i++) {
-        result[i] = array[i] || 0;
+    /**
+     * Writes an unsigned integer to a buffer in little-endian format
+     */
+    static writeUIntLE(buf, value, offset, byteLength, noAssert) {
+        value = +value;
+        offset = offset >>> 0;
+        byteLength = byteLength >>> 0;
+        if (!noAssert) {
+            const maxBytes = Math.pow(2, 8 * byteLength) - 1;
+            BytesUtils.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;
+    }
+    /**
+     * Fills with zeros to set length
+     * @param array little endian Uint8Array
+     * @param length amount to pad
+     * @returns little endian Uint8Array padded with zeros to set length
+     */
+    static zeroPadLE(array, length) {
+        const result = new Uint8Array(length);
+        for (let i = 0; i < length; i++) {
+            result[i] = array[i] || 0;
+        }
+        return result;
+    }
+    // Adapted from https://github.com/feross/buffer
+    static 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");
+    }
+    /**
+     * Concatenate Uint8Arrays
+     * @param input
+     * @returns concatenation of all Uint8Array received as input
+     */
+    static concatenate(...input) {
+        let totalLength = 0;
+        for (const arr of input) {
+            totalLength += arr.length;
+        }
+        const result = new Uint8Array(totalLength);
+        let offset = 0;
+        for (const arr of input) {
+            result.set(arr, offset);
+            offset += arr.length;
+        }
+        return result;
     }
-    return result;
 }
 
-export { buildBigIntFromUint8Array, concatenate, writeUIntLE, zeroPadLE };
+export { BytesUtils };

package/bundle/packages/rln/dist/utils/epoch.js

@@ -1,6 +1,6 @@
-import '../../../utils/node_modules/@waku/interfaces/dist/protocols.js';
-import '../../../utils/node_modules/@waku/interfaces/dist/connection_manager.js';
-import '../../../utils/node_modules/@waku/interfaces/dist/health_indicator.js';
+import '../../../interfaces/dist/protocols.js';
+import '../../../interfaces/dist/connection_manager.js';
+import '../../../interfaces/dist/health_indicator.js';
 import '../../../../node_modules/multiformats/dist/src/bases/base10.js';
 import '../../../../node_modules/multiformats/dist/src/bases/base16.js';
 import '../../../../node_modules/multiformats/dist/src/bases/base2.js';

package/bundle/packages/rln/dist/utils/hash.js

@@ -1,9 +1,9 @@
 import { poseidonHash as poseidonHash$1 } from '../../../../node_modules/@waku/zerokit-rln-wasm/rln_wasm.js';
-import { writeUIntLE, concatenate } from './bytes.js';
+import { BytesUtils } from './bytes.js';
 
 function poseidonHash(...input) {
-    const inputLen = writeUIntLE(new Uint8Array(8), input.length, 0, 8);
-    const lenPrefixedData = concatenate(inputLen, ...input);
+    const inputLen = BytesUtils.writeUIntLE(new Uint8Array(8), input.length, 0, 8);
+    const lenPrefixedData = BytesUtils.concatenate(inputLen, ...input);
     return poseidonHash$1(lenPrefixedData);
 }
 

package/bundle/packages/rln/dist/zerokit.js

@@ -2,7 +2,7 @@ import { generateExtendedMembershipKey, generateSeededExtendedMembershipKey, ins
 import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from './contract/constants.js';
 import { IdentityCredential } from './identity.js';
 import { Proof, proofToBytes } from './proof.js';
-import { writeUIntLE, concatenate } from './utils/bytes.js';
+import { BytesUtils } from './utils/bytes.js';
 import { epochIntToBytes, dateToEpoch } from './utils/epoch.js';
 
 class Zerokit {
@@ -40,8 +40,8 @@ class Zerokit {
     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);
+        const idCommitmentLen = BytesUtils.writeUIntLE(new Uint8Array(8), idCommitments.length, 0, 8);
+        const idCommitmentBytes = BytesUtils.concatenate(idCommitmentLen, ...idCommitments);
         setLeavesFrom(this.zkRLN, index, idCommitmentBytes);
     }
     deleteMember(index) {
@@ -52,11 +52,11 @@ class Zerokit {
     }
     serializeMessage(uint8Msg, memIndex, epoch, idKey, rateLimit) {
         // 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 ?? this.rateLimit, 0, 8);
+        const msgLen = BytesUtils.writeUIntLE(new Uint8Array(8), uint8Msg.length, 0, 8);
+        const memIndexBytes = BytesUtils.writeUIntLE(new Uint8Array(8), memIndex, 0, 8);
+        const rateLimitBytes = BytesUtils.writeUIntLE(new Uint8Array(8), rateLimit ?? this.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);
+        return BytesUtils.concatenate(idKey, memIndexBytes, epoch, msgLen, uint8Msg, rateLimitBytes);
     }
     async generateRLNProof(msg, index, epoch, idSecretHash, rateLimit) {
         if (epoch === undefined) {
@@ -92,9 +92,9 @@ class Zerokit {
             pBytes = proofToBytes(proof);
         }
         // calculate message length
-        const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
-        const rateLimitBytes = writeUIntLE(new Uint8Array(8), rateLimit ?? this.rateLimit, 0, 8);
-        return verifyRLNProof(this.zkRLN, concatenate(pBytes, msgLen, msg, rateLimitBytes));
+        const msgLen = BytesUtils.writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
+        const rateLimitBytes = BytesUtils.writeUIntLE(new Uint8Array(8), rateLimit ?? this.rateLimit, 0, 8);
+        return verifyRLNProof(this.zkRLN, BytesUtils.concatenate(pBytes, msgLen, msg, rateLimitBytes));
     }
     verifyWithRoots(proof, msg, roots, rateLimit) {
         let pBytes;
@@ -105,10 +105,10 @@ class Zerokit {
             pBytes = proofToBytes(proof);
         }
         // calculate message length
-        const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
-        const rateLimitBytes = writeUIntLE(new Uint8Array(8), rateLimit ?? this.rateLimit, 0, 8);
-        const rootsBytes = concatenate(...roots);
-        return verifyWithRoots(this.zkRLN, concatenate(pBytes, msgLen, msg, rateLimitBytes), rootsBytes);
+        const msgLen = BytesUtils.writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
+        const rateLimitBytes = BytesUtils.writeUIntLE(new Uint8Array(8), rateLimit ?? this.rateLimit, 0, 8);
+        const rootsBytes = BytesUtils.concatenate(...roots);
+        return verifyWithRoots(this.zkRLN, BytesUtils.concatenate(pBytes, msgLen, msg, rateLimitBytes), rootsBytes);
     }
     verifyWithNoRoot(proof, msg, rateLimit) {
         let pBytes;
@@ -119,9 +119,9 @@ class Zerokit {
             pBytes = proofToBytes(proof);
         }
         // calculate message length
-        const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
-        const rateLimitBytes = writeUIntLE(new Uint8Array(8), rateLimit ?? this.rateLimit, 0, 8);
-        return verifyWithRoots(this.zkRLN, concatenate(pBytes, msgLen, msg, rateLimitBytes), new Uint8Array());
+        const msgLen = BytesUtils.writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
+        const rateLimitBytes = BytesUtils.writeUIntLE(new Uint8Array(8), rateLimit ?? this.rateLimit, 0, 8);
+        return verifyWithRoots(this.zkRLN, BytesUtils.concatenate(pBytes, msgLen, msg, rateLimitBytes), new Uint8Array());
     }
 }
 

package/bundle/packages/utils/dist/common/sharding/index.js

@@ -1,8 +1,8 @@
 import { sha256 } from '../../../../../node_modules/@noble/hashes/esm/sha256.js';
-import '../../../node_modules/@waku/interfaces/dist/protocols.js';
-import '../../../node_modules/@waku/interfaces/dist/connection_manager.js';
-import { DEFAULT_CLUSTER_ID } from '../../../node_modules/@waku/interfaces/dist/constants.js';
-import '../../../node_modules/@waku/interfaces/dist/health_indicator.js';
+import '../../../../interfaces/dist/protocols.js';
+import '../../../../interfaces/dist/connection_manager.js';
+import { DEFAULT_CLUSTER_ID } from '../../../../interfaces/dist/constants.js';
+import '../../../../interfaces/dist/health_indicator.js';
 import { concat, utf8ToBytes } from '../../bytes/index.js';
 
 const singleShardInfoToPubsubTopic = (shardInfo) => {