10523224458

Committed 23 Aug 2024 09:18AM UTC coverage: 46.656% (-0.04%) from 46.695%

Build # 10523224458

Build Type

push

github

Committed by

web-flow

Commit Message

Add StakingStatus to native staking deposit transactions (#1842)

Add StakingStatus to native staking deposit transactions

Run Details

496 of 3005 branches covered (16.51%)

Branch coverage included in aggregate %.

6 of 15 new or added lines in 4 files covered. (40.0%)

2 existing lines in 2 files now uncovered.

4729 of 8194 relevant lines covered (57.71%)

12.32 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

25.0

/src/routes/transactions/mappers/common/native-staking.mapper.ts

import { NetworkStats } from '@/datasources/staking-api/entities/network-stats.entity';
import { IStakingRepository } from '@/domain/staking/staking.repository.interface';
import { StakingRepositoryModule } from '@/domain/staking/staking.repository.module';
import { NativeStakingDepositTransactionInfo } from '@/routes/transactions/entities/staking/native-staking-info.entity';
import { StakingStatus } from '@/routes/transactions/entities/staking/staking.entity';
import { Inject, Injectable, Module, NotFoundException } from '@nestjs/common';

@Injectable()
export class NativeStakingMapper {
  constructor(
    @Inject(IStakingRepository)
    private readonly stakingRepository: IStakingRepository,
  ) {}

  /**
   * Maps the {@link NativeStakingDepositTransactionInfo} for the given
   * native staking deployment's `deposit` call
   *
   * @param args.chainId - the chain ID of the native staking deployment
   * @param args.to - the address of the native staking deployment
   * @param args.isConfirmed - whether the deposit transaction is confirmed
   * @param args.depositExecutionDate - the date when the deposit transaction was executed
   *
   * @returns {@link NativeStakingDepositTransactionInfo} for the given native staking deployment
   */
  public async mapDepositInfo(args: {
    chainId: string;
    to: `0x${string}`;
    isConfirmed: boolean;
    depositExecutionDate: Date | null;
  }): Promise<NativeStakingDepositTransactionInfo> {
    const deployment = await this.stakingRepository.getDeployment({
      chainId: args.chainId,
      address: args.to,
    });

    if (
      deployment.product_type !== 'dedicated' ||
      deployment.chain === 'unknown' ||
      deployment.status === 'unknown'
    ) {
      throw new NotFoundException('Native staking deployment not found');
    }

    const [nativeStakingStats, networkStats] = await Promise.all([
      this.stakingRepository.getDedicatedStakingStats(args.chainId),
      this.stakingRepository.getNetworkStats(args.chainId),
    ]);

    const fee = deployment.product_fee ? Number(deployment.product_fee) : 0;
    // NRR = GRR * (1 - service_fees)
    // Kiln also uses last_30d field, with product_fee
    const nrr = nativeStakingStats.gross_apy.last_30d * (1 - fee);

    return new NativeStakingDepositTransactionInfo({
      status: this.mapStatus(
        networkStats,
        args.isConfirmed,
        args.depositExecutionDate,
      ),
      estimatedEntryTime: networkStats.estimated_entry_time_seconds,
      estimatedExitTime: networkStats.estimated_exit_time_seconds,
      estimatedWithdrawalTime: networkStats.estimated_withdrawal_time_seconds,
      fee,
      // For uniform data structure, we have monthly/annual but we use the same value
      monthlyNrr: nrr,
      annualNrr: nrr,
    });
  }

  /**
   * Maps the {@link StakingStatus} for the given native staking deployment's `deposit` call.
   * - If the deposit transaction is not confirmed, the status is `SignatureNeeded`.
   * - If the deposit transaction is confirmed but the deposit execution date is not available,
   * the status is `AwaitingEntry`.
   * - If the deposit execution date is available, the status is `AwaitingEntry` if the current
   * date is before the estimated entry time, otherwise the status is `Validating`.
   * - If the status cannot be determined, the status is `Unknown`.
   *
   * @param networkStats - the network stats for the chain where the native staking deployment lives
   * @param isConfirmed - whether the deposit transaction is confirmed
   * @param depositExecutionDate - the date when the deposit transaction was executed
   * @returns
   */
  private mapStatus(
    networkStats: NetworkStats,
    isConfirmed: boolean,
    depositExecutionDate: Date | null,
  ): StakingStatus {
    if (!isConfirmed) {
      return StakingStatus.SignatureNeeded;
    }

    if (!depositExecutionDate) {
      return StakingStatus.AwaitingEntry;
    }

    const estimatedDepositEntryTime =
      depositExecutionDate.getTime() +
      networkStats.estimated_entry_time_seconds * 1000;

    return Date.now() <= estimatedDepositEntryTime
      ? StakingStatus.AwaitingEntry
      : StakingStatus.Validating;
  }
}

@Module({
  imports: [StakingRepositoryModule],
  providers: [NativeStakingMapper],
  exports: [NativeStakingMapper],
})
export class NativeStakingMapperModule {}

1	import { NetworkStats } from '@/datasources/staking-api/entities/network-stats.entity';
2	import { IStakingRepository } from '@/domain/staking/staking.repository.interface';	16✔
3	import { StakingRepositoryModule } from '@/domain/staking/staking.repository.module';	16✔
4	import { NativeStakingDepositTransactionInfo } from '@/routes/transactions/entities/staking/native-staking-info.entity';	16✔
5	import { StakingStatus } from '@/routes/transactions/entities/staking/staking.entity';	16✔
6	import { Inject, Injectable, Module, NotFoundException } from '@nestjs/common';	16✔
7
8	@Injectable()
9	export class NativeStakingMapper {	16✔
10	constructor(
11	@Inject(IStakingRepository)
12	private readonly stakingRepository: IStakingRepository,	16✔
13	) {}
14
15	/**
16	* Maps the {@link NativeStakingDepositTransactionInfo} for the given
17	* native staking deployment's `deposit` call
18	*
19	* @param args.chainId - the chain ID of the native staking deployment
20	* @param args.to - the address of the native staking deployment
21	* @param args.isConfirmed - whether the deposit transaction is confirmed
22	* @param args.depositExecutionDate - the date when the deposit transaction was executed
23	*
24	* @returns {@link NativeStakingDepositTransactionInfo} for the given native staking deployment
25	*/
26	public async mapDepositInfo(args: {
27	chainId: string;
28	to: `0x${string}`;
29	isConfirmed: boolean;
30	depositExecutionDate: Date \| null;
31	}): Promise<NativeStakingDepositTransactionInfo> {
32	const deployment = await this.stakingRepository.getDeployment({	×
33	chainId: args.chainId,
34	address: args.to,
35	});
36
37	if (	×
38	deployment.product_type !== 'dedicated' \|\|	×
39	deployment.chain === 'unknown' \|\|
40	deployment.status === 'unknown'
41	) {
42	throw new NotFoundException('Native staking deployment not found');	×
43	}
44
45	const [nativeStakingStats, networkStats] = await Promise.all([	×
46	this.stakingRepository.getDedicatedStakingStats(args.chainId),
47	this.stakingRepository.getNetworkStats(args.chainId),
48	]);
49
50	const fee = deployment.product_fee ? Number(deployment.product_fee) : 0;	×
51	// NRR = GRR * (1 - service_fees)
52	// Kiln also uses last_30d field, with product_fee
53	const nrr = nativeStakingStats.gross_apy.last_30d * (1 - fee);	×
54
55	return new NativeStakingDepositTransactionInfo({	×
56	status: this.mapStatus(
57	networkStats,
58	args.isConfirmed,
59	args.depositExecutionDate,
60	),
61	estimatedEntryTime: networkStats.estimated_entry_time_seconds,
62	estimatedExitTime: networkStats.estimated_exit_time_seconds,
63	estimatedWithdrawalTime: networkStats.estimated_withdrawal_time_seconds,
64	fee,
65	// For uniform data structure, we have monthly/annual but we use the same value
66	monthlyNrr: nrr,
67	annualNrr: nrr,
68	});
69	}
70
71	/**
72	* Maps the {@link StakingStatus} for the given native staking deployment's `deposit` call.
73	* - If the deposit transaction is not confirmed, the status is `SignatureNeeded`.
74	* - If the deposit transaction is confirmed but the deposit execution date is not available,
75	* the status is `AwaitingEntry`.
76	* - If the deposit execution date is available, the status is `AwaitingEntry` if the current
77	* date is before the estimated entry time, otherwise the status is `Validating`.
78	* - If the status cannot be determined, the status is `Unknown`.
79	*
80	* @param networkStats - the network stats for the chain where the native staking deployment lives
81	* @param isConfirmed - whether the deposit transaction is confirmed
82	* @param depositExecutionDate - the date when the deposit transaction was executed
83	* @returns
84	*/
85	private mapStatus(
86	networkStats: NetworkStats,
87	isConfirmed: boolean,
88	depositExecutionDate: Date \| null,
89	): StakingStatus {
NEW 90	if (!isConfirmed) {	×
NEW 91	return StakingStatus.SignatureNeeded;	×
92	}
93
NEW 94	if (!depositExecutionDate) {	×
NEW 95	return StakingStatus.AwaitingEntry;	×
96	}
97
98	const estimatedDepositEntryTime =
NEW 99	depositExecutionDate.getTime() +	×
100	networkStats.estimated_entry_time_seconds * 1000;
101
NEW 102	return Date.now() <= estimatedDepositEntryTime	×
103	? StakingStatus.AwaitingEntry
104	: StakingStatus.Validating;
105	}
106	}
107
108	@Module({
109	imports: [StakingRepositoryModule],
110	providers: [NativeStakingMapper],
111	exports: [NativeStakingMapper],
112	})
113	export class NativeStakingMapperModule {}	16✔

safe-global / safe-client-gateway / 10523224458

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous