@maci-protocol/coordinator 0.0.0-ci.da13fbb → 0.0.0-ci.de6bbd5

package/build/ts/health/__tests__/health.service.test.js

@@ -0,0 +1,88 @@
+import { EMode } from "@maci-protocol/contracts";
+import dotenv from "dotenv";
+import { zeroAddress } from "viem";
+import { FileService } from "../../file/file.service";
+import { RedisService } from "../../redis/redis.service";
+import { HealthService } from "../health.service";
+dotenv.config();
+describe("HealthService", () => {
+    const fileService = new FileService();
+    const redisService = new RedisService();
+    const healthService = new HealthService(fileService, redisService);
+    beforeAll(async () => {
+        await redisService.onModuleInit();
+    });
+    describe("checkRapidsnark", () => {
+        it("should return rapidsnark path and executability status", async () => {
+            const response = await healthService.checkRapidsnark();
+            expect(response.rapidsnarkExecutablePath).toBe(process.env.COORDINATOR_RAPIDSNARK_EXE);
+            expect(response.rapidsnarkIsAccessible).toBe(true);
+            expect(response.rapidsnarkIsExecutable).toBe(true);
+        });
+        it("should return false when rapidsnark path is not set", async () => {
+            process.env.COORDINATOR_RAPIDSNARK_EXE = "/incorrect/path/to/rapidsnark";
+            const response = await healthService.checkRapidsnark();
+            expect(response.rapidsnarkIsAccessible).toBe(false);
+            expect(response.rapidsnarkIsExecutable).toBe(false);
+        });
+    });
+    describe("checkZkeysDirectory", () => {
+        it("should return if zkeys directory exists and the available zkeys paths", async () => {
+            const { zkeysDirectoryExists, availableZkeys } = await healthService.checkZkeysDirectory();
+            const numberofZkeys = Object.keys(availableZkeys).length;
+            const expectedNumberOfZkeys = 1 + // poll joining zkey
+                1 + // poll joined zkey
+                3 + // message process zkey for modes (QV, NON_QV, FULL)
+                2; // vote tally zkey for modes (only QV and NON_QV)
+            expect(zkeysDirectoryExists).toBe(true);
+            expect(numberofZkeys).toBe(expectedNumberOfZkeys);
+        });
+        it("should return less available zkeys when COORDINATOR_POLL_JOINING_ZKEY_NAME is not set in the env file", async () => {
+            process.env.COORDINATOR_POLL_JOINING_ZKEY_NAME = "/incorrect/path/to/poll_joining";
+            const { availableZkeys } = await healthService.checkZkeysDirectory();
+            expect(availableZkeys[process.env.COORDINATOR_POLL_JOINING_ZKEY_NAME]).toBe(undefined);
+        });
+        it("should return less available zkeys when COORDINATOR_POLL_JOINED_ZKEY_NAME is not set in the env file", async () => {
+            process.env.COORDINATOR_POLL_JOINED_ZKEY_NAME = "/incorrect/path/to/poll_joined";
+            const { availableZkeys } = await healthService.checkZkeysDirectory();
+            expect(availableZkeys[process.env.COORDINATOR_POLL_JOINED_ZKEY_NAME]).toBe(undefined);
+        });
+        it("should return less available zkeys when COORDINATOR_TALLY_ZKEY_NAME is not set in the env file", async () => {
+            process.env.COORDINATOR_TALLY_ZKEY_NAME = "/incorrect/path/to/tally_zkey";
+            const { availableZkeys } = await healthService.checkZkeysDirectory();
+            expect(availableZkeys[`${process.env.COORDINATOR_TALLY_ZKEY_NAME}_Mode_${String(EMode.NON_QV)}`]).toBe(undefined);
+            expect(availableZkeys[`${process.env.COORDINATOR_TALLY_ZKEY_NAME}_Mode_${String(EMode.QV)}`]).toBe(undefined);
+        });
+        it("should return less available zkeys when COORDINATOR_MESSAGE_PROCESS_ZKEY_NAME is not set in the env file", async () => {
+            process.env.COORDINATOR_MESSAGE_PROCESS_ZKEY_NAME = "/incorrect/path/to/message_process_zkey";
+            const { availableZkeys } = await healthService.checkZkeysDirectory();
+            expect(availableZkeys[`${process.env.COORDINATOR_MESSAGE_PROCESS_ZKEY_NAME}_Mode_${String(EMode.NON_QV)}`]).toBe(undefined);
+            expect(availableZkeys[`${process.env.COORDINATOR_MESSAGE_PROCESS_ZKEY_NAME}_Mode_${String(EMode.QV)}`]).toBe(undefined);
+            expect(availableZkeys[`${process.env.COORDINATOR_MESSAGE_PROCESS_ZKEY_NAME}_Mode_${String(EMode.FULL)}`]).toBe(undefined);
+        });
+        it("should return false when zkeys directory is not set", async () => {
+            process.env.COORDINATOR_ZKEY_PATH = "/incorrect/path/to/zkeys";
+            const { zkeysDirectoryExists } = await healthService.checkZkeysDirectory();
+            expect(zkeysDirectoryExists).toBe(false);
+        });
+    });
+    describe("checkWalletFunds", () => {
+        it("should return the wallet address", async () => {
+            const { address } = await healthService.checkWalletFunds();
+            expect(address).toBeDefined();
+            expect(address).not.toBe(zeroAddress);
+        });
+        it("should return 0x if coordinator private key is not set", async () => {
+            process.env.PRIVATE_KEY = "";
+            const { address } = await healthService.checkWalletFunds();
+            expect(address).toBe(zeroAddress);
+        });
+    });
+    describe("checkRedisConnection", () => {
+        it("should return true if Redis connection is open", () => {
+            const isRedisOpen = healthService.checkRedisConnection();
+            expect(isRedisOpen).toBe(true);
+        });
+    });
+});
+//# sourceMappingURL=health.service.test.js.map

