feat(1707): mirror node getaccount response validation (#1728)

Signed-off-by: rozekmichal <michal.rozek@blockydevs.com>

Author: rozekmichal

src/core/services/mirrornode/hedera-mirrornode-service.ts

@@ -1,7 +1,6 @@
 import type { NetworkService } from '@/core/services/network/network-service.interface';
 import type { HederaMirrornodeService } from './hedera-mirrornode-service.interface';
 import type {
-  AccountAPIResponse,
   AccountListItemAPIResponse,
   AccountListItemDto,
   AccountResponse,
@@ -36,7 +35,11 @@ import { KeyAlgorithm } from '@/core/shared/constants';
 import { parseWithSchema } from '@/core/shared/validation/parse-with-schema.zod';
 import { handleMirrorNodeErrorResponse } from '@/core/utils/handle-mirror-node-error-response';
 
-import { TokenInfoSchema } from './schema';
+import {
+  AccountAPIResponseSchema,
+  GetAccountsAPIResponseSchema,
+  TokenInfoSchema,
+} from './schemas';
 import { NetworkToBaseUrl } from './types';
 
 export class HederaMirrornodeServiceDefaultImpl implements HederaMirrornodeService {
@@ -82,7 +85,11 @@ export class HederaMirrornodeServiceDefaultImpl implements HederaMirrornodeServi
         return null;
       }
 
-      const data = (await response.json()) as AccountAPIResponse;
+      const data = parseWithSchema(
+        AccountAPIResponseSchema,
+        await response.json(),
+        `Mirror Node GET /accounts/${accountId}`,
+      );
 
       if (!data.account) {
         throw new NotFoundError(`Account ${accountId} not found`);
@@ -102,8 +109,7 @@ export class HederaMirrornodeServiceDefaultImpl implements HederaMirrornodeServi
         keyAlgorithm: this.getKeyAlgorithm(data.key._type),
       };
     } catch (error) {
-      if (error instanceof NotFoundError || error instanceof NetworkError)
-        throw error;
+      if (error instanceof CliError) throw error;
       throw new NetworkError(`Failed to fetch account ${accountId}`, {
         cause: error,
         recoverable: true,
@@ -179,14 +185,21 @@ export class HederaMirrornodeServiceDefaultImpl implements HederaMirrornodeServi
           break;
         }
 
-        const data = (await response.json()) as GetAccountsAPIResponse;
+        const pagePayload: GetAccountsAPIResponse = parseWithSchema(
+          GetAccountsAPIResponseSchema,
+          await response.json(),
+          `Mirror Node GET /accounts (page ${fetchedPages})`,
+        );
 
-        allAccounts.push(...(data.accounts ?? []));
+        allAccounts.push(...(pagePayload.accounts ?? []));
         if (fetchedPages >= 100) {
           break;
         }
-        url = data.links?.next ? this.getBaseUrl() + data.links.next : null;
+        url = pagePayload.links?.next
+          ? this.getBaseUrl() + pagePayload.links.next
+          : null;
       } catch (error) {
+        if (error instanceof CliError) throw error;
         if (error instanceof NetworkError) throw error;
         throw new NetworkError(`Failed to fetch accounts`, {
           cause: error,
@@ -208,7 +221,7 @@ export class HederaMirrornodeServiceDefaultImpl implements HederaMirrornodeServi
       accountId: apiAccount.account,
       createdTimestamp: apiAccount.created_timestamp,
     };
-    if (apiAccount.alias !== undefined) dto.alias = apiAccount.alias;
+    if (apiAccount.alias != null) dto.alias = apiAccount.alias;
     if (apiAccount.deleted !== undefined) dto.deleted = apiAccount.deleted;
     if (apiAccount.memo !== undefined) dto.memo = apiAccount.memo;
     if (apiAccount.evm_address !== undefined)

src/core/services/mirrornode/schema.ts

@@ -0,0 +1,103 @@
+import type {
+  AccountAPIBalance,
+  AccountAPIKey,
+  AccountAPIResponse,
+  AccountListItemAPIResponse,
+  AccountListItemBalance,
+  AccountListItemTokenBalance,
+  GetAccountsAPIResponse,
+  TokenInfo,
+} from './types';
+
+import { z } from 'zod';
+
+const mirrorKeyObject = z.object({
+  _type: z.string(),
+  key: z.string(),
+});
+
+const optionalKeyRef = z.union([mirrorKeyObject, z.null()]).optional();
+
+export const TokenInfoSchema: z.ZodType<TokenInfo> = z.object({
+  token_id: z.string(),
+  symbol: z.string(),
+  name: z.string(),
+  decimals: z.string(),
+  total_supply: z.string(),
+  max_supply: z.string(),
+  type: z.string(),
+  treasury_account_id: z.string(),
+  admin_key: optionalKeyRef,
+  kyc_key: optionalKeyRef,
+  freeze_key: optionalKeyRef,
+  wipe_key: optionalKeyRef,
+  supply_key: optionalKeyRef,
+  fee_schedule_key: optionalKeyRef,
+  pause_key: optionalKeyRef,
+  created_timestamp: z.string(),
+  deleted: z.boolean().nullable().optional(),
+  freeze_default: z.boolean().optional(),
+  pause_status: z.string(),
+  memo: z.string(),
+});
+
+const mirrorNodeKeyTypeSchema = z.enum(['ECDSA_SECP256K1', 'ED25519']);
+
+export const AccountAPIBalanceSchema: z.ZodType<AccountAPIBalance> = z.object({
+  balance: z.number(),
+  timestamp: z.string(),
+});
+
+export const AccountAPIKeySchema: z.ZodType<AccountAPIKey> = z.object({
+  _type: mirrorNodeKeyTypeSchema,
+  key: z.string(),
+});
+
+export const AccountAPIResponseSchema: z.ZodType<AccountAPIResponse> = z.object(
+  {
+    account: z.string(),
+    alias: z.string().nullable().optional(),
+    balance: AccountAPIBalanceSchema,
+    created_timestamp: z.string(),
+    evm_address: z.string().optional(),
+    key: AccountAPIKeySchema.optional(),
+    max_automatic_token_associations: z.number(),
+    memo: z.string(),
+    receiver_sig_required: z.boolean(),
+  },
+);
+
+const accountListItemTokenBalanceSchema: z.ZodType<AccountListItemTokenBalance> =
+  z.object({
+    token_id: z.string(),
+    balance: z.number(),
+  });
+
+export const AccountListItemBalanceSchema: z.ZodType<AccountListItemBalance> =
+  z.object({
+    timestamp: z.string(),
+    balance: z.number(),
+    tokens: z.array(accountListItemTokenBalanceSchema).optional(),
+  });
+
+export const AccountListItemAPIResponseSchema: z.ZodType<AccountListItemAPIResponse> =
+  z.object({
+    account: z.string(),
+    alias: z.string().nullable().optional(),
+    balance: AccountListItemBalanceSchema.optional(),
+    created_timestamp: z.string(),
+    evm_address: z.string().optional(),
+    key: z.union([AccountAPIKeySchema, z.null()]).optional(),
+    deleted: z.boolean().optional(),
+    memo: z.string().optional(),
+  });
+
+export const GetAccountsAPIResponseSchema: z.ZodType<GetAccountsAPIResponse> =
+  z.object({
+    accounts: z.array(AccountListItemAPIResponseSchema),
+    links: z
+      .object({
+        next: z.string().nullable().optional(),
+      })
+      .optional(),
+  });

src/core/services/mirrornode/schemas.ts

@@ -16,20 +16,23 @@ export const NetworkToBaseUrl = new Map<SupportedNetwork, string>([
 
 export type MirrorNodeKeyType = 'ECDSA_SECP256K1' | 'ED25519';
 
-// Account API Response
+export interface AccountAPIBalance {
+  balance: number;
+  timestamp: string;
+}
+
+export interface AccountAPIKey {
+  _type: MirrorNodeKeyType;
+  key: string;
+}
+
 export interface AccountAPIResponse {
   account: string;
-  alias?: string;
-  balance: {
-    balance: number;
-    timestamp: string;
-  };
+  alias?: string | null;
+  balance: AccountAPIBalance;
   created_timestamp: string;
   evm_address?: string;
-  key?: {
-    _type: MirrorNodeKeyType;
-    key: string;
-  };
+  key?: AccountAPIKey;
   max_automatic_token_associations: number;
   memo: string;
   receiver_sig_required: boolean;
@@ -281,17 +284,24 @@ export interface GetAccountsQueryParams {
   order?: MirrorNodeRequestOrderParameter;
 }
 
+export interface AccountListItemTokenBalance {
+  token_id: string;
+  balance: number;
+}
+
+export interface AccountListItemBalance {
+  timestamp: string;
+  balance: number;
+  tokens?: AccountListItemTokenBalance[];
+}
+
 export interface AccountListItemAPIResponse {
   account: string;
-  alias?: string;
-  balance?: {
-    timestamp: string;
-    balance: number;
-    tokens?: Array<{ token_id: string; balance: number }>;
-  };
+  alias?: string | null;
+  balance?: AccountListItemBalance;
   created_timestamp: string;
   evm_address?: string;
-  key?: { _type: MirrorNodeKeyType; key: string } | null;
+  key?: AccountAPIKey | null;
   deleted?: boolean;
   memo?: string;
 }