@waku/rln 0.0.2-ce9a6ae.0 → 0.0.2-e3aa837.0

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

@@ -5,7 +5,7 @@ import { hexToBytes } from '../../../utils/dist/bytes/index.js';
 import { Logger } from '../../../utils/dist/logger/index.js';
 import { MerkleRootTracker } from '../root_tracker.js';
 import { zeroPadLE } from '../utils/bytes.js';
-import { RLN_V2_ABI } from './abi/rlnv2.js';
+import { RLN_ABI } from './abi.js';
 import { RATE_LIMIT_PARAMS, DEFAULT_RATE_LIMIT } from './constants.js';
 import { Contract } from '../../../../node_modules/@ethersproject/contracts/lib.esm/index.js';
 import { BigNumber } from '../../../../node_modules/@ethersproject/bignumber/lib.esm/bignumber.js';
@@ -45,8 +45,7 @@ class RLNContract {
         this.rateLimit = rateLimit;
         const initialRoot = rlnInstance.zerokit.getMerkleRoot();
         // Use the injected contract if provided; otherwise, instantiate a new one.
-        this.contract =
-            contract || new Contract(address, RLN_V2_ABI, signer);
+        this.contract = contract || new Contract(address, RLN_ABI, signer);
         this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
         // Initialize event filters for MembershipRegistered and MembershipRemoved
         this._membersFilter = this.contract.filters.MembershipRegistered();
@@ -58,6 +57,18 @@ class RLNContract {
     getRateLimit() {
         return this.rateLimit;
     }
+    /**
+     * Gets the contract address
+     */
+    get address() {
+        return this.contract.address;
+    }
+    /**
+     * Gets the contract provider
+     */
+    get provider() {
+        return this.contract.provider;
+    }
     /**
      * Gets the minimum allowed rate limit from the contract
      * @returns Promise<number> The minimum rate limit in messages per epoch

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

@@ -1,12 +1,6 @@
-import { arrayify } from '../../../node_modules/@ethersproject/bytes/lib.esm/index.js';
-import { keccak256 } from '../../../node_modules/@ethersproject/keccak256/lib.esm/index.js';
-import { Poseidon as m } from '../../../node_modules/@iden3/js-crypto/dist/browser/esm/index.js';
-import { streamXOR } from '../../../node_modules/@stablelib/chacha/lib/chacha.js';
 import { buildBigIntFromUint8Array } from './utils/bytes.js';
 import './utils/epoch.js';
 
-// BN254 curve field size (Snark friendly curve)
-const BN254_FIELD_SIZE = BigInt("21888242871839275222246405745257275088548364400416034343698204186575808495617");
 class IdentityCredential {
     IDTrapdoor;
     IDNullifier;
@@ -31,46 +25,6 @@ class IdentityCredential {
         const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment, 32);
         return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment, idCommitmentBigInt);
     }
-    /**
-     * Normalizes a bigint to be within the BN254 field size
-     * @param value The bigint value to normalize
-     * @returns A bigint value that is within the field size
-     */
-    static normalizeToFieldSize(value) {
-        // Apply modulo operation to ensure the value is within the field
-        return value % BN254_FIELD_SIZE;
-    }
-    static generateSeeded(signature) {
-        try {
-            // Generate deterministic seed from signature
-            const seed = arrayify(keccak256(signature));
-            // Use ChaCha for deterministic randomness (as in Rust code)
-            const nonce = new Uint8Array(12);
-            const idSecretHash = new Uint8Array(32);
-            streamXOR(seed, nonce, idSecretHash, idSecretHash);
-            // Convert to bigint for Poseidon
-            const secretBigInt = BigInt("0x" + Buffer.from(idSecretHash).toString("hex"));
-            // Normalize the value to be within the field size
-            const normalizedSecretBigInt = this.normalizeToFieldSize(secretBigInt);
-            // Generate commitment using Poseidon with normalized value
-            const idCommitmentBigInt = m.hash([normalizedSecretBigInt]);
-            // Convert commitment back to Uint8Array
-            const idCommitment = arrayify("0x" + idCommitmentBigInt.toString(16).padStart(64, "0"));
-            // Generate deterministic trapdoor and nullifier from the secret hash
-            const idTrapdoor = new Uint8Array(32);
-            const idNullifier = new Uint8Array(32);
-            streamXOR(idSecretHash, nonce, idTrapdoor, idTrapdoor);
-            streamXOR(idTrapdoor, nonce, idNullifier, idNullifier);
-            return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment, idCommitmentBigInt);
-        }
-        catch (error) {
-            // Additional fallback for any other errors
-            if (error instanceof Error) {
-                throw new Error(`Failed to generate identity credential: ${error.message}`);
-            }
-            throw error;
-        }
-    }
 }
 
 export { IdentityCredential };

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

