@waku/rln 0.0.1 → 0.0.2-09108d9.0

package/src/contract/rln_contract.ts

@@ -0,0 +1,353 @@
+import { Logger } from "@waku/utils";
+import { hexToBytes } from "@waku/utils/bytes";
+import { ethers } from "ethers";
+
+import type { IdentityCredential } from "../identity.js";
+import type { DecryptedCredentials } from "../keystore/index.js";
+import type { RLNInstance } from "../rln.js";
+import { MerkleRootTracker } from "../root_tracker.js";
+import { zeroPadLE } from "../utils/index.js";
+
+import { RLN_REGISTRY_ABI, RLN_STORAGE_ABI } from "./constants.js";
+
+const log = new Logger("waku:rln:contract");
+
+type Member = {
+  idCommitment: string;
+  index: ethers.BigNumber;
+};
+
+type Signer = ethers.Signer;
+
+type RLNContractOptions = {
+  signer: Signer;
+  registryAddress: string;
+};
+
+type RLNStorageOptions = {
+  storageIndex?: number;
+};
+
+type RLNContractInitOptions = RLNContractOptions & RLNStorageOptions;
+
+type FetchMembersOptions = {
+  fromBlock?: number;
+  fetchRange?: number;
+  fetchChunks?: number;
+};
+
+export class RLNContract {
+  private registryContract: ethers.Contract;
+  private merkleRootTracker: MerkleRootTracker;
+
+  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: RLNContractInitOptions
+  ): Promise<RLNContract> {
+    const rlnContract = new RLNContract(rlnInstance, options);
+
+    await rlnContract.initStorageContract(options.signer);
+    await rlnContract.fetchMembers(rlnInstance);
+    rlnContract.subscribeToMembers(rlnInstance);
+
+    return rlnContract;
+  }
+
+  public constructor(
+    rlnInstance: RLNInstance,
+    { registryAddress, signer }: RLNContractOptions
+  ) {
+    const initialRoot = rlnInstance.zerokit.getMerkleRoot();
+
+    this.registryContract = new ethers.Contract(
+      registryAddress,
+      RLN_REGISTRY_ABI,
+      signer
+    );
+    this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
+  }
+
+  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 {
+    if (!this.storageContract) {
+      throw Error("Storage contract was not initialized");
+    }
+    return this.storageContract as ethers.Contract;
+  }
+
+  public get members(): Member[] {
+    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(
+    rlnInstance: RLNInstance,
+    options: FetchMembersOptions = {}
+  ): Promise<void> {
+    const registeredMemberEvents = await queryFilter(this.contract, {
+      fromBlock: this.deployBlock,
+      ...options,
+      membersFilter: this.membersFilter
+    });
+    this.processEvents(rlnInstance, registeredMemberEvents);
+  }
+
+  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 insertMembers(
+    rlnInstance: RLNInstance,
+    toInsert: Map<number, ethers.Event[]>
+  ): void {
+    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 = zeroPadLE(hexToBytes(_idCommitment?._hex), 32);
+        rlnInstance.zerokit.insertMember(idCommitment);
+        this._members.set(index.toNumber(), {
+          index,
+          idCommitment: _idCommitment?._hex
+        });
+      });
+
+      const currentRoot = rlnInstance.zerokit.getMerkleRoot();
+      this.merkleRootTracker.pushRoot(blockNumber, currentRoot);
+    });
+  }
+
+  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.zerokit.deleteMember(index);
+        }
+      });
+
+      this.merkleRootTracker.backFill(blockNumber);
+    });
+  }
+
+  public subscribeToMembers(rlnInstance: RLNInstance): void {
+    this.contract.on(this.membersFilter, (_pubkey, _index, event) =>
+      this.processEvents(rlnInstance, [event])
+    );
+  }
+
+  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();
+
+    // 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
+    );
+
+    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[] {
+    return this.merkleRootTracker.roots();
+  }
+}
+
+type CustomQueryOptions = FetchMembersOptions & {
+  membersFilter: ethers.EventFilter;
+};
+
+// these value should be tested on other networks
+const FETCH_CHUNK = 5;
+const BLOCK_RANGE = 3000;
+
+async function queryFilter(
+  contract: ethers.Contract,
+  options: CustomQueryOptions
+): Promise<ethers.Event[]> {
+  const {
+    fromBlock,
+    membersFilter,
+    fetchRange = BLOCK_RANGE,
+    fetchChunks = FETCH_CHUNK
+  } = options;
+
+  if (!fromBlock) {
+    return contract.queryFilter(membersFilter);
+  }
+
+  if (!contract.signer.provider) {
+    throw Error("No provider found on the contract's signer.");
+  }
+
+  const toBlock = await contract.signer.provider.getBlockNumber();
+
+  if (toBlock - fromBlock < fetchRange) {
+    return contract.queryFilter(membersFilter);
+  }
+
+  const events: ethers.Event[][] = [];
+  const chunks = splitToChunks(fromBlock, toBlock, fetchRange);
+
+  for (const portion of takeN<[number, number]>(chunks, fetchChunks)) {
+    const promises = portion.map(([left, right]) =>
+      ignoreErrors(contract.queryFilter(membersFilter, left, right), [])
+    );
+    const fetchedEvents = await Promise.all(promises);
+    events.push(fetchedEvents.flatMap((v) => v));
+  }
+
+  return events.flatMap((v) => v);
+}
+
+function splitToChunks(
+  from: number,
+  to: number,
+  step: number
+): Array<[number, number]> {
+  const chunks = [];
+
+  let left = from;
+  while (left < to) {
+    const right = left + step < to ? left + step : to;
+
+    chunks.push([left, right] as [number, number]);
+
+    left = right;
+  }
+
+  return chunks;
+}
+
+function* takeN<T>(array: T[], size: number): Iterable<T[]> {
+  let start = 0;
+
+  while (start < array.length) {
+    const portion = array.slice(start, start + size);
+
+    yield portion;
+
+    start += size;
+  }
+}
+
+function ignoreErrors<T>(promise: Promise<T>, defaultValue: T): Promise<T> {
+  return promise.catch((err) => {
+    log.info(`Ignoring an error during query: ${err?.message}`);
+    return defaultValue;
+  });
+}