package/build/ts/health/__tests__/health.service.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.service.test.js","sourceRoot":"","sources":["../../../../ts/health/__tests__/health.service.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAEnC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,MAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IACtC,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;IACxC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAEnE,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,YAAY,CAAC,YAAY,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;YACtE,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,eAAe,EAAE,CAAC;YAEvD,MAAM,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;YACvF,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnD,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,+BAA+B,CAAC;YACzE,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,eAAe,EAAE,CAAC;YAEvD,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpD,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;YACrF,MAAM,EAAE,oBAAoB,EAAE,cAAc,EAAE,GAAG,MAAM,aAAa,CAAC,mBAAmB,EAAE,CAAC;YAC3F,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC;YAEzD,MAAM,qBAAqB,GACzB,CAAC,GAAG,oBAAoB;gBACxB,CAAC,GAAG,mBAAmB;gBACvB,CAAC,GAAG,oDAAoD;gBACxD,CAAC,CAAC,CAAC,iDAAiD;YAEtD,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uGAAuG,EAAE,KAAK,IAAI,EAAE;YACrH,OAAO,CAAC,GAAG,CAAC,kCAAkC,GAAG,iCAAiC,CAAC;YACnF,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,aAAa,CAAC,mBAAmB,EAAE,CAAC;YAErE,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sGAAsG,EAAE,KAAK,IAAI,EAAE;YACpH,OAAO,CAAC,GAAG,CAAC,iCAAiC,GAAG,gCAAgC,CAAC;YACjF,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,aAAa,CAAC,mBAAmB,EAAE,CAAC;YAErE,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gGAAgG,EAAE,KAAK,IAAI,EAAE;YAC9G,OAAO,CAAC,GAAG,CAAC,2BAA2B,GAAG,+BAA+B,CAAC;YAC1E,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,aAAa,CAAC,mBAAmB,EAAE,CAAC;YAErE,MAAM,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,2BAA2B,SAAS,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAClH,MAAM,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,2BAA2B,SAAS,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0GAA0G,EAAE,KAAK,IAAI,EAAE;YACxH,OAAO,CAAC,GAAG,CAAC,qCAAqC,GAAG,yCAAyC,CAAC;YAC9F,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,aAAa,CAAC,mBAAmB,EAAE,CAAC;YAErE,MAAM,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,qCAAqC,SAAS,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAC9G,SAAS,CACV,CAAC;YACF,MAAM,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,qCAAqC,SAAS,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAC1G,SAAS,CACV,CAAC;YACF,MAAM,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,qCAAqC,SAAS,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAC5G,SAAS,CACV,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,OAAO,CAAC,GAAG,CAAC,qBAAqB,GAAG,0BAA0B,CAAC;YAC/D,MAAM,EAAE,oBAAoB,EAAE,GAAG,MAAM,aAAa,CAAC,mBAAmB,EAAE,CAAC;YAE3E,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;YAChD,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,aAAa,CAAC,gBAAgB,EAAE,CAAC;YAE3D,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;YAC9B,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;YACtE,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,EAAE,CAAC;YAC7B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,aAAa,CAAC,gBAAgB,EAAE,CAAC;YAE3D,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,MAAM,WAAW,GAAG,aAAa,CAAC,oBAAoB,EAAE,CAAC;YAEzD,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/ts/health/health.controller.d.ts

