@waku/rln 0.1.4 → 0.1.5-1d384f2.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_base_contract.js

@@ -0,0 +1,477 @@
+import '../../../interfaces/dist/protocols.js';
+import '../../../interfaces/dist/connection_manager.js';
+import '../../../interfaces/dist/health_indicator.js';
+import '../../../../node_modules/multiformats/dist/src/bases/base10.js';
+import '../../../../node_modules/multiformats/dist/src/bases/base16.js';
+import '../../../../node_modules/multiformats/dist/src/bases/base2.js';
+import '../../../../node_modules/multiformats/dist/src/bases/base256emoji.js';
+import '../../../../node_modules/multiformats/dist/src/bases/base32.js';
+import '../../../../node_modules/multiformats/dist/src/bases/base36.js';
+import '../../../../node_modules/multiformats/dist/src/bases/base58.js';
+import '../../../../node_modules/multiformats/dist/src/bases/base64.js';
+import '../../../../node_modules/multiformats/dist/src/bases/base8.js';
+import '../../../../node_modules/multiformats/dist/src/bases/identity.js';
+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 { 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';
+
+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
+     */
+    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
+     */
+    async getMinRateLimit() {
+        const minRate = await this.contract.minMembershipRateLimit();
+        return BigNumber.from(minRate).toNumber();
+    }
+    /**
+     * Gets the maximum allowed rate limit from the contract
+     * @returns Promise<number> The maximum rate limit in messages per epoch
+     */
+    async getMaxRateLimit() {
+        const maxRate = await this.contract.maxMembershipRateLimit();
+        return BigNumber.from(maxRate).toNumber();
+    }
+    /**
+     * Gets the maximum total rate limit across all memberships
+     * @returns Promise<number> The maximum total rate limit in messages per epoch
+     */
+    async getMaxTotalRateLimit() {
+        const maxTotalRate = await this.contract.maxTotalRateLimit();
+        return maxTotalRate.toNumber();
+    }
+    /**
+     * Gets the current total rate limit usage across all memberships
+     * @returns Promise<number> The current total rate limit usage in messages per epoch
+     */
+    async getCurrentTotalRateLimit() {
+        const currentTotal = await this.contract.currentTotalRateLimit();
+        return currentTotal.toNumber();
+    }
+    /**
+     * Gets the remaining available total rate limit that can be allocated
+     * @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 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() {
+        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 {
+            return await promise;
+        }
+        catch (err) {
+            if (err instanceof Error) {
+                log.info(`Ignoring an error during query: ${err.message}`);
+            }
+            else {
+                log.info(`Ignoring an unknown error during query`);
+            }
+            return defaultValue;
+        }
+    }
+    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]);
+        });
+    }
+    /**
+     * 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) {
+        try {
+            const [startBlock, endBlock, rateLimit] = await this.contract.getMembershipInfo(idCommitment);
+            const currentBlock = await this.contract.provider.getBlockNumber();
+            let state;
+            if (currentBlock < startBlock) {
+                state = MembershipState.Active;
+            }
+            else if (currentBlock < endBlock) {
+                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
+            };
+        }
+        catch (error) {
+            return undefined;
+        }
+    }
+    async extendMembership(idCommitment) {
+        return this.contract.extendMemberships([idCommitment]);
+    }
+    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}`);
+        }
+        return this.contract.register(idCommitment, rateLimit, []);
+    }
+    async withdraw(token, holder) {
+        try {
+            const tx = await this.contract.withdraw(token, { from: holder });
+            await tx.wait();
+        }
+        catch (error) {
+            log.error(`Error in withdraw: ${error.message}`);
+        }
+    }
+    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());
+            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");
+                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 = Number(decodedData.index);
+            return {
+                identity,
+                membership: {
+                    address,
+                    treeIndex: membershipId,
+                    chainId: network.chainId.toString(),
+                    rateLimit: decodedData.membershipRateLimit.toNumber()
+                }
+            };
+        }
+        catch (error) {
+            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
+                });
+            }
+        }
+    }
+    async registerWithPermitAndErase(identity, permit, idCommitmentsToErase) {
+        try {
+            log.info(`Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`);
+            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 = Number(decodedData.index);
+            return {
+                identity,
+                membership: {
+                    address,
+                    treeIndex: membershipId,
+                    chainId: network.chainId.toString(),
+                    rateLimit: decodedData.membershipRateLimit.toNumber()
+                }
+            };
+        }
+        catch (error) {
+            log.error(`Error in registerWithPermitAndErase: ${error.message}`);
+            return undefined;
+        }
+    }
+    /**
+     * 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`);
+        }
+    }
+    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;
+        }
+    }
+}
+
+export { RLNBaseContract };