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

package/build/ts/redis/redis.module.js

@@ -0,0 +1,18 @@
+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 { RedisService } from "./redis.service";
+let RedisModule = class RedisModule {
+};
+RedisModule = __decorate([
+    Module({
+        exports: [RedisService],
+        providers: [RedisService],
+    })
+], RedisModule);
+export { RedisModule };
+//# sourceMappingURL=redis.module.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redis.module.js","sourceRoot":"","sources":["../../../ts/redis/redis.module.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAMxC,IAAM,WAAW,GAAjB,MAAM,WAAW;CAAG,CAAA;AAAd,WAAW;IAJvB,MAAM,CAAC;QACN,OAAO,EAAE,CAAC,YAAY,CAAC;QACvB,SAAS,EAAE,CAAC,YAAY,CAAC;KAC1B,CAAC;GACW,WAAW,CAAG"}

package/build/ts/redis/redis.service.d.ts

@@ -0,0 +1,52 @@
+import { OnModuleInit } from "@nestjs/common";
+/**
+ * Redis service to interact with the Redis database.
+ */
+export declare class RedisService implements OnModuleInit {
+    /**
+     * Client instance used to interact with the Redis database.
+     */
+    private client;
+    /**
+     * Create a new instance of the RedisService.
+     * The Redis configuration is set up here
+     */
+    constructor();
+    /**
+     * Initializes the Redis client connection when the module has been uploaded.
+     * @dev it is a lifecycle hook provided by NestJS that is called after all dependencies
+     * are injected and the module is fully initialized.
+     * This ensures your service is ready and all dependencies are available.
+     */
+    onModuleInit(): Promise<void>;
+    /**
+     * Saves a new key-value pair in Redis.
+     * @param key key for the Redis entry
+     * @param value value to be stored in Redis
+     */
+    set(key: string, value: string): Promise<void>;
+    /**
+     * Retrieves a value from Redis by its key.
+     * @param key key for the Redis entry
+     * @returns the value stored as string in Redis or null if the key does not exist
+     */
+    get(key: string): Promise<string | null>;
+    /**
+     * Retrieves all keys from Redis that match a specific pattern.
+     * @param match optional pattern to match keys in Redis
+     * @dev if no match is provided, it will return all keys
+     * @returns the array of string values stored in Redis that match the pattern
+     */
+    getAll(match?: string): Promise<string[]>;
+    /**
+     * Deletes a key from Redis.
+     * @param key key to be deleted from Redis
+     */
+    delete(key: string): Promise<number>;
+    /**
+     * Check if the connection to Redis is open
+     * @return true if the connection is open, false otherwise
+     */
+    isOpen(): boolean;
+}
+//# sourceMappingURL=redis.service.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redis.service.d.ts","sourceRoot":"","sources":["../../../ts/redis/redis.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG1D;;GAEG;AACH,qBACa,YAAa,YAAW,YAAY;IAC/C;;OAEG;IACH,OAAO,CAAC,MAAM,CAAkB;IAEhC;;;OAGG;;IAQH;;;;;OAKG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAInC;;;;OAIG;IACG,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpD;;;;OAIG;IACG,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAI9C;;;;;OAKG;IACG,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAmB/C;;;OAGG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1C;;;OAGG;IACH,MAAM,IAAI,OAAO;CAGlB"}

package/build/ts/redis/redis.service.js