@@ -0,0 +1,16 @@
+import { HealthService } from "./health.service";
+import { IHealthCheckResponse } from "./types";
+export declare class HealthController {
+    private readonly healthService;
+    /**
+     * Initialize HealthController
+     */
+    constructor(healthService: HealthService);
+    /**
+     * Health check api method.
+     *
+     * @returns true if the service is running
+     */
+    check(): Promise<IHealthCheckResponse>;
+}
+//# sourceMappingURL=health.controller.d.ts.map

package/build/ts/health/health.controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.controller.d.ts","sourceRoot":"","sources":["../../../ts/health/health.controller.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE/C,qBAEa,gBAAgB;IAIf,OAAO,CAAC,QAAQ,CAAC,aAAa;IAH1C;;OAEG;gBAC0B,aAAa,EAAE,aAAa;IAEzD;;;;OAIG;IAGH,KAAK,IAAI,OAAO,CAAC,oBAAoB,CAAC;CAGvC"}

package/build/ts/health/health.controller.js

@@ -0,0 +1,43 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Controller, Get, HttpStatus } from "@nestjs/common";
+import { ApiResponse, ApiTags } from "@nestjs/swagger";
+import { HealthService } from "./health.service";
+let HealthController = class HealthController {
+    healthService;
+    /**
+     * Initialize HealthController
+     */
+    constructor(healthService) {
+        this.healthService = healthService;
+    }
+    /**
+     * Health check api method.
+     *
+     * @returns true if the service is running
+     */
+    check() {
+        return this.healthService.checkCoordinatorHealth();
+    }
+};
+__decorate([
+    ApiResponse({ status: HttpStatus.OK, description: "The service is running" }),
+    Get("check"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], HealthController.prototype, "check", null);
+HealthController = __decorate([
+    ApiTags("v1/health"),
+    Controller("v1/health"),
+    __metadata("design:paramtypes", [HealthService])
+], HealthController);
+export { HealthController };
+//# sourceMappingURL=health.controller.js.map

package/build/ts/health/health.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.controller.js","sourceRoot":"","sources":["../../../ts/health/health.controller.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAEvD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAK1C,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAIE;IAH7B;;OAEG;IACH,YAA6B,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;IAAG,CAAC;IAE7D;;;;OAIG;IAGH,KAAK;QACH,OAAO,IAAI,CAAC,aAAa,CAAC,sBAAsB,EAAE,CAAC;IACrD,CAAC;CACF,CAAA;AAHC;IAFC,WAAW,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,WAAW,EAAE,wBAAwB,EAAE,CAAC;IAC7E,GAAG,CAAC,OAAO,CAAC;;;;6CAGZ;AAfU,gBAAgB;IAF5B,OAAO,CAAC,WAAW,CAAC;IACpB,UAAU,CAAC,WAAW,CAAC;qCAKsB,aAAa;GAJ9C,gBAAgB,CAgB5B"}

package/build/ts/health/health.module.d.ts

@@ -0,0 +1,3 @@
+export declare class HealthModule {
+}
+//# sourceMappingURL=health.module.d.ts.map

package/build/ts/health/health.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.module.d.ts","sourceRoot":"","sources":["../../../ts/health/health.module.ts"],"names":[],"mappings":"AAQA,qBAKa,YAAY;CAAG"}

package/build/ts/health/health.module.js

@@ -0,0 +1,22 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Module } from "@nestjs/common";
+import { FileModule } from "../file/file.module";
+import { RedisModule } from "../redis/redis.module";
+import { HealthController } from "./health.controller";
+import { HealthService } from "./health.service";
+let HealthModule = class HealthModule {
+};
+HealthModule = __decorate([
+    Module({
+        imports: [FileModule, RedisModule],
+        controllers: [HealthController],
+        providers: [HealthService],
+    })
+], HealthModule);
+export { HealthModule };
+//# sourceMappingURL=health.module.js.map

