feat: added pooled staking vault daily apy averages to earn controller state

Author: Matt561

packages/earn-controller/src/EarnController.test.ts

@@ -27,6 +27,7 @@ jest.mock('@metamask/stake-sdk', () => ({
     getPooledStakingEligibility: jest.fn(),
     getVaultData: jest.fn(),
     getVaultDailyApys: jest.fn(),
+    getVaultApyAverages: jest.fn(),
   })),
 }));
 
@@ -178,6 +179,15 @@ const mockPooledStakingVaultDailyApys = [
   },
 ];
 
+const mockPooledStakingVaultApyAverages = {
+  oneDay: '3.047713358665092375',
+  oneWeek: '3.25756026351317301786',
+  oneMonth: '3.25616054301749304217',
+  threeMonths: '3.31863306662107446672',
+  sixMonths: '3.05557344496273894133',
+  oneYear: '0',
+};
+
 const setupController = ({
   options = {},
 
@@ -257,6 +267,9 @@ describe('EarnController', () => {
       getVaultDailyApys: jest
         .fn()
         .mockResolvedValue(mockPooledStakingVaultDailyApys),
+      getVaultApyAverages: jest
+        .fn()
+        .mockResolvedValue(mockPooledStakingVaultApyAverages),
     } as Partial<StakingApiService>;
 
     StakingApiServiceMock.mockImplementation(
@@ -278,6 +291,7 @@ describe('EarnController', () => {
           vaultMetadata: mockVaultMetadata,
           isEligible: true,
           vaultDailyApys: mockPooledStakingVaultDailyApys,
+          vaultApyAverages: mockPooledStakingVaultApyAverages,
         },
         lastUpdated: 1234567890,
       };
@@ -362,6 +376,7 @@ describe('EarnController', () => {
         exchangeRate: '1.5',
         vaultMetadata: mockVaultMetadata,
         vaultDailyApys: mockPooledStakingVaultDailyApys,
+        vaultApyAverages: mockPooledStakingVaultApyAverages,
         isEligible: true,
       });
       expect(controller.state.lastUpdated).toBeDefined();
@@ -420,13 +435,14 @@ describe('EarnController', () => {
       consoleErrorSpy.mockRestore();
     });
 
-    // if no account is selected, it should not fetch stakes data but still update vault metadata
+    // if no account is selected, it should not fetch stakes data but still update vault metadata, vault daily apys and vault apy averages.
     it('does not fetch staking data if no account is selected', async () => {
       const { controller } = setupController({
         mockGetSelectedAccount: jest.fn(() => null),
       });
 
       expect(mockedStakingApiService.getPooledStakes).not.toHaveBeenCalled();
+
       await controller.refreshPooledStakingData();
 
       expect(controller.state.pooled_staking.pooledStakes).toStrictEqual(
@@ -435,6 +451,12 @@ describe('EarnController', () => {
       expect(controller.state.pooled_staking.vaultMetadata).toStrictEqual(
         mockVaultMetadata,
       );
+      expect(controller.state.pooled_staking.vaultDailyApys).toStrictEqual(
+        mockPooledStakingVaultDailyApys,
+      );
+      expect(controller.state.pooled_staking.vaultApyAverages).toStrictEqual(
+        mockPooledStakingVaultApyAverages,
+      );
       expect(controller.state.pooled_staking.isEligible).toBe(false);
     });
   });

packages/earn-controller/src/EarnController.ts

@@ -23,6 +23,7 @@ import {
   type StakeSdkConfig,
   type VaultData,
   type VaultDailyApy,
+  type VaultApyAverages,
 } from '@metamask/stake-sdk';
 
 export const controllerName = 'EarnController';
@@ -32,6 +33,7 @@ export type PooledStakingState = {
   exchangeRate: string;
   vaultMetadata: VaultData;
   vaultDailyApys: VaultDailyApy[];
+  vaultApyAverages: VaultApyAverages;
   isEligible: boolean;
 };
 
@@ -87,6 +89,15 @@ const DEFAULT_STABLECOIN_VAULT: StablecoinVault = {
   liquidity: '0',
 };
 
+const DEFAULT_POOLED_STAKING_VAULT_APY_AVERAGES: VaultApyAverages = {
+  oneDay: '0',
+  oneWeek: '0',
+  oneMonth: '0',
+  threeMonths: '0',
+  sixMonths: '0',
+  oneYear: '0',
+};
+
 /**
  * Gets the default state for the EarnController.
  *
@@ -110,6 +121,7 @@ export function getDefaultEarnControllerState(): EarnControllerState {
         vaultAddress: '0x0000000000000000000000000000000000000000',
       },
       vaultDailyApys: [],
+      vaultApyAverages: DEFAULT_POOLED_STAKING_VAULT_APY_AVERAGES,
       isEligible: false,
     },
     stablecoin_lending: {
@@ -368,7 +380,7 @@ export class EarnController extends BaseController<
    * Updates the pooled staking vault daily apys controller state.
    *
    * @param days - The number of days to fetch pooled staking vault daily apys for (defaults to 30).
-   * @param order - The order in which to fetch pooled staking vault daily apys. Descending order fetches the latest N days (latest working backwards). Ascending order fetches the oldest N days (oldest working forwards).
+   * @param order - The order in which to fetch pooled staking vault daily apys. Descending order fetches the latest N days (latest working backwards). Ascending order fetches the oldest N days (oldest working forwards) (defaults to 'desc').
    * @returns A promise that resolves when the pooled staking vault daily apys have been updated.
    */
   async refreshPooledStakingVaultDailyApys(
@@ -387,6 +399,22 @@ export class EarnController extends BaseController<
     });
   }
 
+  /**
+   * Refreshes pooled staking vault apy averages for the current chain.
+   * Updates the pooled staking vault apy averages controller state.
+   *
+   * @returns A promise that resolves when the pooled staking vault apy averages have been updated.
+   */
+  async refreshPooledStakingVaultApyAverages() {
+    const chainId = this.#getCurrentChainId();
+    const vaultApyAverages =
+      await this.#stakingApiService.getVaultApyAverages(chainId);
+
+    this.update((state) => {
+      state.pooled_staking.vaultApyAverages = vaultApyAverages;
+    });
+  }
+
   /**
    * Refreshes all pooled staking related data including stakes, eligibility, and vault data.
    * This method allows partial success, meaning some data may update while other requests fail.
@@ -412,6 +440,9 @@ export class EarnController extends BaseController<
       this.refreshPooledStakingVaultDailyApys().catch((error) => {
         errors.push(error);
       }),
+      this.refreshPooledStakingVaultApyAverages().catch((error) => {
+        errors.push(error);
+      }),
     ]);
 
     if (errors.length > 0) {