Migrate Balance validation to zod

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

@@ -125,7 +125,7 @@ export class SafeBalancesApi implements IBalancesApi {
   ): Promise<Balance[]> {
     const tokenAddresses = balances
       .map((balance) => balance.tokenAddress)
-      .filter((address): address is string => address !== null);
+      .filter((address): address is `0x${string}` => address !== null);
 
     const assetPrices = await this.coingeckoApi.getTokenPrices({
       chainId: this.chainId,

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

@@ -32,6 +32,7 @@ import { DataSourceError } from '@/domain/errors/data-source.error';
 import { IBalancesApi } from '@/domain/interfaces/balances-api.interface';
 import { ILoggingService, LoggingService } from '@/logging/logging.interface';
 import { Inject, Injectable } from '@nestjs/common';
+import { getAddress } from 'viem';
 
 export const IZerionBalancesApi = Symbol('IZerionBalancesApi');
 
@@ -230,7 +231,7 @@ export class ZerionBalancesApi implements IBalancesApi {
   ): Erc20Balance {
     const { fungible_info, quantity } = zerionBalanceAttributes;
     return {
-      tokenAddress,
+      tokenAddress: getAddress(tokenAddress),
       token: {
         name: fungible_info.name ?? '',
         symbol: fungible_info.symbol ?? '',

src/domain.module.ts

@@ -49,7 +49,6 @@ import { HealthRepository } from '@/domain/health/health.repository';
 import { HumanDescriptionApiModule } from '@/datasources/human-description-api/human-description-api.module';
 import { IHumanDescriptionRepository } from '@/domain/human-description/human-description.repository.interface';
 import { HumanDescriptionRepository } from '@/domain/human-description/human-description.repository';
-import { BalancesValidator } from '@/domain/balances/balances.validator';
 import { BalancesApiModule } from '@/datasources/balances-api/balances-api.module';
 
 @Global()
@@ -93,7 +92,6 @@ import { BalancesApiModule } from '@/datasources/balances-api/balances-api.modul
     SafeAppsValidator,
     SafeListValidator,
     SafeValidator,
-    BalancesValidator,
     TokenValidator,
     TransactionTypeValidator,
     TransferValidator,

src/domain/balances/balances.repository.ts

@@ -1,15 +1,14 @@
 import { Inject, Injectable } from '@nestjs/common';
 import { IBalancesRepository } from '@/domain/balances/balances.repository.interface';
 import { Balance } from '@/domain/balances/entities/balance.entity';
-import { BalancesValidator } from '@/domain/balances/balances.validator';
+import { BalanceSchema } from '@/domain/balances/entities/schemas/balance.schema';
 import { IBalancesApiManager } from '@/domain/interfaces/balances-api.manager.interface';
 
 @Injectable()
 export class BalancesRepository implements IBalancesRepository {
   constructor(
     @Inject(IBalancesApiManager)
     private readonly balancesApiManager: IBalancesApiManager,
-    private readonly balancesValidator: BalancesValidator,
   ) {}
 
   async getBalances(args: {
@@ -21,7 +20,7 @@ export class BalancesRepository implements IBalancesRepository {
   }): Promise<Balance[]> {
     const api = await this.balancesApiManager.getBalancesApi(args.chainId);
     const balances = await api.getBalances(args);
-    return balances.map((balance) => this.balancesValidator.validate(balance));
+    return balances.map((balance) => BalanceSchema.parse(balance));
   }
 
   async clearBalances(args: {

src/domain/balances/entities/__tests__/balance.builder.ts

@@ -2,10 +2,11 @@ import { Builder, IBuilder } from '@/__tests__/builder';
 import { faker } from '@faker-js/faker';
 import { balanceTokenBuilder } from './balance.token.builder';
 import { Balance } from '@/domain/balances/entities/balance.entity';
+import { getAddress } from 'viem';
 
 export function balanceBuilder(): IBuilder<Balance> {
   return new Builder<Balance>()
-    .with('tokenAddress', faker.finance.ethereumAddress())
+    .with('tokenAddress', getAddress(faker.finance.ethereumAddress()))
     .with('token', balanceTokenBuilder().build())
     .with('balance', faker.string.numeric());
 }

src/domain/balances/entities/balance.entity.ts

@@ -1,18 +1,12 @@
-import { BalanceToken } from '@/domain/balances/entities/balance.token.entity';
+import {
+  BalanceSchema,
+  Erc20BalanceSchema,
+  NativeBalanceSchema,
+} from '@/domain/balances/entities/schemas/balance.schema';
+import { z } from 'zod';
 
-export interface NativeBalance {
-  tokenAddress: null;
-  token: null;
-  balance: string;
-}
+export type NativeBalance = z.infer<typeof NativeBalanceSchema>;
 
-export interface Erc20Balance {
-  tokenAddress: string;
-  token: BalanceToken;
-  balance: string;
-}
+export type Erc20Balance = z.infer<typeof Erc20BalanceSchema>;
 
-export type Balance = (NativeBalance | Erc20Balance) & {
-  fiatBalance: string | null;
-  fiatConversion: string | null;
-};
+export type Balance = z.infer<typeof BalanceSchema>;

src/domain/balances/entities/balance.token.entity.ts

@@ -1,6 +1,4 @@
-export interface BalanceToken {
-  name: string;
-  symbol: string;
-  decimals: number;
-  logoUri: string;
-}
+import { BalanceTokenSchema } from '@/domain/balances/entities/schemas/balance.schema';
+import { z } from 'zod';
+
+export type BalanceToken = z.infer<typeof BalanceTokenSchema>;