Merge pull request #13 from near-daos/feature/bounty-end-time

feature(bounty end time): added endTime field to bounty claim

apps/aggregator/src/bounty-aggregator/types/bounty.ts

@@ -1,5 +1,10 @@
 import camelcaseKeys from 'camelcase-keys';
-import { btoaJSON, buildBountyClaimId, buildBountyId } from '@sputnik-v2/utils';
+import {
+  btoaJSON,
+  buildBountyClaimId,
+  buildBountyId,
+  calculateClaimEndTime,
+} from '@sputnik-v2/utils';
 import { Transaction } from '@sputnik-v2/near-indexer';
 import { Dao } from '@sputnik-v2/dao';
 import {
@@ -16,6 +21,7 @@ export function castBountyClaim(
 ) {
   const claimDto = {
     ...claim,
+    endTime: calculateClaimEndTime(claim.startTime, claim.deadline),
     id: buildBountyClaimId(dao.id, bounty.id, claim.startTime),
     bounty: {
       id: buildBountyId(dao.id, bounty.id),

libs/bounty/src/dto/bounty-claim.dto.ts

@@ -9,6 +9,7 @@ export class BountyClaimDto extends TransactionInfo {
   startTime: string;
   /// Deadline specified by claimer.
   deadline: string;
+  endTime: string;
   /// Completed?
   completed: boolean;
 }

libs/bounty/src/entities/bounty-claim.entity.ts

@@ -1,5 +1,5 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { AfterLoad, Column, Entity, ManyToOne, PrimaryColumn } from 'typeorm';
+import { Column, Entity, ManyToOne, PrimaryColumn } from 'typeorm';
 import { TransactionEntity } from '@sputnik-v2/common';
 
 import { Bounty } from './bounty.entity';
@@ -30,10 +30,6 @@ export class BountyClaim extends TransactionEntity {
   completed: boolean;
 
   @ApiProperty()
+  @Column({ nullable: true })
   endTime: string;
-
-  @AfterLoad()
-  getEndTime() {
-    this.endTime = (BigInt(this.startTime) + BigInt(this.deadline)).toString();
-  }
 }

libs/migrations/src/migration.module.ts

@@ -11,6 +11,7 @@ import configuration, {
 } from '@sputnik-v2/config/aggregator-dao-config';
 import { Token } from '@sputnik-v2/token';
 import { Dao } from '@sputnik-v2/dao';
+import { BountyClaim } from '@sputnik-v2/bounty';
 
 import migrationScripts from './scripts';
 
@@ -19,7 +20,7 @@ import migrationScripts from './scripts';
     TypeOrmModule.forRootAsync({
       useClass: TypeOrmConfigService,
     }),
-    TypeOrmModule.forFeature([Dao, Token]),
+    TypeOrmModule.forFeature([Dao, Token, BountyClaim]),
     ConfigModule.forRoot({
       isGlobal: true,
       load: configuration,

libs/migrations/src/scripts/bounty-claim-end-time.ts

@@ -0,0 +1,38 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { InjectRepository } from '@nestjs/typeorm';
+import { Repository } from 'typeorm';
+import { Dao } from '@sputnik-v2/dao';
+import { calculateClaimEndTime } from '@sputnik-v2/utils';
+import { BountyClaim } from '@sputnik-v2/bounty';
+
+import { Migration } from '..';
+
+@Injectable()
+export class BountyClaimEndTimeMigration implements Migration {
+  private readonly logger = new Logger(BountyClaimEndTimeMigration.name);
+
+  constructor(
+    @InjectRepository(BountyClaim)
+    private readonly bountyClaimRepository: Repository<BountyClaim>,
+  ) {}
+
+  public async migrate(): Promise<void> {
+    this.logger.log('Starting Bounty Claim End Time migration...');
+
+    this.logger.log('Collecting bounty claims...');
+    const bountyClaims = await this.bountyClaimRepository.find();
+
+    this.logger.log('Setting endTime field...');
+    await this.bountyClaimRepository.save(
+      bountyClaims.map((bountyClaim) => {
+        return {
+          ...bountyClaim,
+          endTime: calculateClaimEndTime(
+            bountyClaim.startTime,
+            bountyClaim.deadline,
+          ),
+        };
+      }),
+    );
+  }
+}

libs/migrations/src/scripts/index.ts

@@ -2,10 +2,12 @@ import { ProposalPurgeMigration } from './proposal-purge.migration';
 import { ProposalActionsMigration } from './proposal-actions.migration';
 import { TokenIdsMigration } from './token-ids.migration';
 import { DaoMetadataMigration } from './dao-metadata.migration';
+import { BountyClaimEndTimeMigration } from './bounty-claim-end-time';
 
 export default [
   ProposalPurgeMigration,
   ProposalActionsMigration,
   TokenIdsMigration,
   DaoMetadataMigration,
+  BountyClaimEndTimeMigration,
 ];

libs/sputnikdao/src/sputnik.service.ts

@@ -16,6 +16,7 @@ import {
   buildBountyId,
   buildProposalId,
   buildRoleId,
+  calculateClaimEndTime,
 } from '@sputnik-v2/utils';
 
 import { castRolePermission, castVotePolicy } from './types';
@@ -195,6 +196,7 @@ export class SputnikDaoService {
             .filter((claim) => bounty.id === claim.bountyId)
             .map((claim) => ({
               ...camelcaseKeys(claim),
+              endTime: calculateClaimEndTime(claim.startTime, claim.deadline),
               id: buildBountyClaimId(contractId, bounty.id, claim.startTime),
               bounty: {
                 id: buildBountyId(contractId, bounty.id),

libs/transaction-handler/src/types/bounty.ts

@@ -3,6 +3,7 @@ import { BountyDto, BountyClaimDto } from '@sputnik-v2/bounty/dto';
 import {
   buildBountyClaimId,
   buildBountyId,
+  calculateClaimEndTime,
   getBlockTimestamp,
 } from '@sputnik-v2/utils';
 
@@ -39,6 +40,7 @@ export function castBountyClaims({
       const claim = camelcaseKeys(bountyClaim);
       return {
         ...claim,
+        endTime: calculateClaimEndTime(claim.startTime, claim.deadline),
         id: buildBountyClaimId(contractId, claim.bountyId, claim.startTime),
         accountId,
         bounty: {

libs/utils/src/index.ts

@@ -127,3 +127,10 @@ export function paginate<T>(
 export const sleep = async (ms: number) => {
   return new Promise((resolve) => setTimeout(resolve, ms));
 };
+
+export const calculateClaimEndTime = (
+  startTime = '0',
+  deadline = '0',
+): string => {
+  return (BigInt(startTime) + BigInt(deadline)).toString();
+};