10474024058

Committed 20 Aug 2024 02:55PM UTC coverage: 46.651% (-0.02%) from 46.675%

Build # 10474024058

Build Type

Pull #1834

github

Committed by

iamacook

Commit Message

Adjust tests and add documentation

Pull Request Pull Request #1834: Add confirmation screen for native staking `deposit` calls

Run Details

490 of 2978 branches covered (16.45%)

Branch coverage included in aggregate %.

57 of 112 new or added lines in 12 files covered. (50.89%)

22 existing lines in 4 files now uncovered.

4678 of 8100 relevant lines covered (57.75%)

12.36 hits per line

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

31.82

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

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
   *
   * @returns {@link NativeStakingDepositTransactionInfo} for the given native staking deployment
   */
  public async mapDepositInfo(args: {
    chainId: string;
    to: `0x${string}`;
  }): 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({
      // TODO: Implement once confirmed with design
      status: StakingStatus.Unknown,
      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,
    });
  }
}

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

1	import { IStakingRepository } from '@/domain/staking/staking.repository.interface';	16✔
2	import { StakingRepositoryModule } from '@/domain/staking/staking.repository.module';	16✔
3	import { NativeStakingDepositTransactionInfo } from '@/routes/transactions/entities/staking/native-staking-info.entity';	16✔
4	import { StakingStatus } from '@/routes/transactions/entities/staking/staking.entity';	16✔
5	import { Inject, Injectable, Module, NotFoundException } from '@nestjs/common';	16✔
6
7	@Injectable()
8	export class NativeStakingMapper {	16✔
9	constructor(
10	@Inject(IStakingRepository)
NEW 11	private readonly stakingRepository: IStakingRepository,	×
12	) {}
13
14	/**
15	* Maps the {@link NativeStakingDepositTransactionInfo} for the given
16	* native staking deployment's `deposit` call
17	*
18	* @param args.chainId - the chain ID of the native staking deployment
19	* @param args.to - the address of the native staking deployment
20	*
21	* @returns {@link NativeStakingDepositTransactionInfo} for the given native staking deployment
22	*/
23	public async mapDepositInfo(args: {
24	chainId: string;
25	to: `0x${string}`;
26	}): Promise<NativeStakingDepositTransactionInfo> {
NEW 27	const deployment = await this.stakingRepository.getDeployment({	×
28	chainId: args.chainId,
29	address: args.to,
30	});
31
NEW 32	if (	×
33	deployment.product_type !== 'dedicated' \|\|	×
34	deployment.chain === 'unknown' \|\|
35	deployment.status === 'unknown'
36	) {
NEW 37	throw new NotFoundException('Native staking deployment not found');	×
38	}
39
NEW 40	const [nativeStakingStats, networkStats] = await Promise.all([	×
41	this.stakingRepository.getDedicatedStakingStats(args.chainId),
42	this.stakingRepository.getNetworkStats(args.chainId),
43	]);
44
NEW 45	const fee = deployment.product_fee ? Number(deployment.product_fee) : 0;	×
46	// NRR = GRR * (1 - service_fees)
47	// Kiln also uses last_30d field, with product_fee
NEW 48	const nrr = nativeStakingStats.gross_apy.last_30d * (1 - fee);	×
49
NEW 50	return new NativeStakingDepositTransactionInfo({	×
51	// TODO: Implement once confirmed with design
52	status: StakingStatus.Unknown,
53	estimatedEntryTime: networkStats.estimated_entry_time_seconds,
54	estimatedExitTime: networkStats.estimated_exit_time_seconds,
55	estimatedWithdrawalTime: networkStats.estimated_withdrawal_time_seconds,
56	fee,
57	// For uniform data structure, we have monthly/annual but we use the same value
58	monthlyNrr: nrr,
59	annualNrr: nrr,
60	});
61	}
62	}
63
64	@Module({
65	imports: [StakingRepositoryModule],
66	providers: [NativeStakingMapper],
67	exports: [NativeStakingMapper],
68	})
69	export class NativeStakingMapperModule {}	16✔

safe-global / safe-client-gateway / 10474024058

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