@@ -0,0 +1,97 @@
+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 { Injectable } from "@nestjs/common";
+import { createClient } from "@redis/client";
+/**
+ * Redis service to interact with the Redis database.
+ */
+let RedisService = class RedisService {
+    /**
+     * Client instance used to interact with the Redis database.
+     */
+    client;
+    /**
+     * Create a new instance of the RedisService.
+     * The Redis configuration is set up here
+     */
+    constructor() {
+        this.client = createClient({
+            url: `redis://${process.env.COORDINATOR_REDIS_HOST}:${process.env.COORDINATOR_REDIS_PORT}`,
+            disableOfflineQueue: true,
+        });
+    }
+    /**
+     * Initializes the Redis client connection when the module has been uploaded.
+     * @dev it is a lifecycle hook provided by NestJS that is called after all dependencies
+     * are injected and the module is fully initialized.
+     * This ensures your service is ready and all dependencies are available.
+     */
+    async onModuleInit() {
+        await this.client.connect();
+    }
+    /**
+     * Saves a new key-value pair in Redis.
+     * @param key key for the Redis entry
+     * @param value value to be stored in Redis
+     */
+    async set(key, value) {
+        // we are not using @redis/json because we dont need complex search capabilities
+        // we store a string (lightweight) and parse it to use the object
+        await this.client.set(key, value);
+    }
+    /**
+     * Retrieves a value from Redis by its key.
+     * @param key key for the Redis entry
+     * @returns the value stored as string in Redis or null if the key does not exist
+     */
+    async get(key) {
+        return this.client.get(key);
+    }
+    /**
+     * Retrieves all keys from Redis that match a specific pattern.
+     * @param match optional pattern to match keys in Redis
+     * @dev if no match is provided, it will return all keys
+     * @returns the array of string values stored in Redis that match the pattern
+     */
+    async getAll(match) {
+        let result = [];
+        let currentCursor = "0";
+        do {
+            // using a cursor is recommended to be use in production environment
+            // eslint-disable-next-line no-await-in-loop
+            const { cursor, keys } = await this.client.scan(currentCursor, { MATCH: match || "*", COUNT: 100 });
+            // eslint-disable-next-line no-await-in-loop
+            const values = await Promise.all(keys.map((key) => this.get(key)));
+            result = result.concat(values.filter((value) => value !== null));
+            currentCursor = cursor;
+        } while (currentCursor !== "0");
+        return result;
+    }
+    /**
+     * Deletes a key from Redis.
+     * @param key key to be deleted from Redis
+     */
+    async delete(key) {
+        return this.client.del(key);
+    }
+    /**
+     * Check if the connection to Redis is open
+     * @return true if the connection is open, false otherwise
+     */
+    isOpen() {
+        return this.client.isOpen;
+    }
+};
+RedisService = __decorate([
+    Injectable(),
+    __metadata("design:paramtypes", [])
+], RedisService);
+export { RedisService };
+//# sourceMappingURL=redis.service.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redis.service.js","sourceRoot":"","sources":["../../../ts/redis/redis.service.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAgB,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAmB,MAAM,eAAe,CAAC;AAE9D;;GAEG;AAEI,IAAM,YAAY,GAAlB,MAAM,YAAY;IACvB;;OAEG;IACK,MAAM,CAAkB;IAEhC;;;OAGG;IACH;QACE,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;YACzB,GAAG,EAAE,WAAW,OAAO,CAAC,GAAG,CAAC,sBAAsB,IAAI,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE;YAC1F,mBAAmB,EAAE,IAAI;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAa;QAClC,gFAAgF;QAChF,iEAAiE;QACjE,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,KAAc;QACzB,IAAI,MAAM,GAAa,EAAE,CAAC;QAC1B,IAAI,aAAa,GAAG,GAAG,CAAC;QAExB,GAAG,CAAC;YACF,oEAAoE;YACpE,4CAA4C;YAC5C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,KAAK,IAAI,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YAEpG,4CAA4C;YAC5C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACnE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC;YAEjE,aAAa,GAAG,MAAM,CAAC;QACzB,CAAC,QAAQ,aAAa,KAAK,GAAG,EAAE;QAEhC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;CACF,CAAA;AAvFY,YAAY;IADxB,UAAU,EAAE;;GACA,YAAY,CAuFxB"}

package/build/ts/redis/types.d.ts

