feat: made all VaultApyResponse fields optional except for apy and timestamp. Vaults aren't guaranteed to have the other properties when there's no activity

Author: Matt561

packages/money-account-controller/src/money-account-balance-service/requestNormalization.ts

@@ -1,7 +1,7 @@
 import { Infer } from '@metamask/superstruct';
 
-import { VaultApyResponseStruct } from './structs';
 import { VaultApyResponse } from './response.types';
+import { VaultApyResponseStruct } from './structs';
 
 /**
  * Normalizes the raw response from the Veda performance API into the expected
@@ -20,13 +20,15 @@ export function normalizeVaultApyResponse(
     apy: response.apy,
     chainAllocation: response.chain_allocation,
     fees: response.fees,
-    globalApyBreakdown: {
-      fee: response.global_apy_breakdown.fee,
-      maturityApy: response.global_apy_breakdown.maturity_apy,
-      realApy: response.global_apy_breakdown.real_apy,
-    },
+    globalApyBreakdown: response.global_apy_breakdown
+      ? {
+          fee: response.global_apy_breakdown.fee,
+          maturityApy: response.global_apy_breakdown.maturity_apy,
+          realApy: response.global_apy_breakdown.real_apy,
+        }
+      : undefined,
     performanceFees: response.performance_fees,
-    realApyBreakdown: response.real_apy_breakdown.map((item) => ({
+    realApyBreakdown: response.real_apy_breakdown?.map((item) => ({
       allocation: item.allocation,
       apy: item.apy,
       apyNet: item.apy_net,

packages/money-account-controller/src/money-account-balance-service/response.types.ts

@@ -28,26 +28,29 @@ export type MusdEquivalentValueResponse = {
 /**
  * Response from {@link MoneyAccountBalanceService.getVaultApy}.
  * All APY / fee values are decimals (multiply by 100 for percentage).
+ *
+ * Only `apy` and `timestamp` are guaranteed to be present — all other fields
+ * are optional because the Veda API omits them when the vault has no activity.
  */
 export type VaultApyResponse = {
-  aggregationPeriod: string; // E.g. "7 days"
+  aggregationPeriod?: string; // E.g. "7 days"
   apy: number;
-  chainAllocation: {
+  chainAllocation?: {
     [network: string]: number;
   };
-  fees: number;
-  globalApyBreakdown: {
-    fee: number;
-    maturityApy: number;
-    realApy: number;
+  fees?: number;
+  globalApyBreakdown?: {
+    fee?: number;
+    maturityApy?: number;
+    realApy?: number;
   };
-  performanceFees: number;
-  realApyBreakdown: {
-    allocation: number;
-    apy: number;
-    apyNet: number;
-    chain: string;
-    protocol: string;
+  performanceFees?: number;
+  realApyBreakdown?: {
+    allocation?: number;
+    apy?: number;
+    apyNet?: number;
+    chain?: string;
+    protocol?: string;
   }[];
   timestamp: string;
 };

packages/money-account-controller/src/money-account-balance-service/structs.ts

@@ -1,32 +1,46 @@
-import { array, number, record, string, type } from '@metamask/superstruct';
+import {
+  array,
+  number,
+  optional,
+  record,
+  string,
+  type,
+} from '@metamask/superstruct';
 
 /**
  * Superstruct schema for {@link VaultApyResponse}.
  *
  * Uses `type()` (loose validation) so that unknown fields returned by the
  * Veda API do not cause validation failures.
+ *
+ * Only `apy` and `timestamp` are required — all other fields are optional
+ * because the Veda API omits some fields when the vault has no activity.
  */
 export const VaultApyResponseStruct = type({
   Response: type({
-    aggregation_period: string(),
+    aggregation_period: optional(string()),
     apy: number(),
-    chain_allocation: record(string(), number()),
-    fees: number(),
-    global_apy_breakdown: type({
-      fee: number(),
-      maturity_apy: number(),
-      real_apy: number(),
-    }),
-    performance_fees: number(),
-    real_apy_breakdown: array(
+    chain_allocation: optional(record(string(), number())),
+    fees: optional(number()),
+    global_apy_breakdown: optional(
       type({
-        allocation: number(),
-        apy: number(),
-        apy_net: number(),
-        chain: string(),
-        protocol: string(),
+        fee: optional(number()),
+        maturity_apy: optional(number()),
+        real_apy: optional(number()),
       }),
     ),
+    performance_fees: optional(number()),
+    real_apy_breakdown: optional(
+      array(
+        type({
+          allocation: optional(number()),
+          apy: optional(number()),
+          apy_net: optional(number()),
+          chain: optional(string()),
+          protocol: optional(string()),
+        }),
+      ),
+    ),
     timestamp: string(),
   }),
 });

yarn.lock

@@ -4427,6 +4427,7 @@ __metadata:
     async-mutex: "npm:^0.5.0"
     deepmerge: "npm:^4.2.2"
     jest: "npm:^29.7.0"
+    nock: "npm:^13.3.1"
     ts-jest: "npm:^29.2.5"
     tsx: "npm:^4.20.5"
     typedoc: "npm:^0.25.13"