10574620161

Committed 27 Aug 2024 08:34AM UTC coverage: 46.768% (+0.04%) from 46.733%

Build # 10574620161

Build Type

Pull #1859

github

Committed by

web-flow

Commit Message

Merge 9b6b9892f into b1233d3ed

Pull Request Pull Request #1859: Add token metadata to Native Staking transactions

Run Details

496 of 3003 branches covered (16.52%)

Branch coverage included in aggregate %.

59 of 62 new or added lines in 6 files covered. (95.16%)

1 existing line in 1 file now uncovered.

4750 of 8214 relevant lines covered (57.83%)

12.35 hits per line

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

32.43

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

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

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

  /**
   * 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 chain = await this.chainsRepository.getChain(args.chainId);
    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,
      monthlyNrr: nrr / 12,
      annualNrr: nrr,
      // tokenInfo is set to the native currency of the chain for native staking deposits
      tokenInfo: new TokenInfo({
        address: NULL_ADDRESS,
        decimals: chain.nativeCurrency.decimals,
        logoUri: chain.nativeCurrency.logoUri,
        name: chain.nativeCurrency.name,
        symbol: chain.nativeCurrency.symbol,
        trusted: true,
      }),
    });
  }

  /**
   * 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, ChainsRepositoryModule],
  providers: [NativeStakingMapper],
  exports: [NativeStakingMapper],
})
export class NativeStakingMapperModule {}

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

safe-global / safe-client-gateway / 10574620161

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