package/src/create.ts

@@ -0,0 +1,9 @@
+import type { RLNInstance } from "./rln.js";
+
+export async function createRLN(): Promise<RLNInstance> {
+  // A dependency graph that contains any wasm must all be imported
+  // asynchronously. This file does the single async import, so
+  // that no one else needs to worry about it again.
+  const rlnModule = await import("./rln.js");
+  return rlnModule.create();
+}

package/src/identity.ts

@@ -0,0 +1,31 @@
+import { buildBigIntFromUint8Array } from "./utils/index.js";
+
+export class IdentityCredential {
+  public constructor(
+    public readonly IDTrapdoor: Uint8Array,
+    public readonly IDNullifier: Uint8Array,
+    public readonly IDSecretHash: Uint8Array,
+    public readonly IDCommitment: Uint8Array,
+    public readonly IDCommitmentBigInt: bigint
+  ) {}
+
+  public static fromBytes(memKeys: Uint8Array): IdentityCredential {
+    if (memKeys.length < 128) {
+      throw new Error("Invalid memKeys length - must be at least 128 bytes");
+    }
+
+    const idTrapdoor = memKeys.subarray(0, 32);
+    const idNullifier = memKeys.subarray(32, 64);
+    const idSecretHash = memKeys.subarray(64, 96);
+    const idCommitment = memKeys.subarray(96, 128);
+    const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment, 32);
+
+    return new IdentityCredential(
+      idTrapdoor,
+      idNullifier,
+      idSecretHash,
+      idCommitment,
+      idCommitmentBigInt
+    );
+  }
+}

package/src/index.ts

