7741074162

Committed 01 Feb 2024 12:16PM UTC coverage: 93.255% (-0.06%) from 93.311%

Build # 7741074162

Build Type

Pull #1096

github

Committed by

hectorgomezv

Commit Message

Refactor, add Zerion docs reference

Pull Request Pull Request #1096: Add Zerion Balances provider

Run Details

1502 of 1798 branches covered (0.0%)

Branch coverage included in aggregate %.

66 of 70 new or added lines in 5 files covered. (94.29%)

1 existing line in 1 file now uncovered.

5743 of 5971 relevant lines covered (96.18%)

177.55 hits per line

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

82.54

/src/datasources/balances-api/zerion-balances-api.service.ts

import { IConfigurationService } from '@/config/configuration.service.interface';
import { ChainAttributes } from '@/datasources/balances-api/entities/provider-chain-attributes.entity';
import {
  ZerionAttributes,
  ZerionBalance,
} from '@/datasources/balances-api/entities/zerion-balance.entity';
import { CacheFirstDataSource } from '@/datasources/cache/cache.first.data.source';
import { CacheRouter } from '@/datasources/cache/cache.router';
import {
  CacheService,
  ICacheService,
} from '@/datasources/cache/cache.service.interface';
import {
  Balance,
  Erc20Balance,
  NativeBalance,
} from '@/domain/balances/entities/balance.entity';
import { getNumberString } from '@/domain/common/utils/utils';
import { DataSourceError } from '@/domain/errors/data-source.error';
import { IBalancesApi } from '@/domain/interfaces/balances-api.interface';
import { asError } from '@/logging/utils';
import { Inject, Injectable } from '@nestjs/common';

export const IZerionBalancesApi = Symbol('IZerionBalancesApi');

@Injectable()
export class ZerionBalancesApi implements IBalancesApi {
  private readonly apiKey: string | undefined;
  private readonly baseUri: string;
  private readonly chainsConfiguration: Record<number, ChainAttributes>;
  private readonly defaultExpirationTimeInSeconds: number;
  private readonly defaultNotFoundExpirationTimeSeconds: number;

  constructor(
    @Inject(CacheService) private readonly cacheService: ICacheService,
    @Inject(IConfigurationService)
    private readonly configurationService: IConfigurationService,
    private readonly dataSource: CacheFirstDataSource,
  ) {
    this.apiKey = this.configurationService.get<string>(
      'balances.providers.zerion.apiKey',
    );
    this.baseUri = this.configurationService.getOrThrow<string>(
      'balances.providers.zerion.baseUri',
    );
    this.defaultExpirationTimeInSeconds =
      this.configurationService.getOrThrow<number>(
        'expirationTimeInSeconds.default',
      );
    this.defaultNotFoundExpirationTimeSeconds =
      this.configurationService.getOrThrow<number>(
        'expirationTimeInSeconds.notFound.default',
      );
    this.chainsConfiguration = this.configurationService.getOrThrow<
      Record<number, ChainAttributes>
    >('balances.providers.zerion.chains');
  }

  async getBalances(args: {
    chainId: string;
    safeAddress: string;
    fiatCode: string;
  }): Promise<Balance[]> {
    try {
      const cacheDir = CacheRouter.getZerionBalancesCacheDir(args);
      const chainName = this._getChainName(args.chainId);
      const currency = args.fiatCode.toLowerCase();
      const url = `${this.baseUri}/v1/wallets/${args.safeAddress}/positions?filter[chain_ids]=${chainName}&currency=${currency}&sort=value`;
      const zerionBalances = await this.dataSource.get<ZerionBalance[]>({
        cacheDir,
        url,
        notFoundExpireTimeSeconds: this.defaultNotFoundExpirationTimeSeconds,
        networkRequest: { headers: { Authorization: `Basic ${this.apiKey}` } },
        expireTimeSeconds: this.defaultExpirationTimeInSeconds,
      });
      return this._mapBalances(chainName, zerionBalances);
    } catch (error) {
      throw new DataSourceError(
        `Error getting ${args.safeAddress} balances from provider: ${asError(error).message}}`,
      );
    }
  }

