@maci-protocol/coordinator 0.0.0-ci.40d164d → 0.0.0-ci.4450fd6

package/LICENSE

@@ -1,7 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Barry WhiteHat, Kendrick Tan, Kobi Gurkan, Kirill Goncharov
-Cory Dickson, Han Jian, Chih-Cheng Liang, and Koh Wei Jie
+Copyright (c) 2025 Ethereum Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -2,16 +2,77 @@
 
 Please refer to [Offchain relayer service documentation](https://maci.pse.dev/docs/category/offchain-relayer) for more information.
 
-## Instructions
-
-1. Add `.env` file (see `.env.example`).
-2. Generate RSA key pair with `pnpm run generate-keypair`.
-3. Download zkey files using `pnpm run download-zkeys:{type}` (only test type is available for now).
-4. Make sure you copied RSA public key to your application. This will be needed for encrypting `Authorization` header and coordinator private key for proof generation. Also it can be accessed through API method `GET v1/proof/publicKey`.
-5. Run `pnpm run start` to run the service.
-6. All API calls must be called with `Authorization` header, where the value is encrypted with RSA public key you generated before. Header value contains message signature and message digest created by `COORDINATOR_ADDRESSES`. The format is `publicEncrypt({signature}:{digest})`.
-   Make sure you set `COORDINATOR_ADDRESSES` env variable and sign any message with the addresses from your application (see [AccountSignatureGuard](./ts/auth/AccountSignatureGuard.service.ts)).
-7. Proofs can be generated with `POST v1/proof/generate` API method or with Websockets (see [dto spec](./ts/proof/dto.ts), [controller](./ts/app.controller.ts) and [wsgateway](./ts/events/events.gateway.ts)).
+## Requirements
+
+1. [Node.js](https://nodejs.org/en) version 20.0.0.
+2. [pnpm](https://pnpm.io/installation) package manager.
+3. [rapidsnark](https://github.com/iden3/rapidsnark) program.
+4. (Optional) [Redis](https://redis.io/docs/latest/operate/oss_and_stack/install/archive/install-redis/) database if you want to use the scheduler module.
+
+- Please note that the build process might fail in a Windows environment. If you are using Windows, it is recommended to use Windows Subsystem for Linux (WSL) or a virtual machine with a Linux distribution.
+
+## Install and build it from source
+
+1. Install dependencies and build the project
+
+```bash
+pnpm install
+pnpm run build
+```
+
+2. Install Redis database (if the scheduler module is going to be used) using [the official guide](https://redis.io/docs/latest/operate/oss_and_stack/install/archive/install-redis/)
+
+3. Download the zkeys
+
+```bash
+pnpm run download-zkeys:test
+# for production zkeys
+# pnpm run download-zkeys:ceremony
+```
+
+4. Move to the coordinator service directory
+
+```bash
+cd apps/coordinator
+```
+
+5. Generate the RSA key pair to encrypt values throughout the communication workflow
+
+```bash
+pnpm run generate-keypair
+```
+
+6. Setup .env file (see `.env.example` for reference)
+
+```bash
+cp .env.example .env
+```
+
+7. Run the NestJS application
+
+```bash
+pnpm run start
+# or
+pnpm run start:prod
+```
+
+## Docker
+
+Remember to run it from the monorepo root directory.
+
+```bash
+# Build docker
+docker compose -f apps/coordinator/docker-compose.yml build
+
+# Run container detached
+docker compose -f apps/coordinator/docker-compose.yml up -d
+
+# Enter the container
+docker compose -f apps/coordinator/docker-compose.yml exec coordinator-service /bin/sh
+
+# Stop container
+docker compose -f apps/coordinator/docker-compose.yml down
+```
 
 ## Subgraph deployment
 

package/build/hardhat.config.cjs

@@ -7,22 +7,30 @@ dotenv.config();
 const parentDir = __dirname.includes("build") ? ".." : "";
 const TEST_MNEMONIC = "test test test test test test test test test test test junk";
 module.exports = {
-    defaultNetwork: "sepolia",
+    defaultNetwork: "localhost",
     networks: {
-        sepolia: {
+        localhost: {
             url: process.env.COORDINATOR_RPC_URL || "http://localhost:8545",
-            accounts: {
-                mnemonic: TEST_MNEMONIC,
-                path: "m/44'/60'/0'/0",
-                initialIndex: 0,
-                count: 20,
-            },
-            loggingEnabled: false,
+            accounts: process.env.PRIVATE_KEY
+                ? [process.env.PRIVATE_KEY]
+                : {
+                    mnemonic: process.env.MNEMONIC || TEST_MNEMONIC,
+                    path: "m/44'/60'/0'/0",
+                    initialIndex: process.env.INITIAL_INDEX ? Number(process.env.INITIAL_INDEX) : 0,
+                    count: 20,
+                },
         },
         hardhat: {
             loggingEnabled: false,
+            mining: {
+                auto: false,
+                interval: 5000,
+            },
         },
     },
+    solidity: {
+        version: "0.8.28",
+    },
     paths: {
         sources: path.resolve(__dirname, parentDir, "./node_modules/@maci-protocol/sdk/node_modules/@maci-protocol/contracts/contracts"),
         artifacts: path.resolve(__dirname, parentDir, "./node_modules/@maci-protocol/sdk/node_modules/@maci-protocol/contracts/artifacts"),

package/build/hardhat.config.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"hardhat.config.cjs","sourceRoot":"","sources":["../hardhat.config.cjs"],"names":[],"mappings":";AAAA,uDAAuD;AACvD,OAAO,CAAC,kCAAkC,CAAC,CAAC;AAC5C,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEjC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAE7B,MAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1D,MAAM,aAAa,GAAG,6DAA6D,CAAC;AAEpF,MAAM,CAAC,OAAO,GAAG;IACf,cAAc,EAAE,SAAS;IACzB,QAAQ,EAAE;QACR,OAAO,EAAE;YACP,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,uBAAuB;YAC/D,QAAQ,EAAE;gBACR,QAAQ,EAAE,aAAa;gBACvB,IAAI,EAAE,gBAAgB;gBACtB,YAAY,EAAE,CAAC;gBACf,KAAK,EAAE,EAAE;aACV;YACD,cAAc,EAAE,KAAK;SACtB;QACD,OAAO,EAAE;YACP,cAAc,EAAE,KAAK;SACtB;KACF;IACD,KAAK,EAAE;QACL,OAAO,EAAE,IAAI,CAAC,OAAO,CACnB,SAAS,EACT,SAAS,EACT,mFAAmF,CACpF;QACD,SAAS,EAAE,IAAI,CAAC,OAAO,CACrB,SAAS,EACT,SAAS,EACT,mFAAmF,CACpF;KACF;CACF,CAAC"}
+{"version":3,"file":"hardhat.config.cjs","sourceRoot":"","sources":["../hardhat.config.cjs"],"names":[],"mappings":";AAAA,uDAAuD;AACvD,OAAO,CAAC,kCAAkC,CAAC,CAAC;AAC5C,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEjC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAE7B,MAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;AAC1D,MAAM,aAAa,GAAG,6DAA6D,CAAC;AAEpF,MAAM,CAAC,OAAO,GAAG;IACf,cAAc,EAAE,WAAW;IAC3B,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,uBAAuB;YAC/D,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW;gBAC/B,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;gBAC3B,CAAC,CAAC;oBACE,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa;oBAC/C,IAAI,EAAE,gBAAgB;oBACtB,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC/E,KAAK,EAAE,EAAE;iBACV;SACN;QACD,OAAO,EAAE;YACP,cAAc,EAAE,KAAK;YACrB,MAAM,EAAE;gBACN,IAAI,EAAE,KAAK;gBACX,QAAQ,EAAE,IAAI;aACf;SACF;KACF;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,QAAQ;KAClB;IACD,KAAK,EAAE;QACL,OAAO,EAAE,IAAI,CAAC,OAAO,CACnB,SAAS,EACT,SAAS,EACT,mFAAmF,CACpF;QACD,SAAS,EAAE,IAAI,CAAC,OAAO,CACrB,SAAS,EACT,SAAS,EACT,mFAAmF,CACpF;KACF;CACF,CAAC"}

package/build/hardhat.config.d.cts

@@ -1,24 +1,27 @@
-declare const TEST_MNEMONIC: "test test test test test test test test test test test junk";
 export let defaultNetwork: string;
 export namespace networks {
-    namespace sepolia {
+    namespace localhost {
         let url: string;
-        namespace accounts {
-            export { TEST_MNEMONIC as mnemonic };
-            export let path: string;
-            export let initialIndex: number;
-            export let count: number;
-        }
-        let loggingEnabled: boolean;
+        let accounts: string[] | {
+            mnemonic: string;
+            path: string;
+            initialIndex: number;
+            count: number;
+        };
     }
     namespace hardhat {
-        let loggingEnabled_1: boolean;
-        export { loggingEnabled_1 as loggingEnabled };
+        let loggingEnabled: boolean;
+        namespace mining {
+            let auto: boolean;
+            let interval: number;
+        }
     }
 }
+export namespace solidity {
+    let version: string;
+}
 export namespace paths {
     let sources: string;
     let artifacts: string;
 }
-export {};
 //# sourceMappingURL=hardhat.config.d.cts.map

package/build/hardhat.config.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"hardhat.config.d.cts","sourceRoot":"","sources":["../hardhat.config.cjs"],"names":[],"mappings":"AASA,6BAAsB,6DAA6D,CAAC"}
+{"version":3,"file":"hardhat.config.d.cts","sourceRoot":"","sources":["../hardhat.config.cjs"],"names":[],"mappings":""}

package/build/scripts/generateKeypair.js

@@ -17,8 +17,8 @@ export async function generateRsaKeypair() {
     const publicKey = keypair.publicKey.export({ type: "pkcs1", format: "pem" });
     const privateKey = keypair.privateKey.export({ type: "pkcs1", format: "pem" });
     await Promise.all([
-        fs.promises.writeFile(path.resolve(process.env.COORDINATOR_PUBLIC_KEY_PATH), publicKey),
-        fs.promises.writeFile(path.resolve(process.env.COORDINATOR_PRIVATE_KEY_PATH), privateKey),
+        fs.promises.writeFile(path.resolve(process.env.COORDINATOR_PUBLIC_KEY_PATH || "./public.key"), publicKey),
+        fs.promises.writeFile(path.resolve(process.env.COORDINATOR_PRIVATE_KEY_PATH || "./private.key"), privateKey),
     ]);
 }
 generateRsaKeypair();

package/build/scripts/generateKeypair.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateKeypair.js","sourceRoot":"","sources":["../../scripts/generateKeypair.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,yCAAyC;AACzC,iDAAiD;AACjD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACnE,wCAAwC;AACxC,gDAAgD;AAEhD,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC;AAE1G,MAAM,cAAc,GAAG,IAAI,CAAC;AAE5B,MAAM,CAAC,KAAK,UAAU,kBAAkB;IACtC,MAAM,OAAO,GAAG,mBAAmB,CAAC,KAAK,EAAE;QACzC,aAAa,EAAE,cAAc;KAC9B,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7E,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAE/E,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA4B,CAAC,EAAE,SAAS,CAAC;QACxF,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA6B,CAAC,EAAE,UAAU,CAAC;KAC3F,CAAC,CAAC;AACL,CAAC;AAED,kBAAkB,EAAE,CAAC"}
+{"version":3,"file":"generateKeypair.js","sourceRoot":"","sources":["../../scripts/generateKeypair.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,yCAAyC;AACzC,iDAAiD;AACjD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACnE,wCAAwC;AACxC,gDAAgD;AAEhD,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC;AAE1G,MAAM,cAAc,GAAG,IAAI,CAAC;AAE5B,MAAM,CAAC,KAAK,UAAU,kBAAkB;IACtC,MAAM,OAAO,GAAG,mBAAmB,CAAC,KAAK,EAAE;QACzC,aAAa,EAAE,cAAc;KAC9B,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7E,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAE/E,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,IAAI,cAAc,CAAC,EAAE,SAAS,CAAC;QACzG,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,IAAI,eAAe,CAAC,EAAE,UAAU,CAAC;KAC7G,CAAC,CAAC;AACL,CAAC;AAED,kBAAkB,EAAE,CAAC"}

package/build/tests/constants.d.ts

@@ -1,8 +1,7 @@
-export declare const pollJoiningTestZkeyPath = "./zkeys/PollJoining_10_test/PollJoining_10_test.0.zkey";
-export declare const testPollJoiningWasmPath = "./zkeys/PollJoining_10_test/PollJoining_10_test_js/PollJoining_10_test.wasm";
-export declare const testPollJoiningWitnessPath = "./zkeys/PollJoining_10_test/PollJoining_10_test_cpp/PollJoining_10_test";
+export declare const pollJoiningTestZkeyPath: string;
+export declare const testPollJoiningWasmPath: string;
+export declare const testPollJoiningWitnessPath: string;
 export declare const testRapidsnarkPath: string;
 export declare const zeroUint256Encoded: string;
 export declare const oneUint256Encoded: string;
-export declare const pollDuration = 10;
 //# sourceMappingURL=constants.d.ts.map

package/build/tests/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../tests/constants.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,uBAAuB,2DAA2D,CAAC;AAChG,eAAO,MAAM,uBAAuB,gFAAgF,CAAC;AACrH,eAAO,MAAM,0BAA0B,4EAA4E,CAAC;AACpH,eAAO,MAAM,kBAAkB,QAAyC,CAAC;AAEzE,eAAO,MAAM,kBAAkB,QAAsD,CAAC;AACtF,eAAO,MAAM,iBAAiB,QAAsD,CAAC;AAErF,eAAO,MAAM,YAAY,KAAK,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../tests/constants.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,uBAAuB,QAA+E,CAAC;AACpH,eAAO,MAAM,uBAAuB,QAGnC,CAAC;AACF,eAAO,MAAM,0BAA0B,QAGtC,CAAC;AACF,eAAO,MAAM,kBAAkB,QAAyC,CAAC;AAEzE,eAAO,MAAM,kBAAkB,QAAsD,CAAC;AACtF,eAAO,MAAM,iBAAiB,QAAsD,CAAC"}

package/build/tests/constants.js

@@ -1,10 +1,11 @@
 import { AbiCoder } from "ethers";
 import { homedir } from "os";
-export const pollJoiningTestZkeyPath = "./zkeys/PollJoining_10_test/PollJoining_10_test.0.zkey";
-export const testPollJoiningWasmPath = "./zkeys/PollJoining_10_test/PollJoining_10_test_js/PollJoining_10_test.wasm";
-export const testPollJoiningWitnessPath = "./zkeys/PollJoining_10_test/PollJoining_10_test_cpp/PollJoining_10_test";
+import path from "path";
+const root = path.resolve(__dirname, "../../..");
+export const pollJoiningTestZkeyPath = path.resolve(root, "./zkeys/PollJoining_10_test/PollJoining_10_test.0.zkey");
+export const testPollJoiningWasmPath = path.resolve(root, "./zkeys/PollJoining_10_test/PollJoining_10_test_js/PollJoining_10_test.wasm");
+export const testPollJoiningWitnessPath = path.resolve(root, "./zkeys/PollJoining_10_test/PollJoining_10_test_cpp/PollJoining_10_test");
 export const testRapidsnarkPath = `${homedir()}/rapidsnark/build/prover`;
 export const zeroUint256Encoded = AbiCoder.defaultAbiCoder().encode(["uint256"], [0]);
 export const oneUint256Encoded = AbiCoder.defaultAbiCoder().encode(["uint256"], [1]);
-export const pollDuration = 10; // 100 seconds (added to unix timestamp of start date)
 //# sourceMappingURL=constants.js.map

package/build/tests/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../tests/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAE7B,MAAM,CAAC,MAAM,uBAAuB,GAAG,wDAAwD,CAAC;AAChG,MAAM,CAAC,MAAM,uBAAuB,GAAG,6EAA6E,CAAC;AACrH,MAAM,CAAC,MAAM,0BAA0B,GAAG,yEAAyE,CAAC;AACpH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,OAAO,EAAE,0BAA0B,CAAC;AAEzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAAQ,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACtF,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAErF,MAAM,CAAC,MAAM,YAAY,GAAG,EAAE,CAAC,CAAC,sDAAsD"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../tests/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAC7B,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AAEjD,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,wDAAwD,CAAC,CAAC;AACpH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAC,OAAO,CACjD,IAAI,EACJ,6EAA6E,CAC9E,CAAC;AACF,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,CAAC,OAAO,CACpD,IAAI,EACJ,yEAAyE,CAC1E,CAAC;AACF,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,OAAO,EAAE,0BAA0B,CAAC;AAEzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAAQ,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACtF,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/build/tests/e2e.deploy.test.js

@@ -1,59 +1,57 @@
-// To only run this file: pnpm exec jest --testPathPattern=tests/e2e.deploy.test.ts
-import { generateRandomSalt } from "@maci-protocol/crypto";
 import { Keypair } from "@maci-protocol/domainobjs";
-import { joinPoll, publish, signup, sleep } from "@maci-protocol/sdk";
+import { isArm, joinPoll, signup, sleepUntil, ESupportedChains, ContractStorage } from "@maci-protocol/sdk";
 import { ValidationPipe } from "@nestjs/common";
 import { Test } from "@nestjs/testing";
 import dotenv from "dotenv";
-import hardhat from "hardhat";
 import { io } from "socket.io-client";
 import { zeroAddress } from "viem";
+import path from "path";
 import { AppModule } from "../ts/app.module";
-import { ESupportedNetworks } from "../ts/common";
-import { getPublicClient } from "../ts/common/accountAbstraction";
-import { testMaciDeploymentConfig, testPollDeploymentConfig } from "../ts/deployer/__tests__/utils";
+import { getSigner } from "../ts/common";
+import { pollDuration, pollStartDateExtraSeconds, testMaciDeploymentConfig, testPollDeploymentConfig, } from "../ts/deployer/__tests__/utils";
+import { DeployerModule } from "../ts/deployer/deployer.module";
 import { FileModule } from "../ts/file/file.module";
-import { generateApproval, getKernelAccount } from "../ts/sessionKeys/__tests__/utils";
-import { pollDuration, pollJoiningTestZkeyPath, testPollJoiningWasmPath, testPollJoiningWitnessPath, testRapidsnarkPath, zeroUint256Encoded, } from "./constants";
-import { getAuthorizationHeader, rechargeGasIfNeeded } from "./utils";
+import { ProofModule } from "../ts/proof/proof.module";
+import { SessionKeysModule } from "../ts/sessionKeys/sessionKeys.module";
+import { pollJoiningTestZkeyPath, testPollJoiningWasmPath, testPollJoiningWitnessPath, testRapidsnarkPath, zeroUint256Encoded, } from "./constants";
+import { getAuthorizationHeader } from "./utils";
 dotenv.config();
-const LOCALHOST = "http://localhost:3000";
+jest.setTimeout(700000); // Sets timeout to 700 seconds
+const PORT = process.env.COORDINATOR_PORT || 3001;
+const TEST_URL = `http://localhost:${PORT}/v1`;
+const CHAIN = ESupportedChains.Localhost;
+const REGEX_SUBGRAPH = /^https:\/\/api\.studio\.thegraph\.com\/query\/\d+\/maci-subgraph\/v0\.0\.\d+$/;
 const NUM_USERS = 1;
-const voteOptions = {
+const VOTE_OPTIONS = {
     "0": 0,
     "1": 0,
 };
+const useWasm = isArm();
 describe("E2E Deployment Tests", () => {
     let signer;
     let encryptedHeader;
-    let coordinatorKeypair;
-    let sessionKeyAddress;
-    let approval;
     let app;
     let socket;
-    const publicClient = getPublicClient(ESupportedNetworks.OPTIMISM_SEPOLIA);
     let maciAddress;
+    let maciCreatedAt;
     let pollId;
     // set up coordinator address
     beforeAll(async () => {
-        [signer] = await hardhat.ethers.getSigners();
+        signer = await getSigner(CHAIN);
         encryptedHeader = await getAuthorizationHeader(signer);
-        coordinatorKeypair = new Keypair();
         process.env.COORDINATOR_ADDRESSES = await signer.getAddress();
-        await rechargeGasIfNeeded(process.env.COORDINATOR_ADDRESSES, "0.007", "0.007");
-    });
-    // set up NestJS app
-    beforeAll(async () => {
         const moduleFixture = await Test.createTestingModule({
-            imports: [AppModule, FileModule],
+            imports: [AppModule, FileModule, DeployerModule, ProofModule, SessionKeysModule],
         }).compile();
         app = moduleFixture.createNestApplication();
         app.useGlobalPipes(new ValidationPipe({ transform: true }));
         await app.init();
-        await app.listen(3000);
+        await app.listen(PORT);
     });
     afterAll(async () => {
         await app.close();
+        const storageInstance = ContractStorage.getInstance(path.join(process.cwd(), "deployed-contracts.json"));
+        storageInstance.cleanup(CHAIN);
     });
     // set up auth header in WS connection
     beforeEach(async () => {
@@ -74,9 +72,24 @@ describe("E2E Deployment Tests", () => {
     afterEach(() => {
         socket.disconnect();
     });
-    // run tests
+    test("should return true in the health check", async () => {
+        const response = await fetch(`${TEST_URL}/health/check`, { method: "GET" });
+        const body = (await response.json());
+        expect(response.status).toBe(200);
+        expect(body.rapidsnark.rapidsnarkIsExecutable).toBe(true);
+        expect(body.zkeysDirectory.zkeysDirectoryExists).toBe(true);
+        expect(body.coordinatorWalletFunds.fundsInNetworks[0].address).not.toBe(zeroAddress);
+    });
+    test("should retrieve RSA public key", async () => {
+        const response = await fetch(`${TEST_URL}/proof/publicKey`, {
+            method: "GET",
+        });
+        const body = (await response.json());
+        expect(response.status).toBe(200);
+        expect(body.publicKey).toBeDefined();
+    });
     test("should retrieve the session key address", async () => {
-        const response = await fetch(`${LOCALHOST}/v1/session-keys/generate`, {
+        const response = await fetch(`${TEST_URL}/session-keys/generate`, {
             method: "GET",
             headers: {
                 Authorization: encryptedHeader,
@@ -85,56 +98,41 @@ describe("E2E Deployment Tests", () => {
         const body = (await response.json());
         expect(response.status).toBe(200);
         expect(body.sessionKeyAddress).not.toBe(zeroAddress);
-        // save them for next tests
-        sessionKeyAddress = body.sessionKeyAddress;
-        approval = await generateApproval(sessionKeyAddress);
-        const sessionKeyAccount = await getKernelAccount(sessionKeyAddress);
-        await rechargeGasIfNeeded(sessionKeyAccount.address, "0.03", "0.03");
     });
     test("should deploy MACI correctly", async () => {
-        const config = testMaciDeploymentConfig;
-        config.VerifyingKeysRegistry.args.stateTreeDepth = config.VerifyingKeysRegistry.args.stateTreeDepth.toString();
-        config.VerifyingKeysRegistry.args.intStateTreeDepth =
-            config.VerifyingKeysRegistry.args.intStateTreeDepth.toString();
-        config.VerifyingKeysRegistry.args.voteOptionTreeDepth =
-            config.VerifyingKeysRegistry.args.voteOptionTreeDepth.toString();
-        const response = await fetch(`${LOCALHOST}/v1/deploy/maci`, {
+        const response = await fetch(`${TEST_URL}/deploy/maci`, {
             method: "POST",
             headers: {
                 Authorization: encryptedHeader,
                 "Content-Type": "application/json",
             },
             body: JSON.stringify({
-                approval,
-                sessionKeyAddress,
-                chain: ESupportedNetworks.OPTIMISM_SEPOLIA,
-                config,
+                chain: CHAIN,
+                config: testMaciDeploymentConfig,
             }),
         });
         const body = (await response.json());
         expect(response.status).toBe(201);
         expect(body.address).not.toBe(zeroAddress);
         // save them for next tests
+        const blockNumber = await signer.provider.getBlockNumber();
+        maciCreatedAt = BigInt(blockNumber);
         maciAddress = body.address;
     });
     test("should deploy a poll correctly", async () => {
-        const config = testPollDeploymentConfig;
-        config.coordinatorPublicKey = coordinatorKeypair.publicKey.serialize();
-        config.voteOptions = config.voteOptions.toString();
-        const startDate = Math.floor(Date.now() / 1000) + 10;
-        config.startDate = startDate;
-        config.endDate = startDate + pollDuration;
-        const response = await fetch(`${LOCALHOST}/v1/deploy/poll`, {
+        testPollDeploymentConfig.voteOptions = testPollDeploymentConfig.voteOptions.toString();
+        const startDate = Math.floor(Date.now() / 1000) + pollStartDateExtraSeconds;
+        testPollDeploymentConfig.startDate = startDate;
+        testPollDeploymentConfig.endDate = startDate + pollDuration;
+        const response = await fetch(`${TEST_URL}/deploy/poll`, {
             method: "POST",
             headers: {
                 Authorization: encryptedHeader,
                 "Content-Type": "application/json",
             },
             body: JSON.stringify({
-                approval,
-                sessionKeyAddress,
-                chain: ESupportedNetworks.OPTIMISM_SEPOLIA,
-                config,
+                chain: CHAIN,
+                config: testPollDeploymentConfig,
             }),
         });
         const body = (await response.json());
@@ -143,36 +141,14 @@ describe("E2E Deployment Tests", () => {
         // save them for next tests
         pollId = BigInt(body.pollId);
     });
-    test("should deploy a subgraph correctly", async () => {
-        const blockNumber = Number(await publicClient.getBlockNumber());
-        const response = await fetch(`${LOCALHOST}/v1/subgraph/deploy`, {
-            method: "POST",
-            headers: {
-                Authorization: encryptedHeader,
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify({
-                maciContractAddress: maciAddress,
-                startBlock: blockNumber,
-                network: ESupportedNetworks.OPTIMISM_SEPOLIA,
-                name: process.env.SUBGRAPH_NAME,
-                tag: `v0.0.${blockNumber}`, // different versions per test using block number
-            }),
-        });
-        const body = (await response.json());
-        const { url } = body;
-        const regex = /^https:\/\/api\.studio\.thegraph\.com\/query\/\d+\/maci-subgraph\/v0\.0\.\d+$/;
-        expect(response.status).toBe(201);
-        expect(body.url).toBeDefined();
-        expect(regex.test(url)).toBe(true);
-    });
     test("should allow voting on a poll", async () => {
+        await sleepUntil(testPollDeploymentConfig.startDate * 1000);
         for (let i = 0; i < NUM_USERS; i += 1) {
             const keypairUser = new Keypair();
             const userPublicKey = keypairUser.publicKey.serialize();
             const userPrivateKey = keypairUser.privateKey.serialize();
             const vote = i % 2;
-            voteOptions[String(vote)] += 1;
+            VOTE_OPTIONS[String(vote)] += 1;
             // user signs up to MACI
             // eslint-disable-next-line no-await-in-loop
             await signup({
@@ -186,37 +162,50 @@ describe("E2E Deployment Tests", () => {
             await joinPoll({
                 maciAddress,
                 privateKey: userPrivateKey,
-                stateIndex: 1n,
                 pollId: BigInt(pollId),
                 pollJoiningZkey: pollJoiningTestZkeyPath,
-                useWasm: true,
-                pollWasm: testPollJoiningWasmPath,
-                pollWitgen: testPollJoiningWitnessPath,
+                useWasm,
+                pollJoiningWasm: testPollJoiningWasmPath,
+                pollWitnessGenerator: testPollJoiningWitnessPath,
                 rapidsnark: testRapidsnarkPath,
                 sgDataArg: zeroUint256Encoded,
                 ivcpDataArg: zeroUint256Encoded,
                 signer,
             });
-            // user publishes a vote
-            // eslint-disable-next-line no-await-in-loop
-            const publishData = await publish({
-                publicKey: userPublicKey,
-                stateIndex: 1n,
-                voteOptionIndex: BigInt(vote),
-                nonce: 1n,
-                pollId: BigInt(pollId),
-                newVoteWeight: 1n,
-                maciAddress,
-                salt: generateRandomSalt(),
-                privateKey: userPrivateKey,
-                signer,
-            });
-            expect(publishData.hash).not.toBe(zeroAddress);
         }
     });
+    test("should deploy a subgraph correctly", async () => {
+        const response = await fetch(`${TEST_URL}/subgraph/deploy`, {
+            method: "POST",
+            headers: {
+                Authorization: encryptedHeader,
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify({
+                maciContractAddress: maciAddress,
+                startBlock: Number(maciCreatedAt),
+                network: ESupportedChains.OptimismSepolia,
+                name: process.env.SUBGRAPH_NAME,
+                tag: `v0.0.${+new Date()}`, // different versions per test using timestamp
+            }),
+        });
+        const body = await response.json();
+        if (response.status === 400) {
+            const errorMessage = body.message;
+            if (errorMessage.includes("api.thegraph.com | 502: Bad gateway")) {
+                // eslint-disable-next-line no-console
+                console.info("It looks like there was a problem with The Graph endpoint. We are passing this test.");
+                return;
+            }
+        }
+        const { url } = body;
+        expect(response.status).toBe(201);
+        expect(url).toBeDefined();
+        expect(REGEX_SUBGRAPH.test(url)).toBe(true);
+    });
     test("should merge correctly", async () => {
-        await sleep(10000);
-        const response = await fetch(`${LOCALHOST}/v1/proof/merge`, {
+        await sleepUntil((testPollDeploymentConfig.endDate + 13) * 1000); // 13 seconds of grace time after the poll end date
+        const response = await fetch(`${TEST_URL}/proof/merge`, {
             method: "POST",
             headers: {
                 Authorization: encryptedHeader,
@@ -225,9 +214,48 @@ describe("E2E Deployment Tests", () => {
             body: JSON.stringify({
                 maciContractAddress: maciAddress,
                 pollId: Number(pollId),
-                approval,
-                sessionKeyAddress,
-                chain: ESupportedNetworks.OPTIMISM_SEPOLIA,
+                chain: CHAIN,
+            }),
+        });
+        expect(response.status).toBe(201);
+    });
+    test("should generate proofs correctly", async () => {
+        const response = await fetch(`${TEST_URL}/proof/generate`, {
+            method: "POST",
+            headers: {
+                Authorization: encryptedHeader,
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify({
+                poll: Number(pollId),
+                maciContractAddress: maciAddress,
+                mode: testPollDeploymentConfig.mode,
+                startBlock: Number(maciCreatedAt),
+                blocksPerBatch: 500,
+                chain: CHAIN,
+                useWasm,
+            }),
+        });
+        const body = (await response.json());
+        expect(response.status).toBe(201);
+        expect(body.processProofs).toBeDefined();
+        expect(body.processProofs.length).toBeGreaterThan(0);
+        expect(body.tallyProofs).toBeDefined();
+        expect(body.tallyProofs.length).toBeGreaterThan(0);
+        expect(body.tallyData).toBeDefined();
+        expect(body.tallyData.results).toBeDefined();
+    });
+    test("should submit results on-chain correctly", async () => {
+        const response = await fetch(`${TEST_URL}/proof/submit`, {
+            method: "POST",
+            headers: {
+                Authorization: encryptedHeader,
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify({
+                pollId: Number(pollId),
+                maciContractAddress: maciAddress,
+                chain: CHAIN,
             }),
         });
         expect(response.status).toBe(201);