feat: fetch fees endpoint (#3)

* feat: add fees route and get total count by chain

* feat: add chains endpoint to get chain config data

* test: collect coverage from unit tests rather than e2e tests

* feat: add get fees route with pagination

* test: add e2e tests for querying collected fees

docker-compose.test.yml

@@ -26,17 +26,6 @@ services:
       - plutus_network_test
     ports:
       - "${APP_PORT:-3000}:${APP_PORT:-3000}"
-    volumes:
-      - ./src:/usr/app/src:cached
-      - ./test:/usr/app/test:cached
-      - ./jest.config.ts:/usr/app/jest.config.ts:cached
-      - ./jest.config.e2e.ts:/usr/app/jest.config.e2e.ts:cached
-      - ./jest.config.unit.ts:/usr/app/jest.config.unit.ts:cached
-      - ./nest-cli.json:/usr/app/nest-cli.json:cached
-      - ./package.json:/usr/app/package.json:cached
-      - ./tsconfig.build.json:/usr/app/tsconfig.build.json:cached
-      - ./tsconfig.json:/usr/app/tsconfig.json:cached
-      - ./yarn.lock:/usr/app/yarn.lock:cached
 
   ###
   # database

jest.config.e2e.ts

@@ -4,9 +4,7 @@ import baseConfig from './jest.config';
 
 const config: Config = {
   ...baseConfig,
-  collectCoverage: true,
-  collectCoverageFrom: ['<rootDir>/src/**/*.ts', '!<rootDir>/src/**/*.d.ts'],
-  coverageDirectory: 'coverage',
+  collectCoverage: false,
   testMatch: ['<rootDir>/src/**/e2e.test.ts'],
 };
 

jest.config.unit.ts

@@ -4,7 +4,9 @@ import baseConfig from './jest.config';
 
 const config: Config = {
   ...baseConfig,
-  collectCoverage: false,
+  collectCoverage: true,
+  collectCoverageFrom: ['<rootDir>/src/**/*.ts', '!<rootDir>/src/**/*.d.ts'],
+  coverageDirectory: 'coverage',
   testMatch: ['<rootDir>/src/**/{!(e2e),}.test.ts'],
 };
 

package.json

@@ -55,11 +55,13 @@
     "@types/supertest": "^6.0.2",
     "@typescript-eslint/eslint-plugin": "^7.2.0",
     "@typescript-eslint/parser": "^7.2.0",
+    "dotenv": "^16.4.5",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "husky": "^8.0.3",
     "jest": "^29.7.0",
     "lint-staged": "^15.2.2",
+    "mongo-seeding": "^4.0.0",
     "prettier": "^3.2.5",
     "semantic-release": "^23.0.2",
     "source-map-support": "^0.5.21",
@@ -76,7 +78,10 @@
     "@nestjs/event-emitter": "^2.0.4",
     "@nestjs/platform-express": "^10.0.0",
     "@typegoose/typegoose": "^12.2.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
     "ethers": "^6.11.1",
+    "express": "^4.18.3",
     "joi": "^17.12.2",
     "mongoose": "^8.2.1",
     "morgan": "^1.10.0",

scripts/run.sh

@@ -33,6 +33,7 @@ function main() {
   printf "%b starting docker compose...\n" "${INFO_PREFIX}"
   docker compose \
     up \
+    api \
     --build
 
   exit 0

scripts/test.sh

@@ -34,6 +34,7 @@ function main {
     -p plutus_test \
     -f docker-compose.test.yml \
     up \
+    --build \
     -d
 
   # poll the healthchecks

src/constants/Durations.ts

@@ -1 +1 @@
-export const QUERY_EVENT_DELAY_IN_MILLISECONDS: number = 100; // 100 milliseconds
+export const QUERY_EVENT_DELAY_IN_MILLISECONDS: number = 500; // 500 milliseconds

src/constants/Limiits.ts

@@ -1 +1,2 @@
+export const FEE_PAGINATION_MAX_LIMIT: number = 25;
 export const QUERY_EVENT_MAX_LIMIT: number = 100;

src/enums/APIPathEnum.ts

@@ -1,4 +1,6 @@
 enum APIPathEnum {
+  Chains = 'chains',
+  Fees = 'fees',
   Versions = 'versions',
 }
 

src/main.ts

@@ -1,4 +1,4 @@
-import { LoggerService } from '@nestjs/common';
+import { LoggerService, ValidationPipe } from '@nestjs/common';
 import { NestApplication, NestFactory } from '@nestjs/core';
 import { ConfigService } from '@nestjs/config';
 import morgan from 'morgan';
@@ -39,6 +39,7 @@ import createLoggerService from '@app/utils/createLoggerService';
         },
       })
     );