@@ -1,11 +1,30 @@
-import { RLNInstance } from "./rln";
+import { RLNDecoder, RLNEncoder } from "./codec.js";
+import {
+  RLN_REGISTRY_ABI,
+  RLN_STORAGE_ABI,
+  SEPOLIA_CONTRACT
+} from "./contract/index.js";
+import { RLNContract } 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 { MerkleRootTracker } from "./root_tracker.js";
+import { extractMetaMaskSigner } from "./utils/index.js";
 
-// reexport the create function, dynamically imported from rln.ts
-export async function create(): Promise<RLNInstance> {
-  // A dependency graph that contains any wasm must all be imported
-  // asynchronously. This file does the single async import, so
-  // that no one else needs to worry about it again.
-  const rlnModule = await import("./rln");
-
-  return await rlnModule.create();
-}
+export {
+  createRLN,
+  Keystore,
+  RLNInstance,
+  IdentityCredential,
+  Proof,
+  RLNEncoder,
+  RLNDecoder,
+  MerkleRootTracker,
+  RLNContract,
+  RLN_STORAGE_ABI,
+  RLN_REGISTRY_ABI,
+  SEPOLIA_CONTRACT,
+  extractMetaMaskSigner
+};

package/src/keystore/cipher.ts

@@ -0,0 +1,54 @@
+import type { IKeystore as IEipKeystore } from "@chainsafe/bls-keystore";
+import { cipherDecrypt } from "@chainsafe/bls-keystore/lib/cipher";
+import { kdf } from "@chainsafe/bls-keystore/lib/kdf";
+import { normalizePassword } from "@chainsafe/bls-keystore/lib/password";
+import { keccak256 } from "ethereum-cryptography/keccak";
+import {
+  bytesToHex,
+  concatBytes,
+  hexToBytes
+} from "ethereum-cryptography/utils";
+
+import type { Keccak256Hash, Password } from "./types.js";
+
+// eipKeystore supports only sha256 checksum so we just make an assumption it is keccak256
+const validateChecksum = async (
+  password: Password,
+  eipKeystore: IEipKeystore
+): Promise<boolean> => {
+  const computedChecksum = await keccak256Checksum(password, eipKeystore);
+  return computedChecksum === eipKeystore.crypto.checksum.message;
+};
+
+// decrypt from @chainsafe/bls-keystore supports only sha256
+// but nwaku uses keccak256
+// https://github.com/waku-org/nwaku/blob/25d6e52e3804d15f9b61bc4cc6dd448540c072a1/waku/waku_keystore/keyfile.nim#L367
+export const decryptEipKeystore = async (
+  password: Password,
+  eipKeystore: IEipKeystore
+): Promise<Uint8Array> => {
+  const decryptionKey = await kdf(
+    eipKeystore.crypto.kdf,
+    normalizePassword(password)
+  );
+  const isChecksumValid = await validateChecksum(password, eipKeystore);
+
+  if (!isChecksumValid) {
+    throw Error("Password is invalid.");
+  }
+
+  return cipherDecrypt(eipKeystore.crypto.cipher, decryptionKey.slice(0, 16));
+};
+
+export const keccak256Checksum = async (
+  password: Password,
+  eipKeystore: IEipKeystore
+): Promise<Keccak256Hash> => {
+  const key = await kdf(eipKeystore.crypto.kdf, normalizePassword(password));
+  const payload = concatBytes(
+    key.slice(16),
+    hexToBytes(eipKeystore.crypto.cipher.message)
+  );
+  const ciphertext = keccak256(payload);
+  return bytesToHex(ciphertext);
+};

package/src/keystore/credential_validation_generated.ts

