@waku/rln 0.1.5-053bb95.0 → 0.1.5-35b50c3.0

package/src/contract/rln_contract.ts

@@ -1,11 +1,11 @@
 import { Logger } from "@waku/utils";
 import { hexToBytes } from "@waku/utils/bytes";
+import { ethers } from "ethers";
 
 import type { RLNInstance } from "../rln.js";
 import { MerkleRootTracker } from "../root_tracker.js";
 import { zeroPadLE } from "../utils/bytes.js";
 
-import { ContractStateError } from "./errors.js";
 import { RLNBaseContract } from "./rln_base_contract.js";
 import { RLNContractInitOptions } from "./types.js";
 
@@ -14,7 +14,6 @@ const log = new Logger("waku:rln:contract");
 export class RLNContract extends RLNBaseContract {
   private instance: RLNInstance;
   private merkleRootTracker: MerkleRootTracker;
-  private lastSyncedBlock: number = 0;
 
   /**
    * Asynchronous initializer for RLNContract.
@@ -25,42 +24,8 @@ export class RLNContract extends RLNBaseContract {
     options: RLNContractInitOptions
   ): Promise<RLNContract> {
     const rlnContract = new RLNContract(rlnInstance, options);
-    await rlnContract.syncState();
-    return rlnContract;
-  }
-
-  /**
-   * Override base contract method to keep Merkle tree in sync
-   * Registers a new membership with the given commitment and rate limit
-   */
-  public override async registerMembership(
-    idCommitment: string,
-    rateLimit: number = this.getRateLimit()
-  ): Promise<void> {
-    await super.registerMembership(idCommitment, rateLimit);
-    await this.syncState();
-  }
 
-  /**
-   * Override base contract method to keep Merkle tree in sync
-   * Erases an existing membership from the contract
-   */
-  public override async eraseMembership(
-    idCommitment: string,
-    eraseFromMembershipSet: boolean = true
-  ): Promise<void> {
-    await super.eraseMembership(idCommitment, eraseFromMembershipSet);
-    await this.syncState();
-  }
-
-  /**
-   * Gets the current Merkle root
-   * Returns the latest valid root or empty array if no roots exist
-   */
-  public async getMerkleRoot(): Promise<Uint8Array> {
-    await this.syncState();
-    const roots = this.merkleRootTracker.roots();
-    return roots.length > 0 ? roots[0] : new Uint8Array();
+    return rlnContract;
   }
 
   private constructor(
@@ -68,102 +33,112 @@ export class RLNContract extends RLNBaseContract {
     options: RLNContractInitOptions
   ) {
     super(options);
+
     this.instance = rlnInstance;
+
     const initialRoot = rlnInstance.zerokit.getMerkleRoot();
     this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
   }
 
-  /**
-   * Syncs the local Merkle tree with the current contract state
-   */
-  private async syncState(): Promise<void> {
-    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;
+  public override processEvents(events: ethers.Event[]): void {
+    const toRemoveTable = new Map<number, number[]>();
+    const toInsertTable = new Map<number, ethers.Event[]>();
+
+    events.forEach((evt) => {
+      if (!evt.args) {
         return;
       }
 
-      // 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);
-        } catch (error) {
-          // Ignore errors for non-existent members
-          continue;
+      if (
+        evt.event === "MembershipErased" ||
+        evt.event === "MembershipExpired"
+      ) {
+        let index = evt.args.index;
+
+        if (!index) {
+          return;
         }
-      }
 
-      // Insert all members
-      for (const member of members) {
-        const idCommitment = zeroPadLE(hexToBytes(member.idCommitment), 32);
-        this.instance.zerokit.insertMember(idCommitment);
+        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;
+        }
+
+        const toRemoveVal = toRemoveTable.get(evt.blockNumber);
+        if (toRemoveVal != undefined) {
+          toRemoveVal.push(index.toNumber());
+          toRemoveTable.set(evt.blockNumber, toRemoveVal);
+        } else {
+          toRemoveTable.set(evt.blockNumber, [index.toNumber()]);
+        }
+      } else if (evt.event === "MembershipRegistered") {
+        let eventsPerBlock = toInsertTable.get(evt.blockNumber);
+        if (eventsPerBlock == undefined) {
+          eventsPerBlock = [];
+        }
+
+        eventsPerBlock.push(evt);
+        toInsertTable.set(evt.blockNumber, eventsPerBlock);
       }
+    });
 
-      // 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("Failed to sync state", error);
-      throw new ContractStateError("Failed to sync contract state");
-    }
+    this.removeMembers(this.instance, toRemoveTable);
+    this.insertMembers(this.instance, toInsertTable);
   }
 
-  /**
-   * Syncs new members added between fromBlock and toBlock
-   */
-  private async syncNewMembers(
-    fromBlock: number,
-    toBlock: number
-  ): Promise<void> {
-    // 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()
-      );
-    }
+  private insertMembers(
+    rlnInstance: RLNInstance,
+    toInsert: Map<number, ethers.Event[]>
+  ): void {
+    toInsert.forEach((events: ethers.Event[], blockNumber: number) => {
+      events.forEach((evt) => {
+        if (!evt.args) return;
+
+        const _idCommitment = evt.args.idCommitment as string;
+        let index = evt.args.index;
+
+        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, {
+          index,
+          idCommitment: _idCommitment
+        });
+      });
+
+      const currentRoot = rlnInstance.zerokit.getMerkleRoot();
+      this.merkleRootTracker.pushRoot(blockNumber, currentRoot);
+    });
+  }
+
+  private removeMembers(
+    rlnInstance: RLNInstance,
+    toRemove: Map<number, number[]>
+  ): void {
+    const removeDescending = new Map([...toRemove].reverse());
+    removeDescending.forEach((indexes: number[], blockNumber: number) => {
+      indexes.forEach((index) => {
+        if (this._members.has(index)) {
+          this._members.delete(index);
+          rlnInstance.zerokit.deleteMember(index);
+        }
+      });
+
+      this.merkleRootTracker.backFill(blockNumber);
+    });
   }
 }

