@waku/rln 0.1.6-27c1236.0 → 0.1.6-2ce706d.0

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

@@ -13,8 +13,9 @@ import '../../../../node_modules/multiformats/dist/src/bases/base8.js';
 import '../../../../node_modules/multiformats/dist/src/bases/identity.js';
 import '../../../../node_modules/multiformats/dist/src/codecs/json.js';
 import { Logger } from '../../../utils/dist/logger/index.js';
+import { IdentityCredential } from '../identity.js';
 import { RLN_ABI } from './abi.js';
-import { DEFAULT_Q, DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from './constants.js';
+import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from './constants.js';
 import { MembershipState } from './types.js';
 import { Contract } from '../../../../node_modules/@ethersproject/contracts/lib.esm/index.js';
 import { BigNumber } from '../../../../node_modules/@ethersproject/bignumber/lib.esm/bignumber.js';
@@ -26,11 +27,6 @@ class RLNBaseContract {
     rateLimit;
     minRateLimit;
     maxRateLimit;
-    /**
-     * Default Q value for the RLN contract.
-     * @see https://github.com/waku-org/waku-rlnv2-contract/blob/b7e9a9b1bc69256a2a3076c1f099b50ce84e7eff/src/WakuRlnV2.sol#L25
-     */
-    idCommitmentBigIntLimit = DEFAULT_Q;
     _members = new Map();
     _membersFilter;
     _membershipErasedFilter;
@@ -69,14 +65,13 @@ class RLNBaseContract {
      */
     static async create(options) {
         const instance = new RLNBaseContract(options);
-        const [min, max, idCommitmentBigIntLimit] = await Promise.all([
+        const [min, max] = await Promise.all([
             instance.contract.minMembershipRateLimit(),
             instance.contract.maxMembershipRateLimit(),
             instance.contract.Q()
         ]);
         instance.minRateLimit = BigNumber.from(min).toNumber();
         instance.maxRateLimit = BigNumber.from(max).toNumber();
-        instance.idCommitmentBigIntLimit = BigInt(idCommitmentBigIntLimit.toString());
         instance.validateRateLimit(instance.rateLimit);
         return instance;
     }
@@ -347,8 +342,9 @@ class RLNBaseContract {
     async registerWithIdentity(identity) {
         try {
             log.info(`Registering identity with rate limit: ${this.rateLimit} messages/epoch`);
+            const idCommitmentBigInt = IdentityCredential.getIdCommitmentBigInt(identity.IDCommitment);
             // Check if the ID commitment is already registered
-            const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt);
+            const existingIndex = await this.getMemberIndex(idCommitmentBigInt);
             if (existingIndex) {
                 throw new Error(`ID commitment is already registered with index ${existingIndex}`);
             }
@@ -357,9 +353,11 @@ class RLNBaseContract {
             if (remainingRateLimit < this.rateLimit) {
                 throw new Error(`Not enough remaining rate limit. Requested: ${this.rateLimit}, Available: ${remainingRateLimit}`);
             }
-            const estimatedGas = await this.contract.estimateGas.register(identity.IDCommitmentBigInt, this.rateLimit, []);
+            const estimatedGas = await this.contract.estimateGas.register(idCommitmentBigInt, this.rateLimit, []);
             const gasLimit = estimatedGas.add(10000);
-            const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit });
+            const txRegisterResponse = await this.contract.register(idCommitmentBigInt, this.rateLimit, [], {
+                gasLimit
+            });
             const txRegisterReceipt = await txRegisterResponse.wait();
             if (txRegisterReceipt.status === 0) {
                 throw new Error("Transaction failed on-chain");
@@ -421,7 +419,7 @@ class RLNBaseContract {
     async registerWithPermitAndErase(identity, permit, idCommitmentsToErase) {
         try {
             log.info(`Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`);
-            const txRegisterResponse = await this.contract.registerWithPermit(permit.owner, permit.deadline, permit.v, permit.r, permit.s, identity.IDCommitmentBigInt, this.rateLimit, idCommitmentsToErase.map((id) => BigNumber.from(id)));
+            const txRegisterResponse = await this.contract.registerWithPermit(permit.owner, permit.deadline, permit.v, permit.r, permit.s, IdentityCredential.getIdCommitmentBigInt(identity.IDCommitment), this.rateLimit, idCommitmentsToErase.map((id) => BigNumber.from(id)));
             const txRegisterReceipt = await txRegisterResponse.wait();
             const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
             if (!memberRegistered || !memberRegistered.args) {

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

@@ -20,7 +20,7 @@ import { RLNBaseContract } from './contract/rln_base_contract.js';
 import { IdentityCredential } from './identity.js';
 import { Keystore } from './keystore/keystore.js';
 import { extractMetaMaskSigner } from './utils/metamask.js';
-import { buildBigIntFromUint8ArrayLE } from './utils/bytes.js';
+import { switchEndianness } from './utils/bytes.js';
 import './utils/epoch.js';
 
 const log = new Logger("waku:credentials");
@@ -198,22 +198,19 @@ class RLNCredentialsManager {
         const seedBytes = encoder.encode(seed);
         // Generate deterministic values using HMAC-SHA256
         // We use different context strings for each component to ensure they're different
-        const idTrapdoor = hmac(sha256, seedBytes, encoder.encode("IDTrapdoor"));
-        const idNullifier = hmac(sha256, seedBytes, encoder.encode("IDNullifier"));
-        const combinedBytes = new Uint8Array([...idTrapdoor, ...idNullifier]);
-        const idSecretHash = sha256(combinedBytes);
-        const idCommitment = sha256(idSecretHash);
-        let idCommitmentBigInt = buildBigIntFromUint8ArrayLE(idCommitment);
-        if (!this.contract) {
-            throw Error("RLN contract is not initialized");
-        }
-        const idCommitmentBigIntLimit = this.contract.idCommitmentBigIntLimit;
-        if (idCommitmentBigInt >= idCommitmentBigIntLimit) {
-            log.warn(`ID commitment is greater than Q, reducing it by Q(idCommitmentBigIntLimit): ${idCommitmentBigInt} % ${idCommitmentBigIntLimit}`);
-            idCommitmentBigInt = idCommitmentBigInt % idCommitmentBigIntLimit;
-        }
+        const idTrapdoorBE = hmac(sha256, seedBytes, encoder.encode("IDTrapdoor"));
+        const idNullifierBE = hmac(sha256, seedBytes, encoder.encode("IDNullifier"));
+        const combinedBytes = new Uint8Array([...idTrapdoorBE, ...idNullifierBE]);
+        const idSecretHashBE = sha256(combinedBytes);
+        const idCommitmentBE = sha256(idSecretHashBE);
+        // All hashing functions return big-endian bytes
+        // We need to switch to little-endian for the identity credential
+        const idTrapdoorLE = switchEndianness(idTrapdoorBE);
+        const idNullifierLE = switchEndianness(idNullifierBE);
+        const idSecretHashLE = switchEndianness(idSecretHashBE);
+        const idCommitmentLE = switchEndianness(idCommitmentBE);
         log.info("Successfully generated identity credential");
-        return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment, idCommitmentBigInt);
+        return new IdentityCredential(idTrapdoorLE, idNullifierLE, idSecretHashLE, idCommitmentLE);
     }
 }
 

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

@@ -1,18 +1,35 @@
-import { buildBigIntFromUint8ArrayLE } from './utils/bytes.js';
-import './utils/epoch.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';
+import '../../../node_modules/multiformats/dist/src/bases/base256emoji.js';
+import '../../../node_modules/multiformats/dist/src/bases/base32.js';
+import '../../../node_modules/multiformats/dist/src/bases/base36.js';
+import '../../../node_modules/multiformats/dist/src/bases/base58.js';
+import '../../../node_modules/multiformats/dist/src/bases/base64.js';
+import '../../../node_modules/multiformats/dist/src/bases/base8.js';
+import '../../../node_modules/multiformats/dist/src/bases/identity.js';
+import '../../../node_modules/multiformats/dist/src/codecs/json.js';
+import { Logger } from '../../utils/dist/logger/index.js';
+import { DEFAULT_Q } from './contract/constants.js';
+import { buildBigIntFromUint8ArrayBE } from './utils/bytes.js';
 
+const log = new Logger("waku:rln:identity");
 class IdentityCredential {
     IDTrapdoor;
     IDNullifier;
     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;
     }
     static fromBytes(memKeys) {
         if (memKeys.length < 128) {
@@ -22,8 +39,21 @@ class IdentityCredential {
         const idNullifier = memKeys.subarray(32, 64);
         const idSecretHash = memKeys.subarray(64, 96);
         const idCommitment = memKeys.subarray(96, 128);
-        const idCommitmentBigInt = buildBigIntFromUint8ArrayLE(idCommitment);
-        return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment, idCommitmentBigInt);
+        return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment);
+    }
+    /**
+     * Converts an ID commitment from bytes to a BigInt, normalizing it against a limit if needed
+     * @param bytes The ID commitment bytes to convert
+     * @param limit Optional limit to normalize against (Q value)
+     * @returns The ID commitment as a BigInt
+     */
+    static getIdCommitmentBigInt(bytes, limit = DEFAULT_Q) {
+        let idCommitmentBigIntBE = buildBigIntFromUint8ArrayBE(bytes);
+        if (limit && idCommitmentBigIntBE >= limit) {
+            log.warn(`ID commitment is greater than Q, reducing it by Q: ${idCommitmentBigIntBE} % ${limit}`);
+            idCommitmentBigIntBE = idCommitmentBigIntBE % limit;
+        }
+        return idCommitmentBigIntBE;
     }
 }
 

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

@@ -17,7 +17,6 @@ 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 { buildBigIntFromUint8ArrayLE } 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';
@@ -161,22 +160,19 @@ class Keystore {
         };
     }
     static fromBytesToIdentity(bytes) {
-        function fromLittleEndian(bytes) {
-            return new Uint8Array(bytes).reverse();
-        }
         try {
             const str = bytesToUtf8(bytes);
             const obj = JSON.parse(str);
-            // Use little-endian bytes directly for BigInt conversion (matches storage and contract expectation)
             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: fromLittleEndian(idCommitmentLE),
-                    IDTrapdoor: fromLittleEndian(Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idTrapdoor", []))),
-                    IDNullifier: fromLittleEndian(Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idNullifier", []))),
-                    // Do NOT reverse for BigInt conversion; use little-endian as stored
-                    IDCommitmentBigInt: buildBigIntFromUint8ArrayLE(idCommitmentLE),
-                    IDSecretHash: fromLittleEndian(Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idSecretHash", [])))
+                    IDCommitment: idCommitmentLE,
+                    IDTrapdoor: idTrapdoorLE,
+                    IDNullifier: idNullifierLE,
+                    IDSecretHash: idSecretHashLE
                 },
                 membership: {
                     treeIndex: _.get(obj, "treeIndex"),

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

@@ -16,12 +16,12 @@ function concatenate(...input) {
     }
     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 switchEndianness(bytes) {
+    return new Uint8Array(bytes.reverse());
+}
+function buildBigIntFromUint8ArrayBE(bytes) {
+    // Interpret bytes as big-endian
+    return bytes.reduce((acc, byte) => (acc << 8n) + BigInt(byte), 0n);
 }
 function writeUIntLE(buf, value, offset, byteLength, noAssert) {
     value = +value;
@@ -39,9 +39,6 @@ function writeUIntLE(buf, value, offset, byteLength, noAssert) {
     }
     return buf;
 }
-function buildBigIntFromUint8ArrayLE(bytes) {
-    return bytes.reduce((acc, byte, i) => acc + BigInt(byte) * (1n << (8n * BigInt(i))), 0n);
-}
 /**
  * Fills with zeros to set length
  * @param array little endian Uint8Array
@@ -55,5 +52,12 @@ function zeroPadLE(array, length) {
     }
     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");
+}
 
-export { buildBigIntFromUint8ArrayLE, concatenate, writeUIntLE, zeroPadLE };
+export { buildBigIntFromUint8ArrayBE, concatenate, switchEndianness, writeUIntLE, zeroPadLE };