fix(isregistereduser): fetch events in batches

privacy-scaling-explorations · May 28, 2024 · 6319120 · 6319120
1 parent 0c18913
commit 6319120
Show file tree

Hide file tree

Showing 26 changed files with 286 additions and 70 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.3](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.2...v1.2.3) (2024-05-28)
+
+
+### Bug Fixes
+
+* **isregistereduser:** fetch events in batches ([1e71fa6](https://github.com/privacy-scaling-explorations/maci/commit/1e71fa65ecf2b79a504541ea7e1392eebd8119c4))
+
+
+
 ## [1.2.2](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.1...v1.2.2) (2024-05-15)
 
 **Note:** Version bump only for package maci

diff --git a/circuits/CHANGELOG.md b/circuits/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.3](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.2...v1.2.3) (2024-05-28)
+
+**Note:** Version bump only for package maci-circuits
+
+
+
+
+
 ## [1.2.2](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.1...v1.2.2) (2024-05-15)
 
 **Note:** Version bump only for package maci-circuits

diff --git a/circuits/package.json b/circuits/package.json
@@ -1,6 +1,6 @@
 {
   "name": "maci-circuits",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "zk-SNARK circuits for MACI",
   "main": "build/ts/index.js",
   "files": [
@@ -38,9 +38,9 @@
     "@zk-kit/circuits": "^0.4.0",
     "circomkit": "^0.1.0",
     "circomlib": "^2.0.5",
-    "maci-core": "^1.2.2",
-    "maci-crypto": "^1.2.2",
-    "maci-domainobjs": "^1.2.2",
+    "maci-core": "^1.2.3",
+    "maci-crypto": "^1.2.3",
+    "maci-domainobjs": "^1.2.3",
     "snarkjs": "^0.7.4"
   },
   "devDependencies": {

diff --git a/cli/CHANGELOG.md b/cli/CHANGELOG.md
@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.3](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.2...v1.2.3) (2024-05-28)
+
+
+### Bug Fixes
+
+* **isregistereduser:** fetch events in batches ([1e71fa6](https://github.com/privacy-scaling-explorations/maci/commit/1e71fa65ecf2b79a504541ea7e1392eebd8119c4))
+
+
+
 ## [1.2.2](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.1...v1.2.2) (2024-05-15)
 
 **Note:** Version bump only for package maci-cli

diff --git a/cli/package.json b/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "maci-cli",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "CLI utilities for MACI",
   "main": "build/ts/index.js",
   "exports": {
@@ -38,6 +38,7 @@
     "test:timeTravel": "ts-mocha --exit tests/unit/timeTravel.test.ts",
     "test:fundWallet": "ts-mocha --exit tests/unit/fundWallet.test.ts",
     "test:utils": "ts-mocha --exit tests/unit/utils.test.ts",
+    "test:signup": "ts-mocha --exit tests/unit/signup.test.ts",
     "docs": "typedoc --plugin typedoc-plugin-markdown --options ./typedoc.json"
   },
   "dependencies": {
@@ -47,11 +48,11 @@
     "dotenv": "^16.4.5",
     "ethers": "^6.12.0",
     "hardhat": "^2.22.3",
-    "maci-circuits": "^1.2.2",
-    "maci-contracts": "^1.2.2",
-    "maci-core": "^1.2.2",
-    "maci-crypto": "^1.2.2",
-    "maci-domainobjs": "^1.2.2",
+    "maci-circuits": "^1.2.3",
+    "maci-contracts": "^1.2.3",
+    "maci-core": "^1.2.3",
+    "maci-crypto": "^1.2.3",
+    "maci-domainobjs": "^1.2.3",
     "prompt": "^1.3.0"
   },
   "devDependencies": {

diff --git a/cli/tests/unit/signup.test.ts b/cli/tests/unit/signup.test.ts
@@ -0,0 +1,70 @@
+import { expect } from "chai";
+import { Signer } from "ethers";
+import { getDefaultSigner } from "maci-contracts";
+import { Keypair } from "maci-domainobjs";
+
+import {
+  deploy,
+  DeployedContracts,
+  deployVkRegistryContract,
+  isRegisteredUser,
+  setVerifyingKeys,
+  signup,
+} from "../../ts";
+import { deployArgs, setVerifyingKeysArgs } from "../constants";
+
+describe("signup", () => {
+  let signer: Signer;
+  let maciAddresses: DeployedContracts;
+  const user = new Keypair();
+  // before all tests we deploy the vk registry contract and set the verifying keys
+  before(async () => {
+    signer = await getDefaultSigner();
+
+    // we deploy the vk registry contract
+    await deployVkRegistryContract({ signer });
+    // we set the verifying keys
+    await setVerifyingKeys({ ...setVerifyingKeysArgs, signer });
+    // deploy the smart contracts
+    maciAddresses = await deploy({ ...deployArgs, signer });
+  });
+
+  it("should allow to signup and return the user data", async () => {
+    const signUpData = await signup({
+      maciAddress: maciAddresses.maciAddress,
+      maciPubKey: user.pubKey.serialize(),
+      signer,
+    });
+
+    const registeredUserData = await isRegisteredUser({
+      maciAddress: maciAddresses.maciAddress,
+      startBlock: await signer.provider?.getBlockNumber(),
+      maciPubKey: user.pubKey.serialize(),
+      signer,
+    });
+
+    expect(registeredUserData.isRegistered).to.eq(true);
+    expect(registeredUserData.stateIndex).to.eq(signUpData.stateIndex);
+  });
+
+  it("should not get the user data if the user is not registered", async () => {
+    const registeredUserData = await isRegisteredUser({
+      maciAddress: maciAddresses.maciAddress,
+      startBlock: await signer.provider?.getBlockNumber(),
+      maciPubKey: new Keypair().pubKey.serialize(),
+      signer,
+    });
+
+    expect(registeredUserData.isRegistered).to.eq(false);
+  });
+
+  it("should start fetchig from block zero if the start block is not provided", async () => {
+    const registeredUserData = await isRegisteredUser({
+      maciAddress: maciAddresses.maciAddress,
+      maciPubKey: user.pubKey.serialize(),
+      signer,
+    });
+
+    expect(registeredUserData.isRegistered).to.eq(true);
+  });
+});
diff --git a/cli/ts/commands/signup.ts b/cli/ts/commands/signup.ts
@@ -1,7 +1,7 @@
 import { MACI__factory as MACIFactory } from "maci-contracts/typechain-types";
 import { PubKey } from "maci-domainobjs";
 
-import type { IRegisteredUserArgs, ISignupData, SignupArgs } from "../utils/interfaces";
+import type { IParseSignupEventsArgs, IRegisteredUserArgs, ISignupData, SignupArgs } from "../utils/interfaces";
 import type { ContractTransactionReceipt } from "ethers";
 
 import { banner } from "../utils/banner";
@@ -86,6 +86,36 @@ export const signup = async ({
   };
 };
 
+/**
+ * Parse the signup events from the MACI contract
+ */
+const parseSignupEvents = async ({ maciContract, startBlock, currentBlock, publicKey }: IParseSignupEventsArgs) => {
+  // 1000 blocks at a time
+  for (let block = startBlock; block <= currentBlock; block += 1000) {
+    const toBlock = Math.min(block + 999, currentBlock);
+    // eslint-disable-next-line no-await-in-loop
+    const newEvents = await maciContract.queryFilter(
+      maciContract.filters.SignUp(undefined, publicKey.rawPubKey[0], publicKey.rawPubKey[1]),
+      block,
+      toBlock,
+    );
+
+    if (newEvents.length > 0) {
+      const [event] = newEvents;
+
+      return {
+        stateIndex: event.args[0].toString(),
+        voiceCredits: event.args[3].toString(),
+      };
+    }
+  }
+
+  return {
+    stateIndex: undefined,
+    voiceCredits: undefined,
+  };
+};
+
 /**
  * Checks if user is registered with public key
  * @param IRegisteredArgs - The arguments for the register check command
@@ -101,14 +131,16 @@ export const isRegisteredUser = async ({
   banner(quiet);
 
   const maciContract = MACIFactory.connect(maciAddress, signer);
-  const publicKey = PubKey.deserialize(maciPubKey).asContractParam();
-
-  const events = await maciContract.queryFilter(
-    maciContract.filters.SignUp(undefined, publicKey.x, publicKey.y),
-    startBlock,
-  );
-  const stateIndex = events[0]?.args[0].toString() as string | undefined;
-  const voiceCredits = events[0]?.args[3].toString() as string | undefined;
+  const publicKey = PubKey.deserialize(maciPubKey);
+  const startBlockNumber = startBlock || 0;
+  const currentBlock = await signer.provider!.getBlockNumber();
+
+  const { stateIndex, voiceCredits } = await parseSignupEvents({
+    maciContract,
+    startBlock: startBlockNumber,
+    currentBlock,
+    publicKey,
+  });
 
   logGreen(quiet, success(`State index: ${stateIndex?.toString()}, registered: ${stateIndex !== undefined}`));
 

diff --git a/cli/ts/utils/index.ts b/cli/ts/utils/index.ts
@@ -45,6 +45,7 @@ export type {
   IPublishBatchArgs,
   IPublishBatchData,
   IPublishMessage,
+  IParseSignupEventsArgs,
 } from "./interfaces";
 export { compareVks } from "./vks";
 export { delay } from "./time";

diff --git a/cli/ts/utils/interfaces.ts b/cli/ts/utils/interfaces.ts
@@ -1,3 +1,6 @@
+import { MACI } from "maci-contracts/typechain-types";
+import { PubKey } from "maci-domainobjs";
+
 import type { Provider, Signer } from "ethers";
 import type { SnarkProof } from "maci-contracts";
 import type { CircuitInputs } from "maci-core";
@@ -1134,3 +1137,28 @@ export interface DeployVkRegistryArgs {
    */
   quiet?: boolean;
 }
+
+/**
+ * Interface for the arguments to the parseSignupEvents function
+ */
+export interface IParseSignupEventsArgs {
+  /**
+   * The MACI contract
+   */
+  maciContract: MACI;
+
+  /**
+   * The start block
+   */
+  startBlock: number;
+
+  /**
+   * The current block
+   */
+  currentBlock: number;
+
+  /**
+   * The public key
+   */
+  publicKey: PubKey;
+}
diff --git a/contracts/CHANGELOG.md b/contracts/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.3](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.2...v1.2.3) (2024-05-28)
+
+**Note:** Version bump only for package maci-contracts
+
+
+
+
+
 ## [1.2.2](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.1...v1.2.2) (2024-05-15)
 
 **Note:** Version bump only for package maci-contracts

diff --git a/contracts/package.json b/contracts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "maci-contracts",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Solidity Smart Contracts for MACI (Minimal Anti-Collusion Infrastructure)",
   "main": "build/ts/index.js",
   "exports": {
@@ -77,10 +77,10 @@
     "ethers": "^6.12.0",
     "hardhat": "^2.22.3",
     "lowdb": "^1.0.0",
-    "maci-circuits": "^1.2.2",
-    "maci-core": "^1.2.2",
-    "maci-crypto": "^1.2.2",
-    "maci-domainobjs": "^1.2.2",
+    "maci-circuits": "^1.2.3",
+    "maci-core": "^1.2.3",
+    "maci-crypto": "^1.2.3",
+    "maci-domainobjs": "^1.2.3",
     "solidity-docgen": "^0.6.0-beta.36"
   },
   "devDependencies": {

diff --git a/coordinator/CHANGELOG.md b/coordinator/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.3](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.2...v1.2.3) (2024-05-28)
+
+**Note:** Version bump only for package maci-coordinator
+
+
+
+
+
 ## [1.2.2](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.1...v1.2.2) (2024-05-15)
 
 **Note:** Version bump only for package maci-coordinator

diff --git a/coordinator/package.json b/coordinator/package.json
@@ -1,6 +1,6 @@
 {
   "name": "maci-coordinator",
-  "version": "0.1.0",
+  "version": "1.2.3",
   "private": true,
   "description": "Coordinator service for MACI",
   "main": "build/ts/main.js",
@@ -28,10 +28,10 @@
     "ethers": "^6.12.0",
     "hardhat": "^2.22.3",
     "helmet": "^7.1.0",
-    "maci-circuits": "^1.2.2",
-    "maci-cli": "^1.2.2",
-    "maci-contracts": "^1.2.2",
-    "maci-domainobjs": "^1.2.2",
+    "maci-circuits": "^1.2.3",
+    "maci-cli": "^1.2.3",
+    "maci-contracts": "^1.2.3",
+    "maci-domainobjs": "^1.2.3",
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1"
   },

diff --git a/core/CHANGELOG.md b/core/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.3](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.2...v1.2.3) (2024-05-28)
+
+**Note:** Version bump only for package maci-core
+
+
+
+
+
 ## [1.2.2](https://github.com/privacy-scaling-explorations/maci/compare/v1.2.1...v1.2.2) (2024-05-15)
 
 **Note:** Version bump only for package maci-core

diff --git a/core/package.json b/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "maci-core",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "",
   "main": "build/ts/index.js",
   "types": "build/ts/index.d.ts",
@@ -22,8 +22,8 @@
     "docs": "typedoc --plugin typedoc-plugin-markdown --options ./typedoc.json"
   },
   "dependencies": {
-    "maci-crypto": "^1.2.2",
-    "maci-domainobjs": "^1.2.2"
+    "maci-crypto": "^1.2.3",
+    "maci-domainobjs": "^1.2.3"
   },
   "devDependencies": {
     "@types/chai": "^4.3.11",