package/build/ts/health/health.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.module.js","sourceRoot":"","sources":["../../../ts/health/health.module.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAO1C,IAAM,YAAY,GAAlB,MAAM,YAAY;CAAG,CAAA;AAAf,YAAY;IALxB,MAAM,CAAC;QACN,OAAO,EAAE,CAAC,UAAU,EAAE,WAAW,CAAC;QAClC,WAAW,EAAE,CAAC,gBAAgB,CAAC;QAC/B,SAAS,EAAE,CAAC,aAAa,CAAC;KAC3B,CAAC;GACW,YAAY,CAAG"}

package/build/ts/health/health.service.d.ts

@@ -0,0 +1,42 @@
+import type { ICheckRapidsnark, ICheckWalletFunds, ICheckZkeysDirectory, IHealthCheckResponse } from "./types";
+import { FileService } from "../file/file.service";
+import { RedisService } from "../redis/redis.service";
+/**
+ * Health service functions to check the status of the coordinator service.
+ */
+export declare class HealthService {
+    private readonly fileService;
+    private readonly redisService;
+    /**
+     * Create a new instance of the HealthService.
+     *
+     * @param fileService - file service
+     */
+    constructor(fileService: FileService, redisService: RedisService);
+    /**
+     * Check if rapidsnark is available and executable.
+     * @returns the rapidsnark executable path and its executability status
+     */
+    checkRapidsnark(): Promise<ICheckRapidsnark>;
+    /**
+     * Check if zkeys directory exists
+     * @returns the existence of the zkeys directory and the required zkeys
+     */
+    checkZkeysDirectory(): Promise<ICheckZkeysDirectory>;
+    /**
+     * Check if coordinator wallet has funds
+     * @returns the address and its funds in all networks
+     */
+    checkWalletFunds(): Promise<ICheckWalletFunds>;
+    /**
+     * Check redis client is connected and open
+     * @return true if the redis client is connected and open, false otherwise
+     */
+    checkRedisConnection(): boolean;
+    /**
+     * Check coordinator service health
+     * @returns an object containing the results of all the health checks
+     */
+    checkCoordinatorHealth(): Promise<IHealthCheckResponse>;
+}
+//# sourceMappingURL=health.service.d.ts.map

package/build/ts/health/health.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.service.d.ts","sourceRoot":"","sources":["../../../ts/health/health.service.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAG/G,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD;;GAEG;AACH,qBACa,aAAa;IAOtB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAP/B;;;;OAIG;gBAEgB,WAAW,EAAE,WAAW,EACxB,YAAY,EAAE,YAAY;IAG7C;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAuBlD;;;OAGG;IACG,mBAAmB,IAAI,OAAO,CAAC,oBAAoB,CAAC;IA0D1D;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAuCpD;;;OAGG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;;OAGG;IACG,sBAAsB,IAAI,OAAO,CAAC,oBAAoB,CAAC;CAe9D"}

package/build/ts/health/health.service.js