@@ -0,0 +1,7 @@
+/* eslint eslint-comments/no-unlimited-disable: "off" */
+// This file was generated by /scripts/schema-validation-codegen.ts
+// Do not modify this file by hand.
+
+/* eslint-disable */
+// @ts-ignore
+"use strict";export const Credential = validate11;const schema12 = {"type":"object","properties":{"crypto":{"type":"object","properties":{"cipher":{"type":"string"},"cipherparams":{"type":"object"},"ciphertext":{"type":"string"},"kdf":{"type":"string"},"kdfparams":{"type":"object"},"mac":{"type":"string"}},"required":["cipher","cipherparams","ciphertext","kdf","kdfparams","mac"]}},"required":["crypto"]};function validate11(data, {instancePath="", parentData, parentDataProperty, rootData=data}={}){let vErrors = null;let errors = 0;if(errors === 0){if(data && typeof data == "object" && !Array.isArray(data)){let missing0;if((data.crypto === undefined) && (missing0 = "crypto")){validate11.errors = [{instancePath,schemaPath:"#/required",keyword:"required",params:{missingProperty: missing0},message:"must have required property '"+missing0+"'"}];return false;}else {if(data.crypto !== undefined){let data0 = data.crypto;const _errs1 = errors;if(errors === _errs1){if(data0 && typeof data0 == "object" && !Array.isArray(data0)){let missing1;if(((((((data0.cipher === undefined) && (missing1 = "cipher")) || ((data0.cipherparams === undefined) && (missing1 = "cipherparams"))) || ((data0.ciphertext === undefined) && (missing1 = "ciphertext"))) || ((data0.kdf === undefined) && (missing1 = "kdf"))) || ((data0.kdfparams === undefined) && (missing1 = "kdfparams"))) || ((data0.mac === undefined) && (missing1 = "mac"))){validate11.errors = [{instancePath:instancePath+"/crypto",schemaPath:"#/properties/crypto/required",keyword:"required",params:{missingProperty: missing1},message:"must have required property '"+missing1+"'"}];return false;}else {if(data0.cipher !== undefined){const _errs3 = errors;if(typeof data0.cipher !== "string"){validate11.errors = [{instancePath:instancePath+"/crypto/cipher",schemaPath:"#/properties/crypto/properties/cipher/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid1 = _errs3 === errors;}else {var valid1 = true;}if(valid1){if(data0.cipherparams !== undefined){let data2 = data0.cipherparams;const _errs5 = errors;if(!(data2 && typeof data2 == "object" && !Array.isArray(data2))){validate11.errors = [{instancePath:instancePath+"/crypto/cipherparams",schemaPath:"#/properties/crypto/properties/cipherparams/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}var valid1 = _errs5 === errors;}else {var valid1 = true;}if(valid1){if(data0.ciphertext !== undefined){const _errs7 = errors;if(typeof data0.ciphertext !== "string"){validate11.errors = [{instancePath:instancePath+"/crypto/ciphertext",schemaPath:"#/properties/crypto/properties/ciphertext/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid1 = _errs7 === errors;}else {var valid1 = true;}if(valid1){if(data0.kdf !== undefined){const _errs9 = errors;if(typeof data0.kdf !== "string"){validate11.errors = [{instancePath:instancePath+"/crypto/kdf",schemaPath:"#/properties/crypto/properties/kdf/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid1 = _errs9 === errors;}else {var valid1 = true;}if(valid1){if(data0.kdfparams !== undefined){let data5 = data0.kdfparams;const _errs11 = errors;if(!(data5 && typeof data5 == "object" && !Array.isArray(data5))){validate11.errors = [{instancePath:instancePath+"/crypto/kdfparams",schemaPath:"#/properties/crypto/properties/kdfparams/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}var valid1 = _errs11 === errors;}else {var valid1 = true;}if(valid1){if(data0.mac !== undefined){const _errs13 = errors;if(typeof data0.mac !== "string"){validate11.errors = [{instancePath:instancePath+"/crypto/mac",schemaPath:"#/properties/crypto/properties/mac/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid1 = _errs13 === errors;}else {var valid1 = true;}}}}}}}}else {validate11.errors = [{instancePath:instancePath+"/crypto",schemaPath:"#/properties/crypto/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}}}}else {validate11.errors = [{instancePath,schemaPath:"#/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}validate11.errors = vErrors;return errors === 0;}

package/src/keystore/index.ts

@@ -0,0 +1,5 @@
+import { Keystore } from "./keystore.js";
+import type { DecryptedCredentials, EncryptedCredentials } from "./types.js";
+
+export { Keystore };
+export type { EncryptedCredentials, DecryptedCredentials };