@waku/rln 0.1.1 → 0.1.2-e1679b6

package/src/rln_contract.ts

@@ -1,19 +1,30 @@
+import { hexToBytes } from "@waku/utils/bytes";
 import { ethers } from "ethers";
 
-import { RLN_ABI } from "./constants.js";
-import { IdentityCredential, RLNInstance } from "./rln.js";
-import { MerkleRootTracker } from "./root_tracker";
+import { zeroPadLE } from "./byte_utils.js";
+import { RLN_REGISTRY_ABI, RLN_STORAGE_ABI } from "./constants.js";
+import type { DecryptedCredentials } from "./keystore/index.js";
+import { type IdentityCredential, RLNInstance } from "./rln.js";
+import { MerkleRootTracker } from "./root_tracker.js";
 
 type Member = {
-  pubkey: string;
-  index: number;
+  idCommitment: string;
+  index: ethers.BigNumber;
 };
 
-type ContractOptions = {
-  address: string;
-  provider: ethers.Signer | ethers.providers.Provider;
+type Signer = ethers.Signer;
+
+type RLNContractOptions = {
+  signer: Signer;
+  registryAddress: string;
+};
+
+type RLNStorageOptions = {
+  storageIndex?: number;
 };
 
+type RLNContractInitOptions = RLNContractOptions & RLNStorageOptions;
+
 type FetchMembersOptions = {
   fromBlock?: number;
   fetchRange?: number;
@@ -21,18 +32,23 @@ type FetchMembersOptions = {
 };
 
 export class RLNContract {
-  private _contract: ethers.Contract;
-  private membersFilter: ethers.EventFilter;
+  private registryContract: ethers.Contract;
   private merkleRootTracker: MerkleRootTracker;
 
-  private _members: Member[] = [];
+  private deployBlock: undefined | number;
+  private storageIndex: undefined | number;
+  private storageContract: undefined | ethers.Contract;
+  private _membersFilter: undefined | ethers.EventFilter;
+
+  private _members: Map<number, Member> = new Map();
 
   public static async init(
     rlnInstance: RLNInstance,
-    options: ContractOptions
+    options: RLNContractInitOptions
   ): Promise<RLNContract> {
     const rlnContract = new RLNContract(rlnInstance, options);
 
+    await rlnContract.initStorageContract(options.signer);
     await rlnContract.fetchMembers(rlnInstance);
     rlnContract.subscribeToMembers(rlnInstance);
 
@@ -41,21 +57,68 @@ export class RLNContract {
 
   constructor(
     rlnInstance: RLNInstance,
-    { address, provider }: ContractOptions
+    { registryAddress, signer }: RLNContractOptions
   ) {
     const initialRoot = rlnInstance.getMerkleRoot();
 
-    this._contract = new ethers.Contract(address, RLN_ABI, provider);
+    this.registryContract = new ethers.Contract(
+      registryAddress,
+      RLN_REGISTRY_ABI,
+      signer
+    );
     this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
-    this.membersFilter = this.contract.filters.MemberRegistered();
+  }
+
+  private async initStorageContract(
+    signer: Signer,
+    options: RLNStorageOptions = {}
+  ): Promise<void> {
+    const storageIndex = options?.storageIndex
+      ? options.storageIndex
+      : await this.registryContract.usingStorageIndex();
+    const storageAddress = await this.registryContract.storages(storageIndex);
+
+    if (!storageAddress || storageAddress === ethers.constants.AddressZero) {
+      throw Error("No RLN Storage initialized on registry contract.");
+    }
+
+    this.storageIndex = storageIndex;
+    this.storageContract = new ethers.Contract(
+      storageAddress,
+      RLN_STORAGE_ABI,
+      signer
+    );
+    this._membersFilter = this.storageContract.filters.MemberRegistered();
+
+    this.deployBlock = await this.storageContract.deployedBlockNumber();
+  }
+
+  public get registry(): ethers.Contract {
+    if (!this.registryContract) {
+      throw Error("Registry contract was not initialized");
+    }
+    return this.registryContract as ethers.Contract;
   }
 
   public get contract(): ethers.Contract {
-    return this._contract;
+    if (!this.storageContract) {
+      throw Error("Storage contract was not initialized");
+    }
+    return this.storageContract as ethers.Contract;
   }
 
   public get members(): Member[] {
-    return this._members;
+    const sortedMembers = Array.from(this._members.values()).sort(
+      (left, right) => left.index.toNumber() - right.index.toNumber()
+    );
+    return sortedMembers;
+  }
+
+  private get membersFilter(): ethers.EventFilter {
+    if (!this._membersFilter) {
+      throw Error("Members filter was not initialized.");
+    }
+    return this._membersFilter as ethers.EventFilter;
   }
 
   public async fetchMembers(
@@ -63,6 +126,7 @@ export class RLNContract {
     options: FetchMembersOptions = {}
   ): Promise<void> {
     const registeredMemberEvents = await queryFilter(this.contract, {
+      fromBlock: this.deployBlock,
       ...options,
       membersFilter: this.membersFilter,
     });
@@ -79,13 +143,13 @@ export class RLNContract {
       }
 
       if (evt.removed) {
-        const index: number = evt.args.index;
+        const index: ethers.BigNumber = evt.args.index;
         const toRemoveVal = toRemoveTable.get(evt.blockNumber);
         if (toRemoveVal != undefined) {
-          toRemoveVal.push(index);
+          toRemoveVal.push(index.toNumber());
           toRemoveTable.set(evt.blockNumber, toRemoveVal);
         } else {
-          toRemoveTable.set(evt.blockNumber, [index]);
+          toRemoveTable.set(evt.blockNumber, [index.toNumber()]);
         }
       } else {
         let eventsPerBlock = toInsertTable.get(evt.blockNumber);
@@ -96,10 +160,10 @@ export class RLNContract {
         eventsPerBlock.push(evt);
         toInsertTable.set(evt.blockNumber, eventsPerBlock);
       }
-
-      this.removeMembers(rlnInstance, toRemoveTable);
-      this.insertMembers(rlnInstance, toInsertTable);
     });
+
+    this.removeMembers(rlnInstance, toRemoveTable);
+    this.insertMembers(rlnInstance, toInsertTable);
   }
 
   private insertMembers(
@@ -108,18 +172,19 @@ export class RLNContract {
   ): void {
     toInsert.forEach((events: ethers.Event[], blockNumber: number) => {
       events.forEach((evt) => {
-        if (!evt.args) {
+        const _idCommitment = evt?.args?.idCommitment;
+        const index: ethers.BigNumber = evt?.args?.index;
+
+        if (!_idCommitment || !index) {
           return;
         }
 
-        const pubkey = evt.args.pubkey;
-        const index = evt.args.index;
-        const idCommitment = ethers.utils.zeroPad(
-          ethers.utils.arrayify(pubkey),
-          32
-        );
+        const idCommitment = zeroPadLE(hexToBytes(_idCommitment?._hex), 32);
         rlnInstance.insertMember(idCommitment);
-        this.members.push({ index, pubkey });
+        this._members.set(index.toNumber(), {
+          index,
+          idCommitment: _idCommitment?._hex,
+        });
       });
 
       const currentRoot = rlnInstance.getMerkleRoot();
@@ -134,9 +199,8 @@ export class RLNContract {
     const removeDescending = new Map([...toRemove].sort().reverse());
     removeDescending.forEach((indexes: number[], blockNumber: number) => {
       indexes.forEach((index) => {
-        const idx = this.members.findIndex((m) => m.index === index);
-        if (idx > -1) {
-          this.members.splice(idx, 1);
+        if (this._members.has(index)) {
+          this._members.delete(index);
         }
         rlnInstance.deleteMember(index);
       });
@@ -147,32 +211,50 @@ export class RLNContract {
 
   public subscribeToMembers(rlnInstance: RLNInstance): void {
     this.contract.on(this.membersFilter, (_pubkey, _index, event) =>
-      this.processEvents(rlnInstance, event)
+      this.processEvents(rlnInstance, [event])
     );
   }
 
-  public async registerWithSignature(
-    rlnInstance: RLNInstance,
-    signature: string
-  ): Promise<ethers.Event | undefined> {
-    const identityCredential =
-      await rlnInstance.generateSeededIdentityCredential(signature);
+  public async registerWithIdentity(
+    identity: IdentityCredential
+  ): Promise<DecryptedCredentials | undefined> {
+    if (this.storageIndex === undefined) {
+      throw Error(
+        "Cannot register credential, no storage contract index found."
+      );
+    }
+    const txRegisterResponse: ethers.ContractTransaction =
+      await this.registryContract["register(uint16,uint256)"](
+        this.storageIndex,
+        identity.IDCommitmentBigInt,
+        { gasLimit: 100000 }
+      );
+    const txRegisterReceipt = await txRegisterResponse.wait();
 
-    return this.registerWithKey(identityCredential);
-  }
+    // assumption: register(uint16,uint256) emits one event
+    const memberRegistered = txRegisterReceipt?.events?.[0];
 
-  public async registerWithKey(
-    credential: IdentityCredential
-  ): Promise<ethers.Event | undefined> {
-    const depositValue = await this.contract.MEMBERSHIP_DEPOSIT();
+    if (!memberRegistered) {
+      return undefined;
+    }
 
-    const txRegisterResponse: ethers.ContractTransaction =
-      await this.contract.register(credential.IDCommitmentBigInt, {
-        value: depositValue,
-      });
-    const txRegisterReceipt = await txRegisterResponse.wait();
+    const decodedData = this.contract.interface.decodeEventLog(
+      "MemberRegistered",
+      memberRegistered.data
+    );
 
-    return txRegisterReceipt?.events?.[0];
+    const network = await this.registryContract.provider.getNetwork();
+    const address = this.registryContract.address;
+    const membershipId = decodedData.index.toNumber();
+
+    return {
+      identity,
+      membership: {
+        address,
+        treeIndex: membershipId,
+        chainId: network.chainId,
+      },
+    };
   }
 
   public roots(): Uint8Array[] {