feat: schema, interface and mocks update for TokenInfo

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

Author: rozekmichal

src/__tests__/mocks/mocks.ts

@@ -435,8 +435,7 @@ export const makeMirrorMock = (
         treasury_account_id: '0.0.1234',
         created_timestamp: '1234567890',
         deleted: false,
-        default_freeze_status: false,
-        default_kyc_status: false,
+        freeze_default: false,
         pause_status: 'NOT_APPLICABLE',
         memo: '',
       });
@@ -451,8 +450,7 @@ export const makeMirrorMock = (
       treasury_account_id: '0.0.1234',
       created_timestamp: '1234567890',
       deleted: false,
-      default_freeze_status: false,
-      default_kyc_status: false,
+      freeze_default: false,
       pause_status: 'NOT_APPLICABLE',
       memo: '',
     });

src/core/errors/index.ts

@@ -12,4 +12,8 @@ export { NotFoundError } from './not-found-error';
 export { StateError } from './state-error';
 export { TransactionError } from './transaction-error';
 export { TransactionPrecheckError } from './transaction-precheck-error';
-export { ValidationError } from './validation-error';
+export {
+  formatZodIssueLine,
+  formatZodIssuesForMessage,
+  ValidationError,
+} from './validation-error';

src/core/errors/validation-error.ts

@@ -1,7 +1,18 @@
 import type { ZodError } from 'zod';
 
+import { type $ZodIssue, toDotPath } from 'zod/v4/core';
+
 import { CliError } from './cli-error';
 
+export function formatZodIssueLine(issue: $ZodIssue): string {
+  const path = issue.path.length === 0 ? '(root)' : toDotPath(issue.path);
+  return `${path}: ${issue.message}`;
+}
+
+export function formatZodIssuesForMessage(zodError: ZodError): string {
+  return zodError.issues.map((i) => `  - ${formatZodIssueLine(i)}`).join('\n');
+}
+
 export class ValidationError extends CliError {
   static readonly CODE = 'VALIDATION_ERROR';
 
@@ -21,11 +32,13 @@ export class ValidationError extends CliError {
   }
 
   static fromZod(zodError: ZodError): ValidationError {
-    const issues = zodError.issues.map((i) => i.message);
-    const message = `Validation failed:\n${issues.map((i) => `  - ${i}`).join('\n')}`;
+    const issueLines = zodError.issues.map((issue) =>
+      formatZodIssueLine(issue),
+    );
+    const message = `Validation failed:\n${formatZodIssuesForMessage(zodError)}`;
 
     return new ValidationError(message, {
-      context: { issues },
+      context: { issues: issueLines },
       cause: zodError,
     });
   }

src/core/services/mirrornode/__tests__/unit/mocks.ts

@@ -116,8 +116,7 @@ export const createMockTokenInfo = (
   treasury_account_id: '0.0.1234',
   created_timestamp: '2024-01-01T12:00:00.000Z',
   deleted: false,
-  default_freeze_status: false,
-  default_kyc_status: false,
+  freeze_default: false,
   pause_status: 'UNPAUSED',
   memo: '',
   ...overrides,
@@ -139,8 +138,7 @@ export const createMockMirrorNodeTokenByIdJson = (
   treasury_account_id: '0.0.1234',
   created_timestamp: '2024-01-01T12:00:00.000Z',
   deleted: false,
-  default_freeze_status: false,
-  default_kyc_status: false,
+  freeze_default: false,
   pause_status: 'UNPAUSED',
   memo: '',
   ...overrides,

src/core/services/mirrornode/schema.ts

@@ -2,12 +2,12 @@ import type { TokenInfo } from './types';
 
 import { z } from 'zod';
 
-const optionalMirrorKey = z
-  .object({
-    _type: z.string(),
-    key: z.string(),
-  })
-  .optional();
+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(),
@@ -18,17 +18,16 @@ export const TokenInfoSchema: z.ZodType<TokenInfo> = z.object({
   max_supply: z.string(),
   type: z.string(),
   treasury_account_id: z.string(),
-  admin_key: optionalMirrorKey,
-  kyc_key: optionalMirrorKey,
-  freeze_key: optionalMirrorKey,
-  wipe_key: optionalMirrorKey,
-  supply_key: optionalMirrorKey,
-  fee_schedule_key: optionalMirrorKey,
-  pause_key: optionalMirrorKey,
+  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(),
-  default_freeze_status: z.boolean(),
-  default_kyc_status: z.boolean(),
+  deleted: z.boolean().nullable().optional(),
+  freeze_default: z.boolean().optional(),
   pause_status: z.string(),
   memo: z.string(),
 });

src/core/services/mirrornode/types.ts

@@ -60,7 +60,11 @@ export interface TokenBalanceInfo {
   decimals: number;
 }
 
-// Token Info
+export type MirrorNodeTokenKey = {
+  _type: string;
+  key: string;
+};
+
 export interface TokenInfo {
   token_id: string;
   symbol: string;
@@ -70,38 +74,16 @@ export interface TokenInfo {
   max_supply: string;
   type: string;
   treasury_account_id: string;
-  admin_key?: {
-    _type: string;
-    key: string;
-  };
-  kyc_key?: {
-    _type: string;
-    key: string;
-  };
-  freeze_key?: {
-    _type: string;
-    key: string;
-  };
-  wipe_key?: {
-    _type: string;
-    key: string;
-  };
-  supply_key?: {
-    _type: string;
-    key: string;
-  };
-  fee_schedule_key?: {
-    _type: string;
-    key: string;
-  };
-  pause_key?: {
-    _type: string;
-    key: string;
-  };
+  admin_key?: MirrorNodeTokenKey | null;
+  kyc_key?: MirrorNodeTokenKey | null;
+  freeze_key?: MirrorNodeTokenKey | null;
+  wipe_key?: MirrorNodeTokenKey | null;
+  supply_key?: MirrorNodeTokenKey | null;
+  fee_schedule_key?: MirrorNodeTokenKey | null;
+  pause_key?: MirrorNodeTokenKey | null;
   created_timestamp: string;
-  deleted: boolean;
-  default_freeze_status: boolean;
-  default_kyc_status: boolean;
+  deleted?: boolean | null;
+  freeze_default?: boolean;
   pause_status: string;
   memo: string;
 }

src/core/shared/validation/parse-with-schema.zod.ts

@@ -1,6 +1,10 @@
 import type { z } from 'zod';
 
-import { ValidationError } from '@/core/errors';
+import {
+  formatZodIssueLine,
+  formatZodIssuesForMessage,
+  ValidationError,
+} from '@/core/errors';
 
 export function parseWithSchema<T>(
   schema: z.ZodType<T>,
@@ -9,10 +13,16 @@ export function parseWithSchema<T>(
 ): T {
   const result = schema.safeParse(data);
   if (!result.success) {
-    throw new ValidationError(`Invalid response (${context})`, {
-      cause: result.error,
-      context: { issues: result.error.issues },
-    });
+    const issueLines = result.error.issues.map((issue) =>
+      formatZodIssueLine(issue),
+    );
+    throw new ValidationError(
+      `Invalid response (${context}):\n${formatZodIssuesForMessage(result.error)}`,
+      {
+        cause: result.error,
+        context: { issues: issueLines },
+      },
+    );
   }
   return result.data;
 }