@waku/rln 0.1.6-16328a3.0 → 0.1.6-2ce706d.0

package/bundle/index.js

@@ -1,7 +1,7 @@
 export { RLNDecoder, RLNEncoder } from './packages/rln/dist/codec.js';
 export { RLN_ABI } from './packages/rln/dist/contract/abi.js';
 export { RLNContract } from './packages/rln/dist/contract/rln_contract.js';
-export { DEFAULT_RATE_LIMIT, LINEA_CONTRACT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS } from './packages/rln/dist/contract/constants.js';
+export { DEFAULT_Q, DEFAULT_RATE_LIMIT, LINEA_CONTRACT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS } from './packages/rln/dist/contract/constants.js';
 export { MembershipState } from './packages/rln/dist/contract/types.js';
 export { RLNBaseContract } from './packages/rln/dist/contract/rln_base_contract.js';
 export { createRLN } from './packages/rln/dist/create.js';

package/bundle/packages/core/dist/lib/message/version_0.js

@@ -29,9 +29,6 @@ class DecodedMessage {
     get contentTopic() {
         return this.proto.contentTopic;
     }
-    get _rawTimestamp() {
-        return this.proto.timestamp;
-    }
     get timestamp() {
         // In the case we receive a value that is bigger than JS's max number,
         // we catch the error and return undefined.
@@ -53,7 +50,7 @@ class DecodedMessage {
     get version() {
         // https://rfc.vac.dev/spec/14/
         // > If omitted, the value SHOULD be interpreted as version 0.
-        return this.proto.version ?? 0;
+        return this.proto.version ?? Version;
     }
     get rateLimitProof() {
         return this.proto.rateLimitProof;

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

@@ -22,6 +22,12 @@ const RATE_LIMIT_PARAMS = {
     MAX_TOTAL_RATE: 160_000, // Maximum total rate limit across all memberships
     EPOCH_LENGTH: 600 // Epoch length in seconds (10 minutes)
 };
+/**
+ * Default Q value for the RLN contract
+ * This is the upper bound for the ID commitment
+ * @see https://github.com/waku-org/specs/blob/master/standards/core/rln-contract.md#implementation-suggestions
+ */
+const DEFAULT_Q = BigInt("21888242871839275222246405745257275088548364400416034343698204186575808495617");
 const DEFAULT_RATE_LIMIT = RATE_LIMIT_PARAMS.MAX_RATE;
 
-export { DEFAULT_RATE_LIMIT, LINEA_CONTRACT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS };
+export { DEFAULT_Q, DEFAULT_RATE_LIMIT, LINEA_CONTRACT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS };

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

@@ -13,6 +13,7 @@ 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_RATE_LIMIT, RATE_LIMIT_PARAMS } from './constants.js';
 import { MembershipState } from './types.js';
@@ -66,7 +67,8 @@ class RLNBaseContract {
         const instance = new RLNBaseContract(options);
         const [min, max] = await Promise.all([
             instance.contract.minMembershipRateLimit(),
-            instance.contract.maxMembershipRateLimit()
+            instance.contract.maxMembershipRateLimit(),
+            instance.contract.Q()
         ]);
         instance.minRateLimit = BigNumber.from(min).toNumber();
         instance.maxRateLimit = BigNumber.from(max).toNumber();
@@ -340,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}`);
             }
@@ -350,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");
@@ -414,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

@@ -1,5 +1,5 @@
 import { hmac } from '../../../node_modules/@noble/hashes/esm/hmac.js';
-import { sha256 } from '../../../node_modules/@noble/hashes/esm/sha256.js';
+import { sha256 } from '../../../node_modules/@noble/hashes/esm/sha2.js';
 import '../../interfaces/dist/protocols.js';
 import '../../interfaces/dist/connection_manager.js';
 import '../../interfaces/dist/health_indicator.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 { buildBigIntFromUint8Array } from './utils/bytes.js';
+import { switchEndianness } from './utils/bytes.js';
 import './utils/epoch.js';
 
 const log = new Logger("waku:credentials");
@@ -95,7 +95,7 @@ class RLNCredentialsManager {
             }
             else {
                 log.info("Using local implementation to generate identity");
-                identity = this.generateSeededIdentityCredential(options.signature);
+                identity = await this.generateSeededIdentityCredential(options.signature);
             }
         }
         if (!identity) {
@@ -191,24 +191,26 @@ class RLNCredentialsManager {
      * @param seed A string seed to generate the identity from
      * @returns IdentityCredential
      */
-    generateSeededIdentityCredential(seed) {
+    async generateSeededIdentityCredential(seed) {
         log.info("Generating seeded identity credential");
         // Convert the seed to bytes
         const encoder = new TextEncoder();
         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"));
-        // Generate IDSecretHash as a hash of IDTrapdoor and IDNullifier
-        const combinedBytes = new Uint8Array([...idTrapdoor, ...idNullifier]);
-        const idSecretHash = sha256(combinedBytes);
-        // Generate IDCommitment as a hash of IDSecretHash
-        const idCommitment = sha256(idSecretHash);
-        // Convert IDCommitment to BigInt
-        const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment);
+        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 { buildBigIntFromUint8Array } 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 = buildBigIntFromUint8Array(idCommitment, 32);
-        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 { buildBigIntFromUint8Array } 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';
@@ -164,14 +163,16 @@ 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
                 },
                 membership: {
                     treeIndex: _.get(obj, "treeIndex"),
@@ -208,13 +209,16 @@ class Keystore {
     // follows nwaku implementation
     // https://github.com/waku-org/nwaku/blob/f05528d4be3d3c876a8b07f9bb7dfaae8aa8ec6e/waku/waku_keystore/protocol_types.nim#L98
     static fromIdentityToBytes(options) {
+        function toLittleEndian(bytes) {
+            return new Uint8Array(bytes).reverse();
+        }
         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),
-                idTrapdoor: Array.from(options.identity.IDTrapdoor)
+                idCommitment: Array.from(toLittleEndian(options.identity.IDCommitment)),
+                idNullifier: Array.from(toLittleEndian(options.identity.IDNullifier)),
+                idSecretHash: Array.from(toLittleEndian(options.identity.IDSecretHash)),
+                idTrapdoor: Array.from(toLittleEndian(options.identity.IDTrapdoor))
             },
             membershipContract: {
                 chainId: options.membership.chainId,

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/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,15 +39,6 @@ function writeUIntLE(buf, value, offset, byteLength, noAssert) {
     }
     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
@@ -61,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 { buildBigIntFromUint8Array, concatenate, writeUIntLE, zeroPadLE };
+export { buildBigIntFromUint8ArrayBE, concatenate, switchEndianness, writeUIntLE, zeroPadLE };