Merge pull request #56 from axone-protocol/refactor/range

refactor: change range enum
axone-protocol · Jul 3, 2024 · cf98e2e · cf98e2e
2 parents 3f700a1 + 637ee7c
commit cf98e2e
Show file tree

Hide file tree

Showing 14 changed files with 20 additions and 47 deletions.
diff --git a/src/core/enums/db-time-interval.enum.ts b/src/core/enums/db-time-interval.enum.ts
@@ -1,5 +1,4 @@
 export enum DBTimeInterval {
-  TWO_MINUTES = '2 minutes',
   TWO_HOUR = '2 hour',
   SIX_HOUR = '6 hour',
   DAY = '1 day',

diff --git a/src/core/enums/range.enum.ts b/src/core/enums/range.enum.ts
@@ -1,11 +1,8 @@
 export enum Range {
     ALL = 'all',
-    FIVE_MIN = 'fiveMin',
-    HOUR = 'hour',
     DAY = 'day',
     WEEK = 'week',
     MONTH = 'month',
-    THREE_MONTH = 'threeMonth',
     YEAR = 'year',
 }
 
diff --git a/src/core/schemas/range.schema.ts b/src/core/schemas/range.schema.ts
@@ -0,0 +1,6 @@
+import { Range } from '@core/enums/range.enum';
+import * as Joi from 'joi';
+
+export const RangeSchema = Joi.string()
+  .valid(...Object.values(Range))
+  .required();
diff --git a/src/modules/governance/dto/gov-overview.dto.ts b/src/modules/governance/dto/gov-overview.dto.ts
@@ -1,6 +1,6 @@
 export interface GovOverviewDto {
-  totalProposals: number;
-  currentProposals: number;
+  totalProposals: string;
+  currentProposals: string;
   votingPeriod: string;
   depositRequired: string;
 }
diff --git a/src/modules/governance/services/governance.service.ts b/src/modules/governance/services/governance.service.ts
@@ -28,7 +28,7 @@ export class GovernanceService implements OnModuleInit {
       const govProposals = await this.okp4Service.getProposals();
 
       const govOverview: GovOverviewDto = {
-        totalProposals: Number.parseInt(govProposals.pagination.total),
+        totalProposals: govProposals.pagination.total,
         currentProposals: this.currentProposals(govProposals.proposals),
         votingPeriod: this.votingPeriodToView(
           govResponse.voting_params.voting_period
@@ -56,7 +56,7 @@ export class GovernanceService implements OnModuleInit {
         return count;
       }
       return acc;
-    }, 0);
+    }, 0).toString();
   }
 
   private votingPeriodToView(votingPeriod: string) {

diff --git a/src/modules/supply/schemas/change-range.schema.ts b/src/modules/supply/schemas/change-range.schema.ts
diff --git a/src/modules/supply/schemas/charts-range.schema.ts b/src/modules/supply/schemas/charts-range.schema.ts
diff --git a/src/modules/supply/schemas/historical-range.schema.ts b/src/modules/supply/schemas/historical-range.schema.ts
diff --git a/src/modules/supply/services/supply.service.ts b/src/modules/supply/services/supply.service.ts
@@ -26,10 +26,10 @@ export class SupplyService implements OnModuleInit {
     private readonly cache: SupplyCache,
   ) {
     this.rangeTimeIntervalMap = new Map([
-      [Range.HOUR, { interval: DBTimeInterval.TWO_MINUTES, count: 30 }],
       [Range.DAY, { interval: DBTimeInterval.TWO_HOUR, count: 12 }],
       [Range.WEEK, { interval: DBTimeInterval.SIX_HOUR, count: 28 }],
       [Range.MONTH, { interval: DBTimeInterval.DAY, count: 30 }],
+      [Range.YEAR, { interval: DBTimeInterval.MONTH, count: 12 }],
       [Range.ALL, { interval: DBTimeInterval.MONTH}],
     ]);
   }
@@ -181,11 +181,10 @@ export class SupplyService implements OnModuleInit {
   private calculatePastDateByRange(range: Range): Date {
     let date = new Date();
     switch (range) {
-      case Range.FIVE_MIN: date = new Date(date.setMinutes(date.getMinutes() - 5)); break;
-      case Range.HOUR: date = new Date(date.setHours(date.getHours() - 1)); break;
       case Range.DAY: date = new Date(date.setDate(date.getDate() - 1)); break;
       case Range.WEEK: date = new Date(date.setDate(date.getDate() - 7)); break;
       case Range.MONTH: date = new Date(date.setMonth(date.getMonth() - 1)); break;
+      case Range.YEAR: date = new Date(date.setFullYear(date.getFullYear() - 1)); break;
     }
 
     return date;

diff --git a/src/modules/supply/supply.controller.ts b/src/modules/supply/supply.controller.ts
@@ -4,11 +4,9 @@ import { SupplyEndpoints } from "./enums/supply-endpoints.enum";
 import { SupplyCache } from "./services/supply.cache";
 import { QueryParam } from "./enums/query-param.enum";
 import { SchemaValidatePipe } from "@core/pipes/schema-validate.pipe";
-import { HistoricalRangeSchema } from "./schemas/historical-range.schema";
 import { SupplyService } from "./services/supply.service";
-import { ChangeRangeSchema } from "./schemas/change-range.schema";
 import { Range } from "@core/enums/range.enum";
-import { ChartsRangeSchema } from "./schemas/charts-range.schema";
+import { RangeSchema } from "@core/schemas/range.schema";
 
 @Controller(Routes.SUPPLY)
 export class SupplyController {
@@ -19,7 +17,7 @@ export class SupplyController {
 
   @Get(SupplyEndpoints.HISTORICAL)
   async getHistoricalSupply(
-    @Query(QueryParam.RANGE, new SchemaValidatePipe(HistoricalRangeSchema))
+    @Query(QueryParam.RANGE, new SchemaValidatePipe(RangeSchema))
       range: Range
   ) {
     return this.cache.getSupplyHistorical(range);
@@ -32,15 +30,15 @@ export class SupplyController {
 
   @Get(SupplyEndpoints.CHANGE)
   async getSupplyChange(
-    @Query(QueryParam.RANGE, new SchemaValidatePipe(ChangeRangeSchema))
+    @Query(QueryParam.RANGE, new SchemaValidatePipe(RangeSchema))
       range: Range
   ) {
     return this.service.getSupplyChange(range);
   }
 
   @Get(SupplyEndpoints.CHARTS)
   async getCharts(
-    @Query(QueryParam.RANGE, new SchemaValidatePipe(ChartsRangeSchema))
+    @Query(QueryParam.RANGE, new SchemaValidatePipe(RangeSchema))
       range: Range
   ) {
     return this.service.getCharts(range);

diff --git a/src/modules/token/dtos/token-info.dto.ts b/src/modules/token/dtos/token-info.dto.ts
@@ -2,7 +2,7 @@ export interface TokenInfoDto {
 	price: ItemWithChange;
 	marketCap: ItemWithChange;
 	volume: number;
-	apr: string;
+	apr: number;
 }
 
 export interface ItemWithChange {

diff --git a/src/modules/token/schemas/historical-price-range.schema.ts b/src/modules/token/schemas/historical-price-range.schema.ts
diff --git a/src/modules/token/services/token.service.ts b/src/modules/token/services/token.service.ts
@@ -33,7 +33,6 @@ export class TokenService implements OnModuleInit {
       [Range.DAY, { interval: DBTimeInterval.TWO_HOUR, count: 12 }],
       [Range.WEEK, { interval: DBTimeInterval.SIX_HOUR, count: 28 }],
       [Range.MONTH, { interval: DBTimeInterval.DAY, count: 30 }],
-      [Range.THREE_MONTH, { interval: DBTimeInterval.THREE_DAY, count: 30 }],
       [Range.YEAR, { interval: DBTimeInterval.MONTH, count: 12 }],
     ]);
   }
@@ -109,7 +108,7 @@ export class TokenService implements OnModuleInit {
         change: mcap!.change,
       },
       volume: res.volume_24h,
-      apr,
+      apr: isNaN(Number(apr)) ? 0 : Number(apr),
     };
 
     await this.cache.cacheTokenInfo(tokenInfoDto);

diff --git a/src/modules/token/token.controller.ts b/src/modules/token/token.controller.ts
@@ -4,8 +4,8 @@ import { TokenCache } from "./services/token.cache";
 import { TokenEndpoint } from "./enums/token-endpoint.enum";
 import { QueryParam } from "@core/enums/query-param.enum";
 import { SchemaValidatePipe } from "@core/pipes/schema-validate.pipe";
-import { HistoricalPriceRange } from "./schemas/historical-price-range.schema";
 import { Range } from "@core/enums/range.enum";
+import { RangeSchema } from "@core/schemas/range.schema";
 
 @Controller(Routes.TOKEN)
 export class TokenController {
@@ -20,7 +20,7 @@ export class TokenController {
 
   @Get(TokenEndpoint.HISTORICAL)
   async getHistoricalPrice(
-    @Query(QueryParam.RANGE, new SchemaValidatePipe(HistoricalPriceRange))
+    @Query(QueryParam.RANGE, new SchemaValidatePipe(RangeSchema))
       range: Range,
   ) {
     return this.cache.getTokenHistoricalPrice(range);