@waku/rln 0.1.4 → 0.1.5-6198efb.0

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

@@ -1,8 +1,8 @@
 import { RLN_ABI } from './abi.js';
 
-const SEPOLIA_CONTRACT = {
-    chainId: 11155111,
-    address: "0xCB33Aa5B38d79E3D9Fa8B10afF38AA201399a7e3",
+const LINEA_CONTRACT = {
+    chainId: 59141,
+    address: "0xb9cd878c90e49f797b4431fbf4fb333108cb90e6",
     abi: RLN_ABI
 };
 /**
@@ -23,4 +23,4 @@ const RATE_LIMIT_PARAMS = {
 };
 const DEFAULT_RATE_LIMIT = RATE_LIMIT_PARAMS.MAX_RATE;
 
-export { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS, SEPOLIA_CONTRACT };
+export { DEFAULT_RATE_LIMIT, LINEA_CONTRACT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS };

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

@@ -25,7 +25,8 @@ class RLNContract {
     rateLimit;
     _members = new Map();
     _membersFilter;
-    _membersRemovedFilter;
+    _membershipErasedFilter;
+    _membersExpiredFilter;
     /**
      * Asynchronous initializer for RLNContract.
      * Allows injecting a mocked contract for testing purposes.
@@ -38,18 +39,26 @@ class RLNContract {
     }
     constructor(rlnInstance, options) {
         const { address, signer, rateLimit = DEFAULT_RATE_LIMIT, contract } = options;
-        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} messages per epoch`);
-        }
+        this.validateRateLimit(rateLimit);
         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_ABI, signer);
         this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
-        // Initialize event filters for MembershipRegistered and MembershipRemoved
+        // Initialize event filters
         this._membersFilter = this.contract.filters.MembershipRegistered();
-        this._membersRemovedFilter = this.contract.filters.MembershipRemoved();
+        this._membershipErasedFilter = this.contract.filters.MembershipErased();
+        this._membersExpiredFilter = this.contract.filters.MembershipExpired();
+    }
+    /**
+     * Validates that the rate limit is within the allowed range
+     * @throws Error if the rate limit is outside the allowed range
+     */
+    validateRateLimit(rateLimit) {
+        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} messages per epoch`);
+        }
     }
     /**
      * Gets the current rate limit for this contract instance
@@ -75,7 +84,7 @@ class RLNContract {
      */
     async getMinRateLimit() {
         const minRate = await this.contract.minMembershipRateLimit();
-        return minRate.toNumber();
+        return BigNumber.from(minRate).toNumber();
     }
     /**
      * Gets the maximum allowed rate limit from the contract
@@ -83,7 +92,7 @@ class RLNContract {
      */
     async getMaxRateLimit() {
         const maxRate = await this.contract.maxMembershipRateLimit();
-        return maxRate.toNumber();
+        return BigNumber.from(maxRate).toNumber();
     }
     /**
      * Gets the maximum total rate limit across all memberships
@@ -110,13 +119,14 @@ class RLNContract {
             this.contract.maxTotalRateLimit(),
             this.contract.currentTotalRateLimit()
         ]);
-        return maxTotal.sub(currentTotal).toNumber();
+        return Number(maxTotal) - Number(currentTotal);
     }
     /**
      * Updates the rate limit for future registrations
      * @param newRateLimit The new rate limit to use
      */
     async setRateLimit(newRateLimit) {
+        this.validateRateLimit(newRateLimit);
         this.rateLimit = newRateLimit;
     }
     get members() {
@@ -129,11 +139,17 @@ class RLNContract {
         }
         return this._membersFilter;
     }
-    get membersRemovedFilter() {
-        if (!this._membersRemovedFilter) {
-            throw Error("MembersRemoved filter was not initialized.");
+    get membershipErasedFilter() {
+        if (!this._membershipErasedFilter) {
+            throw Error("MembershipErased filter was not initialized.");
         }
-        return this._membersRemovedFilter;
+        return this._membershipErasedFilter;
+    }
+    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, {
@@ -144,9 +160,18 @@ class RLNContract {
         const removedMemberEvents = await queryFilter(this.contract, {
             fromBlock: this.deployBlock,
             ...options,
-            membersFilter: this.membersRemovedFilter
+            membersFilter: this.membershipErasedFilter
+        });
+        const expiredMemberEvents = await queryFilter(this.contract, {
+            fromBlock: this.deployBlock,
+            ...options,
+            membersFilter: this.membersExpiredFilter
         });
-        const events = [...registeredMemberEvents, ...removedMemberEvents];
+        const events = [
+            ...registeredMemberEvents,
+            ...removedMemberEvents,
+            ...expiredMemberEvents
+        ];
         this.processEvents(rlnInstance, events);
     }
     processEvents(rlnInstance, events) {
@@ -156,8 +181,22 @@ class RLNContract {
             if (!evt.args) {
                 return;
             }
-            if (evt.event === "MembershipRemoved") {
-                const index = evt.args.index;
+            if (evt.event === "MembershipErased" ||
+                evt.event === "MembershipExpired") {
+                let index = evt.args.index;
+                if (!index) {
+                    return;
+                }
+                if (typeof index === "number" || typeof index === "string") {
+                    index = BigNumber.from(index);
+                }
+                else {
+                    log.error("Index is not a number or string", {
+                        index,
+                        event: evt
+                    });
+                    return;
+                }
                 const toRemoveVal = toRemoveTable.get(evt.blockNumber);
                 if (toRemoveVal != undefined) {
                     toRemoveVal.push(index.toNumber());
@@ -185,13 +224,17 @@ class RLNContract {
                 if (!evt.args)
                     return;
                 const _idCommitment = evt.args.idCommitment;
-                const index = evt.args.index;
+                let index = evt.args.index;
                 if (!_idCommitment || !index) {
                     return;
                 }
+                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(), {
+                const numericIndex = index.toNumber();
+                this._members.set(numericIndex, {
                     index,
                     idCommitment: _idCommitment
                 });
@@ -213,18 +256,36 @@ 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.membershipErasedFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
             this.processEvents(rlnInstance, [event]);
         });
-        this.contract.on(this.membersRemovedFilter, (_idCommitment, _index, event) => {
+        this.contract.on(this.membersExpiredFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
             this.processEvents(rlnInstance, [event]);
         });
     }
     async registerWithIdentity(identity) {
         try {
             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) {
+                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) {
+                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 gasLimit = estimatedGas.add(10000);
+            const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit });
             const txRegisterReceipt = await txRegisterResponse.wait();
+            if (txRegisterReceipt.status === 0) {
+                throw new Error("Transaction failed on-chain");
+            }
             const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
             if (!memberRegistered || !memberRegistered.args) {
                 log.error("Failed to register membership: No MembershipRegistered event found");
@@ -232,26 +293,51 @@ 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 index ${decodedData.index} ` +
-                `and rate limit ${decodedData.rateLimit}`);
+                `and rate limit ${decodedData.membershipRateLimit}`);
             const network = await this.contract.provider.getNetwork();
             const address = this.contract.address;
