@waku/rln 0.1.5-6997987.0 → 0.1.5-731214b.0

package/bundle/index.js

@@ -1,7 +1,8 @@
 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 { 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';

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

@@ -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_base_contract.js

@@ -19,6 +19,7 @@ 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';
 
+/* eslint-disable no-console */
 const log = new Logger("waku:rln:contract:base");
 class RLNBaseContract {
     contract;
@@ -33,6 +34,22 @@ class RLNBaseContract {
      * Allows injecting a mocked contract for testing purposes.
      */
     constructor(options) {
+        const { address, signer, rateLimit = DEFAULT_RATE_LIMIT, contract } = options;
+        log.info("Initializing RLNBaseContract", { address, rateLimit });
+        this.contract = contract || new Contract(address, RLN_ABI, signer);
+        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(() => {
@@ -41,14 +58,10 @@ class RLNBaseContract {
             .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();
+        // 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
@@ -116,7 +129,7 @@ class RLNBaseContract {
      * @param newRateLimit The new rate limit to use
      */
     async setRateLimit(newRateLimit) {
-        this.validateRateLimit(newRateLimit);
+        await this.validateRateLimit(newRateLimit);
         this.rateLimit = newRateLimit;
     }
     get members() {
@@ -247,56 +260,47 @@ class RLNBaseContract {
             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) {
+    async getMembershipInfo(idCommitmentBigInt) {
         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);
+            console.log("idCommitmentBigInt", idCommitmentBigInt);
+            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);
+            console.log("gracePeriodEnd", gracePeriodEnd);
             let state;
-            if (currentBlock < startBlock) {
+            if (currentBlock < gracePeriodStartTimestamp.toNumber()) {
                 state = MembershipState.Active;
             }
-            else if (currentBlock < endBlock) {
+            else if (currentBlock < gracePeriodEnd.toNumber()) {
                 state = MembershipState.GracePeriod;
             }
             else {
                 state = MembershipState.Expired;
             }
-            const index = await this.getMemberIndex(idCommitment);
-            if (!index)
-                return undefined;
+            console.log("state", state);
+            console.log("index", index);
+            console.log("idCommitment", idCommitmentBigInt.toString());
+            console.log("rateLimit", rateLimit);
+            console.log("gracePeriodStartTimestamp", gracePeriodStartTimestamp);
+            console.log("gracePeriodEnd", gracePeriodEnd);
             return {
                 index,
-                idCommitment,
-                rateLimit: rateLimit.toNumber(),
-                startBlock: startBlock.toNumber(),
-                endBlock: endBlock.toNumber(),
-                state
+                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;
         }
     }
@@ -313,9 +317,9 @@ class RLNBaseContract {
         }
         return this.contract.register(idCommitment, rateLimit, []);
     }
-    async withdraw(token, holder) {
+    async withdraw(token, from) {
         try {
-            const tx = await this.contract.withdraw(token, { from: holder });
+            const tx = await this.contract.withdraw(token, from);
             await tx.wait();
         }
         catch (error) {
@@ -362,7 +366,7 @@ class RLNBaseContract {
                 membership: {
                     address,
                     treeIndex: membershipId,
-                    chainId: network.chainId,
+                    chainId: network.chainId.toString(),
                     rateLimit: decodedData.membershipRateLimit.toNumber()
                 }
             };
@@ -421,7 +425,7 @@ class RLNBaseContract {
                 membership: {
                     address,
                     treeIndex: membershipId,
-                    chainId: network.chainId,
+                    chainId: network.chainId.toString(),
                     rateLimit: decodedData.membershipRateLimit.toNumber()
                 }
             };
@@ -435,10 +439,15 @@ class RLNBaseContract {
      * 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`);
+    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`);
         }
     }
     get membersFilter() {

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

@@ -32,33 +32,15 @@ const log = new Logger("waku:credentials");
 class RLNCredentialsManager {
     started = false;
     starting = false;
-    _contract;
-    _signer;
+    contract;
+    signer;
     keystore = Keystore.create();
-    _credentials;
+    credentials;
     zerokit;
     constructor(zerokit) {
         log.info("RLNCredentialsManager initialized");
         this.zerokit = zerokit;
     }
-    get contract() {
-        return this._contract;
-    }
-    set contract(contract) {
-        this._contract = contract;
-    }
-    get signer() {
-        return this._signer;
-    }
-    set signer(signer) {
-        this._signer = signer;
-    }
-    get credentials() {
-        return this._credentials;
-    }
-    set credentials(credentials) {
-        this._credentials = credentials;
-    }
     get provider() {
         return this.contract?.provider;
     }
@@ -80,12 +62,12 @@ class RLNCredentialsManager {
                 this.keystore = keystore;
                 log.info("Using provided keystore");
             }
-            this._credentials = credentials;
-            this._signer = signer;
-            this._contract = new RLNBaseContract({
+            this.credentials = credentials;
+            this.signer = signer;
+            this.contract = new RLNBaseContract({
                 address: address,
                 signer: signer,
-                rateLimit: rateLimit ?? this.zerokit?.getRateLimit
+                rateLimit: rateLimit ?? this.zerokit?.rateLimit
             });
             log.info("RLNCredentialsManager successfully started");
             this.started = true;
@@ -130,8 +112,8 @@ class RLNCredentialsManager {
      */
     async useCredentials(id, password) {
         log.info(`Attempting to use credentials with ID: ${id}`);
-        this._credentials = await this.keystore?.readCredential(id, password);
-        if (this._credentials) {
+        this.credentials = await this.keystore?.readCredential(id, password);
+        if (this.credentials) {
             log.info("Successfully loaded credentials");
         }
         else {
@@ -144,13 +126,13 @@ class RLNCredentialsManager {
             options.address ||
             LINEA_CONTRACT.address;
         if (address === LINEA_CONTRACT.address) {
-            chainId = LINEA_CONTRACT.chainId;
+            chainId = LINEA_CONTRACT.chainId.toString();
             log.info(`Using Linea contract with chainId: ${chainId}`);
         }
         const signer = options.signer || (await extractMetaMaskSigner());
         const currentChainId = await signer.getChainId();
         log.info(`Current chain ID: ${currentChainId}`);
-        if (chainId && chainId !== currentChainId) {
+        if (chainId && chainId !== currentChainId.toString()) {
             log.error(`Chain ID mismatch: contract=${chainId}, current=${currentChainId}`);
             throw Error(`Failed to start RLN contract, chain ID of contract is different from current one: contract-${chainId}, current network-${currentChainId}`);
         }
@@ -199,7 +181,7 @@ class RLNCredentialsManager {
         const chainId = credentials.membership.chainId;
         const network = await this.contract.provider.getNetwork();
         const currentChainId = network.chainId;
-        if (chainId !== currentChainId) {
+        if (chainId !== currentChainId.toString()) {
             throw Error(`Failed to verify chain coordinates: credentials chainID=${chainId} is not equal to registryContract chainID=${currentChainId}`);
         }
     }

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

@@ -177,7 +177,7 @@ class Keystore {
                     treeIndex: _.get(obj, "treeIndex"),
                     chainId: _.get(obj, "membershipContract.chainId"),
                     address: _.get(obj, "membershipContract.address"),
-                    rateLimit: _.get(obj, "membershipContract.rateLimit")
+                    rateLimit: _.get(obj, "userMessageLimit")
                 }
             };
         }
@@ -187,6 +187,9 @@ class Keystore {
         }
     }
     static fromArraylikeToBytes(obj) {
+        if (Array.isArray(obj)) {
+            return new Uint8Array(obj);
+        }
         const bytes = [];
         let index = 0;
         let lastElement = obj[index];
@@ -208,15 +211,16 @@ class Keystore {
         return utf8ToBytes(JSON.stringify({
             treeIndex: options.membership.treeIndex,
             identityCredential: {
-                idCommitment: options.identity.IDCommitment,
-                idNullifier: options.identity.IDNullifier,
-                idSecretHash: options.identity.IDSecretHash,
-                idTrapdoor: options.identity.IDTrapdoor
+                idCommitment: Array.from(options.identity.IDCommitment),
+                idNullifier: Array.from(options.identity.IDNullifier),
+                idSecretHash: Array.from(options.identity.IDSecretHash),
+                idTrapdoor: Array.from(options.identity.IDTrapdoor)
             },
             membershipContract: {
                 chainId: options.membership.chainId,
                 address: options.membership.address
-            }
+            },
+            userMessageLimit: options.membership.rateLimit
         }));
     }
 }

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

@@ -8,11 +8,11 @@ import { epochIntToBytes, dateToEpoch } from './utils/epoch.js';
 class Zerokit {
     zkRLN;
     witnessCalculator;
-    rateLimit;
-    constructor(zkRLN, witnessCalculator, rateLimit = DEFAULT_RATE_LIMIT) {
+    _rateLimit;
+    constructor(zkRLN, witnessCalculator, _rateLimit = DEFAULT_RATE_LIMIT) {
         this.zkRLN = zkRLN;
         this.witnessCalculator = witnessCalculator;
-        this.rateLimit = rateLimit;
+        this._rateLimit = _rateLimit;
     }
     get getZkRLN() {
         return this.zkRLN;
@@ -20,8 +20,8 @@ class Zerokit {
     get getWitnessCalculator() {
         return this.witnessCalculator;
     }
-    get getRateLimit() {
-        return this.rateLimit;
+    get rateLimit() {
+        return this._rateLimit;
     }
     generateIdentityCredentials() {
         const memKeys = generateExtendedMembershipKey(this.zkRLN); // TODO: rename this function in zerokit rln-wasm