add vesting schedule entity and resolver, and update package.json with new test scripts and also add a migration to fill the data of vesting schedules

Author: ae2079

migration/1746613421852-createVestingScheduleTable.ts

@@ -0,0 +1,26 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class CreateVestingScheduleTable1746613421852
+  implements MigrationInterface
+{
+  name = 'CreateVestingScheduleTable1746613421852';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE "vesting_schedule" (
+        "id" SERIAL NOT NULL,
+        "name" character varying NOT NULL,
+        "start" TIMESTAMP NOT NULL,
+        "cliff" TIMESTAMP NOT NULL,
+        "end" TIMESTAMP NOT NULL,
+        "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
+        "updatedAt" TIMESTAMP NOT NULL DEFAULT now(),
+        CONSTRAINT "PK_vesting_schedule_id" PRIMARY KEY ("id")
+      )`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "vesting_schedule"`);
+  }
+}

migration/1746613421853-populateVestingSchedules.ts

@@ -0,0 +1,71 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class PopulateVestingSchedules1746613421853
+  implements MigrationInterface
+{
+  name = 'PopulateVestingSchedules1746613421853';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    // Define the vesting schedule data
+    const vestingSchedules = [
+      {
+        name: 'Season 1 projects',
+        start: '2024-10-29',
+        cliff: '2025-10-29',
+        end: '2026-10-29',
+      },
+      {
+        name: 'Season 2 projects',
+        start: '2025-04-11',
+        cliff: '2026-04-11',
+        end: '2027-04-11',
+      },
+      {
+        name: 'R1 Season 1 buyers',
+        start: '2024-12-20',
+        cliff: '2025-06-20',
+        end: '2025-12-20',
+      },
+      {
+        name: 'R2 Season 1 buyers',
+        start: '2025-05-13',
+        cliff: '2025-10-13',
+        end: '2026-03-13',
+      },
+      {
+        name: 'R2 Season 2 buyers',
+        start: '2025-05-13',
+        cliff: '2025-11-13',
+        end: '2026-05-13',
+      },
+    ];
+
+    // Insert each vesting schedule
+    for (const schedule of vestingSchedules) {
+      await queryRunner.query(
+        `INSERT INTO "vesting_schedule" ("name", "start", "cliff", "end")
+         VALUES ($1, $2, $3, $4)`,
+        [schedule.name, schedule.start, schedule.cliff, schedule.end],
+      );
+    }
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    // Define the schedule names that were inserted
+    const scheduleNames = [
+      'Season 1 projects',
+      'Season 2 projects',
+      'R1 Season 1 buyers',
+      'R2 Season 1 buyers',
+      'R2 Season 2 buyers',
+    ];
+
+    // Remove the inserted vesting schedules
+    for (const name of scheduleNames) {
+      await queryRunner.query(
+        `DELETE FROM "vesting_schedule" WHERE "name" = $1`,
+        [name],
+      );
+    }
+  }
+}

package.json

@@ -191,6 +191,8 @@
         "test:inverterScript": "NODE_ENV=test mocha ./test/pre-test-scripts.ts ./src/scripts/syncDataWithInverter.test.ts",
         "test:healthCheck": "NODE_ENV=test mocha ./test/pre-test-scripts.ts ./src/server/bootstrap.test.ts",
         "test:tokenPriceResolver": "NODE_ENV=test mocha ./test/pre-test-scripts.ts ./src/resolvers/tokenPriceResolver.test.ts",
+        "test:vestingScheduleRepository": "NODE_ENV=test mocha ./test/pre-test-scripts.ts ./src/repositories/vestingScheduleRepository.test.ts",
+        "test:vestingScheduleResolver": "NODE_ENV=test mocha ./test/pre-test-scripts.ts ./src/resolvers/vestingScheduleResolver.test.ts",
         "start": "NODE_ENV=development ts-node-dev --project ./tsconfig.json --respawn ./src/index.ts",
         "start:test": "NODE_ENV=development ts-node-dev --project ./tsconfig.json --respawn ./test.ts",
         "serve": "pm2 startOrRestart ecosystem.config.js --node-args='--max-old-space-size=8192'",

src/entities/entities.ts

@@ -40,6 +40,7 @@ import { SwapTransaction } from './swapTransaction';
 import { QaccPointsHistory } from './qaccPointsHistory';
 import { UserRankMaterializedView } from './userRanksMaterialized';
 import { VestingData } from './vestingData';
+import { VestingSchedule } from './vestingSchedule';
 import { TokenPriceHistory } from './tokenPriceHistory';
 
 export const getEntities = (): DataSourceOptions['entities'] => {
@@ -94,6 +95,7 @@ export const getEntities = (): DataSourceOptions['entities'] => {
     SwapTransaction,
     UserRankMaterializedView,
     VestingData,
+    VestingSchedule,
     TokenPriceHistory,
   ];
 };

src/entities/vestingSchedule.ts

