@waku/rln 0.1.4-d27db21.0 → 0.1.5-053bb95.0

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

@@ -5,434 +5,123 @@ import { hexToBytes } from '../../../utils/dist/bytes/index.js';
 import { Logger } from '../../../utils/dist/logger/index.js';
 import { MerkleRootTracker } from '../root_tracker.js';
 import { zeroPadLE } from '../utils/bytes.js';
-import { RLN_ABI } from './abi.js';
-import { RATE_LIMIT_PARAMS, DEFAULT_RATE_LIMIT } from './constants.js';
-import { Contract } from '../../../../node_modules/@ethersproject/contracts/lib.esm/index.js';
-import { BigNumber } from '../../../../node_modules/@ethersproject/bignumber/lib.esm/bignumber.js';
+import { ContractStateError } from './errors.js';
+import { RLNBaseContract } from './rln_base_contract.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 RLNContract {
-    contract;
+class RLNContract extends RLNBaseContract {
+    instance;
     merkleRootTracker;
-    deployBlock;
-    rateLimit;
-    _members = new Map();
-    _membersFilter;
-    _membersRemovedFilter;
+    lastSyncedBlock = 0;
     /**
      * Asynchronous initializer for RLNContract.
      * Allows injecting a mocked contract for testing purposes.
      */
     static async init(rlnInstance, options) {
         const rlnContract = new RLNContract(rlnInstance, options);
-        await rlnContract.fetchMembers(rlnInstance);
-        rlnContract.subscribeToMembers(rlnInstance);
+        await rlnContract.syncState();
         return rlnContract;
     }
-    constructor(rlnInstance, 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;
-        const initialRoot = rlnInstance.zerokit.getMerkleRoot();
-        // Use the injected contract if provided; otherwise, instantiate a new one.
-        this.contract = contract || new Contract(address, RLN_ABI, signer);
-        this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
-        // Initialize event filters for MembershipRegistered and MembershipRemoved
-        this._membersFilter = this.contract.filters.MembershipRegistered();
-        this._membersRemovedFilter = this.contract.filters.MembershipRemoved();
-    }
-    /**
-     * 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
+     * Override base contract method to keep Merkle tree in sync
+     * Registers a new membership with the given commitment and rate limit
      */
-    get provider() {
-        return this.contract.provider;
+    async registerMembership(idCommitment, rateLimit = this.getRateLimit()) {
+        await super.registerMembership(idCommitment, rateLimit);
+        await this.syncState();
     }
     /**
-     * Gets the minimum allowed rate limit from the contract
-     * @returns Promise<number> The minimum rate limit in messages per epoch
+     * Override base contract method to keep Merkle tree in sync
+     * Erases an existing membership from the contract
      */
-    async getMinRateLimit() {
-        const minRate = await this.contract.minMembershipRateLimit();
-        return 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 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();
+    async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
+        await super.eraseMembership(idCommitment, eraseFromMembershipSet);
+        await this.syncState();
     }
     /**
-     * Gets the current total rate limit usage across all memberships
-     * @returns Promise<number> The current total rate limit usage in messages per epoch
+     * Gets the current Merkle root
+     * Returns the latest valid root or empty array if no roots exist
      */
-    async getCurrentTotalRateLimit() {
-        const currentTotal = await this.contract.currentTotalRateLimit();
-        return currentTotal.toNumber();
+    async getMerkleRoot() {
+        await this.syncState();
+        const roots = this.merkleRootTracker.roots();
+        return roots.length > 0 ? roots[0] : new Uint8Array();
     }
-    /**
-     * 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 maxTotal.sub(currentTotal).toNumber();
+    constructor(rlnInstance, options) {
+        super(options);
+        this.instance = rlnInstance;
+        const initialRoot = rlnInstance.zerokit.getMerkleRoot();
+        this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
     }
     /**
-     * Updates the rate limit for future registrations
-     * @param newRateLimit The new rate limit to use
+     * Syncs the local Merkle tree with the current contract state
      */
-    async setRateLimit(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 membersRemovedFilter() {
-        if (!this._membersRemovedFilter) {
-            throw Error("MembersRemoved filter was not initialized.");
-        }
-        return this._membersRemovedFilter;
-    }
-    async fetchMembers(rlnInstance, options = {}) {
-        const registeredMemberEvents = await queryFilter(this.contract, {
-            fromBlock: this.deployBlock,
-            ...options,
-            membersFilter: this.membersFilter
-        });
-        const removedMemberEvents = await queryFilter(this.contract, {
-            fromBlock: this.deployBlock,
-            ...options,
-            membersFilter: this.membersRemovedFilter
-        });
-        const events = [...registeredMemberEvents, ...removedMemberEvents];
-        this.processEvents(rlnInstance, events);
-    }
-    processEvents(rlnInstance, events) {
-        const toRemoveTable = new Map();
-        const toInsertTable = new Map();
-        events.forEach((evt) => {
-            if (!evt.args) {
+    async syncState() {
+        try {
+            const currentBlock = await this.provider.getBlockNumber();
+            // If we're already synced, just get new members
+            if (this.lastSyncedBlock > 0) {
+                await this.syncNewMembers(this.lastSyncedBlock, currentBlock);
+                this.lastSyncedBlock = currentBlock;
                 return;
             }
-            if (evt.event === "MembershipRemoved") {
-                const index = evt.args.index;
-                const toRemoveVal = toRemoveTable.get(evt.blockNumber);
-                if (toRemoveVal != undefined) {
-                    toRemoveVal.push(index.toNumber());
-                    toRemoveTable.set(evt.blockNumber, toRemoveVal);
+            // First time sync - get all members
+            const nextIndex = await this.contract.nextFreeIndex();
+            const members = await this.getMembersInRange(0, nextIndex.toNumber());
+            // Clear existing members by deleting them one by one
+            // This effectively resets the tree without needing resetTree()
+            for (let i = 0; i < nextIndex.toNumber(); i++) {
+                try {
+                    this.instance.zerokit.deleteMember(i);
                 }
-                else {
-                    toRemoveTable.set(evt.blockNumber, [index.toNumber()]);
+                catch (error) {
+                    // Ignore errors for non-existent members
+                    continue;
                 }
             }
-            else if (evt.event === "MembershipRegistered") {
-                let eventsPerBlock = toInsertTable.get(evt.blockNumber);
-                if (eventsPerBlock == undefined) {
-                    eventsPerBlock = [];
-                }
-                eventsPerBlock.push(evt);
-                toInsertTable.set(evt.blockNumber, eventsPerBlock);
-            }
-        });
-        this.removeMembers(rlnInstance, toRemoveTable);
-        this.insertMembers(rlnInstance, toInsertTable);
-    }
-    insertMembers(rlnInstance, toInsert) {
-        toInsert.forEach((events, blockNumber) => {
-            events.forEach((evt) => {
-                if (!evt.args)
-                    return;
-                const _idCommitment = evt.args.idCommitment;
-                const index = evt.args.index;
-                if (!_idCommitment || !index) {
-                    return;
-                }
-                const idCommitment = zeroPadLE(hexToBytes(_idCommitment), 32);
-                rlnInstance.zerokit.insertMember(idCommitment);
-                this._members.set(index.toNumber(), {
-                    index,
-                    idCommitment: _idCommitment
-                });
-            });
-            const currentRoot = rlnInstance.zerokit.getMerkleRoot();
-            this.merkleRootTracker.pushRoot(blockNumber, currentRoot);
-        });
-    }
-    removeMembers(rlnInstance, toRemove) {
-        const removeDescending = new Map([...toRemove].reverse());
-        removeDescending.forEach((indexes, blockNumber) => {
-            indexes.forEach((index) => {
-                if (this._members.has(index)) {
-                    this._members.delete(index);
-                    rlnInstance.zerokit.deleteMember(index);
-                }
-            });
-            this.merkleRootTracker.backFill(blockNumber);
-        });
-    }
-    subscribeToMembers(rlnInstance) {
-        this.contract.on(this.membersFilter, (_idCommitment, _rateLimit, _index, event) => {
-            this.processEvents(rlnInstance, [event]);
-        });
-        this.contract.on(this.membersRemovedFilter, (_idCommitment, _index, event) => {
-            this.processEvents(rlnInstance, [event]);
-        });
-    }
-    async registerWithIdentity(identity) {
-        try {
-            log.info(`Registering identity with rate limit: ${this.rateLimit} messages/epoch`);
-            const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit: 300000 });
-            const txRegisterReceipt = await txRegisterResponse.wait();
-            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;
+            // Insert all members
+            for (const member of members) {
+                const idCommitment = zeroPadLE(hexToBytes(member.idCommitment), 32);
+                this.instance.zerokit.insertMember(idCommitment);
             }
-            const decodedData = {
-                idCommitment: memberRegistered.args.idCommitment,
-                rateLimit: memberRegistered.args.rateLimit,
-                index: memberRegistered.args.index
-            };
-            log.info(`Successfully registered membership with index ${decodedData.index} ` +
-                `and rate limit ${decodedData.rateLimit}`);
-            const network = await this.contract.provider.getNetwork();
-            const address = this.contract.address;
-            const membershipId = decodedData.index.toNumber();
-            return {
-                identity,
-                membership: {
-                    address,
-                    treeIndex: membershipId,
-                    chainId: network.chainId
-                }
-            };
+            // Update root tracker
+            const currentRoot = this.instance.zerokit.getMerkleRoot();
+            this.merkleRootTracker.pushRoot(currentBlock, currentRoot);
+            this.lastSyncedBlock = currentBlock;
+            log.info(`Synced ${members.length} members to current block ${currentBlock}`);
         }
         catch (error) {
-            log.error(`Error in registerWithIdentity: ${error.message}`);
-            return undefined;
+            log.error("Failed to sync state", error);
+            throw new ContractStateError("Failed to sync contract state");
         }
     }
     /**
-     * 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
+     * Syncs new members added between fromBlock and toBlock
      */
-    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, rateLimit.sub(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`);
-            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,
-                rateLimit: memberRegistered.args.rateLimit,
-                index: memberRegistered.args.index
-            };
-            log.info(`Successfully registered membership with permit. Index: ${decodedData.index}, ` +
-                `Rate limit: ${decodedData.rateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
-            const network = await this.contract.provider.getNetwork();
-            const address = this.contract.address;
-            const membershipId = decodedData.index.toNumber();
-            return {
-                identity,
-                membership: {
-                    address,
-                    treeIndex: membershipId,
-                    chainId: network.chainId
-                }
-            };
-        }
-        catch (error) {
-            log.error(`Error in registerWithPermitAndErase: ${error.message}`);
-            return undefined;
-        }
-    }
-    roots() {
-        return this.merkleRootTracker.roots();
-    }
-    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 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 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;
-        }
-    }
-}
-// 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`);
+    async syncNewMembers(fromBlock, toBlock) {
+        // Get members that were added
+        const filter = this.contract.filters.MembershipRegistered();
+        const addEvents = await this.contract.queryFilter(filter, fromBlock, toBlock);
+        // Get members that were removed
+        const removeFilter = this.contract.filters.MembershipErased();
+        const removeEvents = await this.contract.queryFilter(removeFilter, fromBlock, toBlock);
+        // Process removals first (in reverse block order)
+        for (const evt of removeEvents.sort((a, b) => b.blockNumber - a.blockNumber)) {
+            if (!evt.args)
+                continue;
+            const index = evt.args.index.toNumber();
+            this.instance.zerokit.deleteMember(index);
+            this.merkleRootTracker.backFill(evt.blockNumber);
+        }
+        // Then process additions
+        for (const evt of addEvents) {
+            if (!evt.args)
+                continue;
+            const idCommitment = zeroPadLE(hexToBytes(evt.args.idCommitment), 32);
+            this.instance.zerokit.insertMember(idCommitment);
+            this.merkleRootTracker.pushRoot(evt.blockNumber, this.instance.zerokit.getMerkleRoot());
         }
-        return defaultValue;
     }
 }
 
-export { MembershipState, RLNContract };
+export { RLNContract };

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

@@ -0,0 +1,9 @@
+var MembershipState;
+(function (MembershipState) {
+    MembershipState["Active"] = "Active";
+    MembershipState["GracePeriod"] = "GracePeriod";
+    MembershipState["Expired"] = "Expired";
+    MembershipState["ErasedAwaitsWithdrawal"] = "ErasedAwaitsWithdrawal";
+})(MembershipState || (MembershipState = {}));
+
+export { MembershipState };

package/bundle/packages/rln/dist/create.js

@@ -3,7 +3,7 @@ async function createRLN() {
     // asynchronously. This file does the single async import, so
     // that no one else needs to worry about it again.
     const rlnModule = await import('./rln.js');
-    return rlnModule.create();
+    return rlnModule.RLNInstance.create();
 }
 
 export { createRLN };