@waku/rln 0.1.0 → 0.1.1-0fbf6be

package/src/message.ts

@@ -14,7 +14,7 @@ export function toRLNSignal(contentTopic: string, msg: IMessage): Uint8Array {
 }
 
 export class RlnMessage<T extends IDecodedMessage> implements IDecodedMessage {
-  public pubSubTopic = "";
+  public pubsubTopic = "";
 
   constructor(
     public rlnInstance: RLNInstance,
@@ -22,11 +22,12 @@ export class RlnMessage<T extends IDecodedMessage> implements IDecodedMessage {
     public rateLimitProof: IRateLimitProof | undefined
   ) {}
 
-  public verify(): boolean | undefined {
+  public verify(roots: Uint8Array[]): boolean | undefined {
     return this.rateLimitProof
       ? this.rlnInstance.verifyWithRoots(
           this.rateLimitProof,
-          toRLNSignal(this.msg.contentTopic, this.msg)
+          toRLNSignal(this.msg.contentTopic, this.msg),
+          ...roots
         ) // this.rlnInstance.verifyRLNProof once issue status-im/nwaku#1248 is fixed
       : undefined;
   }
@@ -56,6 +57,10 @@ export class RlnMessage<T extends IDecodedMessage> implements IDecodedMessage {
     return this.msg.ephemeral;
   }
 
+  get meta(): Uint8Array | undefined {
+    return this.msg.meta;
+  }
+
   get epoch(): number | undefined {
     const bytes = this.msg.rateLimitProof?.epoch;
     if (!bytes) return;

package/src/rln.ts

@@ -1,7 +1,8 @@
 import type { IRateLimitProof } from "@waku/interfaces";
-import init, * as zerokitRLN from "@waku/zerokit-rln-wasm";
+import init from "@waku/zerokit-rln-wasm";
+import * as zerokitRLN from "@waku/zerokit-rln-wasm";
 
-import { writeUIntLE } from "./byte_utils.js";
+import { buildBigIntFromUint8Array, writeUIntLE } from "./byte_utils.js";
 import { dateToEpoch, epochIntToBytes } from "./epoch.js";
 import verificationKey from "./resources/verification_key.js";
 import * as wc from "./witness_calculator.js";
@@ -26,16 +27,6 @@ function concatenate(...input: Uint8Array[]): Uint8Array {
   return result;
 }
 
-/**
- * Transforms Uint8Array into BigInt
- * @param array: Uint8Array
- * @returns BigInt
- */
-function buildBigIntFromUint8Array(array: Uint8Array): bigint {
-  const dataView = new DataView(array.buffer);
-  return dataView.getBigUint64(0, true);
-}
-
 const stringEncoder = new TextEncoder();
 
 const DEPTH = 20;
@@ -57,7 +48,7 @@ async function loadZkey(): Promise<Uint8Array> {
  * @returns RLNInstance
  */
 export async function create(): Promise<RLNInstance> {
-  await init();
+  await (init as any)?.();
   zerokitRLN.init_panic_hook();
   const witnessCalculator = await loadWitnessCalculator();
   const zkey = await loadZkey();

package/src/rln_contract.ts

@@ -1,18 +1,27 @@
 import { ethers } from "ethers";
 
-import { RLN_ABI } from "./constants.js";
+import { RLN_REGISTRY_ABI, RLN_STORAGE_ABI } from "./constants.js";
 import { 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 Provider = ethers.Signer | ethers.providers.Provider;
+
+type RLNContractOptions = {
+  provider: Provider;
+  registryAddress: string;
+};
+
+type RLNStorageOptions = {
+  storageIndex?: number;
 };
 
+type RLNContractInitOptions = RLNContractOptions & RLNStorageOptions;
+
 type FetchMembersOptions = {
   fromBlock?: number;
   fetchRange?: number;
@@ -20,34 +29,86 @@ 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(options);
+    const rlnContract = new RLNContract(rlnInstance, options);
 
+    await rlnContract.initStorageContract(options.provider);
     await rlnContract.fetchMembers(rlnInstance);
     rlnContract.subscribeToMembers(rlnInstance);
 
     return rlnContract;
   }
 
-  constructor({ address, provider }: ContractOptions) {
-    this._contract = new ethers.Contract(address, RLN_ABI, provider);
-    this.membersFilter = this.contract.filters.MemberRegistered();
+  constructor(
+    rlnInstance: RLNInstance,
+    { registryAddress, provider }: RLNContractOptions
+  ) {
+    const initialRoot = rlnInstance.getMerkleRoot();
+
+    this.registryContract = new ethers.Contract(
+      registryAddress,
+      RLN_REGISTRY_ABI,
+      provider
+    );
+    this.merkleRootTracker = new MerkleRootTracker(10000, initialRoot);
+  }
+
+  private async initStorageContract(
+    provider: Provider,
+    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,
+      provider
+    );
+    this._membersFilter = this.storageContract.filters.MemberRegistered();
+
+    this.deployBlock = await this.storageContract.deployedBlockNumber();
   }
 
   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(
@@ -55,45 +116,103 @@ export class RLNContract {
     options: FetchMembersOptions = {}
   ): Promise<void> {
     const registeredMemberEvents = await queryFilter(this.contract, {
+      fromBlock: this.deployBlock,
       ...options,
       membersFilter: this.membersFilter,
     });
-
-    for (const event of registeredMemberEvents) {
-      this.addMemberFromEvent(rlnInstance, event);
-    }
+    this.processEvents(rlnInstance, registeredMemberEvents);
   }
 
-  public subscribeToMembers(rlnInstance: RLNInstance): void {
-    this.contract.on(this.membersFilter, (_pubkey, _index, event) =>
-      this.addMemberFromEvent(rlnInstance, event)
-    );
+  public processEvents(rlnInstance: RLNInstance, events: ethers.Event[]): void {
+    const toRemoveTable = new Map<number, number[]>();
+    const toInsertTable = new Map<number, ethers.Event[]>();
+
+    events.forEach((evt) => {
+      if (!evt.args) {
+        return;
+      }
+
+      if (evt.removed) {
+        const index: ethers.BigNumber = evt.args.index;
+        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 {
+        let eventsPerBlock = toInsertTable.get(evt.blockNumber);
+        if (eventsPerBlock == undefined) {
+          eventsPerBlock = [];
+        }
+
+        eventsPerBlock.push(evt);
+        toInsertTable.set(evt.blockNumber, eventsPerBlock);
+      }
+    });
+
+    this.removeMembers(rlnInstance, toRemoveTable);
+    this.insertMembers(rlnInstance, toInsertTable);
   }
 
-  private addMemberFromEvent(
+  private insertMembers(
     rlnInstance: RLNInstance,
-    event: ethers.Event
+    toInsert: Map<number, ethers.Event[]>
   ): void {
-    if (!event.args) {
-      return;
-    }
+    toInsert.forEach((events: ethers.Event[], blockNumber: number) => {
+      events.forEach((evt) => {
+        const _idCommitment = evt?.args?.idCommitment;
+        const index: ethers.BigNumber = evt?.args?.index;
+
+        if (!_idCommitment || !index) {
+          return;
+        }
+
+        const idCommitment = ethers.utils.zeroPad(
+          ethers.utils.arrayify(_idCommitment),
+          32
+        );
+        rlnInstance.insertMember(idCommitment);
+        this._members.set(index.toNumber(), {
+          index,
+          idCommitment:
+            _idCommitment?._hex || ethers.utils.hexlify(idCommitment),
+        });
+      });
+
+      const currentRoot = rlnInstance.getMerkleRoot();
+      this.merkleRootTracker.pushRoot(blockNumber, currentRoot);
+    });
+  }
 
-    const pubkey: string = event.args.pubkey;
-    const index: number = event.args.index;
+  private removeMembers(
+    rlnInstance: RLNInstance,
+    toRemove: Map<number, number[]>
+  ): void {
+    const removeDescending = new Map([...toRemove].sort().reverse());
+    removeDescending.forEach((indexes: number[], blockNumber: number) => {
+      indexes.forEach((index) => {
+        if (this._members.has(index)) {
+          this._members.delete(index);
+        }
+        rlnInstance.deleteMember(index);
+      });
 
-    this.members.push({ index, pubkey });
+      this.merkleRootTracker.backFill(blockNumber);
+    });
+  }
 
-    const idCommitment = ethers.utils.zeroPad(
-      ethers.utils.arrayify(pubkey),
-      32
+  public subscribeToMembers(rlnInstance: RLNInstance): void {
+    this.contract.on(this.membersFilter, (_pubkey, _index, event) =>
+      this.processEvents(rlnInstance, [event])
     );
-    rlnInstance.insertMember(idCommitment);
   }
 
   public async registerWithSignature(
     rlnInstance: RLNInstance,
     signature: string
-  ): Promise<ethers.Event | undefined> {
+  ): Promise<Member | undefined> {
     const identityCredential =
       await rlnInstance.generateSeededIdentityCredential(signature);
 
@@ -102,16 +221,40 @@ export class RLNContract {
 
   public async registerWithKey(
     credential: IdentityCredential
-  ): Promise<ethers.Event | undefined> {
-    const depositValue = await this.contract.MEMBERSHIP_DEPOSIT();
-
+  ): Promise<Member | undefined> {
+    if (this.storageIndex === undefined) {
+      throw Error(
+        "Cannot register credential, no storage contract index found."
+      );
+    }
     const txRegisterResponse: ethers.ContractTransaction =
-      await this.contract.register(credential.IDCommitmentBigInt, {
-        value: depositValue,
-      });
+      await this.registryContract["register(uint16,uint256)"](
+        this.storageIndex,
+        credential.IDCommitmentBigInt,
+        { gasLimit: 100000 }
+      );
     const txRegisterReceipt = await txRegisterResponse.wait();
 
-    return txRegisterReceipt?.events?.[0];
+    // assumption: register(uint16,uint256) emits one event
+    const memberRegistered = txRegisterReceipt?.events?.[0];
+
+    if (!memberRegistered) {
+      return undefined;
+    }
+
+    const decodedData = this.contract.interface.decodeEventLog(
+      "MemberRegistered",
+      memberRegistered.data
+    );
+
+    return {
+      idCommitment: decodedData.idCommitment,
+      index: decodedData.index,
+    };
+  }
+
+  public roots(): Uint8Array[] {
+    return this.merkleRootTracker.roots();
   }
 }