@waku/rln 0.1.5-5e19700.0 → 0.1.5-ea6daae.0

package/src/contract/constants.ts

@@ -1,8 +1,8 @@
 import { RLN_ABI } from "./abi.js";
 
-export const LINEA_CONTRACT = {
-  chainId: 59141,
-  address: "0xb9cd878c90e49f797b4431fbf4fb333108cb90e6",
+export const SEPOLIA_CONTRACT = {
+  chainId: 11155111,
+  address: "0xCB33Aa5B38d79E3D9Fa8B10afF38AA201399a7e3",
   abi: RLN_ABI
 };
 

package/src/contract/rln_contract.ts

@@ -30,7 +30,7 @@ interface RLNContractInitOptions extends RLNContractOptions {
 
 export interface MembershipRegisteredEvent {
   idCommitment: string;
-  membershipRateLimit: ethers.BigNumber;
+  rateLimit: number;
   index: ethers.BigNumber;
 }
 
@@ -65,8 +65,7 @@ export class RLNContract {
 
   private _members: Map<number, Member> = new Map();
   private _membersFilter: ethers.EventFilter;
-  private _membershipErasedFilter: ethers.EventFilter;
-  private _membersExpiredFilter: ethers.EventFilter;
+  private _membersRemovedFilter: ethers.EventFilter;
 
   /**
    * Asynchronous initializer for RLNContract.
@@ -95,7 +94,15 @@ export class RLNContract {
       contract
     } = options;
 
-    this.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`
+      );
+    }
+
     this.rateLimit = rateLimit;
 
     const initialRoot = rlnInstance.zerokit.getMerkleRoot();
@@ -104,25 +111,9 @@ export class RLNContract {
     this.contract = contract || new ethers.Contract(address, RLN_ABI, signer);
     this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
 
-    // Initialize event filters
+    // Initialize event filters for MembershipRegistered and MembershipRemoved
     this._membersFilter = this.contract.filters.MembershipRegistered();
-    this._membershipErasedFilter = this.contract.filters.MembershipErased();
-    this._membersExpiredFilter = this.contract.filters.MembershipExpired();
-  }
-
-  /**
-   * Validates that the rate limit is within the allowed range
-   * @throws Error if the rate limit is outside the allowed range
-   */
-  private validateRateLimit(rateLimit: number): void {
-    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._membersRemovedFilter = this.contract.filters.MembershipRemoved();
   }
 
   /**
@@ -191,7 +182,7 @@ export class RLNContract {
       this.contract.maxTotalRateLimit(),
       this.contract.currentTotalRateLimit()
     ]);
-    return Number(maxTotal) - Number(currentTotal);
+    return maxTotal.sub(currentTotal).toNumber();
   }
 
   /**
@@ -199,7 +190,6 @@ export class RLNContract {
    * @param newRateLimit The new rate limit to use
    */
   public async setRateLimit(newRateLimit: number): Promise<void> {
-    this.validateRateLimit(newRateLimit);
     this.rateLimit = newRateLimit;
   }
 
@@ -217,18 +207,11 @@ export class RLNContract {
     return this._membersFilter;
   }
 
-  private get membershipErasedFilter(): ethers.EventFilter {
-    if (!this._membershipErasedFilter) {
-      throw Error("MembershipErased filter was not initialized.");
+  private get membersRemovedFilter(): ethers.EventFilter {
+    if (!this._membersRemovedFilter) {
+      throw Error("MembersRemoved filter was not initialized.");
     }
-    return this._membershipErasedFilter;
-  }
-
-  private get membersExpiredFilter(): ethers.EventFilter {
-    if (!this._membersExpiredFilter) {
-      throw Error("MembersExpired filter was not initialized.");
-    }
-    return this._membersExpiredFilter;
+    return this._membersRemovedFilter;
   }
 
   public async fetchMembers(
@@ -243,19 +226,10 @@ export class RLNContract {
     const removedMemberEvents = await queryFilter(this.contract, {
       fromBlock: this.deployBlock,
       ...options,
-      membersFilter: this.membershipErasedFilter
-    });
-    const expiredMemberEvents = await queryFilter(this.contract, {
-      fromBlock: this.deployBlock,
-      ...options,
-      membersFilter: this.membersExpiredFilter
+      membersFilter: this.membersRemovedFilter
     });
 
-    const events = [
-      ...registeredMemberEvents,
-      ...removedMemberEvents,
-      ...expiredMemberEvents
-    ];
+    const events = [...registeredMemberEvents, ...removedMemberEvents];
     this.processEvents(rlnInstance, events);
   }
 
@@ -268,26 +242,8 @@ export class RLNContract {
         return;
       }
 
-      if (
-        evt.event === "MembershipErased" ||
-        evt.event === "MembershipExpired"
-      ) {
-        let index = evt.args.index;
-
-        if (!index) {
-          return;
-        }
-
-        if (typeof index === "number" || typeof index === "string") {
-          index = ethers.BigNumber.from(index);
-        } else {
-          log.error("Index is not a number or string", {
-            index,
-            event: evt
-          });
-          return;
-        }
-
+      if (evt.event === "MembershipRemoved") {
+        const index = evt.args.index as ethers.BigNumber;
         const toRemoveVal = toRemoveTable.get(evt.blockNumber);
         if (toRemoveVal != undefined) {
           toRemoveVal.push(index.toNumber());
@@ -319,21 +275,15 @@ export class RLNContract {
         if (!evt.args) return;
 
         const _idCommitment = evt.args.idCommitment as string;
-        let index = evt.args.index;
+        const index = evt.args.index as ethers.BigNumber;
 
         if (!_idCommitment || !index) {
           return;
         }
 
-        if (typeof index === "number" || typeof index === "string") {
-          index = ethers.BigNumber.from(index);
-        }
-
         const idCommitment = zeroPadLE(hexToBytes(_idCommitment), 32);
         rlnInstance.zerokit.insertMember(idCommitment);
-
-        const numericIndex = index.toNumber();
-        this._members.set(numericIndex, {
+        this._members.set(index.toNumber(), {
           index,
           idCommitment: _idCommitment
         });
@@ -366,7 +316,7 @@ export class RLNContract {
       this.membersFilter,
       (
         _idCommitment: string,
-        _membershipRateLimit: ethers.BigNumber,
+        _rateLimit: number,
         _index: ethers.BigNumber,
         event: ethers.Event
       ) => {
@@ -375,22 +325,9 @@ export class RLNContract {
     );
 
     this.contract.on(
-      this.membershipErasedFilter,
+      this.membersRemovedFilter,
       (
         _idCommitment: string,
-        _membershipRateLimit: ethers.BigNumber,
-        _index: ethers.BigNumber,
-        event: ethers.Event
-      ) => {
-        this.processEvents(rlnInstance, [event]);
-      }
-    );
-
-    this.contract.on(
-      this.membersExpiredFilter,
-      (
-        _idCommitment: string,
-        _membershipRateLimit: ethers.BigNumber,
         _index: ethers.BigNumber,
         event: ethers.Event
       ) => {
@@ -407,45 +344,15 @@ export class RLNContract {
         `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()
-      );
-      if (existingIndex) {
-        throw new Error(
-          `ID commitment is already registered with index ${existingIndex}`
-        );
-      }
-
-      // Check if there's enough remaining rate limit
-      const remainingRateLimit = await this.getRemainingTotalRateLimit();
-      if (remainingRateLimit < this.rateLimit) {
-        throw new Error(
-          `Not enough remaining rate limit. Requested: ${this.rateLimit}, Available: ${remainingRateLimit}`
-        );
-      }
-
-      const estimatedGas = await this.contract.estimateGas.register(
-        identity.IDCommitmentBigInt,
-        this.rateLimit,
-        []
-      );
-      const gasLimit = estimatedGas.add(10000);
-
       const txRegisterResponse: ethers.ContractTransaction =
         await this.contract.register(
           identity.IDCommitmentBigInt,
           this.rateLimit,
           [],
-          { gasLimit }
+          { gasLimit: 300000 }
         );
-
       const txRegisterReceipt = await txRegisterResponse.wait();
 
-      if (txRegisterReceipt.status === 0) {
-        throw new Error("Transaction failed on-chain");
-      }
-
       const memberRegistered = txRegisterReceipt.events?.find(
         (event) => event.event === "MembershipRegistered"
       );
@@ -459,55 +366,30 @@ export class RLNContract {
 
       const decodedData: MembershipRegisteredEvent = {
         idCommitment: memberRegistered.args.idCommitment,
-        membershipRateLimit: memberRegistered.args.membershipRateLimit,
+        rateLimit: memberRegistered.args.rateLimit,
         index: memberRegistered.args.index
       };
 
       log.info(
         `Successfully registered membership with index ${decodedData.index} ` +
-          `and rate limit ${decodedData.membershipRateLimit}`
+          `and rate limit ${decodedData.rateLimit}`
       );
 
       const network = await this.contract.provider.getNetwork();
       const address = this.contract.address;
-      const membershipId = Number(decodedData.index);
+      const membershipId = decodedData.index.toNumber();
 
       return {
         identity,
         membership: {
           address,
           treeIndex: membershipId,
-          chainId: network.chainId,
-          rateLimit: decodedData.membershipRateLimit.toNumber()
+          chainId: network.chainId
         }
       };
     } catch (error) {
-      if (error instanceof Error) {
-        const errorMessage = error.message;
-        log.error("registerWithIdentity - error message:", errorMessage);
-        log.error("registerWithIdentity - error stack:", error.stack);
-
-        // Try to extract more specific error information
-        if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
-          throw new Error(
-            "Registration failed: Cannot exceed maximum total rate limit"
-          );
-        } else if (errorMessage.includes("InvalidIdCommitment")) {
-          throw new Error("Registration failed: Invalid ID commitment");
-        } else if (errorMessage.includes("InvalidMembershipRateLimit")) {
-          throw new Error("Registration failed: Invalid membership rate limit");
-        } else if (errorMessage.includes("execution reverted")) {
-          throw new Error(
-            "Contract execution reverted. Check contract requirements."
-          );
-        } else {
-          throw new Error(`Error in registerWithIdentity: ${errorMessage}`);
-        }
-      } else {
-        throw new Error("Unknown error in registerWithIdentity", {
-          cause: error
-        });
-      }
+      log.error(`Error in registerWithIdentity: ${(error as Error).message}`);
+      return undefined;
     }
   }
 
@@ -585,26 +467,25 @@ export class RLNContract {
 
       const decodedData: MembershipRegisteredEvent = {
         idCommitment: memberRegistered.args.idCommitment,
-        membershipRateLimit: memberRegistered.args.membershipRateLimit,
+        rateLimit: memberRegistered.args.rateLimit,
         index: memberRegistered.args.index
       };
 
       log.info(
         `Successfully registered membership with permit. Index: ${decodedData.index}, ` +
-          `Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`
+          `Rate limit: ${decodedData.rateLimit}, Erased ${idCommitmentsToErase.length} commitments`
       );
 
       const network = await this.contract.provider.getNetwork();
       const address = this.contract.address;
-      const membershipId = ethers.BigNumber.from(decodedData.index).toNumber();
+      const membershipId = decodedData.index.toNumber();
 
       return {
         identity,
         membership: {
           address,
           treeIndex: membershipId,
-          chainId: network.chainId,
-          rateLimit: decodedData.membershipRateLimit.toNumber()
+          chainId: network.chainId
         }
       };
     } catch (error) {
@@ -679,9 +560,16 @@ export class RLNContract {
 
   public async registerMembership(
     idCommitment: string,
-    rateLimit: number = this.rateLimit
+    rateLimit: number = DEFAULT_RATE_LIMIT
   ): Promise<ethers.ContractTransaction> {
-    this.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}`
+      );
+    }
     return this.contract.register(idCommitment, rateLimit, []);
   }
 

package/src/index.ts

@@ -1,19 +1,15 @@
 import { RLNDecoder, RLNEncoder } from "./codec.js";
 import { RLN_ABI } from "./contract/abi.js";
-import { LINEA_CONTRACT, RLNContract } from "./contract/index.js";
-import { RLNLightContract } from "./contract/rln_light_contract.js";
+import { RLNContract, SEPOLIA_CONTRACT } from "./contract/index.js";
 import { createRLN } from "./create.js";
 import { IdentityCredential } from "./identity.js";
 import { Keystore } from "./keystore/index.js";
 import { Proof } from "./proof.js";
 import { RLNInstance } from "./rln.js";
-import { RLNLightInstance } from "./rln_light.js";
 import { MerkleRootTracker } from "./root_tracker.js";
 import { extractMetaMaskSigner } from "./utils/index.js";
 
 export {
-  RLNLightInstance,
-  RLNLightContract,
   createRLN,
   Keystore,
   RLNInstance,
@@ -23,18 +19,7 @@ export {
   RLNDecoder,
   MerkleRootTracker,
   RLNContract,
-  LINEA_CONTRACT,
+  SEPOLIA_CONTRACT,
   extractMetaMaskSigner,
   RLN_ABI
 };
-
-export type {
-  DecryptedCredentials,
-  EncryptedCredentials,
-  Keccak256Hash,
-  KeystoreEntity,
-  MembershipHash,
-  MembershipInfo,
-  Password,
-  Sha256Hash
-} from "./keystore/types.js";

package/src/keystore/keystore.ts

@@ -274,8 +274,7 @@ export class Keystore {
         membership: {
           treeIndex: _.get(obj, "treeIndex"),
           chainId: _.get(obj, "membershipContract.chainId"),
-          address: _.get(obj, "membershipContract.address"),
-          rateLimit: _.get(obj, "membershipContract.rateLimit")
+          address: _.get(obj, "membershipContract.address")
         }
       };
     } catch (err) {

package/src/keystore/types.ts

@@ -11,7 +11,6 @@ export type MembershipInfo = {
   chainId: number;
   address: string;
   treeIndex: number;
-  rateLimit: number;
 };
 
 export type KeystoreEntity = {

package/src/rln.ts

@@ -16,7 +16,7 @@ import {
   type RLNEncoder
 } from "./codec.js";
 import { DEFAULT_RATE_LIMIT } from "./contract/constants.js";
-import { LINEA_CONTRACT, RLNContract } from "./contract/index.js";
+import { RLNContract, SEPOLIA_CONTRACT } from "./contract/index.js";
 import { IdentityCredential } from "./identity.js";
 import { Keystore } from "./keystore/index.js";
 import type {
@@ -108,7 +108,7 @@ type StartRLNOptions = {
    */
   signer?: ethers.Signer;
   /**
-   * If not set - will use default LINEA_CONTRACT address.
+   * If not set - will use default SEPOLIA_CONTRACT address.
    */
   address?: string;
   /**
@@ -160,7 +160,7 @@ export class RLNInstance {
     try {
       const { credentials, keystore } =
         await RLNInstance.decryptCredentialsIfNeeded(options.credentials);
-      const { signer, address, rateLimit } = await this.determineStartOptions(
+      const { signer, address } = await this.determineStartOptions(
         options,
         credentials
       );
@@ -174,7 +174,7 @@ export class RLNInstance {
       this._contract = await RLNContract.init(this, {
         address: address!,
         signer: signer!,
-        rateLimit: rateLimit ?? this.zerokit.getRateLimit
+        rateLimit: options.rateLimit ?? this.zerokit.getRateLimit
       });
       this.started = true;
     } finally {
@@ -190,10 +190,10 @@ export class RLNInstance {
     const address =
       credentials?.membership.address ||
       options.address ||
-      LINEA_CONTRACT.address;
+      SEPOLIA_CONTRACT.address;
 
-    if (address === LINEA_CONTRACT.address) {
-      chainId = LINEA_CONTRACT.chainId;
+    if (address === SEPOLIA_CONTRACT.address) {
+      chainId = SEPOLIA_CONTRACT.chainId;
     }
 
     const signer = options.signer || (await extractMetaMaskSigner());