Merge pull request #2620 from privacy-scaling-explorations/feat/coordinator/tests-in-github

feat: coordinator tests in GitHub

Author: NicoSerranoP

.github/workflows/coordinator.yml

@@ -0,0 +1,96 @@
+name: Coordinator
+
+on:
+  push:
+    branches: [dev]
+  pull_request:
+
+env:
+  NODE_OPTIONS: "--max-old-space-size=8192"
+  TTL: ${{ vars.COORDINATOR_TTL }}
+  LIMIT: ${{ vars.COORDINATOR_LIMIT }}
+  COORDINATOR_PUBLIC_KEY_PATH: ${{ vars.COORDINATOR_PUBLIC_KEY_PATH }}
+  COORDINATOR_PRIVATE_KEY_PATH: ${{ vars.COORDINATOR_PRIVATE_KEY_PATH }}
+  COORDINATOR_MACI_PRIVATE_KEY: ${{ secrets.COORDINATOR_MACI_PRIVATE_KEY }}
+  COORDINATOR_TALLY_ZKEY_NAME: ${{ vars.COORDINATOR_TALLY_ZKEY_NAME }}
+  COORDINATOR_MESSAGE_PROCESS_ZKEY_NAME: ${{ vars.COORDINATOR_MESSAGE_PROCESS_ZKEY_NAME }}
+  COORDINATOR_POLL_JOINING_ZKEY_NAME: ${{ vars.COORDINATOR_POLL_JOINING_ZKEY_NAME }}
+  COORDINATOR_POLL_JOINED_ZKEY_NAME: ${{ vars.COORDINATOR_POLL_JOINED_ZKEY_NAME }}
+  COORDINATOR_RAPIDSNARK_EXE: ${{ vars.COORDINATOR_RAPIDSNARK_EXE }}
+  COORDINATOR_ZKEY_PATH: ${{ vars.COORDINATOR_ZKEY_PATH }}
+  COORDINATOR_RPC_URL: ${{ secrets.COORDINATOR_RPC_URL }}
+  COORDINATOR_ADDRESSES: ${{ vars.COORDINATOR_ADDRESSES }}
+  COORDINATOR_ALLOWED_ORIGINS: ${{ vars.COORDINATOR_ALLOWED_ORIGINS }}
+  COORDINATOR_PORT: ${{ vars.COORDINATOR_PORT }}
+  SUBGRAPH_NAME: ${{ vars.COORDINATOR_SUBGRAPH_NAME }}
+  SUBGRAPH_PROVIDER_URL: ${{ vars.COORDINATOR_SUBGRAPH_PROVIDER_URL }}
+  SUBGRAPH_DEPLOY_KEY: ${{ secrets.COORDINATOR_SUBGRAPH_DEPLOY_KEY }}
+  SUBGRAPH_FOLDER: ${{ vars.COORDINATOR_SUBGRAPH_FOLDER }}
+  ZERODEV_BUNDLER_RPC_OP_SEPOLIA: ${{ secrets.COORDINATOR_ZERODEV_BUNDLER_RPC_OP_SEPOLIA }}
+  TEST_PRIVATE_KEY: ${{ secrets.COORDINATOR_TEST_PRIVATE_KEY }}
+  PRIVATE_KEY: ${{ secrets.COORDINATOR_TEST_PRIVATE_KEY }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install --yes \
+            build-essential \
+            libgmp-dev \
+            libsodium-dev \
+            nasm \
+            nlohmann-json3-dev
+
+      - name: Install
+        run: |
+          pnpm install --frozen-lockfile --prefer-offline
+
+      - name: Build
+        run: |
+          unset TEST_PRIVATE_KEY // avoid errors when building contracts
+          unset PRIVATE_KEY // avoid errors when building contracts
+          pnpm run build
+
+      - name: Download rapidsnark (1c137)
+        run: |
+          mkdir -p ~/rapidsnark/build
+          wget -qO ~/rapidsnark/build/prover https://maci-devops-zkeys.s3.ap-northeast-2.amazonaws.com/rapidsnark-linux-amd64-1c137
+          chmod +x ~/rapidsnark/build/prover
+
+      - name: Download zkeys
+        run: |
+          pnpm download-zkeys:test:coordinator
+
+      - name: Generate RSA Keypair
+        working-directory: apps/coordinator
+        run: |
+          pnpm run generate-keypair
+
+      - name: Run tests
+        working-directory: apps/coordinator
+        run: |
+          pnpm run test
+
+      - name: Run E2E tests
+        working-directory: apps/coordinator
+        run: |
+          pnpm run test:e2e

apps/coordinator/.env.example

@@ -1,3 +1,5 @@
+NODE_OPTIONS="--max-old-space-size=8192"
+DOTENV_CONFIG_DEBUG="false"
 # Rate limit configuation
 TTL=60000
 LIMIT=10

apps/coordinator/package.json

@@ -22,7 +22,7 @@
     "run:node": "node --import 'data:text/javascript,import { register } from \"node:module\"; import { pathToFileURL } from \"node:url\"; register(\"ts-node/esm\", pathToFileURL(\"./\"));'",
     "start": "pnpm run run:node ./ts/main.ts",
     "start:prod": "pnpm run run:node build/ts/main.js",
-    "test": "jest --testPathIgnorePatterns=e2e.deploy.test.ts --testPathIgnorePatterns=e2e.test.ts --forceExit",
+    "test": "jest --testPathIgnorePatterns=tests/ --forceExit",
     "test:coverage": "jest --coverage --forceExit",
     "test:e2e": "jest ./tests/*.test.ts --forceExit --runInBand",
     "types": "tsc -p tsconfig.json --noEmit",

apps/coordinator/tests/e2e.aa.test.ts

@@ -1,5 +1,5 @@
 import { Keypair } from "@maci-protocol/domainobjs";
-import { ContractStorage, isArm, joinPoll, signup, sleep } from "@maci-protocol/sdk";
+import { ContractStorage, isArm, joinPoll, signup, sleepUntil } from "@maci-protocol/sdk";
 import { ValidationPipe, type INestApplication } from "@nestjs/common";
 import { Test } from "@nestjs/testing";
 import dotenv from "dotenv";
@@ -110,11 +110,18 @@ describe("E2E Deployment Tests", () => {
       });
     });
   });
