chore: convert coordinator service to esm module

packages/coordinator/hardhat.config.ts → packages/coordinator/hardhat.config.cjs

@@ -1,17 +1,16 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
-import "@nomicfoundation/hardhat-toolbox";
-import * as dotenv from "dotenv";
-import { HardhatUserConfig } from "hardhat/types";
+require("@nomicfoundation/hardhat-toolbox");
+const dotenv = require("dotenv");
 
-import * as path from "path";
+const path = require("path");
 
 dotenv.config();
 
 const parentDir = __dirname.includes("build") ? ".." : "";
 const TEST_MNEMONIC = "test test test test test test test test test test test junk";
 
-const config: HardhatUserConfig = {
-  defaultNetwork: "localhost",
+module.exports = {
+  defaultNetwork: "hardhat",
   networks: {
     localhost: {
       url: process.env.COORDINATOR_RPC_URL || "",
@@ -32,5 +31,3 @@ const config: HardhatUserConfig = {
     artifacts: path.resolve(__dirname, parentDir, "./node_modules/maci-contracts/build/artifacts"),
   },
 };
-
-export default config;

packages/coordinator/package.json

@@ -4,6 +4,10 @@
   "private": true,
   "description": "Coordinator service for MACI",
   "main": "build/ts/main.js",
+  "type": "module",
+  "exports": {
+    ".": "./build/ts/main.js"
+  },
   "files": [
     "build",
     "CHANGELOG.md",
@@ -12,15 +16,15 @@
   "scripts": {
     "hardhat": "hardhat node",
     "build": "nest build",
-    "start": "nest start",
-    "start:dev": "nest start --watch",
-    "start:prod": "node dist/main",
+    "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 --forceExit",
     "test:coverage": "jest --coverage --forceExit",
     "types": "tsc -p tsconfig.json --noEmit",
-    "generate-keypair": "ts-node ./scripts/generateKeypair.ts",
-    "download-zkeys:test": "ts-node ./scripts/downloadZKeys.ts test ./zkeys",
-    "download-zkeys:prod": "ts-node ./scripts/downloadZKeys.ts prod ./zkeys"
+    "generate-keypair": "pnpm run run:node ./scripts/generateKeypair.ts",
+    "download-zkeys:test": "pnpm run run:node ./scripts/downloadZKeys.ts test ./zkeys",
+    "download-zkeys:prod": "pnpm run run:node ./scripts/downloadZKeys.ts prod ./zkeys"
   },
   "dependencies": {
     "@graphprotocol/graph-cli": "^0.79.0",
@@ -58,7 +62,7 @@
     "@types/express": "^4.17.17",
     "@types/jest": "^29.5.2",
     "@types/node": "^20.14.11",
-    "@types/supertest": "^6.0.0",
+    "@types/supertest": "^6.0.2",
     "fast-check": "^3.20.0",
     "jest": "^29.5.0",
     "socket.io-client": "^4.7.5",
@@ -80,8 +84,18 @@
     ],
     "testRegex": ".*\\.test\\.ts$",
     "transform": {
-      "^.+\\.js$": "<rootDir>/ts/jest/transform.js",
-      "^.+\\.(t|j)s$": "ts-jest"
+      "^.+\\.js$": [
+        "<rootDir>/ts/jest/transform.js",
+        {
+          "useESM": true
+        }
+      ],
+      "^.+\\.(t|j)s$": [
+        "ts-jest",
+        {
+          "useESM": true
+        }
+      ]
     },
     "collectCoverageFrom": [
       "**/*.(t|j)s",

packages/coordinator/scripts/generateKeypair.ts

@@ -3,6 +3,13 @@ import dotenv from "dotenv";
 import { generateKeyPairSync } from "crypto";
 import fs from "fs";
 import path from "path";
+import url from "url";
+
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable @typescript-eslint/no-shadow */
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+/* eslint-enable no-underscore-dangle */
+/* eslint-enable @typescript-eslint/no-shadow */
 
 dotenv.config({ path: [path.resolve(__dirname, "../.env"), path.resolve(__dirname, "../.env.example")] });
 

packages/coordinator/tests/app.test.ts

@@ -16,7 +16,7 @@ import {
   mergeMessages,
   mergeSignups,
 } from "maci-cli";
-import { Proof, TallyData, Poll__factory as PollFactory } from "maci-contracts";
+import { type Proof, type TallyData, Poll__factory as PollFactory } from "maci-contracts";
 import { Keypair } from "maci-domainobjs";
 import { io, Socket } from "socket.io-client";
 import request from "supertest";
@@ -30,8 +30,8 @@ import { AppModule } from "../ts/app.module";
 import { ErrorCodes, ESupportedNetworks } from "../ts/common";
 import { CryptoService } from "../ts/crypto/crypto.service";
 import { FileModule } from "../ts/file/file.module";
-import { EProofGenerationEvents, IGenerateArgs } from "../ts/proof/types";
-import { ESubgraphEvents, IDeploySubgraphArgs } from "../ts/subgraph/types";
+import { EProofGenerationEvents, type IGenerateArgs } from "../ts/proof/types";
+import { ESubgraphEvents, type IDeploySubgraphArgs } from "../ts/subgraph/types";
 
 const STATE_TREE_DEPTH = 10;
 const INT_STATE_TREE_DEPTH = 1;

packages/coordinator/ts/auth/AccountSignatureGuard.service.ts

@@ -1,6 +1,6 @@
 import {
   Logger,
-  CanActivate,
+  type CanActivate,
   Injectable,
   SetMetadata,
   type ExecutionContext,

packages/coordinator/ts/jest/transform.js

@@ -1,9 +1,11 @@
 /* eslint-disable */
 
-module.exports = {
-  process(sourceText) {
-    return {
-      code: sourceText.replace("#!/usr/bin/env node", ""),
-    };
-  },
+export function process(sourceText) {
+  return {
+    code: sourceText.replace("#!/usr/bin/env node", ""),
+  };
+}
+
+export default {
+  process,
 };

packages/coordinator/ts/main.ts

@@ -5,8 +5,18 @@ import dotenv from "dotenv";
 import helmet from "helmet";
 
 import path from "path";
+import url from "url";
 
-dotenv.config({ path: [path.resolve(__dirname, "../.env"), path.resolve(__dirname, "../.env.example")] });
+/* eslint-disable no-underscore-dangle */
+/* eslint-disable @typescript-eslint/no-shadow */
+const __filename = url.fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+/* eslint-enable no-underscore-dangle */
+/* eslint-disable @typescript-eslint/no-shadow */
+
+dotenv.config({
+  path: [path.resolve(__dirname, "../.env"), path.resolve(__dirname, "../.env.example")],
+});
 
 async function bootstrap() {
   const { AppModule } = await import("./app.module.js");

packages/coordinator/ts/proof/__tests__/proof.gateway.test.ts

@@ -1,9 +1,9 @@
 import { Test } from "@nestjs/testing";
-import { IGenerateProofsOptions } from "maci-contracts";
 import { Server } from "socket.io";
 
 import type { IGenerateArgs, IGenerateData } from "../types";
 import type { TallyData } from "maci-cli";
+import type { IGenerateProofsOptions } from "maci-contracts";
 
 import { ProofGateway } from "../proof.gateway";
 import { ProofGeneratorService } from "../proof.service";

packages/coordinator/ts/proof/proof.gateway.ts

@@ -1,7 +1,7 @@
 import { Logger, UseGuards, UsePipes, ValidationPipe } from "@nestjs/common";
 import { MessageBody, SubscribeMessage, WebSocketGateway, WebSocketServer, WsException } from "@nestjs/websockets";
-import { IGenerateProofsBatchData, type Proof, type TallyData } from "maci-contracts";
 
+import type { IGenerateProofsBatchData, Proof, TallyData } from "maci-contracts";
 import type { Server } from "socket.io";
 
 import { AccountSignatureGuard } from "../auth/AccountSignatureGuard.service";

packages/coordinator/ts/subgraph/subgraph.gateway.ts

@@ -7,7 +7,7 @@ import { AccountSignatureGuard } from "../auth/AccountSignatureGuard.service";
 
 import { DeploySubgraphDto } from "./dto";
 import { SubgraphService } from "./subgraph.service";
-import { ESubgraphEvents, IProgressArgs } from "./types";
+import { ESubgraphEvents, type IProgressArgs } from "./types";
 
 /**
  * SubgraphGateway is responsible for websockets integration between client and SubgraphService.

packages/coordinator/tsconfig.build.json

@@ -4,8 +4,16 @@
     "outDir": "./build",
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
-    "allowJs": true
+    "lib": ["ES2023"],
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "target": "ES2022",
+    "forceConsistentCasingInFileNames": true
+  },
+  "ts-node": {
+    "esm": true,
+    "experimentalSpecifierResolution": "node"
   },
   "include": ["./ts", "./scripts", "./tests"],
-  "files": ["./hardhat.config.ts"]
+  "files": ["./hardhat.config.cjs"]
 }

packages/coordinator/tsconfig.json

@@ -3,8 +3,17 @@
   "compilerOptions": {
     "outDir": "./build",
     "emitDecoratorMetadata": true,
-    "experimentalDecorators": true
+    "experimentalDecorators": true,
+    "lib": ["ES2023"],
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "target": "ES2022",
+    "forceConsistentCasingInFileNames": true
+  },
+  "ts-node": {
+    "esm": true,
+    "experimentalSpecifierResolution": "node"
   },
   "include": ["./ts", "./scripts", "./tests"],
-  "files": ["hardhat.config.ts"]
+  "files": ["./hardhat.config.cjs"]
 }

packages/interface/tsconfig.build.json

@@ -5,7 +5,6 @@
     "esModuleInterop": true,
     "skipLibCheck": true,
     "target": "es2022",
-    "allowJs": true,
     "resolveJsonModule": true,
     "moduleDetection": "force",
     "isolatedModules": true,

packages/interface/tsconfig.json

@@ -5,7 +5,6 @@
     "esModuleInterop": true,
     "skipLibCheck": true,
     "target": "es2022",
-    "allowJs": true,
     "resolveJsonModule": true,
     "moduleDetection": "force",
     "isolatedModules": true,

tsconfig.json

@@ -6,7 +6,8 @@
     "forceConsistentCasingInFileNames": true,
     "strict": true,
     "skipLibCheck": true,
-    "resolveJsonModule": true
+    "resolveJsonModule": true,
+    "allowJs": true
   },
   "exclude": ["node_modules"],
   "include": ["packages/coordinator/ts", "packages/coordinator/scripts", "./packages/interface/src"]