@waku/rln 0.1.5 → 0.1.6-a7f52e4.0

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

@@ -24,15 +24,32 @@ class RLNBaseContract {
     contract;
     deployBlock;
     rateLimit;
+    minRateLimit;
+    maxRateLimit;
     _members = new Map();
     _membersFilter;
     _membershipErasedFilter;
     _membersExpiredFilter;
     /**
-     * Constructor for RLNBaseContract.
-     * Allows injecting a mocked contract for testing purposes.
+     * Private constructor for RLNBaseContract. Use static create() instead.
      */
     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,20 @@ 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();
+    }
+    /**
+     * Static async factory to create and initialize RLNBaseContract
+     */
+    static async create(options) {
+        const instance = new RLNBaseContract(options);
+        const [min, max] = await Promise.all([
+            instance.contract.minMembershipRateLimit(),
+            instance.contract.maxMembershipRateLimit()
+        ]);
+        instance.minRateLimit = BigNumber.from(min).toNumber();
+        instance.maxRateLimit = BigNumber.from(max).toNumber();
+        instance.validateRateLimit(instance.rateLimit);
+        return instance;
     }
     /**
      * Gets the current rate limit for this contract instance
@@ -69,20 +92,20 @@ class RLNBaseContract {
         return this.contract.provider;
     }
     /**
-     * Gets the minimum allowed rate limit from the contract
-     * @returns Promise<number> The minimum rate limit in messages per epoch
+     * Gets the minimum allowed rate limit (cached)
      */
-    async getMinRateLimit() {
-        const minRate = await this.contract.minMembershipRateLimit();
-        return BigNumber.from(minRate).toNumber();
+    getMinRateLimit() {
+        if (this.minRateLimit === undefined)
+            throw new Error("minRateLimit not initialized");
+        return this.minRateLimit;
     }
     /**
-     * Gets the maximum allowed rate limit from the contract
-     * @returns Promise<number> The maximum rate limit in messages per epoch
+     * Gets the maximum allowed rate limit (cached)
      */
-    async getMaxRateLimit() {
-        const maxRate = await this.contract.maxMembershipRateLimit();
-        return BigNumber.from(maxRate).toNumber();
+    getMaxRateLimit() {
+        if (this.maxRateLimit === undefined)
+            throw new Error("maxRateLimit not initialized");
+        return this.maxRateLimit;
     }
     /**
      * Gets the maximum total rate limit across all memberships
@@ -115,7 +138,7 @@ class RLNBaseContract {
      * Updates the rate limit for future registrations
      * @param newRateLimit The new rate limit to use
      */
-    async setRateLimit(newRateLimit) {
+    setRateLimit(newRateLimit) {
         this.validateRateLimit(newRateLimit);
         this.rateLimit = newRateLimit;
     }
@@ -247,75 +270,67 @@ 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) {
-        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) {
+    async getMembershipInfo(idCommitmentBigInt) {
         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) {
+        if (!(await this.isExpired(idCommitmentBigInt)) ||
+            !(await this.isInGracePeriod(idCommitmentBigInt))) {
+            throw new Error("Membership is not expired or in grace period");
+        }
+        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 +341,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}`);
             }
@@ -432,13 +447,15 @@ class RLNBaseContract {
         }
     }
     /**
-     * Validates that the rate limit is within the allowed range
+     * Validates that the rate limit is within the allowed range (sync)
      * @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`);
+        if (this.minRateLimit === undefined || this.maxRateLimit === undefined) {
+            throw new Error("Rate limits not initialized");
+        }
+        if (rateLimit < this.minRateLimit || rateLimit > this.maxRateLimit) {
+            throw new Error(`Rate limit must be between ${this.minRateLimit} and ${this.maxRateLimit} messages per epoch`);
         }
     }
     get membersFilter() {
@@ -459,9 +476,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
@@ -472,6 +489,45 @@ class RLNBaseContract {
             return undefined;
         }
     }
+    async getMembershipStatus(idCommitment) {
+        const [isExpired, isInGrace] = await Promise.all([
+            this.contract.isExpired(idCommitment),
+            this.contract.isInGracePeriod(idCommitment)
+        ]);
+        if (isExpired)
+            return "expired";
+        if (isInGrace)
+            return "grace";
+        return "active";
+    }
+    /**
+     * Checks if a membership is expired for the given idCommitment
+     * @param idCommitmentBigInt The idCommitment as bigint
+     * @returns Promise<boolean> True if expired, false otherwise
+     */
+    async isExpired(idCommitmentBigInt) {
+        try {
+            return await this.contract.isExpired(idCommitmentBigInt);
+        }
+        catch (error) {
+            log.error("Error in isExpired:", error);
+            return false;
+        }
+    }
+    /**
+     * Checks if a membership is in grace period for the given idCommitment
+     * @param idCommitmentBigInt The idCommitment as bigint
+     * @returns Promise<boolean> True if in grace period, false otherwise
+     */
+    async isInGracePeriod(idCommitmentBigInt) {
+        try {
+            return await this.contract.isInGracePeriod(idCommitmentBigInt);
+        }
+        catch (error) {
+            log.error("Error in isInGracePeriod:", error);
+            return false;
+        }
+    }
 }
 
 export { RLNBaseContract };

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