  private _mapBalances(
    chainName: string,
    zerionBalances: ZerionBalance[],
  ): Balance[] {
    return zerionBalances
      .filter((zb) => zb.attributes.flags.displayable === true)
      .map((zb) => {
        const implementation = zb.attributes.fungible_info.implementations.find(
          (implementation) => implementation.chain_id === chainName,
        );
        if (!implementation)
          throw Error(
            `Zerion error: ${chainName} implementation not found for balance ${zb.id}`,
          );
        const fiatBalance = getNumberString(zb.attributes.value ?? 0);
        const fiatConversion = getNumberString(zb.attributes.price);

        return {
          ...(implementation.address === null
            ? this._mapNativeBalance(zb.attributes)
            : this._mapErc20Balance(zb.attributes, implementation.address)),
          fiatBalance,
          fiatConversion,
        };
      });
  }

  private _mapErc20Balance(
    zerionBalanceAttributes: ZerionAttributes,
    tokenAddress: string,
  ): Erc20Balance {
    const { fungible_info, quantity } = zerionBalanceAttributes;
    return {
      tokenAddress,
      token: {
        name: fungible_info.name!,
        symbol: fungible_info.symbol!,
        decimals: quantity.decimals,
        logoUri: fungible_info.icon.url ?? '',
      },
      balance: quantity.int,
    };
  }

  private _mapNativeBalance(
    zerionBalanceAttributes: ZerionAttributes,
  ): NativeBalance {
    return {
      tokenAddress: null,
      token: null,
      balance: zerionBalanceAttributes.quantity.int,
    };
  }

  async clearBalances(args: {
    chainId: string;
    safeAddress: string;
  }): Promise<void> {
    const key = CacheRouter.getZerionBalancesCacheKey(args);
    await this.cacheService.deleteByKey(key);
  }

  private _getChainName(chainId: string): string {
    const chainName = this.chainsConfiguration[Number(chainId)]?.chainName;
    if (!chainName)
      throw Error(
        `Chain ${chainId} balances retrieval via Zerion is not configured`,
      );
    return chainName;
  }
}