@@ -0,0 +1,182 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { EMode } from "@maci-protocol/sdk";
+import { Injectable } from "@nestjs/common";
+import { formatEther } from "ethers";
+import { zeroAddress } from "viem";
+import fs from "fs";
+import path from "path";
+import { ESupportedNetworks, getSigner } from "../common";
+import { FileService } from "../file/file.service";
+import { RedisService } from "../redis/redis.service";
+/**
+ * Health service functions to check the status of the coordinator service.
+ */
+let HealthService = class HealthService {
+    fileService;
+    redisService;
+    /**
+     * Create a new instance of the HealthService.
+     *
+     * @param fileService - file service
+     */
+    constructor(fileService, redisService) {
+        this.fileService = fileService;
+        this.redisService = redisService;
+    }
+    /**
+     * Check if rapidsnark is available and executable.
+     * @returns the rapidsnark executable path and its executability status
+     */
+    async checkRapidsnark() {
+        const rapidsnarkExecutablePath = process.env.COORDINATOR_RAPIDSNARK_EXE || "";
+        const [rapidsnarkIsAccessible, rapidsnarkIsExecutable] = await Promise.all([
+            fs.promises
+                // eslint-disable-next-line no-bitwise
+                .access(rapidsnarkExecutablePath, fs.constants.F_OK | fs.constants.X_OK)
+                .then(() => true)
+                .catch(() => false),
+            fs.promises
+                // eslint-disable-next-line no-bitwise
+                .stat(rapidsnarkExecutablePath)
+                .then((stats) => stats.isFile())
+                .catch(() => false),
+        ]);
+        return {
+            rapidsnarkExecutablePath,
+            rapidsnarkIsAccessible,
+            rapidsnarkIsExecutable,
+        };
+    }
+    /**
+     * Check if zkeys directory exists
+     * @returns the existence of the zkeys directory and the required zkeys
+     */
+    async checkZkeysDirectory() {
+        const zkeysDirectoryPath = path.resolve(process.env.COORDINATOR_ZKEY_PATH);
+        const requiredZkeyNames = [
+            {
+                name: process.env.COORDINATOR_TALLY_ZKEY_NAME,
+                modes: [EMode.QV, EMode.NON_QV],
+            },
+            {
+                name: process.env.COORDINATOR_MESSAGE_PROCESS_ZKEY_NAME,
+                modes: [EMode.QV, EMode.NON_QV, EMode.FULL],
+            },
+            {
+                name: process.env.COORDINATOR_POLL_JOINING_ZKEY_NAME,
+            },
+            {
+                name: process.env.COORDINATOR_POLL_JOINED_ZKEY_NAME,
+            },
+        ];
+        const zkeysDirectoryExists = await fs.promises
+            .stat(zkeysDirectoryPath)
+            .then((stats) => stats.isDirectory())
+            .catch(() => false);
+        const availableZkeys = requiredZkeyNames.reduce((acc, { name, modes }) => {
+            if (!modes) {
+                try {
+                    acc[name] = this.fileService.getZkeyFilePaths(name);
+                }
+                catch (error) {
+                    acc[name] = undefined;
+                }
+                return acc;
+            }
+            const modeEntries = modes.reduce((modeAcc, mode) => {
+                const pathname = `${name}_Mode_${String(mode)}`;
+                try {
+                    // eslint-disable-next-line no-param-reassign
+                    modeAcc[pathname] = this.fileService.getZkeyFilePaths(name, mode);
+                }
+                catch (error) {
+                    // eslint-disable-next-line no-param-reassign
+                    modeAcc[pathname] = undefined;
+                }
+                return modeAcc;
+            }, {});
+            return { ...acc, ...modeEntries };
+        }, {});
+        return {
+            zkeysDirectoryExists,
+            availableZkeys,
+        };
+    }
+    /**
+     * Check if coordinator wallet has funds
+     * @returns the address and its funds in all networks
+     */
+    async checkWalletFunds() {
+        let address;
+        const networks = Object.values(ESupportedNetworks);
+        try {
+            const signer = getSigner(networks[0]);
+            address = await signer.getAddress();
+        }
+        catch (error) {
+            return {
+                address: zeroAddress,
+                fundsInNetworks: [],
+            };
+        }
+        const fundsInNetworks = await Promise.all(networks.map(async (network) => {
+            const signer = getSigner(network);
+            return signer.provider
+                ?.getBalance(address)
+                .then((balance) => ({
+                network,
+                balance: formatEther(balance),
+                status: true,
+            }))
+                .catch(() => ({
+                network,
+                balance: formatEther(0n),
+                status: false,
+            }));
+        }));
+        return {
+            address,
+            fundsInNetworks,
+        };
+    }
+    /**
+     * Check redis client is connected and open
+     * @return true if the redis client is connected and open, false otherwise
+     */
+    checkRedisConnection() {
+        return this.redisService.isOpen();
+    }
+    /**
+     * Check coordinator service health
+     * @returns an object containing the results of all the health checks
+     */
+    async checkCoordinatorHealth() {
+        const [rapidsnark, zkeysDirectory, coordinatorWalletFunds] = await Promise.all([
+            this.checkRapidsnark(),
+            this.checkZkeysDirectory(),
+            this.checkWalletFunds(),
+        ]);
+        const isRedisOpen = this.checkRedisConnection();
+        return {
+            rapidsnark,
+            zkeysDirectory,
+            coordinatorWalletFunds,
+            isRedisOpen,
+        };
+    }
+};
+HealthService = __decorate([
+    Injectable(),
+    __metadata("design:paramtypes", [FileService,
+        RedisService])
+], HealthService);
+export { HealthService };
+//# sourceMappingURL=health.service.js.map