@@ -0,0 +1,54 @@
+import type { ESupportedNetworks } from "../common";
+import type { EMode } from "@maci-protocol/sdk";
+/**
+ * Interface of the minimal properties to identify a scheduled poll
+ */
+export interface IIdentityScheduledPoll {
+    /**
+     * Maci contract address
+     */
+    maciAddress: string;
+    /**
+     * Poll id (unique identifier)
+     */
+    pollId: string;
+    /**
+     * Chain in which the poll is deployed
+     */
+    chain: ESupportedNetworks;
+}
+/**
+ * Interface for scheduled polls stored in Redis
+ */
+export interface IScheduledPoll extends IIdentityScheduledPoll {
+    /**
+     * Deployment block number
+     */
+    deploymentBlockNumber: number;
+    /**
+     * Voting mode
+     */
+    mode: EMode;
+    /**
+     * End date in seconds
+     */
+    endDate: number;
+    /**
+     * Whether the MACI contract's state root has been merged
+     */
+    merged: boolean;
+    /**
+     * Whether the proofs has been generated
+     */
+    proofsGenerated: boolean;
+}
+/**
+ * getPollKeyForRedis parameters
+ */
+export interface IGetPollKeyForRedisParams extends IIdentityScheduledPoll {
+    /**
+     * Test environment flag (optional)
+     */
+    test?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../ts/redis/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,sBAAsB;IAC5D;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,sBAAsB;IACvE;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB"}

package/build/ts/redis/types.js

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

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

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

package/build/ts/redis/utils.d.ts

@@ -0,0 +1,20 @@
+import type { IGetPollKeyForRedisParams, IIdentityScheduledPoll } from "./types";
+/**
+ * Generates a Redis key for a poll based on its attributes
+ *
+ * @param chain - chain where the poll is deployed
+ * @param maciAddress - maci contract where the poll was created
+ * @param pollId - poll ID
+ * @param test - Optional flag to indicate if this is a test environment
+ * @returns key for Redis
+ */
+export declare const getPollKeyForRedis: ({ chain, maciAddress, pollId, test }: IGetPollKeyForRedisParams) => string;
+/**
+ * Generates a Redis key for a poll object
+ *
+ * @param scheduledPoll - poll object to generate the key from
+ * @param test - Optional flag to indicate if this is a test environment
+ * @returns key for Redis
+ */
+export declare const getPollKeyFromObject: (scheduledPoll: IIdentityScheduledPoll, test?: boolean) => string;
+//# sourceMappingURL=utils.d.ts.map

package/build/ts/redis/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../ts/redis/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAEjF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,GAAI,sCAA8C,yBAAyB,KAAG,MAG5G,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,eAAe,sBAAsB,EAAE,OAAO,OAAO,KAAG,MAMzF,CAAC"}

package/build/ts/redis/utils.js

@@ -0,0 +1,27 @@
+/**
+ * Generates a Redis key for a poll based on its attributes
+ *
+ * @param chain - chain where the poll is deployed
+ * @param maciAddress - maci contract where the poll was created
+ * @param pollId - poll ID
+ * @param test - Optional flag to indicate if this is a test environment
+ * @returns key for Redis
+ */
+export const getPollKeyForRedis = ({ chain, maciAddress, pollId, test = false }) => {
+    const isTest = test || process.env.NODE_ENV === "test";
+    return `${chain}-${maciAddress}-poll-${pollId}${isTest ? `-test` : ""}`;
+};
+/**
+ * Generates a Redis key for a poll object
+ *
+ * @param scheduledPoll - poll object to generate the key from
+ * @param test - Optional flag to indicate if this is a test environment
+ * @returns key for Redis
+ */
+export const getPollKeyFromObject = (scheduledPoll, test) => getPollKeyForRedis({
+    chain: scheduledPoll.chain,
+    maciAddress: scheduledPoll.maciAddress,
+    pollId: scheduledPoll.pollId,
+    test,
+});
+//# sourceMappingURL=utils.js.map

package/build/ts/redis/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../ts/redis/utils.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,GAAG,KAAK,EAA6B,EAAU,EAAE;IACpH,MAAM,MAAM,GAAG,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,CAAC;IACvD,OAAO,GAAG,KAAK,IAAI,WAAW,SAAS,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AAC1E,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,aAAqC,EAAE,IAAc,EAAU,EAAE,CACpG,kBAAkB,CAAC;IACjB,KAAK,EAAE,aAAa,CAAC,KAAK;IAC1B,WAAW,EAAE,aAAa,CAAC,WAAW;IACtC,MAAM,EAAE,aAAa,CAAC,MAAM;IAC5B,IAAI;CACL,CAAC,CAAC"}

package/build/ts/scheduler/__tests__/scheduler.controller.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=scheduler.controller.test.d.ts.map

package/build/ts/scheduler/__tests__/scheduler.controller.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.controller.test.d.ts","sourceRoot":"","sources":["../../../../ts/scheduler/__tests__/scheduler.controller.test.ts"],"names":[],"mappings":""}

package/build/ts/scheduler/__tests__/scheduler.controller.test.js

@@ -0,0 +1,63 @@
+import { EMode } from "@maci-protocol/sdk";
+import { HttpException, HttpStatus } from "@nestjs/common";
+import { ESupportedNetworks } from "../../common";
+import { SchedulerController } from "../scheduler.controller";
+const scheduledPoll = {
+    maciAddress: "0x0",
+    pollId: 5,
+    mode: EMode.NON_QV,
+    chain: ESupportedNetworks.OPTIMISM_SEPOLIA,
+    deploymentBlockNumber: 1,
+};
+const identityScheduledPoll = {
+    maciAddress: scheduledPoll.maciAddress,
+    pollId: scheduledPoll.pollId,
+    chain: scheduledPoll.chain,
+};
+describe("SchedulerController", () => {
+    let service;
+    let controller;
+    beforeEach(() => {
+        service = {
+            registerPoll: jest.fn().mockResolvedValue({ isScheduled: true }),
+            isPollScheduled: jest.fn().mockResolvedValue({ isScheduled: true }),
+            deleteScheduledPoll: jest.fn().mockResolvedValue({ isScheduled: false }),
+        };
+        controller = new SchedulerController(service);
+    });
+    describe("register", () => {
+        test("should register a poll for finalization", async () => {
+            const { isScheduled } = await controller.register(scheduledPoll);
+            expect(isScheduled).toBe(true);
+        });
+        test("should throw an error if registration fails", async () => {
+            const errorMessage = "Registration failed";
+            service.registerPoll.mockRejectedValueOnce(new Error(errorMessage));
+            await expect(controller.register(scheduledPoll)).rejects.toThrow(new HttpException(errorMessage, HttpStatus.BAD_REQUEST));
+        });
+    });
+    describe("status", () => {
+        test("should return scheduled poll status", async () => {
+            const { isScheduled } = await controller.status(identityScheduledPoll);
+            expect(isScheduled).toBe(true);
+        });
+        test("should throw an error if checking status fails", async () => {
+            const errorMessage = "checking status failed";
+            service.isPollScheduled.mockRejectedValueOnce(new Error(errorMessage));
+            await expect(controller.status(scheduledPoll)).rejects.toThrow(new HttpException(errorMessage, HttpStatus.BAD_REQUEST));
+        });
+    });
+    describe("delete", () => {
+        test("should delete a scheduled poll", async () => {
+            await controller.register(scheduledPoll);
+            const { isScheduled } = await controller.delete(identityScheduledPoll);
+            expect(isScheduled).toBe(false);
+        });
+        test("should throw an error if checking status fails", async () => {
+            const errorMessage = "Delete failed";
+            service.deleteScheduledPoll.mockRejectedValueOnce(new Error(errorMessage));
+            await expect(controller.delete(scheduledPoll)).rejects.toThrow(new HttpException(errorMessage, HttpStatus.BAD_REQUEST));
+        });
+    });
+});
+//# sourceMappingURL=scheduler.controller.test.js.map

package/build/ts/scheduler/__tests__/scheduler.controller.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.controller.test.js","sourceRoot":"","sources":["../../../../ts/scheduler/__tests__/scheduler.controller.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAG9D,MAAM,aAAa,GAA8B;IAC/C,WAAW,EAAE,KAAK;IAClB,MAAM,EAAE,CAAC;IACT,IAAI,EAAE,KAAK,CAAC,MAAM;IAClB,KAAK,EAAE,kBAAkB,CAAC,gBAAgB;IAC1C,qBAAqB,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,qBAAqB,GAAG;IAC5B,WAAW,EAAE,aAAa,CAAC,WAAW;IACtC,MAAM,EAAE,aAAa,CAAC,MAAM;IAC5B,KAAK,EAAE,aAAa,CAAC,KAAK;CACC,CAAC;AAE9B,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,IAAI,OAAsC,CAAC;IAE3C,IAAI,UAA+B,CAAC;IAEpC,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,GAAG;YACR,YAAY,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;YAChE,eAAe,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;YACnE,mBAAmB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;SAC7B,CAAC;QAE9C,UAAU,GAAG,IAAI,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACxB,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACzD,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAEjE,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC7D,MAAM,YAAY,GAAG,qBAAqB,CAAC;YAC3C,OAAO,CAAC,YAAY,CAAC,qBAAqB,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;YAEpE,MAAM,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAC9D,IAAI,aAAa,CAAC,YAAY,EAAE,UAAU,CAAC,WAAW,CAAC,CACxD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QACtB,IAAI,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;YAEvE,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;YAChE,MAAM,YAAY,GAAG,wBAAwB,CAAC;YAC9C,OAAO,CAAC,eAAe,CAAC,qBAAqB,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;YAEvE,MAAM,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAC5D,IAAI,aAAa,CAAC,YAAY,EAAE,UAAU,CAAC,WAAW,CAAC,CACxD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QACtB,IAAI,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAChD,MAAM,UAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAEzC,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;YAEvE,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;YAChE,MAAM,YAAY,GAAG,eAAe,CAAC;YACrC,OAAO,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;YAE3E,MAAM,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAC5D,IAAI,aAAa,CAAC,YAAY,EAAE,UAAU,CAAC,WAAW,CAAC,CACxD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/build/ts/scheduler/__tests__/scheduler.service.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=scheduler.service.test.d.ts.map

package/build/ts/scheduler/__tests__/scheduler.service.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.service.test.d.ts","sourceRoot":"","sources":["../../../../ts/scheduler/__tests__/scheduler.service.test.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,264 @@
+import { EMode, getPoll, isTallied } from "@maci-protocol/sdk";
+import { SchedulerRegistry } from "@nestjs/schedule";
+import { ErrorCodes, ESupportedNetworks } from "../../common";
+import { FileService } from "../../file/file.service";
+import { getPollKeyFromObject } from "../../redis/utils";
+import { SessionKeysService } from "../../sessionKeys/sessionKeys.service";
+import { SchedulerService } from "../scheduler.service";
+const scheduledPoll = {
+    maciAddress: "0x0",
+    pollId: "5",
+    mode: EMode.NON_QV,
+    chain: ESupportedNetworks.OPTIMISM_SEPOLIA,
+    endDate: 1752534000,
+    deploymentBlockNumber: 1,
+    merged: false,
+    proofsGenerated: false,
+};
+jest.mock("@maci-protocol/sdk", () => ({
+    ...jest.requireActual("@maci-protocol/sdk"),
+    getPoll: jest.fn().mockResolvedValue({
+        address: "0x123",
+        endDate: 1752534000,
+        isMerged: false,
+    }),
+    isTallied: jest.fn().mockResolvedValue(false),
+}));
+describe("SchedulerService", () => {
+    let fileService;
+    let sessionKeysService;
+    let redisService;
+    let schedulerRegistry;
+    let service;
+    beforeAll(async () => {
+        fileService = new FileService();
+        sessionKeysService = new SessionKeysService(fileService);
+        // Mock RedisService methods as needed
+        redisService = {
+            get: jest.fn().mockResolvedValue(JSON.stringify(scheduledPoll)),
+            set: jest.fn(),
+            delete: jest.fn(),
+            getAll: jest.fn().mockResolvedValue([]),
+        };
+        schedulerRegistry = new SchedulerRegistry();
+        service = new SchedulerService(sessionKeysService, redisService, schedulerRegistry);
+        await service.onModuleInit();
+    });
+    afterAll(() => {
+        jest.clearAllMocks();
+    });
+    afterEach(() => {
+        jest.clearAllMocks();
+        const timeouts = schedulerRegistry.getTimeouts();
+        // Clear all timeouts in the mock scheduler registry
+        timeouts.forEach((timeout) => {
+            if (timeout.includes("-test")) {
+                schedulerRegistry.deleteTimeout(timeout);
+            }
+        });
+    });
+    describe(`isPollScheduled`, () => {
+        test("should return true if poll is saved, scheduled and not tallied", async () => {
+            await service.registerPoll(scheduledPoll);
+            const isPollScheduled = await service.isPollScheduled(scheduledPoll);
+            expect(isPollScheduled.isScheduled).toBe(true);
+        });
+        test("should return false if poll is not saved", async () => {
+            redisService.get.mockResolvedValueOnce(null);
+            const isPollScheduled = await service.isPollScheduled(scheduledPoll);
+            expect(isPollScheduled.isScheduled).toBe(false);
+        });
+        test("should return false if poll is saved and timeout not scheduled", async () => {
+            await service.registerPoll(scheduledPoll);
+            schedulerRegistry.deleteTimeout(getPollKeyFromObject(scheduledPoll));
+            const isPollScheduled = await service.isPollScheduled(scheduledPoll);
+            expect(isPollScheduled.isScheduled).toBe(false);
+        });
+        test("should return false if poll is scheduled but not saved", async () => {
+            redisService.get.mockResolvedValueOnce(null);
+            const isPollScheduled = await service.isPollScheduled(scheduledPoll);
+            expect(isPollScheduled.isScheduled).toBe(false);
+        });
+        test("should throw an error if poll is already tallied", async () => {
+            await service.registerPoll(scheduledPoll);
+            getPoll.mockResolvedValueOnce({
+                isMerged: true,
+            });
+            isTallied.mockResolvedValueOnce(true);
+            await expect(service.isPollScheduled(scheduledPoll)).rejects.toThrow(ErrorCodes.POLL_ALREADY_TALLIED.toString());
+        });
+    });
+    describe("getPollFinalizationData", () => {
+        test("should return the end date and tallied status of a poll", async () => {
+            getPoll.mockResolvedValueOnce({
+                isMerged: false,
+                endDate: scheduledPoll.endDate,
+            });
+            isTallied.mockResolvedValueOnce(false);
+            const { endDate, isPollTallied } = await service.getPollFinalizationData({
+                maciAddress: scheduledPoll.maciAddress,
+                pollId: scheduledPoll.pollId,
+                chain: scheduledPoll.chain,
+            });
+            expect(endDate).toBe(scheduledPoll.endDate);
+            expect(isPollTallied).toBe(false);
+        });
+        test("should return isPollTallied as false if poll is not merged and is not tallied", async () => {
+            getPoll.mockResolvedValueOnce({
+                isMerged: false,
+            });
+            isTallied.mockResolvedValueOnce(false);
+            const { isPollTallied } = await service.getPollFinalizationData({
+                maciAddress: scheduledPoll.maciAddress,
+                pollId: scheduledPoll.pollId,
+                chain: scheduledPoll.chain,
+            });
+            expect(isPollTallied).toBe(false);
+        });
+        test("should return isPollTallied as false if poll is merged and is not tallied", async () => {
+            getPoll.mockResolvedValueOnce({
+                isMerged: true,
+            });
+            isTallied.mockResolvedValueOnce(false);
+            const { isPollTallied } = await service.getPollFinalizationData({
+                maciAddress: scheduledPoll.maciAddress,
+                pollId: scheduledPoll.pollId,
+                chain: scheduledPoll.chain,
+            });
+            expect(isPollTallied).toBe(false);
+        });
+        test("should return isPollTallied as false if poll is not merged and is tallied (it is impossible)", async () => {
+            getPoll.mockResolvedValueOnce({
+                isMerged: false,
+            });
+            isTallied.mockResolvedValueOnce(true);
+            const { isPollTallied } = await service.getPollFinalizationData({
+                maciAddress: scheduledPoll.maciAddress,
+                pollId: scheduledPoll.pollId,
+                chain: scheduledPoll.chain,
+            });
+            expect(isPollTallied).toBe(false);
+        });
+    });
+    describe("registerPoll", () => {
+        test("should register a poll for finalization", async () => {
+            const { isScheduled } = await service.registerPoll(scheduledPoll);
+            const isPollScheduled = await service.isPollScheduled(scheduledPoll);
+            const isPollTimeoutScheduled = schedulerRegistry.doesExist("timeout", getPollKeyFromObject(scheduledPoll));
+            expect(isScheduled).toBe(true);
+            expect(isPollScheduled.isScheduled).toBe(true);
+            expect(isPollTimeoutScheduled).toBe(true);
+        });
+        test("should register 2 polls and schedule their finalization", async () => {
+            const pollOne = { ...scheduledPoll, pollId: "1" };
+            const pollTwo = { ...scheduledPoll, pollId: "2" };
+            const { isScheduled: isScheduledOne } = await service.registerPoll(pollOne);
+            const { isScheduled: isScheduledTwo } = await service.registerPoll(pollTwo);
+            const [isPollScheduledOne, isPollScheduledTwo] = await Promise.all([
+                service.isPollScheduled(pollOne),
+                service.isPollScheduled(pollTwo),
+            ]);
+            const isPollOneTimeoutScheduled = schedulerRegistry.doesExist("timeout", getPollKeyFromObject(pollOne));
+            const isPollTwoTimeoutScheduled = schedulerRegistry.doesExist("timeout", getPollKeyFromObject(pollTwo));
+            expect(isScheduledOne).toBe(true);
+            expect(isScheduledTwo).toBe(true);
+            expect(isPollScheduledOne.isScheduled).toBe(true);
+            expect(isPollScheduledTwo.isScheduled).toBe(true);
+            expect(isPollOneTimeoutScheduled).toBe(true);
+            expect(isPollTwoTimeoutScheduled).toBe(true);
+        });
+        test("should schedule finalization after the poll has ended", async () => {
+            const endedPoll = { ...scheduledPoll, endDate: 1 };
+            const { isScheduled } = await service.registerPoll(endedPoll);
+            const isPollScheduled = await service.isPollScheduled(endedPoll);
+            const isPollTimeoutScheduled = schedulerRegistry.doesExist("timeout", getPollKeyFromObject(endedPoll));
+            expect(isScheduled).toBe(true);
+            expect(isPollScheduled.isScheduled).toBe(true);
+            expect(isPollTimeoutScheduled).toBe(true);
+        });
+        test("should throw an error if poll is already tallied", async () => {
+            getPoll.mockResolvedValueOnce({
+                isMerged: true,
+            });
+            isTallied.mockResolvedValueOnce(true);
+            await expect(service.registerPoll(scheduledPoll)).rejects.toThrow(ErrorCodes.POLL_ALREADY_TALLIED.toString());
+        });
+        test("should throw an error if poll is already scheduled", async () => {
+            await service.registerPoll(scheduledPoll);
+            await expect(service.registerPoll(scheduledPoll)).rejects.toThrow(ErrorCodes.POLL_ALREADY_SCHEDULED.toString());
+        });
+    });
+    describe("deleteScheduledPoll", () => {
+        test("should delete a scheduled poll", async () => {
+            await service.registerPoll(scheduledPoll);
+            const isPollScheduled = await service.isPollScheduled(scheduledPoll);
+            const { isScheduled } = await service.deleteScheduledPoll(scheduledPoll);
+            const isPollDeleted = await service.isPollScheduled(scheduledPoll);
+            expect(isPollScheduled.isScheduled).toBe(true);
+            expect(isScheduled).toBe(false);
+            expect(isPollDeleted.isScheduled).toBe(false);
+        });
+        test("should return isPollScheduled as false if poll was not scheduled", async () => {
+            const { isScheduled } = await service.deleteScheduledPoll(scheduledPoll);
+            expect(isScheduled).toBe(false);
+        });
+    });
+    describe("restoreTimeouts", () => {
+        const polls = [
+            { ...scheduledPoll, pollId: "1" },
+            { ...scheduledPoll, pollId: "2" },
+            { ...scheduledPoll, pollId: "3" },
+        ];
+        beforeEach(async () => {
+            await Promise.all([
+                service.registerPoll(polls[0]),
+                service.registerPoll(polls[1]),
+                service.registerPoll(polls[2]),
+            ]);
+            schedulerRegistry.deleteTimeout(getPollKeyFromObject(polls[0]));
+            schedulerRegistry.deleteTimeout(getPollKeyFromObject(polls[1]));
+            schedulerRegistry.deleteTimeout(getPollKeyFromObject(polls[2]));
+            redisService.getAll.mockResolvedValue(polls.map((poll) => getPollKeyFromObject(poll)));
+            redisService.get.mockImplementation((key) => {
+                const poll = polls.find((p) => getPollKeyFromObject(p) === key);
+                const result = poll ? JSON.stringify(poll) : null;
+                return Promise.resolve(result);
+            });
+        });
+        afterEach(() => {
+            jest.clearAllMocks();
+            getPoll.mockReset().mockResolvedValue({
+                address: "0x123",
+                endDate: 1752534000,
+                isMerged: false,
+            });
+            isTallied.mockReset().mockResolvedValue(false);
+        });
+        test("should restore scheduled polls from Redis", async () => {
+            await service.onModuleInit();
+            const timeouts = schedulerRegistry.getTimeouts();
+            timeouts.forEach((timeout, i) => {
+                expect(timeout).toBe(getPollKeyFromObject(polls[i]));
+            });
+            expect(timeouts.length).toBe(polls.length);
+        });
+        test("should not restore timeouts for tallied polls", async () => {
+            getPoll.mockImplementation(({ pollId }) => Promise.resolve({ isMerged: pollId === 2n }));
+            isTallied.mockImplementation(({ pollId }) => Promise.resolve(pollId === "2"));
+            await service.onModuleInit();
+            const timeouts = schedulerRegistry.getTimeouts();
+            expect(timeouts.length).toBe(polls.length - 1);
+        });
+        test("should not throw if Redis returns null for a key and should delete register", async () => {
+            redisService.get.mockImplementation((key) => {
+                const poll = polls.find((p) => getPollKeyFromObject(p) === key && key !== getPollKeyFromObject(polls[1])); // null to simulate missing poll 2 key
+                const result = poll ? JSON.stringify(poll) : null;
+                return Promise.resolve(result);
+            });
+            await service.onModuleInit();
+            const timeouts = schedulerRegistry.getTimeouts();
+            expect(timeouts.length).toBe(polls.length - 1);
+        });
+    });
+});
+//# sourceMappingURL=scheduler.service.test.js.map