@waku/rln 0.1.5-053bb95.0 → 0.1.5-1d384f2.0

package/bundle/_virtual/utils.js

@@ -1,3 +1,3 @@
-var utils = {exports: {}};
+var utils = {};
 
-export { utils as __module };
+export { utils as __exports };

package/bundle/_virtual/utils2.js

@@ -1,3 +1,3 @@
-var utils = {};
+var utils = {exports: {}};
 
-export { utils as __exports };
+export { utils as __module };

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

@@ -1,7 +1,7 @@
 import { RLN_ABI } from './abi.js';
 
 const LINEA_CONTRACT = {
-    chainId: "59141",
+    chainId: 59141,
     address: "0xb9cd878c90e49f797b4431fbf4fb333108cb90e6",
     abi: RLN_ABI
 };
@@ -17,7 +17,10 @@ const RATE_LIMIT_TIERS = {
 // Global rate limit parameters
 const RATE_LIMIT_PARAMS = {
     MIN_RATE: RATE_LIMIT_TIERS.LOW,
-    MAX_RATE: RATE_LIMIT_TIERS.HIGH};
+    MAX_RATE: RATE_LIMIT_TIERS.HIGH,
+    MAX_TOTAL_RATE: 160_000, // Maximum total rate limit across all memberships
+    EPOCH_LENGTH: 600 // Epoch length in seconds (10 minutes)
+};
 const DEFAULT_RATE_LIMIT = RATE_LIMIT_PARAMS.MAX_RATE;
 
 export { DEFAULT_RATE_LIMIT, LINEA_CONTRACT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS };

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

@@ -15,7 +15,6 @@ import '../../../../node_modules/multiformats/dist/src/codecs/json.js';
 import { Logger } from '../../../utils/dist/logger/index.js';
 import { RLN_ABI } from './abi.js';
 import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from './constants.js';
-import { RLNContractError, InvalidMembershipError, MembershipNotFoundError, MembershipExistsError, RateLimitExceededError, InvalidRateLimitError, TransactionError } from './errors.js';
 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';