package/build/ts/health/health.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.service.js","sourceRoot":"","sources":["../../../ts/health/health.service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAEnC,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAIxB,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD;;GAEG;AAEI,IAAM,aAAa,GAAnB,MAAM,aAAa;IAOL;IACA;IAPnB;;;;OAIG;IACH,YACmB,WAAwB,EACxB,YAA0B;QAD1B,gBAAW,GAAX,WAAW,CAAa;QACxB,iBAAY,GAAZ,YAAY,CAAc;IAC1C,CAAC;IAEJ;;;OAGG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC,0BAA0B,IAAI,EAAE,CAAC;QAE9E,MAAM,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACzE,EAAE,CAAC,QAAQ;gBACT,sCAAsC;iBACrC,MAAM,CAAC,wBAAwB,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC;iBACvE,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;iBAChB,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC;YACrB,EAAE,CAAC,QAAQ;gBACT,sCAAsC;iBACrC,IAAI,CAAC,wBAAwB,CAAC;iBAC9B,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;iBAC/B,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC;SACtB,CAAC,CAAC;QAEH,OAAO;YACL,wBAAwB;YACxB,sBAAsB;YACtB,sBAAsB;SACvB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB;QACvB,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAsB,CAAC,CAAC;QAC5E,MAAM,iBAAiB,GAAG;YACxB;gBACE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,2BAA2B;gBAC7C,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC;aAChC;YACD;gBACE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,qCAAqC;gBACvD,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC;aAC5C;YACD;gBACE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,kCAAkC;aACrD;YACD;gBACE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,iCAAiC;aACpD;SACF,CAAC;QAEF,MAAM,oBAAoB,GAAG,MAAM,EAAE,CAAC,QAAQ;aAC3C,IAAI,CAAC,kBAAkB,CAAC;aACxB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;aACpC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QAEtB,MAAM,cAAc,GAAG,iBAAiB,CAAC,MAAM,CAAyC,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;YAC/G,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,IAAI,CAAC;oBACH,GAAG,CAAC,IAAK,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,IAAK,CAAC,CAAC;gBACxD,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,GAAG,CAAC,IAAK,CAAC,GAAG,SAAS,CAAC;gBACzB,CAAC;gBAED,OAAO,GAAG,CAAC;YACb,CAAC;YAED,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAyC,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;gBACzF,MAAM,QAAQ,GAAG,GAAG,IAAK,SAAS,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAEjD,IAAI,CAAC;oBACH,6CAA6C;oBAC7C,OAAO,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,IAAK,EAAE,IAAI,CAAC,CAAC;gBACrE,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,6CAA6C;oBAC7C,OAAO,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;gBAChC,CAAC;gBAED,OAAO,OAAO,CAAC;YACjB,CAAC,EAAE,EAAE,CAAC,CAAC;YAEP,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,WAAW,EAAE,CAAC;QACpC,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,OAAO;YACL,oBAAoB;YACpB,cAAc;SACf,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB;QACpB,IAAI,OAAe,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAEnD,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YACtC,OAAO,GAAG,MAAM,MAAM,CAAC,UAAU,EAAE,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,WAAW;gBACpB,eAAe,EAAE,EAAE;aACpB,CAAC;QACJ,CAAC;QAED,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACvC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YAC7B,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;YAElC,OAAO,MAAM,CAAC,QAAQ;gBACpB,EAAE,UAAU,CAAC,OAAO,CAAC;iBACpB,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAClB,OAAO;gBACP,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;gBAC7B,MAAM,EAAE,IAAI;aACb,CAAC,CAAC;iBACF,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;gBACZ,OAAO;gBACP,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;gBACxB,MAAM,EAAE,KAAK;aACd,CAAC,CAAC,CAAC;QACR,CAAC,CAAC,CACH,CAAC;QAEF,OAAO;YACL,OAAO;YACP,eAAe;SAChB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,oBAAoB;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,sBAAsB;QAC1B,MAAM,CAAC,UAAU,EAAE,cAAc,EAAE,sBAAsB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC7E,IAAI,CAAC,eAAe,EAAE;YACtB,IAAI,CAAC,mBAAmB,EAAE;YAC1B,IAAI,CAAC,gBAAgB,EAAE;SACxB,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAEhD,OAAO;YACL,UAAU;YACV,cAAc;YACd,sBAAsB;YACtB,WAAW;SACZ,CAAC;IACJ,CAAC;CACF,CAAA;AA1KY,aAAa;IADzB,UAAU,EAAE;qCAQqB,WAAW;QACV,YAAY;GARlC,aAAa,CA0KzB"}