+    app.useGlobalPipes(new ValidationPipe()); // for validating query params
 
     await app.listen(
       configService.get<number>(EnvironmentVariableKeyEnum.AppPort)

src/modules/app/module.ts

@@ -7,7 +7,9 @@ import * as Joi from 'joi';
 import { EnvironmentVariableKeyEnum } from '@app/enums';
 
 // modules
+import ChainsModule from '@app/modules/chains/module';
 import FeesCollectedEventListenerModule from '@app/modules/fees-collected-event-listener/module';
+import FeesModule from '@app/modules/fees/module';
 import VersionsModule from '@app/modules/versions/module';
 
 // providers
@@ -21,6 +23,8 @@ import type { IEnvironmentVariables } from '@app/types';
     /**
      * api
      */
+    ChainsModule,
+    FeesModule,
     VersionsModule,
 
     /**

src/modules/chains/controller.ts

@@ -0,0 +1,21 @@
+import { Controller, Get } from '@nestjs/common';
+
+// configs
+import { chains } from '@app/configs';
+
+// enums
+import { APIPathEnum } from '@app/enums';
+
+// types
+import type { IChainResponseBody } from '@app/types';
+
+// utils
+import mapChainConfigToChainResponseBody from '@app/utils/mapChainConfigToChainResponseBody';
+
+@Controller(APIPathEnum.Chains)
+export default class ChainsController {
+  @Get()
+  public async get(): Promise<IChainResponseBody[]> {
+    return chains.map(mapChainConfigToChainResponseBody);
+  }
+}

src/modules/chains/e2e.test.ts

@@ -0,0 +1,31 @@
+import { HttpStatus } from '@nestjs/common';
+import { agent as request, Response, Agent } from 'supertest';
+
+// configs
+import { chains } from '@app/configs';
+
+// enums
+import { APIPathEnum } from '@app/enums';
+
+// utils
+import mapChainConfigToChainResponseBody from '@app/utils/mapChainConfigToChainResponseBody';
+
+describe(`/${APIPathEnum.Chains}`, () => {
+  let agent: Agent;
+
+  beforeAll(async () => {
+    agent = request(`http://127.0.0.1:3000`);
+  });
+
+  describe(`GET /${APIPathEnum.Chains}`, () => {
+    it('should return the chain configuration', async () => {
+      const response: Response = await agent
+        .get(`/${APIPathEnum.Chains}`)
+        .expect(HttpStatus.OK);
+
+      expect(response.body).toEqual(
+        chains.map(mapChainConfigToChainResponseBody)
+      );
+    });
+  });
+});

src/modules/chains/module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+
+// controllers
+import ChainsController from './controller';
+
+@Module({
+  controllers: [ChainsController],
+})
+export default class ChainsModule {}

src/modules/fee-repository/dtos/FindByPageDTO.ts

@@ -0,0 +1,17 @@
+interface IProps {
+  chainId: string;
+  limit?: number;
+  page?: number;
+}
+
+export default class FindByPageDTO {
+  public readonly chainId: string;
+  public readonly limit?: number;
+  public readonly page?: number;
+
+  constructor({ chainId, limit, page }: IProps) {
+    this.chainId = chainId;
+    this.limit = limit;
+    this.page = page;
+  }
+}

src/modules/fee-repository/dtos/index.ts

@@ -1 +1,2 @@
 export { default as CreateDTO } from './CreateDTO';
+export { default as FindByPageDTO } from './FindByPageDTO';

src/modules/fee-repository/index.ts

@@ -1,2 +1,3 @@
 export { default as FeeRepositoryService } from './service';
 export * from './dtos';
+export * from './types';

src/modules/fee-repository/provider.ts

@@ -14,9 +14,6 @@ const FeeRepositoryProvider: FactoryProvider = {
   useFactory: async (mongoose: Mongoose) =>
     getModelForClass(FeeSchema, {
       existingMongoose: mongoose,
-      options: {
-        customName: 'fee',
-      },
     }),
 };
 

src/modules/fee-repository/service.ts

@@ -1,14 +1,18 @@
 import { Injectable, Inject } from '@nestjs/common';
 import { Model } from 'mongoose';
 
+// constants
+import { FEE_PAGINATION_MAX_LIMIT } from '@app/constants';
+
 // dtos
-import { CreateDTO } from './dtos';
+import { CreateDTO, FindByPageDTO } from './dtos';
 
 // enums
 import { ProviderNameEnum } from '@app/enums';
 
 // types
 import type { IFeeDocument } from '@app/types';
+import type { IFindByPageAggregateResult, IFindByPageResult } from './types';
 
 @Injectable()
 export default class FeeRepositoryService {
@@ -21,10 +25,53 @@ export default class FeeRepositoryService {
     return await this.model.create(dtos);
   }
 
+  public async countByChainId(chainId: string): Promise<number> {
+    return await this.model.countDocuments({ chainId }).exec();
+  }
+
   public async create(dto: CreateDTO): Promise<IFeeDocument> {
     return await this.model.create(dto);
   }
 
+  public async findByPage({
+    chainId,
+    limit = FEE_PAGINATION_MAX_LIMIT,
+    page = 1,
+  }: FindByPageDTO): Promise<IFindByPageResult> {
+    const result: IFindByPageAggregateResult[] =
+      await this.model.aggregate<IFindByPageAggregateResult>([
+        {
+          $match: {
+            chainId,
+          },
+        },
+        {
+          $facet: {
+            metadata: [
+              {
+                $count: 'total',
+              },
+            ],
+            data: [
+              {
+                $skip: (page - 1) * limit,
+              },
+              {
+                $limit: limit,
+              },
+            ],
+          },
+        },
+      ]);
+
+    return {
+      data: result[0].data,
+      limit,
+      page,
+      total: result[0].metadata[0].total,
+    };
+  }
+
   public async findLatestBlockNumberForChainId(
     chainId: string
   ): Promise<bigint | null> {

src/modules/fee-repository/types/IFindByPageAggregateResult.ts

@@ -0,0 +1,9 @@
+// types
+import type { IFeeDocument } from '@app/types';
+
+interface IFindByPageAggregateResult {
+  data: IFeeDocument[];
+  metadata: Record<'total', number>;
+}
+
+export default IFindByPageAggregateResult;

src/modules/fee-repository/types/IFindByPageResult.ts

@@ -0,0 +1,11 @@
+// types
+import type { IFeeDocument } from '@app/types';
+
+interface IFindByPageResult {
+  data: IFeeDocument[];
+  limit: number;
+  page: number;
+  total: number;
+}
+
+export default IFindByPageResult;

src/modules/fee-repository/types/index.ts

@@ -0,0 +1,2 @@
+export { default as IFindByPageAggregateResult } from './IFindByPageAggregateResult';
+export { default as IFindByPageResult } from './IFindByPageResult';