@waku/rln 0.1.5-f39d215.0 → 0.1.5-fdaf129.0

package/bundle/index.js

@@ -1,14 +1,15 @@
 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 { RLNLightContract } from './packages/rln/dist/contract/rln_light_contract.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';
 export { IdentityCredential } from './packages/rln/dist/identity.js';
 export { Keystore } from './packages/rln/dist/keystore/keystore.js';
 export { Proof } from './packages/rln/dist/proof.js';
 export { RLNInstance } from './packages/rln/dist/rln.js';
-export { RLNLightInstance } from './packages/rln/dist/rln_light.js';
 export { MerkleRootTracker } from './packages/rln/dist/root_tracker.js';
 export { extractMetaMaskSigner } from './packages/rln/dist/utils/metamask.js';
 import './packages/rln/dist/utils/epoch.js';

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
 };
@@ -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_light_contract.js → rln_base_contract.js}

@@ -15,18 +15,13 @@ 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");
-var MembershipState;
-(function (MembershipState) {
-    MembershipState["Active"] = "Active";
-    MembershipState["GracePeriod"] = "GracePeriod";
-    MembershipState["Expired"] = "Expired";
-    MembershipState["ErasedAwaitsWithdrawal"] = "ErasedAwaitsWithdrawal";
-})(MembershipState || (MembershipState = {}));
-class RLNLightContract {
+/* eslint-disable no-console */
+const log = new Logger("waku:rln:contract:base");
+class RLNBaseContract {
     contract;
     deployBlock;
     rateLimit;
@@ -35,28 +30,38 @@ class RLNLightContract {
     _membershipErasedFilter;
     _membersExpiredFilter;
     /**
-     * Asynchronous initializer for RLNContract.
+     * Constructor for RLNBaseContract.
      * Allows injecting a mocked contract for testing purposes.
      */
-    static async init(options) {
-        const rlnContract = new RLNLightContract(options);
-        await rlnContract.fetchMembers();
-        rlnContract.subscribeToMembers();
-        return rlnContract;
-    }
     constructor(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.rateLimit = rateLimit;
-        // Use the injected contract if provided; otherwise, instantiate a new one.
+        log.info("Initializing RLNBaseContract", { address, rateLimit });
         this.contract = contract || new Contract(address, RLN_ABI, signer);
-        // Initialize event filters
-        this._membersFilter = this.contract.filters.MembershipRegistered();
-        this._membershipErasedFilter = this.contract.filters.MembershipErased();
-        this._membersExpiredFilter = this.contract.filters.MembershipExpired();
+        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(() => {
+            this.subscribeToMembers();
+        })
+            .catch((error) => {
+            log.error("Failed to initialize members", { error });
+        });
+        // 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
@@ -98,7 +103,7 @@ class RLNLightContract {
      */
     async getMaxTotalRateLimit() {
         const maxTotalRate = await this.contract.maxTotalRateLimit();
-        return BigNumber.from(maxTotalRate).toNumber();
+        return maxTotalRate.toNumber();
     }
     /**
      * Gets the current total rate limit usage across all memberships
@@ -106,7 +111,7 @@ class RLNLightContract {
      */
     async getCurrentTotalRateLimit() {
         const currentTotal = await this.contract.currentTotalRateLimit();
-        return BigNumber.from(currentTotal).toNumber();
+        return currentTotal.toNumber();
     }
     /**
      * Gets the remaining available total rate limit that can be allocated
@@ -117,51 +122,32 @@ class RLNLightContract {
             this.contract.maxTotalRateLimit(),
             this.contract.currentTotalRateLimit()
         ]);
-        return BigNumber.from(maxTotal)
-            .sub(BigNumber.from(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) {
+        await 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;
     }
-    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 fetchMembers(options = {}) {
-        const registeredMemberEvents = await queryFilter(this.contract, {
+        const registeredMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
             fromBlock: this.deployBlock,
             ...options,
             membersFilter: this.membersFilter
         });
-        const removedMemberEvents = await queryFilter(this.contract, {
+        const removedMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
             fromBlock: this.deployBlock,
             ...options,
             membersFilter: this.membershipErasedFilter
         });
-        const expiredMemberEvents = await queryFilter(this.contract, {
+        const expiredMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
             fromBlock: this.deployBlock,
             ...options,
             membersFilter: this.membersExpiredFilter
@@ -173,6 +159,29 @@ class RLNLightContract {
         ];
         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();
@@ -208,6 +217,38 @@ class RLNLightContract {
             }
         });
     }
+    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]);
@@ -219,11 +260,69 @@ class RLNLightContract {
             this.processEvents([event]);
         });
     }
+    async getMembershipInfo(idCommitmentBigInt) {
+        try {
+            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 < gracePeriodStartTimestamp.toNumber()) {
+                state = MembershipState.Active;
+            }
+            else if (currentBlock < gracePeriodEnd.toNumber()) {
+                state = MembershipState.GracePeriod;
+            }
+            else {
+                state = MembershipState.Expired;
+            }
+            return {
+                index,
+                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(idCommitmentBigInt) {
+        return this.contract.extendMemberships([idCommitmentBigInt]);
+    }
+    async eraseMembership(idCommitmentBigInt, eraseFromMembershipSet = true) {
+        return this.contract.eraseMemberships([idCommitmentBigInt], eraseFromMembershipSet);
+    }
+    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 withdraw(token, from) {
+        try {
+            const tx = await this.contract.withdraw(token, from);
+            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());
+            const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt);
             if (existingIndex) {
                 throw new Error(`ID commitment is already registered with index ${existingIndex}`);
             }
@@ -253,12 +352,12 @@ class RLNLightContract {
                 `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()
                 }
@@ -293,29 +392,6 @@ class RLNLightContract {
             }
         }
     }
-    /**
-     * 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 registerWithPermitAndErase(identity, permit, idCommitmentsToErase) {
         try {
             log.info(`Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`);
@@ -335,12 +411,12 @@ class RLNLightContract {
                 `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()
                 }
@@ -351,61 +427,42 @@ class RLNLightContract {
             return undefined;
         }
     }
-    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}`);
+    /**
+     * Validates that the rate limit is within the allowed range
+     * @throws Error if the rate limit is outside the allowed range
+     */
+    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`);
         }
     }
-    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;
+    get membersFilter() {
+        if (!this._membersFilter) {
+            throw Error("Members filter was not initialized.");
         }
+        return this._membersFilter;
     }
-    async extendMembership(idCommitment) {
-        return this.contract.extendMemberships([idCommitment]);
-    }
-    async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
-        return this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
+    get membershipErasedFilter() {
+        if (!this._membershipErasedFilter) {
+            throw Error("MembershipErased filter was not initialized.");
+        }
+        return this._membershipErasedFilter;
     }
-    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}`);
+    get membersExpiredFilter() {
+        if (!this._membersExpiredFilter) {
+            throw Error("MembersExpired filter was not initialized.");
         }
-        return this.contract.register(idCommitment, rateLimit, []);
+        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
@@ -417,61 +474,5 @@ class RLNLightContract {
         }
     }
 }
-// These values should be tested on other networks
-const FETCH_CHUNK = 5;
-const BLOCK_RANGE = 3000;
-async function queryFilter(contract, options) {
-    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 = splitToChunks(fromBlock, toBlock, fetchRange);
-    for (const portion of takeN(chunks, fetchChunks)) {
-        const promises = portion.map(([left, right]) => ignoreErrors(contract.queryFilter(membersFilter, left, right), []));
-        const fetchedEvents = await Promise.all(promises);
-        events.push(fetchedEvents.flatMap((v) => v));
-    }
-    return events.flatMap((v) => v);
-}
-function 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;
-}
-function* takeN(array, size) {
-    let start = 0;
-    while (start < array.length) {
-        const portion = array.slice(start, start + size);
-        yield portion;
-        start += size;
-    }
-}
-async function 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;
-    }
-}
 
-export { MembershipState, RLNLightContract };
+export { RLNBaseContract };