@@ -1,5 +1,5 @@
-import { hmac } from '../node_modules/@noble/hashes/esm/hmac.js';
-import { sha256 } from '../node_modules/@noble/hashes/esm/sha256.js';
+import { hmac } from '../../../node_modules/@noble/hashes/esm/hmac.js';
+import { sha256 } from '../../../node_modules/@noble/hashes/esm/sha256.js';
 import '../../interfaces/dist/protocols.js';
 import '../../interfaces/dist/connection_manager.js';
 import '../../interfaces/dist/health_indicator.js';
@@ -64,7 +64,7 @@ class RLNCredentialsManager {
             }
             this.credentials = credentials;
             this.signer = signer;
-            this.contract = new RLNBaseContract({
+            this.contract = await RLNBaseContract.create({
                 address: address,
                 signer: signer,
                 rateLimit: rateLimit ?? this.zerokit?.rateLimit

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

@@ -22,7 +22,7 @@ class IdentityCredential {
         const idNullifier = memKeys.subarray(32, 64);
         const idSecretHash = memKeys.subarray(64, 96);
         const idCommitment = memKeys.subarray(96, 128);
-        const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment, 32);
+        const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment);
         return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment, idCommitmentBigInt);
     }
 }

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

@@ -1,6 +1,6 @@
-import { cipherDecrypt as cipherDecrypt_1 } from '../../node_modules/@chainsafe/bls-keystore/lib/cipher.js';
-import { kdf as kdf_2 } from '../../node_modules/@chainsafe/bls-keystore/lib/kdf.js';
-import { normalizePassword as normalizePassword_1 } from '../../node_modules/@chainsafe/bls-keystore/lib/password.js';
+import { cipherDecrypt as cipherDecrypt_1 } from '../../../../node_modules/@chainsafe/bls-keystore/lib/cipher.js';
+import { kdf as kdf_2 } from '../../../../node_modules/@chainsafe/bls-keystore/lib/kdf.js';
+import { normalizePassword as normalizePassword_1 } from '../../../../node_modules/@chainsafe/bls-keystore/lib/password.js';
 import { keccak256 } from '../../../../node_modules/ethereum-cryptography/esm/keccak.js';
 import { hexToBytes } from '../../../../node_modules/ethereum-cryptography/esm/utils.js';
 import { concatBytes, bytesToHex } from '../../../../node_modules/@noble/hashes/esm/utils.js';

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

@@ -1,4 +1,4 @@
-import '../../node_modules/@chainsafe/bls-keystore/lib/index.js';
+import '../../../../node_modules/@chainsafe/bls-keystore/lib/index.js';
 import '../../../interfaces/dist/protocols.js';
 import '../../../interfaces/dist/connection_manager.js';
 import '../../../interfaces/dist/health_indicator.js';

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

@@ -44,9 +44,12 @@ function writeUIntLE(buf, value, offset, byteLength, noAssert) {
  * @param array: Uint8Array
  * @returns BigInt
  */
-function buildBigIntFromUint8Array(array, byteOffset = 0) {
-    const dataView = new DataView(array.buffer);
-    return dataView.getBigUint64(byteOffset, true);
+function buildBigIntFromUint8Array(array) {
+    let hex = "";
+    for (let i = 0; i < array.length; i++) {
+        hex = array[i].toString(16).padStart(2, "0") + hex; // Reverse order for big-endian
+    }
+    return BigInt("0x" + hex);
 }
 /**
  * Fills with zeros to set length