@waku/rln 0.1.5-1d384f2.0 → 0.1.5-35b50c3.0

package/bundle/index.js

@@ -1,7 +1,8 @@
 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 { LINEA_CONTRACT } from './packages/rln/dist/contract/constants.js';
+export { 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';
 export { RLNCredentialsManager } from './packages/rln/dist/credentials_manager.js';

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

@@ -12,6 +12,7 @@ const LINEA_CONTRACT = {
  */
 const RATE_LIMIT_TIERS = {
     LOW: 20, // Suggested minimum rate - 20 messages per epoch
+    MEDIUM: 200,
     HIGH: 600 // Suggested maximum rate - 600 messages per epoch
 };
 // Global rate limit parameters

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

@@ -19,6 +19,7 @@ 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';
 
+/* eslint-disable no-console */
 const log = new Logger("waku:rln:contract:base");
 class RLNBaseContract {
     contract;
@@ -33,6 +34,22 @@ class RLNBaseContract {
      * Allows injecting a mocked contract for testing purposes.
      */
     constructor(options) {
+        const { address, signer, rateLimit = DEFAULT_RATE_LIMIT, contract } = options;
+        log.info("Initializing RLNBaseContract", { address, rateLimit });
+        this.contract = contract || new Contract(address, RLN_ABI, signer);
+        this.rateLimit = rateLimit;
+        try {
+            log.info("Setting up event filters");
+            // Initialize event filters
+            this._membersFilter = this.contract.filters.MembershipRegistered();
+            this._membershipErasedFilter = this.contract.filters.MembershipErased();
+            this._membersExpiredFilter = this.contract.filters.MembershipExpired();
+            log.info("Event filters initialized successfully");
+        }
+        catch (error) {
+            log.error("Failed to initialize event filters", { error });
+            throw new Error("Failed to initialize event filters: " + error.message);
+        }
         // Initialize members and subscriptions
         this.fetchMembers()
             .then(() => {
@@ -41,14 +58,10 @@ class RLNBaseContract {
             .catch((error) => {
             log.error("Failed to initialize members", { error });
         });
-        const { address, signer, rateLimit = DEFAULT_RATE_LIMIT, contract } = options;
-        this.validateRateLimit(rateLimit);
-        this.contract = contract || new Contract(address, RLN_ABI, signer);
-        this.rateLimit = rateLimit;
-        // Initialize event filters
-        this._membersFilter = this.contract.filters.MembershipRegistered();
-        this._membershipErasedFilter = this.contract.filters.MembershipErased();
-        this._membersExpiredFilter = this.contract.filters.MembershipExpired();
+        // Validate rate limit asynchronously
+        this.validateRateLimit(rateLimit).catch((error) => {
+            log.error("Failed to validate initial rate limit", { error });
+        });
     }
     /**
      * Gets the current rate limit for this contract instance
@@ -116,7 +129,7 @@ class RLNBaseContract {
      * @param newRateLimit The new rate limit to use
      */
     async setRateLimit(newRateLimit) {
-        this.validateRateLimit(newRateLimit);
+        await this.validateRateLimit(newRateLimit);
         this.rateLimit = newRateLimit;
     }
     get members() {
@@ -247,86 +260,73 @@ class RLNBaseContract {
             this.processEvents([event]);
         });
     }
-    /**
-     * Helper method to get remaining messages in current epoch
-     * @param membershipId The ID of the membership to check
-     * @returns number of remaining messages allowed in current epoch
-     */
-    async getRemainingMessages(membershipId) {
-        try {
-            const [startTime, , rateLimit] = await this.contract.getMembershipInfo(membershipId);
-            // Calculate current epoch
-            const currentTime = Math.floor(Date.now() / 1000);
-            const epochsPassed = Math.floor((currentTime - startTime) / RATE_LIMIT_PARAMS.EPOCH_LENGTH);
-            const currentEpochStart = startTime + epochsPassed * RATE_LIMIT_PARAMS.EPOCH_LENGTH;
-            // Get message count in current epoch using contract's function
-            const messageCount = await this.contract.getMessageCount(membershipId, currentEpochStart);
-            return Math.max(0, BigNumber.from(rateLimit)
-                .sub(BigNumber.from(messageCount))
-                .toNumber());
-        }
-        catch (error) {
-            log.error(`Error getting remaining messages: ${error.message}`);
-            return 0; // Fail safe: assume no messages remaining on error
-        }
-    }
-    async getMembershipInfo(idCommitment) {
+    async getMembershipInfo(idCommitmentBigInt) {
         try {
-            const [startBlock, endBlock, rateLimit] = await this.contract.getMembershipInfo(idCommitment);
+            const membershipData = await this.contract.memberships(idCommitmentBigInt);
             const currentBlock = await this.contract.provider.getBlockNumber();
+            console.log("membershipData", membershipData);
+            const [depositAmount, activeDuration, gracePeriodStartTimestamp, gracePeriodDuration, rateLimit, index, holder, token] = membershipData;
+            const gracePeriodEnd = gracePeriodStartTimestamp.add(gracePeriodDuration);
             let state;
-            if (currentBlock < startBlock) {
+            if (currentBlock < gracePeriodStartTimestamp.toNumber()) {
                 state = MembershipState.Active;
             }
-            else if (currentBlock < endBlock) {
+            else if (currentBlock < gracePeriodEnd.toNumber()) {
                 state = MembershipState.GracePeriod;
             }
             else {
                 state = MembershipState.Expired;
             }
-            const index = await this.getMemberIndex(idCommitment);
-            if (!index)
-                return undefined;
             return {
                 index,
-                idCommitment,
-                rateLimit: rateLimit.toNumber(),
-                startBlock: startBlock.toNumber(),
-                endBlock: endBlock.toNumber(),
-                state
+                idCommitment: idCommitmentBigInt.toString(),
+                rateLimit: Number(rateLimit),
+                startBlock: gracePeriodStartTimestamp.toNumber(),
+                endBlock: gracePeriodEnd.toNumber(),
+                state,
+                depositAmount,
+                activeDuration,
+                gracePeriodDuration,
+                holder,
+                token
             };
         }
         catch (error) {
+            console.error("Error in getMembershipInfo:", error);
             return undefined;
         }
     }
-    async extendMembership(idCommitment) {
-        return this.contract.extendMemberships([idCommitment]);
-    }
-    async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
-        return this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
+    async extendMembership(idCommitmentBigInt) {
+        const tx = await this.contract.extendMemberships([idCommitmentBigInt]);
+        await tx.wait();
+        return tx;
     }
-    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}`);
-        }
-        return this.contract.register(idCommitment, rateLimit, []);
+    async eraseMembership(idCommitmentBigInt, eraseFromMembershipSet = true) {
+        const tx = await this.contract.eraseMemberships([idCommitmentBigInt], eraseFromMembershipSet);
+        await tx.wait();
+        return tx;
     }
-    async withdraw(token, holder) {
+    async withdraw(token, from) {
         try {
-            const tx = await this.contract.withdraw(token, { from: holder });
+            const tx = await this.contract.withdraw(token, from);
             await tx.wait();
         }
         catch (error) {
             log.error(`Error in withdraw: ${error.message}`);
         }
     }
+    async registerMembership(idCommitmentBigInt, 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}`);
+        }
+        return this.contract.register(idCommitmentBigInt, rateLimit, []);
+    }
     async registerWithIdentity(identity) {
         try {
             log.info(`Registering identity with rate limit: ${this.rateLimit} messages/epoch`);
             // Check if the ID commitment is already registered
-            const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt.toString());
+            const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt);
             if (existingIndex) {
                 throw new Error(`ID commitment is already registered with index ${existingIndex}`);
             }
@@ -435,10 +435,15 @@ class RLNBaseContract {
      * 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`);
+    async validateRateLimit(rateLimit) {
+        const [minRate, maxRate] = await Promise.all([
+            this.contract.minMembershipRateLimit(),
+            this.contract.maxMembershipRateLimit()
+        ]);
+        const minRateNum = BigNumber.from(minRate).toNumber();
+        const maxRateNum = BigNumber.from(maxRate).toNumber();
+        if (rateLimit < minRateNum || rateLimit > maxRateNum) {
+            throw new Error(`Rate limit must be between ${minRateNum} and ${maxRateNum} messages per epoch`);
         }
     }
     get membersFilter() {
@@ -459,9 +464,9 @@ class RLNBaseContract {
         }
         return this._membersExpiredFilter;
     }
-    async getMemberIndex(idCommitment) {
+    async getMemberIndex(idCommitmentBigInt) {
         try {
-            const events = await this.contract.queryFilter(this.contract.filters.MembershipRegistered(idCommitment));
+            const events = await this.contract.queryFilter(this.contract.filters.MembershipRegistered(idCommitmentBigInt));
             if (events.length === 0)
                 return undefined;
             // Get the most recent registration event