[Recording Oracle] feat: leaderboard enhancements for new UI

recording-oracle/src/common/utils/http.spec.ts

@@ -1,11 +1,11 @@
-import * as crypto from 'crypto';
 import { Readable } from 'stream';
 
 import { faker } from '@faker-js/faker';
 import nock from 'nock';
 
 import { generateRandomHashString } from '~/test/fixtures/crypto';
 
+import * as cryptoUtils from './crypto';
 import * as httpUtils from './http';
 
 describe('HTTP utilities', () => {
@@ -117,10 +117,7 @@ describe('HTTP utilities', () => {
     it('should throw when downloaded file hash is not valid', async () => {
       const fileUrl = faker.internet.url();
       const fileContent = faker.string.sample();
-      const fileHash = crypto
-        .createHash('sha256')
-        .update(fileContent)
-        .digest('hex');
+      const fileHash = cryptoUtils.hashString(fileContent, 'sha256');
 
       const scope = nock(fileUrl)
         .get('/')
@@ -146,10 +143,7 @@ describe('HTTP utilities', () => {
     it('should return file content when hash is valid', async () => {
       const fileUrl = faker.internet.url();
       const fileContent = faker.string.sample();
-      const fileHash = crypto
-        .createHash('sha1')
-        .update(fileContent)
-        .digest('hex');
+      const fileHash = cryptoUtils.hashString(fileContent, 'sha1');
 
       const scope = nock(fileUrl)
         .get('/')

recording-oracle/src/common/utils/http.ts

@@ -1,4 +1,4 @@
-import * as crypto from 'crypto';
+import crypto from 'crypto';
 
 import { type AxiosError } from 'axios';
 import _ from 'lodash';

recording-oracle/src/modules/campaigns/campaigns.controller.ts

@@ -35,7 +35,6 @@ import {
   ListJoinedCampaignsQueryDto,
   ListJoinedCampaignsSuccessDto,
   CampaignLeaderboardResponseDto,
-  GetLeaderboardQueryDto,
 } from './campaigns.dto';
 import { CampaignsControllerErrorsFilter } from './campaigns.error-filter';
 import { CampaignNotFoundError } from './campaigns.errors';
@@ -252,14 +251,16 @@ export class CampaignsController {
   @Get(`${SPECIFIC_CAMPAIGN_ROUTE}/leaderboard`)
   async getCampaignLeaderboard(
     @Param() { chainId, campaignAddress }: CampaignParamsDto,
-    @Query() { rankBy }: GetLeaderboardQueryDto,
   ): Promise<CampaignLeaderboardResponseDto> {
-    const data = await this.campaignsService.getCampaignLeaderboard(
+    const leaderboardData = await this.campaignsService.getCampaignLeaderboard(
       chainId,
       campaignAddress,
-      rankBy,
     );
 
-    return { data };
+    return {
+      data: leaderboardData.entries,
+      total: leaderboardData.total,
+      updatedAt: leaderboardData.updatedAt.toISOString(),
+    };
   }
 }

recording-oracle/src/modules/campaigns/campaigns.dto.ts

@@ -25,7 +25,6 @@ import {
   CampaignType,
   CampaignJoinStatus,
   ReturnedCampaignStatus,
-  LeaderboardRanking,
 } from './types';
 
 export class JoinCampaignDto {
@@ -265,28 +264,26 @@ export class GetUserProgressResponseDto {
   totalMeta: object;
 }
 
-export class GetLeaderboardQueryDto {
-  @ApiProperty({
-    name: 'rank_by',
-    enum: LeaderboardRanking,
-  })
-  @IsEnum(LeaderboardRanking)
-  rankBy: LeaderboardRanking;
-}
-
 export class LeaderboardEntry {
   @ApiProperty()
   address: string;
 
+  @ApiProperty()
+  score: number;
+
   @ApiProperty({
     description: `
-      This field represents different value based on chosen ranking mode and can be:
-        - total rewards earned by participant
-        - current score on market making campaign
-        - current amount of held tokens
+      This field represents different value based on the campaign type and can be:
+        - generated volume for "market making" campaigns
+        - balance / held tokens for "holding" and "threshold" campaigns
     `,
   })
   result: number;
+
+  @ApiProperty({
+    name: 'estimated_reward',
+  })
+  estimatedReward: number;
 }
 
 export class CampaignLeaderboardResponseDto {
@@ -295,4 +292,12 @@ export class CampaignLeaderboardResponseDto {
     isArray: true,
   })
   data: LeaderboardEntry[];
+
+  @ApiProperty()
+  total: number;
+
+  @ApiProperty({
+    name: 'updated_at',
+  })
+  updatedAt: string;
 }

recording-oracle/src/modules/campaigns/campaigns.repository.ts

@@ -3,7 +3,7 @@ import dayjs from 'dayjs';
 import { DataSource, In, LessThanOrEqual, MoreThan, Repository } from 'typeorm';
 
 import { CampaignEntity } from './campaign.entity';
-import { PROGRESS_PERIOD_DAYS } from './constants';
+import { CAMPAIGNS_DAILY_CYCLE } from './constants';
 import { CampaignStatus } from './types';
 
 @Injectable()
@@ -29,7 +29,7 @@ export class CampaignsRepository extends Repository<CampaignEntity> {
 
   async findForProgressRecording(): Promise<CampaignEntity[]> {
     const now = new Date();
-    const timeAgo = dayjs().subtract(PROGRESS_PERIOD_DAYS, 'day').toDate();
+    const timeAgo = dayjs().subtract(CAMPAIGNS_DAILY_CYCLE, 'day').toDate();
 
     const results = await this.createQueryBuilder('campaign')
       .where(