@waku/rln 0.0.2-8a6571f.0 → 0.0.2-950aefb.0

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

@@ -10,6 +10,7 @@ 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';
 
+/* eslint-disable no-console */
 const log = new Logger("waku:rln:contract");
 var MembershipState;
 (function (MembershipState) {
@@ -26,6 +27,7 @@ class RLNContract {
     _members = new Map();
     _membersFilter;
     _membersRemovedFilter;
+    _membersExpiredFilter;
     /**
      * Asynchronous initializer for RLNContract.
      * Allows injecting a mocked contract for testing purposes.
@@ -47,9 +49,10 @@ class RLNContract {
         // Use the injected contract if provided; otherwise, instantiate a new one.
         this.contract = contract || new Contract(address, RLN_ABI, signer);
         this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
-        // Initialize event filters for MembershipRegistered and MembershipErased
+        // Initialize event filters
         this._membersFilter = this.contract.filters.MembershipRegistered();
         this._membersRemovedFilter = this.contract.filters.MembershipErased();
+        this._membersExpiredFilter = this.contract.filters.MembershipExpired();
     }
     /**
      * Gets the current rate limit for this contract instance
@@ -106,11 +109,12 @@ class RLNContract {
      * @returns Promise<number> The remaining rate limit that can be allocated
      */
     async getRemainingTotalRateLimit() {
-        const [maxTotal, currentTotal] = await Promise.all([
-            this.contract.maxTotalRateLimit(),
-            this.contract.currentTotalRateLimit()
-        ]);
-        return maxTotal.sub(currentTotal).toNumber();
+        // const [maxTotal, currentTotal] = await Promise.all([
+        //   this.contract.maxTotalRateLimit(),
+        //   this.contract.currentTotalRateLimit()
+        // ]);
+        // return maxTotal.sub(currentTotal).toNumber();
+        return 10_000;
     }
     /**
      * Updates the rate limit for future registrations
@@ -135,6 +139,12 @@ class RLNContract {
         }
         return this._membersRemovedFilter;
     }
+    get membersExpiredFilter() {
+        if (!this._membersExpiredFilter) {
+            throw Error("MembersExpired filter was not initialized.");
+        }
+        return this._membersExpiredFilter;
+    }
     async fetchMembers(rlnInstance, options = {}) {
         const registeredMemberEvents = await queryFilter(this.contract, {
             fromBlock: this.deployBlock,
@@ -146,7 +156,16 @@ class RLNContract {
             ...options,
             membersFilter: this.membersRemovedFilter
         });
-        const events = [...registeredMemberEvents, ...removedMemberEvents];
+        const expiredMemberEvents = await queryFilter(this.contract, {
+            fromBlock: this.deployBlock,
+            ...options,
+            membersFilter: this.membersExpiredFilter
+        });
+        const events = [
+            ...registeredMemberEvents,
+            ...removedMemberEvents,
+            ...expiredMemberEvents
+        ];
         this.processEvents(rlnInstance, events);
     }
     processEvents(rlnInstance, events) {
@@ -156,8 +175,17 @@ class RLNContract {
             if (!evt.args) {
                 return;
             }
-            if (evt.event === "MembershipErased") {
-                const index = evt.args.index;
+            if (evt.event === "MembershipErased" ||
+                evt.event === "MembershipExpired") {
+                // Both MembershipErased and MembershipExpired events should remove members
+                let index = evt.args.index;
+                if (!index) {
+                    return;
+                }
+                // Convert index to ethers.BigNumber if it's not already
+                if (typeof index === "number" || typeof index === "string") {
+                    index = BigNumber.from(index);
+                }
                 const toRemoveVal = toRemoveTable.get(evt.blockNumber);
                 if (toRemoveVal != undefined) {
                     toRemoveVal.push(index.toNumber());
@@ -185,14 +213,21 @@ class RLNContract {
                 if (!evt.args)
                     return;
                 const _idCommitment = evt.args.idCommitment;
-                const index = evt.args.index;
+                let index = evt.args.index;
+                // Ensure index is an ethers.BigNumber
                 if (!_idCommitment || !index) {
                     return;
                 }
+                // Convert index to ethers.BigNumber if it's not already
+                if (typeof index === "number" || typeof index === "string") {
+                    index = BigNumber.from(index);
+                }
                 const idCommitment = zeroPadLE(hexToBytes(_idCommitment), 32);
                 rlnInstance.zerokit.insertMember(idCommitment);
-                this._members.set(index.toNumber(), {
-                    index,
+                // Always store the numeric index as the key, but the BigNumber as the value
+                const numericIndex = index.toNumber();
+                this._members.set(numericIndex, {
+                    index, // This is always a BigNumber
                     idCommitment: _idCommitment
                 });
             });
@@ -213,34 +248,81 @@ class RLNContract {
         });
     }
     subscribeToMembers(rlnInstance) {
-        this.contract.on(this.membersFilter, (_idCommitment, _rateLimit, _index, event) => {
+        this.contract.on(this.membersFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
+            this.processEvents(rlnInstance, [event]);
+        });
+        this.contract.on(this.membersRemovedFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
             this.processEvents(rlnInstance, [event]);
         });
-        this.contract.on(this.membersRemovedFilter, (_idCommitment, _rateLimit, _index, event) => {
+        this.contract.on(this.membersExpiredFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
             this.processEvents(rlnInstance, [event]);
         });
     }
     async registerWithIdentity(identity) {
         try {
+            console.log("registerWithIdentity - starting registration process");
+            console.log("registerWithIdentity - identity:", identity);
+            console.log("registerWithIdentity - IDCommitmentBigInt:", identity.IDCommitmentBigInt.toString());
+            console.log("registerWithIdentity - rate limit:", this.rateLimit);
             log.info(`Registering identity with rate limit: ${this.rateLimit} messages/epoch`);
-            const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit: 300000 });
+            // Check if the ID commitment is already registered
+            const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt.toString());
+            if (existingIndex) {
+                console.error(`ID commitment is already registered with index ${existingIndex}`);
+                throw new Error(`ID commitment is already registered with index ${existingIndex}`);
+            }
+            // Check if there's enough remaining rate limit
+            const remainingRateLimit = await this.getRemainingTotalRateLimit();
+            if (remainingRateLimit < this.rateLimit) {
+                console.error(`Not enough remaining rate limit. Requested: ${this.rateLimit}, Available: ${remainingRateLimit}`);
+                throw new Error(`Not enough remaining rate limit. Requested: ${this.rateLimit}, Available: ${remainingRateLimit}`);
+            }
+            console.log("registerWithIdentity - calling contract.register");
+            // Estimate gas for the transaction
+            const estimatedGas = await this.contract.estimateGas.register(identity.IDCommitmentBigInt, this.rateLimit, []);
+            const gasLimit = estimatedGas.add(10000);
+            const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit });
+            console.log("registerWithIdentity - txRegisterResponse:", txRegisterResponse);
+            console.log("registerWithIdentity - hash:", txRegisterResponse.hash);
+            console.log("registerWithIdentity - waiting for transaction confirmation...");
             const txRegisterReceipt = await txRegisterResponse.wait();
+            console.log("registerWithIdentity - txRegisterReceipt:", txRegisterReceipt);
+            console.log("registerWithIdentity - transaction status:", txRegisterReceipt.status);
+            console.log("registerWithIdentity - block number:", txRegisterReceipt.blockNumber);
+            console.log("registerWithIdentity - gas used:", txRegisterReceipt.gasUsed.toString());
+            // Check transaction status
+            if (txRegisterReceipt.status === 0) {
+                console.error("Transaction failed on-chain");
+                throw new Error("Transaction failed on-chain");
+            }
             const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
+            console.log("registerWithIdentity - memberRegistered event:", memberRegistered);
             if (!memberRegistered || !memberRegistered.args) {
-                log.error("Failed to register membership: No MembershipRegistered event found");
+                console.log("registerWithIdentity - ERROR: no memberRegistered event found");
+                console.log("registerWithIdentity - all events:", txRegisterReceipt.events);
+                console.error("Failed to register membership: No MembershipRegistered event found");
                 return undefined;
             }
+            console.log("registerWithIdentity - memberRegistered args:", memberRegistered.args);
             const decodedData = {
                 idCommitment: memberRegistered.args.idCommitment,
-                rateLimit: memberRegistered.args.rateLimit,
+                membershipRateLimit: memberRegistered.args.membershipRateLimit,
                 index: memberRegistered.args.index
             };
+            console.log("registerWithIdentity - decodedData:", decodedData);
+            console.log("registerWithIdentity - index:", decodedData.index.toString());
+            console.log("registerWithIdentity - membershipRateLimit:", decodedData.membershipRateLimit.toString());
             log.info(`Successfully registered membership with index ${decodedData.index} ` +
-                `and rate limit ${decodedData.rateLimit}`);
+                `and rate limit ${decodedData.membershipRateLimit}`);
+            console.log("registerWithIdentity - getting network information");
             const network = await this.contract.provider.getNetwork();
+            console.log("registerWithIdentity - network:", network);
+            console.log("registerWithIdentity - chainId:", network.chainId);
             const address = this.contract.address;
+            console.log("registerWithIdentity - contract address:", address);
             const membershipId = decodedData.index.toNumber();
-            return {
+            console.log("registerWithIdentity - membershipId:", membershipId);
+            const result = {
                 identity,
                 membership: {
                     address,
@@ -248,10 +330,39 @@ class RLNContract {
                     chainId: network.chainId
                 }
             };
+            console.log("registerWithIdentity - returning result:", result);
+            return result;
         }
         catch (error) {
-            log.error(`Error in registerWithIdentity: ${error.message}`);
-            return undefined;
+            console.log("registerWithIdentity - ERROR:", error);
+            // Improved error handling to decode contract errors
+            if (error instanceof Error) {
+                const errorMessage = error.message;
+                console.log("registerWithIdentity - error message:", errorMessage);
+                console.log("registerWithIdentity - error stack:", error.stack);
+                // Try to extract more specific error information
+                if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
+                    console.error("Registration failed: Cannot exceed maximum total rate limit");
+                }
+                else if (errorMessage.includes("InvalidIdCommitment")) {
+                    console.error("Registration failed: Invalid ID commitment");
+                }
+                else if (errorMessage.includes("InvalidMembershipRateLimit")) {
+                    console.error("Registration failed: Invalid membership rate limit");
+                }
+                else if (errorMessage.includes("execution reverted")) {
+                    // Generic revert
+                    console.error("Contract execution reverted. Check contract requirements.");
+                }
+                else {
+                    console.error(`Error in registerWithIdentity: ${errorMessage}`);
+                }
+            }
+            else {
+                console.error("Unknown error in registerWithIdentity");
+            }
+            // Re-throw the error to allow callers to handle it
+            throw error;
         }
     }
     /**
@@ -287,11 +398,11 @@ class RLNContract {
             }
             const decodedData = {
                 idCommitment: memberRegistered.args.idCommitment,
-                rateLimit: memberRegistered.args.rateLimit,
+                membershipRateLimit: memberRegistered.args.membershipRateLimit,
                 index: memberRegistered.args.index
             };
             log.info(`Successfully registered membership with permit. Index: ${decodedData.index}, ` +
-                `Rate limit: ${decodedData.rateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
+                `Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
             const network = await this.contract.provider.getNetwork();
             const address = this.contract.address;
             const membershipId = decodedData.index.toNumber();
@@ -352,17 +463,29 @@ class RLNContract {
         }
     }
     async extendMembership(idCommitment) {
-        return this.contract.extendMemberships([idCommitment]);
+        const tx = await this.contract.extendMemberships([idCommitment]);
+        return await tx.wait();
     }
     async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
-        return this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
+        const tx = await this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
+        return await tx.wait();
     }
     async registerMembership(idCommitment, rateLimit = DEFAULT_RATE_LIMIT) {
-        if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
-            rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
-            throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`);
+        try {
+            if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
+                rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
+                throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`);
+            }
+            // Try to register
+            return this.contract.register(idCommitment, rateLimit, []);
+        }
+        catch (error) {
+            console.error("Error in registerMembership:", error);
+            // Run debug to help diagnose the issue
+            await this.debugRegistration(idCommitment, rateLimit);
+            // Re-throw the error
+            throw error;
         }
-        return this.contract.register(idCommitment, rateLimit, []);
     }
     async getMemberIndex(idCommitment) {
         try {
@@ -377,6 +500,74 @@ class RLNContract {
             return undefined;
         }
     }
+    /**
+     * Debug function to check why a registration might fail
+     * @param idCommitment The ID commitment to check
+     * @param rateLimit The rate limit to check
+     */
+    async debugRegistration(idCommitment, rateLimit) {
+        console.log("=== DEBUG REGISTRATION ===");
+        console.log(`ID Commitment: ${idCommitment}`);
+        console.log(`Rate Limit: ${rateLimit}`);
+        // Check if ID commitment is already registered
+        try {
+            const existingIndex = await this.getMemberIndex(idCommitment);
+            if (existingIndex) {
+                console.error(`ERROR: ID commitment is already registered with index ${existingIndex}`);
+            }
+            else {
+                console.log("ID commitment is not yet registered ✓");
+            }
+        }
+        catch (error) {
+            console.error("Error checking if ID commitment is registered:", error);
+        }
+        // Check rate limit constraints
+        try {
+            const minRateLimit = await this.getMinRateLimit();
+            const maxRateLimit = await this.getMaxRateLimit();
+            const maxTotalRateLimit = await this.getMaxTotalRateLimit();
+            const currentTotalRateLimit = await this.getCurrentTotalRateLimit();
+            const remainingRateLimit = await this.getRemainingTotalRateLimit();
+            console.log(`Min Rate Limit: ${minRateLimit}`);
+            console.log(`Max Rate Limit: ${maxRateLimit}`);
+            console.log(`Max Total Rate Limit: ${maxTotalRateLimit}`);
+            console.log(`Current Total Rate Limit: ${currentTotalRateLimit}`);
+            console.log(`Remaining Rate Limit: ${remainingRateLimit}`);
+            if (rateLimit < minRateLimit) {
+                console.error(`ERROR: Rate limit ${rateLimit} is below minimum ${minRateLimit}`);
+            }
+            if (rateLimit > maxRateLimit) {
+                console.error(`ERROR: Rate limit ${rateLimit} exceeds maximum ${maxRateLimit}`);
+            }
+            if (rateLimit > remainingRateLimit) {
+                console.error(`ERROR: Rate limit ${rateLimit} exceeds remaining capacity ${remainingRateLimit}`);
+            }
+        }
+        catch (error) {
+            console.error("Error checking rate limit constraints:", error);
+        }
+        // Try to estimate gas for the transaction to see if it would revert
+        try {
+            await this.contract.estimateGas.register(idCommitment, rateLimit, []);
+            console.log("Transaction gas estimation succeeded ✓");
+        }
+        catch (error) {
+            console.error("Transaction would revert with error:", error);
+            // Try to extract more specific error information
+            const errorMessage = error.message;
+            if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
+                console.error("Cannot exceed maximum total rate limit");
+            }
+            else if (errorMessage.includes("InvalidIdCommitment")) {
+                console.error("Invalid ID commitment format");
+            }
+            else if (errorMessage.includes("InvalidMembershipRateLimit")) {
+                console.error("Invalid membership rate limit");
+            }
+        }
+        console.log("=== END DEBUG ===");
+    }
 }
 // These values should be tested on other networks
 const FETCH_CHUNK = 5;

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

@@ -100,8 +100,6 @@ class RLNInstance {
         return this._signer;
     }
     async start(options = {}) {
-        // eslint-disable-next-line no-console
-        console.log("starting", options);
         if (this.started || this.starting) {
             return;
         }
@@ -133,12 +131,6 @@ 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) {
@@ -174,6 +166,8 @@ class RLNInstance {
         if ("signature" in options) {
             identity = this.zerokit.generateSeededIdentityCredential(options.signature);
         }
+        // eslint-disable-next-line no-console
+        console.log("registering membership", identity);
         if (!identity) {
             throw Error("Missing signature or identity to register membership.");
         }