+
   afterEach(() => {
     socket.disconnect();
   });
 
   // run tests
+  test("should use OP Sepolia RPC in E2E", async () => {
+    const network = await signer.provider?.getNetwork();
+
+    expect(network?.name).toBe(ESupportedNetworks.OPTIMISM_SEPOLIA);
+  });
+
   test("should return true in the health check", async () => {
     const response = await fetch(`${TEST_URL}/health/check`, { method: "GET" });
     const body = (await response.json()) as IHealthCheckResponse;
@@ -154,14 +161,14 @@ describe("E2E Deployment Tests", () => {
   });
 
   test("should deploy MACI correctly", async () => {
-    const config = testMaciDeploymentConfig;
-    config.VerifyingKeysRegistry.args.stateTreeDepth = config.VerifyingKeysRegistry.args.stateTreeDepth.toString();
-    config.VerifyingKeysRegistry.args.pollStateTreeDepth =
-      config.VerifyingKeysRegistry.args.pollStateTreeDepth.toString();
-    config.VerifyingKeysRegistry.args.tallyProcessingStateTreeDepth =
-      config.VerifyingKeysRegistry.args.tallyProcessingStateTreeDepth.toString();
-    config.VerifyingKeysRegistry.args.voteOptionTreeDepth =
-      config.VerifyingKeysRegistry.args.voteOptionTreeDepth.toString();
+    testMaciDeploymentConfig.VerifyingKeysRegistry.args.stateTreeDepth =
+      testMaciDeploymentConfig.VerifyingKeysRegistry.args.stateTreeDepth.toString();
+    testMaciDeploymentConfig.VerifyingKeysRegistry.args.pollStateTreeDepth =
+      testMaciDeploymentConfig.VerifyingKeysRegistry.args.pollStateTreeDepth.toString();
+    testMaciDeploymentConfig.VerifyingKeysRegistry.args.tallyProcessingStateTreeDepth =
+      testMaciDeploymentConfig.VerifyingKeysRegistry.args.tallyProcessingStateTreeDepth.toString();
+    testMaciDeploymentConfig.VerifyingKeysRegistry.args.voteOptionTreeDepth =
+      testMaciDeploymentConfig.VerifyingKeysRegistry.args.voteOptionTreeDepth.toString();
 
     const response = await fetch(`${TEST_URL}/deploy/maci`, {
       method: "POST",
@@ -171,7 +178,7 @@ describe("E2E Deployment Tests", () => {
       },
       body: JSON.stringify({
         chain: CHAIN,
-        config,
+        config: testMaciDeploymentConfig,
       } as IDeployMaciArgs),
     });
 
@@ -187,12 +194,11 @@ describe("E2E Deployment Tests", () => {
   });
 
   test("should deploy a poll correctly", async () => {
-    const config = testPollDeploymentConfig;
-    config.voteOptions = config.voteOptions.toString();
+    testPollDeploymentConfig.voteOptions = testPollDeploymentConfig.voteOptions.toString();
 
     const startDate = Math.floor(Date.now() / 1000) + pollStartDateExtraSeconds;
-    config.startDate = startDate;
-    config.endDate = startDate + pollDuration;
+    testPollDeploymentConfig.startDate = startDate;
+    testPollDeploymentConfig.endDate = startDate + pollDuration;
 
     const response = await fetch(`${TEST_URL}/deploy/poll`, {
       method: "POST",
@@ -202,10 +208,11 @@ describe("E2E Deployment Tests", () => {
       },
       body: JSON.stringify({
         chain: CHAIN,
-        config,
+        config: testPollDeploymentConfig,
       } as IDeployPollArgs),
     });
     const body = (await response.json()) as { pollId: string };
+
     expect(response.status).toBe(201);
     expect(body.pollId).toBeDefined();
 
@@ -214,7 +221,8 @@ describe("E2E Deployment Tests", () => {
   });
 
   test("should allow voting on a poll", async () => {
-    await sleep(pollStartDateExtraSeconds * 1000);
+    await sleepUntil(testPollDeploymentConfig.startDate * 1000);
+
     for (let i = 0; i < NUM_USERS; i += 1) {
       const keypairUser = new Keypair();
       const userPublicKey = keypairUser.publicKey.serialize();
@@ -285,7 +293,8 @@ describe("E2E Deployment Tests", () => {
   });
 
   test("should merge correctly", async () => {
-    await sleep(pollDuration * 1000);
+    await sleepUntil((testPollDeploymentConfig.endDate + 5) * 1000); // 5 seconds of grace time after the poll end date
+
     const response = await fetch(`${TEST_URL}/proof/merge`, {
       method: "POST",
       headers: {

apps/coordinator/tests/e2e.deploy.test.ts

@@ -47,12 +47,14 @@ export const rechargeGasIfNeeded = async (
   const publicClient = getPublicClient(ESupportedNetworks.OPTIMISM_SEPOLIA);
   const balance = await publicClient.getBalance({ address });
   const balanceAsEther = formatEther(balance);
+
   if (balanceAsEther <= minimumValueOfEther) {
     const testAccount = privateKeyToAccount(process.env.TEST_PRIVATE_KEY! as Hex);
     const walletClient = createWalletClient({
       chain: optimismSepolia,
       transport: http(),
     });
+
     await walletClient.sendTransaction({
       account: testAccount,
       to: address,

apps/coordinator/tests/utils.ts

@@ -61,20 +61,8 @@ describe("common", () => {
   });
 
   describe("getRpcUrl", () => {
-    test("should return the correct RPCUrl for optimism-sepolia", () => {
-      const rpcUrl = getRpcUrl(ESupportedNetworks.OPTIMISM_SEPOLIA);
-      expect(rpcUrl).toBeDefined();
-      expect(rpcUrl).toContain("https://opt-sepolia.g.alchemy.com/v2/");
-    });
-
-    test("should return the correct RPCUrl for sepolia", () => {
-      const rpcUrl = getRpcUrl(ESupportedNetworks.ETHEREUM_SEPOLIA);
-      expect(rpcUrl).toBeDefined();
-      expect(rpcUrl).toContain("https://eth-sepolia.g.alchemy.com/v2/");
-    });
-
     test("should throw when given an unsupported network", () => {
-      expect(() => getRpcUrl(ESupportedNetworks.GNOSIS_CHAIN)).toThrow(ErrorCodes.UNSUPPORTED_NETWORK.toString());
+      expect(() => getRpcUrl("Unsupported" as ESupportedNetworks)).toThrow(ErrorCodes.UNSUPPORTED_NETWORK.toString());
     });
 
     test("should throw when COORDINATOR_RPC_URL is not set", () => {