@@ -23,12 +22,33 @@ import { BigNumber } from '../../../../node_modules/@ethersproject/bignumber/lib
 const log = new Logger("waku:rln:contract:base");
 class RLNBaseContract {
     contract;
+    deployBlock;
     rateLimit;
+    _members = new Map();
+    _membersFilter;
+    _membershipErasedFilter;
+    _membersExpiredFilter;
+    /**
+     * Constructor for RLNBaseContract.
+     * Allows injecting a mocked contract for testing purposes.
+     */
     constructor(options) {
+        // Initialize members and subscriptions
+        this.fetchMembers()
+            .then(() => {
+            this.subscribeToMembers();
+        })
+            .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();
     }
     /**
      * Gets the current rate limit for this contract instance
@@ -99,60 +119,155 @@ class RLNBaseContract {
         this.validateRateLimit(newRateLimit);
         this.rateLimit = newRateLimit;
     }
-    /**
-     * Gets all members in the given range
-     * @param startIndex Start index (inclusive)
-     * @param endIndex End index (exclusive)
-     */
-    async getMembersInRange(startIndex, endIndex) {
+    get members() {
+        const sortedMembers = Array.from(this._members.values()).sort((left, right) => left.index.toNumber() - right.index.toNumber());
+        return sortedMembers;
+    }
+    async fetchMembers(options = {}) {
+        const registeredMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
+            fromBlock: this.deployBlock,
+            ...options,
+            membersFilter: this.membersFilter
+        });
+        const removedMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
+            fromBlock: this.deployBlock,
+            ...options,
+            membersFilter: this.membershipErasedFilter
+        });
+        const expiredMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
+            fromBlock: this.deployBlock,
+            ...options,
+            membersFilter: this.membersExpiredFilter
+        });
+        const events = [
+            ...registeredMemberEvents,
+            ...removedMemberEvents,
+            ...expiredMemberEvents
+        ];
+        this.processEvents(events);
+    }
+    static async queryFilter(contract, options) {
+        const FETCH_CHUNK = 5;
+        const BLOCK_RANGE = 3000;
+        const { fromBlock, membersFilter, fetchRange = BLOCK_RANGE, fetchChunks = FETCH_CHUNK } = options;
+        if (fromBlock === undefined) {
+            return contract.queryFilter(membersFilter);
+        }
+        if (!contract.provider) {
+            throw Error("No provider found on the contract.");
+        }
+        const toBlock = await contract.provider.getBlockNumber();
+        if (toBlock - fromBlock < fetchRange) {
+            return contract.queryFilter(membersFilter, fromBlock, toBlock);
+        }
+        const events = [];
+        const chunks = RLNBaseContract.splitToChunks(fromBlock, toBlock, fetchRange);
+        for (const portion of RLNBaseContract.takeN(chunks, fetchChunks)) {
+            const promises = portion.map(([left, right]) => RLNBaseContract.ignoreErrors(contract.queryFilter(membersFilter, left, right), []));
+            const fetchedEvents = await Promise.all(promises);
+            events.push(fetchedEvents.flatMap((v) => v));
+        }
+        return events.flatMap((v) => v);
+    }
+    processEvents(events) {
+        const toRemoveTable = new Map();
+        const toInsertTable = new Map();
+        events.forEach((evt) => {
+            if (!evt.args) {
+                return;
+            }
+            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);
+                }
+                const toRemoveVal = toRemoveTable.get(evt.blockNumber);
+                if (toRemoveVal != undefined) {
+                    toRemoveVal.push(index.toNumber());
+                    toRemoveTable.set(evt.blockNumber, toRemoveVal);
+                }
+                else {
+                    toRemoveTable.set(evt.blockNumber, [index.toNumber()]);
+                }
+            }
+            else if (evt.event === "MembershipRegistered") {
+                let eventsPerBlock = toInsertTable.get(evt.blockNumber);
+                if (eventsPerBlock == undefined) {
+                    eventsPerBlock = [];
+                }
+                eventsPerBlock.push(evt);
+                toInsertTable.set(evt.blockNumber, eventsPerBlock);
+            }
+        });
+    }
+    static splitToChunks(from, to, step) {
+        const chunks = [];
+        let left = from;
+        while (left < to) {
+            const right = left + step < to ? left + step : to;
+            chunks.push([left, right]);
+            left = right;
+        }
+        return chunks;
+    }
+    static *takeN(array, size) {
+        let start = 0;
+        while (start < array.length) {
+            const portion = array.slice(start, start + size);
+            yield portion;
+            start += size;
+        }
+    }
+    static async ignoreErrors(promise, defaultValue) {
         try {
-            // Get all commitments in one call
-            const idCommitments = await this.contract.getRateCommitmentsInRangeBoundsInclusive(startIndex, endIndex - 1 // -1 because getRateCommitmentsInRangeBoundsInclusive is inclusive
-            );
-            // Get membership info for each commitment in a single batch
-            const membershipPromises = idCommitments.map((idCommitment) => this.contract
-                .memberships(idCommitment)
-                .then((info) => ({
-                idCommitment: idCommitment.toString(),
-                index: BigNumber.from(info.index)
-            }))
-                .catch(() => null) // Skip invalid members
-            );
-            // Wait for all promises to resolve
-            const members = (await Promise.all(membershipPromises)).filter((m) => m !== null);
-            return members;
+            return await promise;
         }
-        catch (error) {
-            if (error instanceof Error &&
-                error.message.includes("InvalidPaginationQuery")) {
-                throw new RLNContractError(`Invalid pagination range: start=${startIndex}, end=${endIndex}`);
+        catch (err) {
+            if (err instanceof Error) {
+                log.info(`Ignoring an error during query: ${err.message}`);
+            }
+            else {
+                log.info(`Ignoring an unknown error during query`);
             }
-            throw error;
+            return defaultValue;
         }
     }
-    /**
-     * Gets all current members
-     */
-    async getAllMembers() {
-        const nextIndex = (await this.contract.nextFreeIndex()).toNumber();
-        return this.getMembersInRange(0, nextIndex);
+    subscribeToMembers() {
+        this.contract.on(this.membersFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
+            this.processEvents([event]);
+        });
+        this.contract.on(this.membershipErasedFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
+            this.processEvents([event]);
+        });
+        this.contract.on(this.membersExpiredFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
+            this.processEvents([event]);
+        });
     }
     /**
-     * Gets the member index if it exists, or null if it doesn't
-     * Throws only on actual errors (invalid input, network issues, etc)
+     * 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 getMemberIndex(idCommitment) {
+    async getRemainingMessages(membershipId) {
         try {
-            const isValid = await this.contract.isInMembershipSet(idCommitment);
-            if (!isValid) {
-                return null;
-            }
-            const membershipInfo = await this.contract.memberships(idCommitment);
-            return BigNumber.from(membershipInfo.index);
+            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 member index: ${error.message}`);
-            throw new InvalidMembershipError(idCommitment);
+            log.error(`Error getting remaining messages: ${error.message}`);
+            return 0; // Fail safe: assume no messages remaining on error
         }
     }
     async getMembershipInfo(idCommitment) {
@@ -170,9 +285,8 @@ class RLNBaseContract {
                 state = MembershipState.Expired;
             }
             const index = await this.getMemberIndex(idCommitment);
-            if (index === null) {
-                throw new MembershipNotFoundError(idCommitment);
-            }
+            if (!index)
+                return undefined;
             return {
                 index,
                 idCommitment,
@@ -183,51 +297,29 @@ class RLNBaseContract {
             };
         }
         catch (error) {
-            if (error instanceof RLNContractError) {
-                throw error;
-            }
-            log.error(`Error getting membership info: ${error.message}`);
-            throw new InvalidMembershipError(idCommitment);
+            return undefined;
         }
     }
     async extendMembership(idCommitment) {
-        const tx = await this.contract.extendMemberships([idCommitment]);
-        await this.confirmTransaction(tx, "MembershipExtended", (event) => ({
-            idCommitment: event.args.idCommitment,
-            endBlock: event.args.endBlock
-        }));
+        return this.contract.extendMemberships([idCommitment]);
     }
     async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
-        const tx = await this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
-        await this.confirmTransaction(tx, "MembershipErased", (event) => ({
-            idCommitment: event.args.idCommitment,
-            index: event.args.index
-        }));
+        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}`);
         }
-        const tx = await this.contract.register(idCommitment, rateLimit, []);
-        await this.confirmTransaction(tx, "MembershipRegistered", (event) => ({
-            idCommitment: event.args.idCommitment,
-            membershipRateLimit: event.args.membershipRateLimit,
-            index: event.args.index
-        }));
+        return this.contract.register(idCommitment, rateLimit, []);
     }
     async withdraw(token, holder) {
         try {
             const tx = await this.contract.withdraw(token, { from: holder });
-            await this.confirmTransaction(tx, "TokenWithdrawn", (event) => ({
-                token: event.args.token,
-                holder: event.args.holder,
-                amount: event.args.amount
-            }));
+            await tx.wait();
         }
         catch (error) {
             log.error(`Error in withdraw: ${error.message}`);
-            throw error;
         }
     }
     async registerWithIdentity(identity) {
@@ -235,82 +327,100 @@ class RLNBaseContract {
             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());
-            if (existingIndex !== null) {
-                throw new MembershipExistsError(identity.IDCommitmentBigInt.toString(), existingIndex.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 RateLimitExceededError(this.rateLimit, remainingRateLimit);
+                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 tx = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit });
-            const decodedData = await this.confirmTransaction(tx, "MembershipRegistered", (event) => ({
-                idCommitment: event.args.idCommitment,
-                membershipRateLimit: event.args.membershipRateLimit,
-                index: event.args.index
-            }));
+            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");
+                return undefined;
+            }
+            const decodedData = {
+                idCommitment: memberRegistered.args.idCommitment,
+                membershipRateLimit: memberRegistered.args.membershipRateLimit,
+                index: memberRegistered.args.index
+            };
             log.info(`Successfully registered membership with index ${decodedData.index} ` +
                 `and rate limit ${decodedData.membershipRateLimit}`);
             const network = await this.contract.provider.getNetwork();
             const address = this.contract.address;
-            const membershipId = decodedData.index.toString();
+            const membershipId = Number(decodedData.index);
             return {
                 identity,
                 membership: {
                     address,
-                    treeIndex: parseInt(membershipId),
+                    treeIndex: membershipId,
                     chainId: network.chainId.toString(),
                     rateLimit: decodedData.membershipRateLimit.toNumber()
                 }
             };
         }
         catch (error) {
-            if (error instanceof RLNContractError) {
-                throw error;
-            }
             if (error instanceof Error) {
                 const errorMessage = error.message;
                 log.error("registerWithIdentity - error message:", errorMessage);
                 log.error("registerWithIdentity - error stack:", error.stack);
-                // Map contract errors to our custom errors
+                // Try to extract more specific error information
                 if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
-                    throw new RateLimitExceededError(this.rateLimit, await this.getRemainingTotalRateLimit());
+                    throw new Error("Registration failed: Cannot exceed maximum total rate limit");
                 }
                 else if (errorMessage.includes("InvalidIdCommitment")) {
-                    throw new InvalidMembershipError(identity.IDCommitmentBigInt.toString());
+                    throw new Error("Registration failed: Invalid ID commitment");
                 }
                 else if (errorMessage.includes("InvalidMembershipRateLimit")) {
-                    throw new InvalidRateLimitError(this.rateLimit, RATE_LIMIT_PARAMS.MIN_RATE, RATE_LIMIT_PARAMS.MAX_RATE);
+                    throw new Error("Registration failed: Invalid membership rate limit");
                 }
                 else if (errorMessage.includes("execution reverted")) {
-                    throw new TransactionError("Contract execution reverted. Check contract requirements.");
+                    throw new Error("Contract execution reverted. Check contract requirements.");
+                }
+                else {
+                    throw new Error(`Error in registerWithIdentity: ${errorMessage}`);
                 }
-                throw new RLNContractError(`Error in registerWithIdentity: ${errorMessage}`);
             }
-            throw new RLNContractError("Unknown error in registerWithIdentity");
+            else {
+                throw new Error("Unknown error in registerWithIdentity", {
+                    cause: error
+                });
+            }
         }
     }
     async registerWithPermitAndErase(identity, permit, idCommitmentsToErase) {
         try {
             log.info(`Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`);
-            const tx = 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 decodedData = await this.confirmTransaction(tx, "MembershipRegistered", (event) => ({
-                idCommitment: event.args.idCommitment,
-                membershipRateLimit: event.args.membershipRateLimit,
-                index: event.args.index
-            }));
+            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 txRegisterReceipt = await txRegisterResponse.wait();
+            const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
+            if (!memberRegistered || !memberRegistered.args) {
+                log.error("Failed to register membership with permit: No MembershipRegistered event found");
+                return undefined;
+            }
+            const decodedData = {
+                idCommitment: memberRegistered.args.idCommitment,
+                membershipRateLimit: memberRegistered.args.membershipRateLimit,
+                index: memberRegistered.args.index
+            };
             log.info(`Successfully registered membership with permit. Index: ${decodedData.index}, ` +
                 `Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
             const network = await this.contract.provider.getNetwork();
             const address = this.contract.address;
-            const membershipId = decodedData.index.toString();
+            const membershipId = Number(decodedData.index);
             return {
                 identity,
                 membership: {
                     address,
-                    treeIndex: parseInt(membershipId),
+                    treeIndex: membershipId,
                     chainId: network.chainId.toString(),
                     rateLimit: decodedData.membershipRateLimit.toNumber()
                 }
@@ -318,7 +428,7 @@ class RLNBaseContract {
         }
         catch (error) {
             log.error(`Error in registerWithPermitAndErase: ${error.message}`);
-            throw error;
+            return undefined;
         }
     }
     /**
@@ -328,19 +438,39 @@ class RLNBaseContract {
     validateRateLimit(rateLimit) {
         if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
             rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
-            throw new InvalidRateLimitError(rateLimit, RATE_LIMIT_PARAMS.MIN_RATE, 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`);
         }
     }
-    /**
-     * Helper to confirm a transaction and extract event data
-     */
-    async confirmTransaction(tx, expectedEvent, transform) {
-        const receipt = await tx.wait();
-        const event = receipt.events?.find((e) => e.event === expectedEvent);
-        if (!event || !event.args) {
-            throw new TransactionError(`Expected event ${expectedEvent} not found`);
+    get membersFilter() {
+        if (!this._membersFilter) {
+            throw Error("Members filter was not initialized.");
+        }
+        return this._membersFilter;
+    }
+    get membershipErasedFilter() {
+        if (!this._membershipErasedFilter) {
+            throw Error("MembershipErased filter was not initialized.");
+        }
+        return this._membershipErasedFilter;
+    }
+    get membersExpiredFilter() {
+        if (!this._membersExpiredFilter) {
+            throw Error("MembersExpired filter was not initialized.");
+        }
+        return this._membersExpiredFilter;
+    }
+    async getMemberIndex(idCommitment) {
+        try {
+            const events = await this.contract.queryFilter(this.contract.filters.MembershipRegistered(idCommitment));
+            if (events.length === 0)
+                return undefined;
+            // Get the most recent registration event
+            const event = events[events.length - 1];
+            return event.args?.index;
+        }
+        catch (error) {
+            return undefined;
         }
-        return transform(event);
     }
 }