@waku/rln 0.1.4-d27db21.0 → 0.1.5-053bb95.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
 };
 /**
@@ -12,16 +12,12 @@ const SEPOLIA_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
 const RATE_LIMIT_PARAMS = {
     MIN_RATE: RATE_LIMIT_TIERS.LOW,
-    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)
-};
+    MAX_RATE: RATE_LIMIT_TIERS.HIGH};
 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/errors.js

@@ -0,0 +1,62 @@
+class RLNContractError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "RLNContractError";
+    }
+}
+class MembershipError extends RLNContractError {
+    constructor(message) {
+        super(message);
+        this.name = "MembershipError";
+    }
+}
+class RateLimitError extends RLNContractError {
+    constructor(message) {
+        super(message);
+        this.name = "RateLimitError";
+    }
+}
+class InvalidMembershipError extends MembershipError {
+    constructor(idCommitment) {
+        super(`Invalid membership ID commitment: ${idCommitment}`);
+        this.name = "InvalidMembershipError";
+    }
+}
+class MembershipNotFoundError extends MembershipError {
+    constructor(idCommitment) {
+        super(`Membership not found for ID commitment: ${idCommitment}`);
+        this.name = "MembershipNotFoundError";
+    }
+}
+class MembershipExistsError extends MembershipError {
+    constructor(idCommitment, index) {
+        super(`Membership already exists for ID commitment: ${idCommitment} at index ${index}`);
+        this.name = "MembershipExistsError";
+    }
+}
+class RateLimitExceededError extends RateLimitError {
+    constructor(requested, available) {
+        super(`Rate limit exceeded. Requested: ${requested}, Available: ${available}`);
+        this.name = "RateLimitExceededError";
+    }
+}
+class InvalidRateLimitError extends RateLimitError {
+    constructor(rateLimit, minRate, maxRate) {
+        super(`Invalid rate limit: ${rateLimit}. Must be between ${minRate} and ${maxRate}`);
+        this.name = "InvalidRateLimitError";
+    }
+}
+class ContractStateError extends RLNContractError {
+    constructor(message) {
+        super(`Contract state error: ${message}`);
+        this.name = "ContractStateError";
+    }
+}
+class TransactionError extends RLNContractError {
+    constructor(message) {
+        super(`Transaction failed: ${message}`);
+        this.name = "TransactionError";
+    }
+}
+
+export { ContractStateError, InvalidMembershipError, InvalidRateLimitError, MembershipError, MembershipExistsError, MembershipNotFoundError, RLNContractError, RateLimitError, RateLimitExceededError, TransactionError };

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

@@ -0,0 +1,347 @@
+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 { 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';
+
+const log = new Logger("waku:rln:contract:base");
+class RLNBaseContract {
+    contract;
+    rateLimit;
+    constructor(options) {
+        const { address, signer, rateLimit = DEFAULT_RATE_LIMIT, contract } = options;
+        this.validateRateLimit(rateLimit);
+        this.contract = contract || new Contract(address, RLN_ABI, signer);
+        this.rateLimit = rateLimit;
+    }
+    /**
+     * 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;
+    }
+    /**
+     * Gets all members in the given range
+     * @param startIndex Start index (inclusive)
+     * @param endIndex End index (exclusive)
+     */
+    async getMembersInRange(startIndex, endIndex) {
+        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;
+        }
+        catch (error) {
+            if (error instanceof Error &&
+                error.message.includes("InvalidPaginationQuery")) {
+                throw new RLNContractError(`Invalid pagination range: start=${startIndex}, end=${endIndex}`);
+            }
+            throw error;
+        }
+    }
+    /**
+     * Gets all current members
+     */
+    async getAllMembers() {
+        const nextIndex = (await this.contract.nextFreeIndex()).toNumber();
+        return this.getMembersInRange(0, nextIndex);
+    }
+    /**
+     * Gets the member index if it exists, or null if it doesn't
+     * Throws only on actual errors (invalid input, network issues, etc)
+     */
+    async getMemberIndex(idCommitment) {
+        try {
+            const isValid = await this.contract.isInMembershipSet(idCommitment);
+            if (!isValid) {
+                return null;
+            }
+            const membershipInfo = await this.contract.memberships(idCommitment);
+            return BigNumber.from(membershipInfo.index);
+        }
+        catch (error) {
+            log.error(`Error getting member index: ${error.message}`);
+            throw new InvalidMembershipError(idCommitment);
+        }
+    }
+    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 === null) {
+                throw new MembershipNotFoundError(idCommitment);
+            }
+            return {
+                index,
+                idCommitment,
+                rateLimit: rateLimit.toNumber(),
+                startBlock: startBlock.toNumber(),
+                endBlock: endBlock.toNumber(),
+                state
+            };
+        }
+        catch (error) {
+            if (error instanceof RLNContractError) {
+                throw error;
+            }
+            log.error(`Error getting membership info: ${error.message}`);
+            throw new InvalidMembershipError(idCommitment);
+        }
+    }
+    async extendMembership(idCommitment) {
+        const tx = await this.contract.extendMemberships([idCommitment]);
+        await this.confirmTransaction(tx, "MembershipExtended", (event) => ({
+            idCommitment: event.args.idCommitment,
+            endBlock: event.args.endBlock
+        }));
+    }
+    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
+        }));
+    }
+    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
+        }));
+    }
+    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
+            }));
+        }
+        catch (error) {
+            log.error(`Error in withdraw: ${error.message}`);
+            throw error;
+        }
+    }
+    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 !== null) {
+                throw new MembershipExistsError(identity.IDCommitmentBigInt.toString(), existingIndex.toString());
+            }
+            // Check if there's enough remaining rate limit
+            const remainingRateLimit = await this.getRemainingTotalRateLimit();
+            if (remainingRateLimit < this.rateLimit) {
+                throw new RateLimitExceededError(this.rateLimit, 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
+            }));
+            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();
+            return {
+                identity,
+                membership: {
+                    address,
+                    treeIndex: parseInt(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
+                if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
+                    throw new RateLimitExceededError(this.rateLimit, await this.getRemainingTotalRateLimit());
+                }
+                else if (errorMessage.includes("InvalidIdCommitment")) {
+                    throw new InvalidMembershipError(identity.IDCommitmentBigInt.toString());
+                }
+                else if (errorMessage.includes("InvalidMembershipRateLimit")) {
+                    throw new InvalidRateLimitError(this.rateLimit, RATE_LIMIT_PARAMS.MIN_RATE, RATE_LIMIT_PARAMS.MAX_RATE);
+                }
+                else if (errorMessage.includes("execution reverted")) {
+                    throw new TransactionError("Contract execution reverted. Check contract requirements.");
+                }
+                throw new RLNContractError(`Error in registerWithIdentity: ${errorMessage}`);
+            }
+            throw new RLNContractError("Unknown error in registerWithIdentity");
+        }
+    }
+    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
+            }));
+            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();
+            return {
+                identity,
+                membership: {
+                    address,
+                    treeIndex: parseInt(membershipId),
+                    chainId: network.chainId.toString(),
+                    rateLimit: decodedData.membershipRateLimit.toNumber()
+                }
+            };
+        }
+        catch (error) {
+            log.error(`Error in registerWithPermitAndErase: ${error.message}`);
+            throw error;
+        }
+    }
+    /**
+     * 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 InvalidRateLimitError(rateLimit, RATE_LIMIT_PARAMS.MIN_RATE, RATE_LIMIT_PARAMS.MAX_RATE);
+        }
+    }
+    /**
+     * 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`);
+        }
+        return transform(event);
+    }
+}
+
+export { RLNBaseContract };