-            const membershipId = decodedData.index.toNumber();
+            const membershipId = Number(decodedData.index);
             return {
                 identity,
                 membership: {
                     address,
                     treeIndex: membershipId,
-                    chainId: network.chainId
+                    chainId: network.chainId,
+                    rateLimit: decodedData.membershipRateLimit.toNumber()
                 }
             };
         }
         catch (error) {
-            log.error(`Error in registerWithIdentity: ${error.message}`);
-            return undefined;
+            if (error instanceof Error) {
+                const errorMessage = error.message;
+                log.error("registerWithIdentity - error message:", errorMessage);
+                log.error("registerWithIdentity - error stack:", error.stack);
+                // Try to extract more specific error information
+                if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
+                    throw new Error("Registration failed: Cannot exceed maximum total rate limit");
+                }
+                else if (errorMessage.includes("InvalidIdCommitment")) {
+                    throw new Error("Registration failed: Invalid ID commitment");
+                }
+                else if (errorMessage.includes("InvalidMembershipRateLimit")) {
+                    throw new Error("Registration failed: Invalid membership rate limit");
+                }
+                else if (errorMessage.includes("execution reverted")) {
+                    throw new Error("Contract execution reverted. Check contract requirements.");
+                }
+                else {
+                    throw new Error(`Error in registerWithIdentity: ${errorMessage}`);
+                }
+            }
+            else {
+                throw new Error("Unknown error in registerWithIdentity", {
+                    cause: error
+                });
+            }
         }
     }
     /**
@@ -287,20 +373,21 @@ 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();
+            const membershipId = BigNumber.from(decodedData.index).toNumber();
             return {
                 identity,
                 membership: {
                     address,
                     treeIndex: membershipId,
-                    chainId: network.chainId
+                    chainId: network.chainId,
+                    rateLimit: decodedData.membershipRateLimit.toNumber()
                 }
             };
         }
@@ -357,11 +444,8 @@ class RLNContract {
     async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
         return this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
     }
-    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}`);
-        }
+    async registerMembership(idCommitment, rateLimit = this.rateLimit) {
+        this.validateRateLimit(rateLimit);
         return this.contract.register(idCommitment, rateLimit, []);
     }
     async getMemberIndex(idCommitment) {