@waku/rln 0.1.5-9901863.0 → 0.1.5-a824fff.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

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

@@ -16,8 +16,8 @@ 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';
+import { Contract } from '@ethersproject/contracts';
+import { BigNumber } from '@ethersproject/bignumber';
 
 const log = new Logger("waku:rln:contract:base");
 class RLNBaseContract {
@@ -33,6 +33,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 +57,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 +128,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,75 +259,63 @@ 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);
+            const membershipData = await this.contract.memberships(idCommitmentBigInt);
             const currentBlock = await this.contract.provider.getBlockNumber();
+            const [depositAmount, activeDuration, gracePeriodStartTimestamp, gracePeriodDuration, rateLimit, index, holder, token] = membershipData;
+            const gracePeriodEnd = gracePeriodStartTimestamp.add(gracePeriodDuration);
             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;
             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) {
+            log.error("Error in getMembershipInfo:", error);
             return undefined;
         }
     }
-    async extendMembership(idCommitment) {
-        return this.contract.extendMemberships([idCommitment]);
+    async extendMembership(idCommitmentBigInt) {
+        const tx = await this.contract.extendMemberships([idCommitmentBigInt]);
+        await tx.wait();
+        return tx;
     }
-    async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
-        return this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
+    async eraseMembership(idCommitmentBigInt, eraseFromMembershipSet = true) {
+        const estimatedGas = await this.contract.estimateGas["eraseMemberships(uint256[],bool)"]([idCommitmentBigInt], eraseFromMembershipSet);
+        const gasLimit = estimatedGas.add(10000);
+        const tx = await this.contract["eraseMemberships(uint256[],bool)"]([idCommitmentBigInt], eraseFromMembershipSet, { gasLimit });
+        await tx.wait();
+        return tx;
     }
-    async registerMembership(idCommitment, rateLimit = DEFAULT_RATE_LIMIT) {
+    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(idCommitment, rateLimit, []);
+        return this.contract.register(idCommitmentBigInt, 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) {
@@ -326,7 +326,7 @@ class RLNBaseContract {
         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}`);
             }
@@ -356,12 +356,12 @@ class RLNBaseContract {
                 `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()
                 }
@@ -415,12 +415,12 @@ class RLNBaseContract {
                 `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()
                 }
@@ -435,10 +435,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() {
@@ -459,9 +464,9 @@ class RLNBaseContract {
         }
         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

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

@@ -6,7 +6,7 @@ import { Logger } from '../../../utils/dist/logger/index.js';
 import { MerkleRootTracker } from '../root_tracker.js';
 import { zeroPadLE } from '../utils/bytes.js';
 import { RLNBaseContract } from './rln_base_contract.js';
-import { BigNumber } from '../../../../node_modules/@ethersproject/bignumber/lib.esm/bignumber.js';
+import { BigNumber } from '@ethersproject/bignumber';
 
 const log = new Logger("waku:rln:contract");
 class RLNContract extends RLNBaseContract {

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,7 +126,7 @@ 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());

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

@@ -25,14 +25,6 @@ class IdentityCredential {
         const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment, 32);
         return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment, idCommitmentBigInt);
     }
-    toJSON() {
-        return {
-            idTrapdoor: Array.from(this.IDTrapdoor),
-            idNullifier: Array.from(this.IDNullifier),
-            idSecretHash: Array.from(this.IDSecretHash),
-            idCommitment: Array.from(this.IDCommitment)
-        };
-    }
 }
 
 export { IdentityCredential };

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

@@ -17,7 +17,6 @@ import { Logger } from '../../../utils/dist/logger/index.js';
 import { sha256 } from '../../../../node_modules/ethereum-cryptography/esm/sha256.js';
 import { bytesToUtf8 } from '../../../../node_modules/ethereum-cryptography/esm/utils.js';
 import _ from '../../../../node_modules/lodash/lodash.js';
-import { IdentityCredential } from '../identity.js';
 import { buildBigIntFromUint8Array } from '../utils/bytes.js';
 import { keccak256Checksum, decryptEipKeystore } from './cipher.js';
 import { isKeystoreValid, isCredentialValid } from './schema_validator.js';
@@ -165,15 +164,15 @@ class Keystore {
         try {
             const str = bytesToUtf8(bytes);
             const obj = JSON.parse(str);
-            // Get identity fields from named object
-            const { idTrapdoor, idNullifier, idSecretHash, idCommitment } = _.get(obj, "identityCredential", {});
-            const idTrapdoorArray = new Uint8Array(idTrapdoor || []);
-            const idNullifierArray = new Uint8Array(idNullifier || []);
-            const idSecretHashArray = new Uint8Array(idSecretHash || []);
-            const idCommitmentArray = new Uint8Array(idCommitment || []);
-            const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitmentArray);
+            // TODO: add runtime validation of nwaku credentials
             return {
-                identity: new IdentityCredential(idTrapdoorArray, idNullifierArray, idSecretHashArray, idCommitmentArray, idCommitmentBigInt),
+                identity: {
+                    IDCommitment: Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idCommitment", [])),
+                    IDTrapdoor: Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idTrapdoor", [])),
+                    IDNullifier: Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idNullifier", [])),
+                    IDCommitmentBigInt: buildBigIntFromUint8Array(Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idCommitment", []))),
+                    IDSecretHash: Keystore.fromArraylikeToBytes(_.get(obj, "identityCredential.idSecretHash", []))
+                },
                 membership: {
                     treeIndex: _.get(obj, "treeIndex"),
                     chainId: _.get(obj, "membershipContract.chainId"),
@@ -187,6 +186,20 @@ class Keystore {
             return;
         }
     }
+    static fromArraylikeToBytes(obj) {
+        if (Array.isArray(obj)) {
+            return new Uint8Array(obj);
+        }
+        const bytes = [];
+        let index = 0;
+        let lastElement = obj[index];
+        while (lastElement !== undefined) {
+            bytes.push(lastElement);
+            index += 1;
+            lastElement = obj[index];
+        }
+        return new Uint8Array(bytes);
+    }
     // follows nwaku implementation
     // https://github.com/waku-org/nwaku/blob/f05528d4be3d3c876a8b07f9bb7dfaae8aa8ec6e/waku/waku_keystore/protocol_types.nim#L111
     static computeMembershipHash(info) {
@@ -196,16 +209,16 @@ class Keystore {
     // https://github.com/waku-org/nwaku/blob/f05528d4be3d3c876a8b07f9bb7dfaae8aa8ec6e/waku/waku_keystore/protocol_types.nim#L98
     static fromIdentityToBytes(options) {
         return utf8ToBytes(JSON.stringify({
-            membershipContract: {
-                chainId: options.membership.chainId,
-                address: options.membership.address
-            },
             treeIndex: options.membership.treeIndex,
             identityCredential: {
-                idTrapdoor: Array.from(options.identity.IDTrapdoor),
+                idCommitment: Array.from(options.identity.IDCommitment),
                 idNullifier: Array.from(options.identity.IDNullifier),
                 idSecretHash: Array.from(options.identity.IDSecretHash),
-                idCommitment: Array.from(options.identity.IDCommitment)
+                idTrapdoor: Array.from(options.identity.IDTrapdoor)
+            },
+            membershipContract: {
+                chainId: options.membership.chainId,
+                address: options.membership.address
             },
             userMessageLimit: options.membership.rateLimit
         }));

package/bundle/packages/rln/dist/utils/metamask.js

@@ -1,4 +1,4 @@
-import { Web3Provider } from '../../../../node_modules/@ethersproject/providers/lib.esm/web3-provider.js';
+import * as providers from '@ethersproject/providers';
 
 const extractMetaMaskSigner = async () => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -7,7 +7,7 @@ const extractMetaMaskSigner = async () => {
         throw Error("Missing or invalid Ethereum provider. Please install a Web3 wallet such as MetaMask.");
     }
     await ethereum.request({ method: "eth_requestAccounts" });
-    const provider = new Web3Provider(ethereum, "any");
+    const provider = new providers.Web3Provider(ethereum, "any");
     return provider.getSigner();
 };
 

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