package/build/ts/health/types.d.ts

@@ -0,0 +1,83 @@
+import type { IGetZkeyFilePathsData } from "../file/types";
+/**
+ * Interface for checking the rapidsnark setup
+ */
+export interface ICheckRapidsnark {
+    /**
+     * Rapidsnark executable path
+     */
+    rapidsnarkExecutablePath: string;
+    /**
+     * Is rapidsnark accessible
+     */
+    rapidsnarkIsAccessible: boolean;
+    /**
+     * Is rapidsnark executable
+     */
+    rapidsnarkIsExecutable: boolean;
+}
+/**
+ * Interface for checking the zkeys directory
+ */
+export interface ICheckZkeysDirectory {
+    /**
+     * Does zkeys directory exist
+     */
+    zkeysDirectoryExists: boolean;
+    /**
+     * Available zkeys
+     */
+    availableZkeys: Record<string, IGetZkeyFilePathsData | undefined>;
+}
+/**
+ * Interface for network info (balance and status)
+ */
+export interface INetworkInfo {
+    /**
+     * Network name
+     */
+    network: string;
+    /**
+     * Balance in the network
+     */
+    balance: string;
+    /**
+     * Is the network accessible
+     */
+    status: boolean;
+}
+/**
+ * Interface for checking the coordinator wallet funds
+ */
+export interface ICheckWalletFunds {
+    /**
+     * Coordinator address
+     */
+    address: string;
+    /**
+     * Funds in all networks
+     */
+    fundsInNetworks: (INetworkInfo | undefined)[];
+}
+/**
+ * Interface for the health check response
+ */
+export interface IHealthCheckResponse {
+    /**
+     * Rapidsnark check result
+     */
+    rapidsnark: ICheckRapidsnark;
+    /**
+     * Zkeys directory check result
+     */
+    zkeysDirectory: ICheckZkeysDirectory;
+    /**
+     * Coordinator wallet funds check result
+     */
+    coordinatorWalletFunds: ICheckWalletFunds;
+    /**
+     * Redis connection is open
+     */
+    isRedisOpen: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/ts/health/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../ts/health/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,GAAG,SAAS,CAAC,CAAC;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,CAAC,YAAY,GAAG,SAAS,CAAC,EAAE,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC;IAE7B;;OAEG;IACH,cAAc,EAAE,oBAAoB,CAAC;IAErC;;OAEG;IACH,sBAAsB,EAAE,iBAAiB,CAAC;IAE1C;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;CACtB"}

package/build/ts/health/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/ts/health/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../ts/health/types.ts"],"names":[],"mappings":""}