@@ -21,27 +21,43 @@ import { Logger } from '../../utils/dist/logger/index.js';
 import '../../core/dist/lib/metadata/metadata.js';
 import __wbg_init, { init_panic_hook, newRLN } from '../../../node_modules/@waku/zerokit-rln-wasm/rln_wasm.js';
 import { createRLNEncoder, createRLNDecoder } from './codec.js';
+import { DEFAULT_RATE_LIMIT, SEPOLIA_CONTRACT } from './contract/constants.js';
 import { RLNContract } from './contract/rln_contract.js';
-import { SEPOLIA_CONTRACT } from './contract/constants.js';
-import { IdentityCredential } from './identity.js';
 import { Keystore } from './keystore/keystore.js';
 import verificationKey from './resources/verification_key.js';
 import { builder } from './resources/witness_calculator.js';
 import { extractMetaMaskSigner } from './utils/metamask.js';
 import './utils/epoch.js';
 import { Zerokit } from './zerokit.js';
-import { arrayify } from '../../../node_modules/@ethersproject/bytes/lib.esm/index.js';
 
 const log = new Logger("waku:rln");
 async function loadWitnessCalculator() {
-    const url = new URL("./resources/rln.wasm", import.meta.url);
-    const response = await fetch(url);
-    return await builder(new Uint8Array(await response.arrayBuffer()), false);
+    try {
+        const url = new URL("./resources/rln.wasm", import.meta.url);
+        const response = await fetch(url);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch witness calculator: ${response.status} ${response.statusText}`);
+        }
+        return await builder(new Uint8Array(await response.arrayBuffer()), false);
+    }
+    catch (error) {
+        log.error("Error loading witness calculator:", error);
+        throw new Error(`Failed to load witness calculator: ${error instanceof Error ? error.message : String(error)}`);
+    }
 }
 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());
+    try {
+        const url = new URL("./resources/rln_final.zkey", import.meta.url);
+        const response = await fetch(url);
+        if (!response.ok) {
+            throw new Error(`Failed to fetch zkey: ${response.status} ${response.statusText}`);
+        }
+        return new Uint8Array(await response.arrayBuffer());
+    }
+    catch (error) {
+        log.error("Error loading zkey:", error);
+        throw new Error(`Failed to load zkey: ${error instanceof Error ? error.message : String(error)}`);
+    }
 }
 /**
  * Create an instance of RLN
@@ -58,7 +74,7 @@ async function create() {
         const vkey = stringEncoder.encode(JSON.stringify(verificationKey));
         const DEPTH = 20;
         const zkRLN = newRLN(DEPTH, zkey, vkey);
-        const zerokit = new Zerokit(zkRLN, witnessCalculator);
+        const zerokit = new Zerokit(zkRLN, witnessCalculator, DEFAULT_RATE_LIMIT);
         return new RLNInstance(zerokit);
     }
     catch (error) {
@@ -99,7 +115,7 @@ class RLNInstance {
             this._contract = await RLNContract.init(this, {
                 address: address,
                 signer: signer,
-                rateLimit: options.rateLimit
+                rateLimit: options.rateLimit ?? this.zerokit.getRateLimit
             });
             this.started = true;
         }
@@ -115,6 +131,12 @@ class RLNInstance {
         if (address === SEPOLIA_CONTRACT.address) {
             chainId = SEPOLIA_CONTRACT.chainId;
         }
+        // eslint-disable-next-line no-console
+        console.log({
+            chainId,
+            address,
+            SEPOLIA_CONTRACT
+        });
         const signer = options.signer || (await extractMetaMaskSigner());
         const currentChainId = await signer.getChainId();
         if (chainId && chainId !== currentChainId) {
@@ -146,9 +168,9 @@ class RLNInstance {
         if (!this.contract) {
             throw Error("RLN Contract is not initialized.");
         }
-        let identity = "identity" in options ? options.identity : undefined;
+        let identity = "identity" in options && options.identity;
         if ("signature" in options) {
-            identity = IdentityCredential.generateSeeded(arrayify(options.signature));
+            identity = this.zerokit.generateSeededIdentityCredential(options.signature);
         }
         if (!identity) {
             throw Error("Missing signature or identity to register membership.");
@@ -182,12 +204,12 @@ class RLNInstance {
             throw Error("Failed to verify chain coordinates: no contract initialized.");
         }
         const registryAddress = credentials.membership.address;
-        const currentRegistryAddress = this._contract.contract.address;
+        const currentRegistryAddress = this._contract.address;
         if (registryAddress !== currentRegistryAddress) {
             throw Error(`Failed to verify chain coordinates: credentials contract address=${registryAddress} is not equal to registryContract address=${currentRegistryAddress}`);
         }
         const chainId = credentials.membership.chainId;
-        const network = await this._contract.contract.provider.getNetwork();
+        const network = await this._contract.provider.getNetwork();
         const currentChainId = network.chainId;
         if (chainId !== currentChainId) {
             throw Error(`Failed to verify chain coordinates: credentials chainID=${chainId} is not equal to registryContract chainID=${currentChainId}`);

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

@@ -8,9 +8,20 @@ import { epochIntToBytes, dateToEpoch } from './utils/epoch.js';
 class Zerokit {
     zkRLN;
     witnessCalculator;
-    constructor(zkRLN, witnessCalculator) {
+    rateLimit;
+    constructor(zkRLN, witnessCalculator, rateLimit = DEFAULT_RATE_LIMIT) {
         this.zkRLN = zkRLN;
         this.witnessCalculator = witnessCalculator;
+        this.rateLimit = rateLimit;
+    }
+    get getZkRLN() {
+        return this.zkRLN;
+    }
+    get getWitnessCalculator() {
+        return this.witnessCalculator;
+    }
+    get getRateLimit() {
+        return this.rateLimit;
     }
     generateIdentityCredentials() {
         const memKeys = generateExtendedMembershipKey(this.zkRLN); // TODO: rename this function in zerokit rln-wasm
@@ -39,32 +50,33 @@ class Zerokit {
     getMerkleRoot() {
         return getRoot(this.zkRLN);
     }
-    serializeMessage(uint8Msg, memIndex, epoch, idKey, rateLimit = DEFAULT_RATE_LIMIT) {
+    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, 0, 8);
+        const rateLimitBytes = 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);
     }
-    async generateRLNProof(msg, index, epoch, idSecretHash, rateLimit = DEFAULT_RATE_LIMIT) {
+    async generateRLNProof(msg, index, epoch, idSecretHash, rateLimit) {
         if (epoch === undefined) {
             epoch = epochIntToBytes(dateToEpoch(new Date()));
         }
         else if (epoch instanceof Date) {
             epoch = epochIntToBytes(dateToEpoch(epoch));
         }
+        const effectiveRateLimit = rateLimit ?? this.rateLimit;
         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) {
+        if (effectiveRateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
+            effectiveRateLimit > 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 serialized_msg = this.serializeMessage(msg, index, epoch, idSecretHash, effectiveRateLimit);
         const rlnWitness = getSerializedRLNWitness(this.zkRLN, serialized_msg);
         const inputs = RLNWitnessToJson(this.zkRLN, rlnWitness);
         const calculatedWitness = await this.witnessCalculator.calculateWitness(inputs, false);
@@ -81,9 +93,7 @@ class Zerokit {
         }
         // 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 rateLimitBytes = writeUIntLE(new Uint8Array(8), rateLimit ?? this.rateLimit, 0, 8);
         return verifyRLNProof(this.zkRLN, concatenate(pBytes, msgLen, msg, rateLimitBytes));
     }
     verifyWithRoots(proof, msg, roots, rateLimit) {
@@ -96,9 +106,7 @@ class Zerokit {
         }
         // 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 rateLimitBytes = writeUIntLE(new Uint8Array(8), rateLimit ?? this.rateLimit, 0, 8);
         const rootsBytes = concatenate(...roots);
         return verifyWithRoots(this.zkRLN, concatenate(pBytes, msgLen, msg, rateLimitBytes), rootsBytes);
     }
@@ -112,9 +120,7 @@ class Zerokit {
         }
         // 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 rateLimitBytes = writeUIntLE(new Uint8Array(8), rateLimit ?? this.rateLimit, 0, 8);
         return verifyWithRoots(this.zkRLN, concatenate(pBytes, msgLen, msg, rateLimitBytes), new Uint8Array());
     }
 }