@@ -0,0 +1,41 @@
+import { Field, ID, ObjectType } from 'type-graphql';
+import {
+  BaseEntity,
+  Column,
+  CreateDateColumn,
+  Entity,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm';
+
+@Entity()
+@ObjectType()
+export class VestingSchedule extends BaseEntity {
+  @Field(_type => ID)
+  @PrimaryGeneratedColumn()
+  readonly id: number;
+
+  @Field()
+  @Column()
+  name: string;
+
+  @Field()
+  @Column('timestamp')
+  start: Date;
+
+  @Field()
+  @Column('timestamp')
+  cliff: Date;
+
+  @Field()
+  @Column('timestamp')
+  end: Date;
+
+  @Field()
+  @CreateDateColumn()
+  createdAt: Date;
+
+  @Field()
+  @UpdateDateColumn()
+  updatedAt: Date;
+}

src/repositories/vestingScheduleRepository.test.ts

@@ -0,0 +1,88 @@
+import { assert } from 'chai';
+import {
+  findAllVestingSchedules,
+  findVestingScheduleById,
+} from './vestingScheduleRepository';
+import { VestingSchedule } from '../entities/vestingSchedule';
+import { saveUserDirectlyToDb, SEED_DATA } from '../../test/testUtils';
+import { User } from '../entities/user';
+
+describe(
+  'VestingSchedule Repository test cases',
+  vestingScheduleRepositoryTestCases,
+);
+
+function vestingScheduleRepositoryTestCases() {
+  let user: User;
+  let vestingSchedule1: VestingSchedule;
+
+  beforeEach(async () => {
+    // Create test user
+    user = await saveUserDirectlyToDb(SEED_DATA.FIRST_USER.email);
+
+    // Create test vesting schedules
+    vestingSchedule1 = await VestingSchedule.create({
+      name: 'Team Vesting',
+      start: new Date('2024-01-01'),
+      cliff: new Date('2024-06-01'),
+      end: new Date('2025-01-01'),
+    }).save();
+
+    await VestingSchedule.create({
+      name: 'Advisor Vesting',
+      start: new Date('2024-03-01'),
+      cliff: new Date('2024-09-01'),
+      end: new Date('2025-03-01'),
+    }).save();
+  });
+
+  afterEach(async () => {
+    // Clean up test data
+    await VestingSchedule.delete({});
+    await User.delete({ id: user.id });
+  });
+
+  describe('findAllVestingSchedules', () => {
+    it('should return all vesting schedules ordered by start date ASC', async () => {
+      const vestingSchedules = await findAllVestingSchedules();
+
+      assert.equal(vestingSchedules.length, 2);
+      assert.equal(vestingSchedules[0].name, 'Team Vesting');
+      assert.equal(vestingSchedules[1].name, 'Advisor Vesting');
+
+      // Verify ordering by start date
+      assert.isTrue(
+        vestingSchedules[0].start.getTime() <=
+          vestingSchedules[1].start.getTime(),
+      );
+    });
+
+    it('should return empty array when no vesting schedules exist', async () => {
+      await VestingSchedule.delete({});
+      const vestingSchedules = await findAllVestingSchedules();
+
+      assert.equal(vestingSchedules.length, 0);
+    });
+  });
+
+  describe('findVestingScheduleById', () => {
+    it('should return vesting schedule by id', async () => {
+      const foundVestingSchedule = await findVestingScheduleById(
+        vestingSchedule1.id,
+      );
+
+      assert.isNotNull(foundVestingSchedule);
+      assert.equal(foundVestingSchedule!.id, vestingSchedule1.id);
+      assert.equal(foundVestingSchedule!.name, 'Team Vesting');
+      assert.deepEqual(foundVestingSchedule!.start, vestingSchedule1.start);
+      assert.deepEqual(foundVestingSchedule!.cliff, vestingSchedule1.cliff);
+      assert.deepEqual(foundVestingSchedule!.end, vestingSchedule1.end);
+    });
+
+    it('should return null when vesting schedule does not exist', async () => {
+      const foundVestingSchedule = await findVestingScheduleById(999999);
+
+      assert.isNull(foundVestingSchedule);
+    });
+  });
+}

src/repositories/vestingScheduleRepository.ts

@@ -0,0 +1,17 @@
+import { VestingSchedule } from '../entities/vestingSchedule';
+
+export const findAllVestingSchedules = async (): Promise<VestingSchedule[]> => {
+  return VestingSchedule.find({
+    order: {
+      start: 'ASC',
+    },
+  });
+};
+
+export const findVestingScheduleById = async (
+  id: number,
+): Promise<VestingSchedule | null> => {
+  return VestingSchedule.findOne({
+    where: { id },
+  });
+};

src/resolvers/resolvers.ts

@@ -18,6 +18,7 @@ import { RoundsResolver } from './roundsResolver';
 import { QAccResolver } from './qAccResolver';
 import { QaccPointsHistoryResolver } from './qaccPointsHistoryResolver';
 import { TokenPriceResolver } from './tokenPriceResolver';
+import { VestingScheduleResolver } from './vestingScheduleResolver';
 
 // eslint-disable-next-line @typescript-eslint/ban-types
 export const getResolvers = (): Function[] => {
@@ -46,5 +47,6 @@ export const getResolvers = (): Function[] => {
     QAccResolver,
     QaccPointsHistoryResolver,
     TokenPriceResolver,
+    VestingScheduleResolver,
   ];
 };