1	import { IConfigurationService } from '@/config/configuration.service.interface';	84✔
2	import { ChainAttributes } from '@/datasources/balances-api/entities/provider-chain-attributes.entity';
3	import {
4	ZerionAttributes,
5	ZerionBalance,
6	} from '@/datasources/balances-api/entities/zerion-balance.entity';
7	import { CacheFirstDataSource } from '@/datasources/cache/cache.first.data.source';	84✔
8	import { CacheRouter } from '@/datasources/cache/cache.router';	84✔
9	import {	84✔
10	CacheService,
11	ICacheService,
12	} from '@/datasources/cache/cache.service.interface';
13	import {
14	Balance,
15	Erc20Balance,
16	NativeBalance,
17	} from '@/domain/balances/entities/balance.entity';
18	import { getNumberString } from '@/domain/common/utils/utils';	84✔
19	import { DataSourceError } from '@/domain/errors/data-source.error';	84✔
20	import { IBalancesApi } from '@/domain/interfaces/balances-api.interface';
21	import { asError } from '@/logging/utils';	84✔
22	import { Inject, Injectable } from '@nestjs/common';	84✔
23
24	export const IZerionBalancesApi = Symbol('IZerionBalancesApi');	84✔
25
26	@Injectable()
27	export class ZerionBalancesApi implements IBalancesApi {	84✔
28	private readonly apiKey: string \| undefined;
29	private readonly baseUri: string;
30	private readonly chainsConfiguration: Record<number, ChainAttributes>;
31	private readonly defaultExpirationTimeInSeconds: number;
32	private readonly defaultNotFoundExpirationTimeSeconds: number;
33
34	constructor(
35	@Inject(CacheService) private readonly cacheService: ICacheService,	614✔
36	@Inject(IConfigurationService)
37	private readonly configurationService: IConfigurationService,	614✔
38	private readonly dataSource: CacheFirstDataSource,	614✔
39	) {
40	this.apiKey = this.configurationService.get<string>(	614✔
41	'balances.providers.zerion.apiKey',
42	);
43	this.baseUri = this.configurationService.getOrThrow<string>(	614✔
44	'balances.providers.zerion.baseUri',
45	);
46	this.defaultExpirationTimeInSeconds =	614✔
47	this.configurationService.getOrThrow<number>(
48	'expirationTimeInSeconds.default',
49	);
50	this.defaultNotFoundExpirationTimeSeconds =	614✔
51	this.configurationService.getOrThrow<number>(
52	'expirationTimeInSeconds.notFound.default',
53	);
54	this.chainsConfiguration = this.configurationService.getOrThrow<	614✔
55	Record<number, ChainAttributes>
56	>('balances.providers.zerion.chains');
57	}
58
59	async getBalances(args: {
60	chainId: string;
61	safeAddress: string;
62	fiatCode: string;
63	}): Promise<Balance[]> {
64	try {	8✔
65	const cacheDir = CacheRouter.getZerionBalancesCacheDir(args);	8✔
66	const chainName = this._getChainName(args.chainId);	8✔
67	const currency = args.fiatCode.toLowerCase();	8✔
68	const url = `${this.baseUri}/v1/wallets/${args.safeAddress}/positions?filter[chain_ids]=${chainName}&currency=${currency}&sort=value`;	8✔
69	const zerionBalances = await this.dataSource.get<ZerionBalance[]>({	8✔
70	cacheDir,
71	url,
72	notFoundExpireTimeSeconds: this.defaultNotFoundExpirationTimeSeconds,
73	networkRequest: { headers: { Authorization: `Basic ${this.apiKey}` } },
74	expireTimeSeconds: this.defaultExpirationTimeInSeconds,
75	});
76	return this._mapBalances(chainName, zerionBalances);	6✔
77	} catch (error) {
78	throw new DataSourceError(	2✔
79	`Error getting ${args.safeAddress} balances from provider: ${asError(error).message}}`,
80	);
81	}
82	}
83
84	private _mapBalances(
85	chainName: string,
86	zerionBalances: ZerionBalance[],
87	): Balance[] {
88	return zerionBalances	6✔
89	.filter((zb) => zb.attributes.flags.displayable === true)	8✔
90	.map((zb) => {
91	const implementation = zb.attributes.fungible_info.implementations.find(	8✔
92	(implementation) => implementation.chain_id === chainName,	12✔
93	);
94	if (!implementation)	8!
NEW 95	throw Error(	×
96	`Zerion error: ${chainName} implementation not found for balance ${zb.id}`,
97	);
98	const fiatBalance = getNumberString(zb.attributes.value ?? 0);	8!
99	const fiatConversion = getNumberString(zb.attributes.price);	8✔
100
101	return {	8✔
102	...(implementation.address === null	4✔
103	? this._mapNativeBalance(zb.attributes)
104	: this._mapErc20Balance(zb.attributes, implementation.address)),
105	fiatBalance,
106	fiatConversion,
107	};
108	});
109	}
110
111	private _mapErc20Balance(
112	zerionBalanceAttributes: ZerionAttributes,
113	tokenAddress: string,
114	): Erc20Balance {
115	const { fungible_info, quantity } = zerionBalanceAttributes;	4✔
116	return {	4✔
117	tokenAddress,
118	token: {
119	name: fungible_info.name!,
120	symbol: fungible_info.symbol!,
121	decimals: quantity.decimals,
122	logoUri: fungible_info.icon.url ?? '',	6!
123	},
124	balance: quantity.int,
125	};
126	}
127
128	private _mapNativeBalance(
129	zerionBalanceAttributes: ZerionAttributes,
130	): NativeBalance {
131	return {	4✔
132	tokenAddress: null,
133	token: null,
134	balance: zerionBalanceAttributes.quantity.int,
135	};
136	}
137
138	async clearBalances(args: {
139	chainId: string;
140	safeAddress: string;
141	}): Promise<void> {
NEW 142	const key = CacheRouter.getZerionBalancesCacheKey(args);	×
NEW 143	await this.cacheService.deleteByKey(key);	×
144	}
145
146	private _getChainName(chainId: string): string {
147	const chainName = this.chainsConfiguration[Number(chainId)]?.chainName;	8!
148	if (!chainName)	8!
NEW 149	throw Error(	×
150	`Chain ${chainId} balances retrieval via Zerion is not configured`,
151	);
152	return chainName;	8✔
153	}
154	}

safe-global / safe-client-gateway / 7741074162

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