feat: make changes to DB + router (#11)

- add index with unique contraint
- updated ApplicationEntity to have alloPoolId instead of poolId
- updated Pool Entity to have customDistribution
- add POST/ set-custom-distribution

Author: thelostone-mc

src/controllers/applicationController.ts

@@ -61,10 +61,10 @@ export const createApplication = async (
   // Create application
   const [error, application] = await catchError(
     applicationService.createApplication({
+      alloPoolId,
       chainId,
       alloApplicationId,
       pool,
-      poolId: pool.id,
     })
   );
 

src/controllers/poolController.ts

@@ -1,14 +1,20 @@
 import type { Request, Response } from 'express';
 import poolService from '@/service/PoolService';
 import applicationService from '@/service/ApplicationService';
-import { catchError, validateRequest } from '@/utils';
+import {
+  catchError,
+  isPoolFinalised,
+  isPoolManager,
+  validateRequest,
+} from '@/utils';
 import { createLogger } from '@/logger';
 import {
   indexerClient,
   type RoundWithApplications as IndexerRoundWithApplications,
 } from '@/ext/indexer';
 
 import {
+  ActionNotAllowedError,
   BadRequestError,
   IsNullError,
   NotFoundError,
@@ -18,6 +24,8 @@ import { EligibilityType } from '@/entity/EligibilityCriteria';
 import { calculate } from '@/utils/calculate';
 import eligibilityCriteriaService from '@/service/EligibilityCriteriaService';
 import { type PoolIdChainId } from './types';
+import { type Distribution } from '@/entity/Pool';
+import { type Hex } from 'viem';
 
 const logger = createLogger();
 
@@ -32,6 +40,12 @@ interface EligibilityCriteriaRequest extends PoolIdChainId {
   data: object;
 }
 
+interface SetCustomDistributionRequest extends PoolIdChainId {
+  signature: Hex;
+  sender: Hex;
+  distribution: Distribution[];
+}
+
 /**
  * Creates a pool
  *
@@ -237,3 +251,75 @@ export const updateEligibilityCriteria = async (req, res): Promise<void> => {
     message: 'Eligibility criteria updated successfully',
   });
 };
+
+export const setCustomDistribution = async (req, res): Promise<void> => {
+  const { alloPoolId, chainId, distribution, signature } =
+    req.body as SetCustomDistributionRequest;
+
+  if (
+    !(await isPoolManager(
+      { alloPoolId, chainId },
+      signature,
+      chainId,
+      alloPoolId
+    ))
+  ) {
+    res.status(401).json({ message: 'Not Authorzied' });
+    throw new BadRequestError('Not Authorzied');
+  }
+
+  if (await isPoolFinalised(alloPoolId, chainId)) {
+    res.status(400).json({ message: 'Pool is finalised' });
+    throw new ActionNotAllowedError('Pool is finalised');
+  }
+
+  const [error] = await catchError(
+    poolService.updateCustomDistribution(alloPoolId, chainId, distribution)
+  );
+
+  if (error !== undefined) {
+    res.status(500).json({
+      message: 'Error setting custom distribution',
+      error: error?.message,
+    });
+    throw new ServerError(`Error setting custom distribution`);
+  }
+
+  res.status(201).json({ message: 'Custom distribution set successfully' });
+};
+
+export const deleteCustomDistribution = async (req, res): Promise<void> => {
+  const { alloPoolId, chainId, signature } =
+    req.body as SetCustomDistributionRequest;
+
+  if (
+    !(await isPoolManager(
+      { alloPoolId, chainId },
+      signature,
+      chainId,
+      alloPoolId
+    ))
+  ) {
+    res.status(401).json({ message: 'Not Authorzied' });
+    throw new BadRequestError('Not Authorzied');
+  }
+
+  if (await isPoolFinalised(alloPoolId, chainId)) {
+    res.status(400).json({ message: 'Pool is finalised' });
+    throw new ActionNotAllowedError('Pool is finalised');
+  }
+
+  const [error] = await catchError(
+    poolService.deleteCustomDistribution(alloPoolId, chainId)
+  );
+
+  if (error !== undefined) {
+    res.status(500).json({
+      message: 'Error deleting custom distribution',
+      error: error?.message,
+    });
+    throw new ServerError(`Error deleting custom distribution`);
+  }
+
+  res.status(200).json({ message: 'Custom distribution deleted successfully' });
+};

src/entity/Application.ts

@@ -3,27 +3,27 @@ import {
   Column,
   Entity,
   ManyToOne,
-  Unique,
+  Index,
 } from 'typeorm';
 import { Pool } from '@/entity/Pool';
 
 @Entity()
-@Unique(['alloApplicationId', 'poolId'])
+@Index(['alloPoolId', 'chainId', 'alloApplicationId'], { unique: true })
 export class Application {
   @PrimaryGeneratedColumn()
   id: number;
 
   @Column()
   chainId: number;
 
+  @Column()
+  alloPoolId: string;
+
   @Column()
   alloApplicationId: string;
 
   @ManyToOne(() => Pool, pool => pool.applications, {
     onDelete: 'CASCADE',
   })
   pool: Pool;
-
-  @Column() // Explicitly define the foreign key column for pool
-  poolId: number;
 }

src/entity/EligibilityCriteria.ts

@@ -1,12 +1,12 @@
-import { Entity, PrimaryGeneratedColumn, Column, Unique } from 'typeorm';
+import { Entity, PrimaryGeneratedColumn, Column, Index } from 'typeorm';
 
 export enum EligibilityType {
   Linear = 'linear',
   // Weighted = 'weighted',
 }
 
 @Entity()
-@Unique(['chainId', 'alloPoolId'])
+@Index(['chainId', 'alloPoolId'], { unique: true })
 export class EligibilityCriteria {
   @PrimaryGeneratedColumn()
   id: number;

src/entity/Pool.ts

@@ -3,9 +3,9 @@ import {
   Column,
   Entity,
   OneToMany,
-  Unique,
   OneToOne,
   JoinColumn,
+  Index,
 } from 'typeorm';
 import { Application } from '@/entity/Application';
 import { EligibilityCriteria } from './EligibilityCriteria';
@@ -22,7 +22,7 @@ export interface Distribution {
 }
 
 @Entity()
-@Unique(['chainId', 'alloPoolId'])
+@Index(['chainId', 'alloPoolId'], { unique: true })
 export class Pool {
   @PrimaryGeneratedColumn()
   id: number;
@@ -47,5 +47,8 @@ export class Pool {
   votes: Vote[];
 
   @Column('simple-json', { nullable: true })
-  distributionData: DistributionData;
+  distributionData: DistributionData | null;
+
+  @Column('simple-json', { nullable: true })
+  customDistributionData: DistributionData | null;
 }

src/entity/Vote.ts

@@ -1,9 +1,11 @@
 import {
   Column,
   Entity,
+  Index,
   ManyToOne,
   PrimaryGeneratedColumn,
   Unique,
+  UpdateDateColumn,
 } from 'typeorm';
 import { Pool } from './Pool';
 
@@ -14,6 +16,7 @@ export interface Ballot {
 
 @Entity()
 @Unique(['poolId', 'voter'])
+@Index(['alloPoolId', 'chainId', 'voter'], { unique: true })
 export class Vote {
   @PrimaryGeneratedColumn()
   id: number;
@@ -35,4 +38,7 @@ export class Vote {
 
   @Column() // Explicitly define the foreign key column for pool
   poolId: number;
+
+  @UpdateDateColumn()
+  updatedAt: Date;
 }

src/migration/1737626955612-InitMigration.ts src/migration/1738605183828-InitMigration.ts

@@ -1,31 +1,39 @@
 import { type MigrationInterface, type QueryRunner } from "typeorm";
 
-export class InitMigration1737626955612 implements MigrationInterface {
-    name = 'InitMigration1737626955612'
+export class InitMigration1738605183828 implements MigrationInterface {
+    name = 'InitMigration1738605183828'
 
     public async up(queryRunner: QueryRunner): Promise<void> {
-        await queryRunner.query(`CREATE TABLE "application" ("id" SERIAL NOT NULL, "chainId" integer NOT NULL, "alloApplicationId" character varying NOT NULL, "poolId" integer NOT NULL, CONSTRAINT "UQ_8849159f2a2681f6be67ef84efb" UNIQUE ("alloApplicationId", "poolId"), CONSTRAINT "PK_569e0c3e863ebdf5f2408ee1670" PRIMARY KEY ("id"))`);
+        await queryRunner.query(`CREATE TABLE "application" ("id" SERIAL NOT NULL, "chainId" integer NOT NULL, "alloPoolId" character varying NOT NULL, "alloApplicationId" character varying NOT NULL, "poolId" integer, CONSTRAINT "PK_569e0c3e863ebdf5f2408ee1670" PRIMARY KEY ("id"))`);
+        await queryRunner.query(`CREATE UNIQUE INDEX "IDX_32767cacf4bb8819b2c51e854e" ON "application" ("alloPoolId", "chainId", "alloApplicationId") `);
         await queryRunner.query(`CREATE TYPE "public"."eligibility_criteria_eligibilitytype_enum" AS ENUM('linear')`);
-        await queryRunner.query(`CREATE TABLE "eligibility_criteria" ("id" SERIAL NOT NULL, "chainId" integer NOT NULL, "alloPoolId" character varying NOT NULL, "eligibilityType" "public"."eligibility_criteria_eligibilitytype_enum" NOT NULL, "data" json NOT NULL, CONSTRAINT "UQ_cab3614863337cf5dba521b9b84" UNIQUE ("chainId", "alloPoolId"), CONSTRAINT "PK_231ea7a8a87bb6092eb3af1c5a8" PRIMARY KEY ("id"))`);
-        await queryRunner.query(`CREATE TABLE "vote" ("id" SERIAL NOT NULL, "voter" character varying(42) NOT NULL, "alloPoolId" character varying NOT NULL, "chainId" integer NOT NULL, "ballot" text NOT NULL, "poolId" integer NOT NULL, CONSTRAINT "UQ_3940f20660f872bfe5386def7f1" UNIQUE ("poolId", "voter"), CONSTRAINT "PK_2d5932d46afe39c8176f9d4be72" PRIMARY KEY ("id"))`);
-        await queryRunner.query(`CREATE TABLE "pool" ("id" SERIAL NOT NULL, "chainId" integer NOT NULL, "alloPoolId" character varying NOT NULL, "metricIdentifiers" text, "distributionData" text, "eligibilityCriteriaId" integer, CONSTRAINT "UQ_72fcaa655b2b7348f4feaf25ea3" UNIQUE ("chainId", "alloPoolId"), CONSTRAINT "REL_bb4a5f9f4367c3de6ccaf665cc" UNIQUE ("eligibilityCriteriaId"), CONSTRAINT "PK_db1bfe411e1516c01120b85f8fe" PRIMARY KEY ("id"))`);
+        await queryRunner.query(`CREATE TABLE "eligibility_criteria" ("id" SERIAL NOT NULL, "chainId" integer NOT NULL, "alloPoolId" character varying NOT NULL, "eligibilityType" "public"."eligibility_criteria_eligibilitytype_enum" NOT NULL, "data" json NOT NULL, CONSTRAINT "PK_231ea7a8a87bb6092eb3af1c5a8" PRIMARY KEY ("id"))`);
+        await queryRunner.query(`CREATE UNIQUE INDEX "IDX_cab3614863337cf5dba521b9b8" ON "eligibility_criteria" ("chainId", "alloPoolId") `);
+        await queryRunner.query(`CREATE TABLE "pool" ("id" SERIAL NOT NULL, "chainId" integer NOT NULL, "alloPoolId" character varying NOT NULL, "metricIdentifiers" text, "distributionData" text, "customDistributionData" text, "eligibilityCriteriaId" integer, CONSTRAINT "REL_bb4a5f9f4367c3de6ccaf665cc" UNIQUE ("eligibilityCriteriaId"), CONSTRAINT "PK_db1bfe411e1516c01120b85f8fe" PRIMARY KEY ("id"))`);
+        await queryRunner.query(`CREATE UNIQUE INDEX "IDX_72fcaa655b2b7348f4feaf25ea" ON "pool" ("chainId", "alloPoolId") `);
+        await queryRunner.query(`CREATE TABLE "vote" ("id" SERIAL NOT NULL, "voter" character varying(42) NOT NULL, "alloPoolId" character varying NOT NULL, "chainId" integer NOT NULL, "ballot" text NOT NULL, "poolId" integer NOT NULL, "updatedAt" TIMESTAMP NOT NULL DEFAULT now(), CONSTRAINT "UQ_3940f20660f872bfe5386def7f1" UNIQUE ("poolId", "voter"), CONSTRAINT "PK_2d5932d46afe39c8176f9d4be72" PRIMARY KEY ("id"))`);
+        await queryRunner.query(`CREATE UNIQUE INDEX "IDX_4f0abff01b2f41e22cf23a215a" ON "vote" ("alloPoolId", "chainId", "voter") `);
         await queryRunner.query(`CREATE TYPE "public"."metric_orientation_enum" AS ENUM('increase', 'decrease')`);
         await queryRunner.query(`CREATE TABLE "metric" ("id" SERIAL NOT NULL, "identifier" character varying NOT NULL, "title" character varying NOT NULL, "description" character varying NOT NULL, "orientation" "public"."metric_orientation_enum" NOT NULL, "enabled" boolean NOT NULL DEFAULT false, CONSTRAINT "UQ_1136bb423acf02b4e7e5c909d0c" UNIQUE ("identifier"), CONSTRAINT "PK_7d24c075ea2926dd32bd1c534ce" PRIMARY KEY ("id"))`);
         await queryRunner.query(`ALTER TABLE "application" ADD CONSTRAINT "FK_a2d1c7a2c6ee681b42112d41284" FOREIGN KEY ("poolId") REFERENCES "pool"("id") ON DELETE CASCADE ON UPDATE NO ACTION`);
-        await queryRunner.query(`ALTER TABLE "vote" ADD CONSTRAINT "FK_86b9c0ae3057aa451170728b2bb" FOREIGN KEY ("poolId") REFERENCES "pool"("id") ON DELETE NO ACTION ON UPDATE NO ACTION`);
         await queryRunner.query(`ALTER TABLE "pool" ADD CONSTRAINT "FK_bb4a5f9f4367c3de6ccaf665cc2" FOREIGN KEY ("eligibilityCriteriaId") REFERENCES "eligibility_criteria"("id") ON DELETE NO ACTION ON UPDATE NO ACTION`);
+        await queryRunner.query(`ALTER TABLE "vote" ADD CONSTRAINT "FK_86b9c0ae3057aa451170728b2bb" FOREIGN KEY ("poolId") REFERENCES "pool"("id") ON DELETE NO ACTION ON UPDATE NO ACTION`);
     }
 
     public async down(queryRunner: QueryRunner): Promise<void> {
-        await queryRunner.query(`ALTER TABLE "pool" DROP CONSTRAINT "FK_bb4a5f9f4367c3de6ccaf665cc2"`);
         await queryRunner.query(`ALTER TABLE "vote" DROP CONSTRAINT "FK_86b9c0ae3057aa451170728b2bb"`);
+        await queryRunner.query(`ALTER TABLE "pool" DROP CONSTRAINT "FK_bb4a5f9f4367c3de6ccaf665cc2"`);
         await queryRunner.query(`ALTER TABLE "application" DROP CONSTRAINT "FK_a2d1c7a2c6ee681b42112d41284"`);
         await queryRunner.query(`DROP TABLE "metric"`);
         await queryRunner.query(`DROP TYPE "public"."metric_orientation_enum"`);
-        await queryRunner.query(`DROP TABLE "pool"`);
+        await queryRunner.query(`DROP INDEX "public"."IDX_4f0abff01b2f41e22cf23a215a"`);
         await queryRunner.query(`DROP TABLE "vote"`);
+        await queryRunner.query(`DROP INDEX "public"."IDX_72fcaa655b2b7348f4feaf25ea"`);
+        await queryRunner.query(`DROP TABLE "pool"`);
+        await queryRunner.query(`DROP INDEX "public"."IDX_cab3614863337cf5dba521b9b8"`);
         await queryRunner.query(`DROP TABLE "eligibility_criteria"`);
         await queryRunner.query(`DROP TYPE "public"."eligibility_criteria_eligibilitytype_enum"`);
+        await queryRunner.query(`DROP INDEX "public"."IDX_32767cacf4bb8819b2c51e854e"`);
         await queryRunner.query(`DROP TABLE "application"`);
     }
 

src/routes/applicationRoutes.ts

@@ -19,7 +19,7 @@ const router = Router();
  *               alloPoolId:
  *                 type: string
  *                 description: The ID of the pool to link the application to
- *                 example: "615"  # Example of poolId
+ *                 example: "673"  # Example of poolId
  *               chainId:
  *                 type: number
  *                 description: The chain ID associated with the pool