package/src/contract/types.ts

@@ -38,6 +38,11 @@ export interface MembershipInfo {
   startBlock: number;
   endBlock: number;
   state: MembershipState;
+  depositAmount: ethers.BigNumber;
+  activeDuration: number;
+  gracePeriodDuration: number;
+  holder: string;
+  token: string;
 }
 
 export enum MembershipState {

package/src/credentials_manager.ts

@@ -155,7 +155,7 @@ export class RLNCredentialsManager {
       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}`);
     }
 

package/src/identity.ts

@@ -28,13 +28,4 @@ export class IdentityCredential {
       idCommitmentBigInt
     );
   }
-
-  public toJSON(): Record<string, number[]> {
-    return {
-      idTrapdoor: Array.from(this.IDTrapdoor),
-      idNullifier: Array.from(this.IDNullifier),
-      idSecretHash: Array.from(this.IDSecretHash),
-      idCommitment: Array.from(this.IDCommitment)
-    };
-  }
 }

package/src/index.ts

@@ -34,7 +34,9 @@ export type {
   Keccak256Hash,
   KeystoreEntity,
   MembershipHash,
-  MembershipInfo,
+  KeystoreMembershipInfo,
   Password,
   Sha256Hash
 } from "./keystore/types.js";
+
+export * from "./contract/index.js";

package/src/keystore/keystore.ts

@@ -14,7 +14,6 @@ import {
 import _ from "lodash";
 import { v4 as uuidV4 } from "uuid";
 
-import { IdentityCredential } from "../identity.js";
 import { buildBigIntFromUint8Array } from "../utils/bytes.js";
 
 import { decryptEipKeystore, keccak256Checksum } from "./cipher.js";
@@ -22,8 +21,8 @@ import { isCredentialValid, isKeystoreValid } from "./schema_validator.js";
 import type {
   Keccak256Hash,
   KeystoreEntity,
+  KeystoreMembershipInfo,
   MembershipHash,
-  MembershipInfo,
   Password,
   Sha256Hash
 } from "./types.js";
@@ -251,27 +250,27 @@ export class Keystore {
       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"),
@@ -285,9 +284,35 @@ export class Keystore {
     }
   }
 
+  private static fromArraylikeToBytes(
+    obj:
+      | number[]
+      | {
+          [key: number]: number;
+        }
+  ): Uint8Array {
+    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
-  private static computeMembershipHash(info: MembershipInfo): MembershipHash {
+  private static computeMembershipHash(
+    info: KeystoreMembershipInfo
+  ): MembershipHash {
     return bytesToHex(
       sha256(utf8ToBytes(`${info.chainId}${info.address}${info.treeIndex}`))
     ).toUpperCase();
@@ -298,16 +323,16 @@ export class Keystore {
   private static fromIdentityToBytes(options: KeystoreEntity): Uint8Array {
     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/src/keystore/types.ts

@@ -7,7 +7,7 @@ export type Password = string | Uint8Array;
 
 // see reference
 // https://github.com/waku-org/nwaku/blob/f05528d4be3d3c876a8b07f9bb7dfaae8aa8ec6e/waku/waku_keystore/protocol_types.nim#L111
-export type MembershipInfo = {
+export type KeystoreMembershipInfo = {
   chainId: string;
   address: string;
   treeIndex: number;
@@ -16,7 +16,7 @@ export type MembershipInfo = {
 
 export type KeystoreEntity = {
   identity: IdentityCredential;
-  membership: MembershipInfo;
+  membership: KeystoreMembershipInfo;
 };
 
 export type DecryptedCredentials = KeystoreEntity;

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

@@ -1,62 +0,0 @@
-class RLNContractError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "RLNContractError";
-    }
-}
-class MembershipError extends RLNContractError {
-    constructor(message) {
-        super(message);
-        this.name = "MembershipError";
-    }
-}
-class RateLimitError extends RLNContractError {
-    constructor(message) {
-        super(message);
-        this.name = "RateLimitError";
-    }
-}
-class InvalidMembershipError extends MembershipError {
-    constructor(idCommitment) {
-        super(`Invalid membership ID commitment: ${idCommitment}`);
-        this.name = "InvalidMembershipError";
-    }
-}
-class MembershipNotFoundError extends MembershipError {
-    constructor(idCommitment) {
-        super(`Membership not found for ID commitment: ${idCommitment}`);
-        this.name = "MembershipNotFoundError";
-    }
-}
-class MembershipExistsError extends MembershipError {
-    constructor(idCommitment, index) {
-        super(`Membership already exists for ID commitment: ${idCommitment} at index ${index}`);
-        this.name = "MembershipExistsError";
-    }
-}
-class RateLimitExceededError extends RateLimitError {
-    constructor(requested, available) {
-        super(`Rate limit exceeded. Requested: ${requested}, Available: ${available}`);
-        this.name = "RateLimitExceededError";
-    }
-}
-class InvalidRateLimitError extends RateLimitError {
-    constructor(rateLimit, minRate, maxRate) {
-        super(`Invalid rate limit: ${rateLimit}. Must be between ${minRate} and ${maxRate}`);
-        this.name = "InvalidRateLimitError";
-    }
-}
-class ContractStateError extends RLNContractError {
-    constructor(message) {
-        super(`Contract state error: ${message}`);
-        this.name = "ContractStateError";
-    }
-}
-class TransactionError extends RLNContractError {
-    constructor(message) {
-        super(`Transaction failed: ${message}`);
-        this.name = "TransactionError";
-    }
-}
-
-export { ContractStateError, InvalidMembershipError, InvalidRateLimitError, MembershipError, MembershipExistsError, MembershipNotFoundError, RLNContractError, RateLimitError, RateLimitExceededError, TransactionError };

package/dist/contract/errors.d.ts

@@ -1,30 +0,0 @@
-export declare class RLNContractError extends Error {
-    constructor(message: string);
-}
-export declare class MembershipError extends RLNContractError {
-    constructor(message: string);
-}
-export declare class RateLimitError extends RLNContractError {
-    constructor(message: string);
-}
-export declare class InvalidMembershipError extends MembershipError {
-    constructor(idCommitment: string);
-}
-export declare class MembershipNotFoundError extends MembershipError {
-    constructor(idCommitment: string);
-}
-export declare class MembershipExistsError extends MembershipError {
-    constructor(idCommitment: string, index: string);
-}
-export declare class RateLimitExceededError extends RateLimitError {
-    constructor(requested: number, available: number);
-}
-export declare class InvalidRateLimitError extends RateLimitError {
-    constructor(rateLimit: number, minRate: number, maxRate: number);
-}
-export declare class ContractStateError extends RLNContractError {
-    constructor(message: string);
-}
-export declare class TransactionError extends RLNContractError {
-    constructor(message: string);
-}

package/dist/contract/errors.js

@@ -1,61 +0,0 @@
-export class RLNContractError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "RLNContractError";
-    }
-}
-export class MembershipError extends RLNContractError {
-    constructor(message) {
-        super(message);
-        this.name = "MembershipError";
-    }
-}
-export class RateLimitError extends RLNContractError {
-    constructor(message) {
-        super(message);
-        this.name = "RateLimitError";
-    }
-}
-export class InvalidMembershipError extends MembershipError {
-    constructor(idCommitment) {
-        super(`Invalid membership ID commitment: ${idCommitment}`);
-        this.name = "InvalidMembershipError";
-    }
-}
-export class MembershipNotFoundError extends MembershipError {
-    constructor(idCommitment) {
-        super(`Membership not found for ID commitment: ${idCommitment}`);
-        this.name = "MembershipNotFoundError";
-    }
-}
-export class MembershipExistsError extends MembershipError {
-    constructor(idCommitment, index) {
-        super(`Membership already exists for ID commitment: ${idCommitment} at index ${index}`);
-        this.name = "MembershipExistsError";
-    }
-}
-export class RateLimitExceededError extends RateLimitError {
-    constructor(requested, available) {
-        super(`Rate limit exceeded. Requested: ${requested}, Available: ${available}`);
-        this.name = "RateLimitExceededError";
-    }
-}
-export class InvalidRateLimitError extends RateLimitError {
-    constructor(rateLimit, minRate, maxRate) {
-        super(`Invalid rate limit: ${rateLimit}. Must be between ${minRate} and ${maxRate}`);
-        this.name = "InvalidRateLimitError";
-    }
-}
-export class ContractStateError extends RLNContractError {
-    constructor(message) {
-        super(`Contract state error: ${message}`);
-        this.name = "ContractStateError";
-    }
-}
-export class TransactionError extends RLNContractError {
-    constructor(message) {
-        super(`Transaction failed: ${message}`);
-        this.name = "TransactionError";
-    }
-}
-//# sourceMappingURL=errors.js.map

package/dist/contract/errors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/contract/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACzC,YAAmB,OAAe;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;IACjC,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,gBAAgB;IACnD,YAAmB,OAAe;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,gBAAgB;IAClD,YAAmB,OAAe;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;IAC/B,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,eAAe;IACzD,YAAmB,YAAoB;QACrC,KAAK,CAAC,qCAAqC,YAAY,EAAE,CAAC,CAAC;QAC3D,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACvC,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,eAAe;IAC1D,YAAmB,YAAoB;QACrC,KAAK,CAAC,2CAA2C,YAAY,EAAE,CAAC,CAAC;QACjE,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;IACxC,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IACxD,YAAmB,YAAoB,EAAE,KAAa;QACpD,KAAK,CACH,gDAAgD,YAAY,aAAa,KAAK,EAAE,CACjF,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACtC,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,cAAc;IACxD,YAAmB,SAAiB,EAAE,SAAiB;QACrD,KAAK,CACH,mCAAmC,SAAS,gBAAgB,SAAS,EAAE,CACxE,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACvC,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IACvD,YAAmB,SAAiB,EAAE,OAAe,EAAE,OAAe;QACpE,KAAK,CACH,uBAAuB,SAAS,qBAAqB,OAAO,QAAQ,OAAO,EAAE,CAC9E,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACtC,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,gBAAgB;IACtD,YAAmB,OAAe;QAChC,KAAK,CAAC,yBAAyB,OAAO,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,gBAAgB;IACpD,YAAmB,OAAe;QAChC,KAAK,CAAC,uBAAuB,OAAO,EAAE,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;IACjC,CAAC;CACF"}