chore: adds non-evm staking (#7448)

## Explanation

Adds a `tron_staking` state structure to support staking APY data for
Tron.

Tron staking uses a different approach than EVM pooled staking, so
rather than forcing Tron into the existing `pooled_staking` structure
(which would require nullable vault-specific fields and conditional
logic), this introduces a dedicated Tron specific state.

We opted for a chain-specific key (`tron_staking`) rather than a generic
`non_evm_staking` map because different non-EVM chains may have
significantly different data requirements. This approach is more
explicit and if we add other non-EVM chains later, they can have their
own state structures.

The idea next is for the mobile client to:
1 - Call `EarnController.refreshNonEvmStakingApy()` with Tron witness
API fetcher
2 - Use the selectors in `selectEarnTokens` to populate
`earnToken.experience.apr` with the Tron APY
3- Get rid of the `useTronStakeApy` hook calls from components

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs)
- [ ] I've introduced [breaking
changes](https://github.com/MetaMask/core/tree/main/docs/breaking-changes.md)
in this PR and have prepared draft pull requests for clients and
consumer packages to resolve them


<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Adds TRON staking APY support to EarnController with a new
`tron_staking` state, fetch/update method, selectors, exports, and
tests.
> 
> - **Earn Controller**:
> - **State**: Introduces `tron_staking` (`TronStakingState`) with
metadata; defaults to `null` (`DEFAULT_TRON_STAKING_STATE`) and included
in `getDefaultEarnControllerState`.
> - **Methods**: Adds `refreshTronStakingApy(apyFetcher)` and
`getTronStakingApy()`.
> - **Exports**: Exposes `TronStakingState`,
`DEFAULT_TRON_STAKING_STATE`, and new selectors via `src/index.ts`.
> - **Selectors**:
>   - Adds `selectTronStaking` and `selectTronStakingApy`.
>   - Tightens return types on existing lending selectors.
> - **Tests**:
> - Adds tests for TRON staking state/methods/selectors and updates
metadata snapshots.
> - **Docs**:
>   - Updates `CHANGELOG.md` to note TRON staking APY support.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
be891ac. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: zone-live

eslint-suppressions.json

@@ -945,9 +945,6 @@
     "@typescript-eslint/explicit-function-return-type": {
       "count": 9
     },
-    "@typescript-eslint/naming-convention": {
-      "count": 1
-    },
     "id-length": {
       "count": 2
     },
@@ -957,7 +954,7 @@
   },
   "packages/earn-controller/src/selectors.ts": {
     "@typescript-eslint/explicit-function-return-type": {
-      "count": 6
+      "count": 3
     }
   },
   "packages/eip-5792-middleware/src/constants.ts": {

packages/earn-controller/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add Tron staking APY support with `tron_staking` state, methods, and selectors ([#7448](https://github.com/MetaMask/core/pull/7448))
+
 ### Changed
 
 - Move peer dependencies for controller and service packages to direct dependencies ([#7209](https://github.com/MetaMask/core/pull/7209), [#7258](https://github.com/MetaMask/core/pull/7258), [#7534](https://github.com/MetaMask/core/pull/7534))

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

@@ -807,6 +807,14 @@ describe('EarnController', () => {
 
       // Verify that default lending state is still present
       expect(controller.state.lending).toBeDefined();
+
+      // Verify that default tron_staking state is still present
+      expect(controller.state.tron_staking).toBeNull();
+    });
+
+    it('initializes with null tron_staking state by default', async () => {
+      const { controller } = await setupController();
+      expect(controller.state.tron_staking).toBeNull();
     });
 
     it('initializes API service with default environment (PROD)', async () => {
@@ -2585,6 +2593,79 @@ describe('EarnController', () => {
     });
   });
 
+  describe('TRON Staking', () => {
+    describe('refreshTronStakingApy', () => {
+      it('updates state with fetched APY data', async () => {
+        const { controller } = await setupController();
+        const mockApy = '3.35';
+        const mockApyFetcher = jest.fn().mockResolvedValue(mockApy);
+
+        await controller.refreshTronStakingApy(mockApyFetcher);
+
+        expect(mockApyFetcher).toHaveBeenCalledTimes(1);
+        expect(controller.state.tron_staking).toStrictEqual(
+          expect.objectContaining({
+            apy: '3.35',
+            lastUpdated: expect.any(Number),
+          }),
+        );
+      });
+
+      it('overwrites existing APY data', async () => {
+        const { controller } = await setupController();
+
+        await controller.refreshTronStakingApy(
+          jest.fn().mockResolvedValue('3.35'),
+        );
+
+        const firstLastUpdated = controller.state.tron_staking?.lastUpdated;
+
+        await new Promise((resolve) => setTimeout(resolve, 10));
+
+        await controller.refreshTronStakingApy(
+          jest.fn().mockResolvedValue('4.0'),
+        );
+
+        expect(controller.state.tron_staking?.apy).toBe('4.0');
+        expect(controller.state.tron_staking?.lastUpdated).toBeGreaterThan(
+          firstLastUpdated as number,
+        );
+      });
+
+      it('handles apyFetcher errors', async () => {
+        const { controller } = await setupController();
+        const mockError = new Error('Failed to fetch APY');
+        const mockApyFetcher = jest.fn().mockRejectedValue(mockError);
+
+        await expect(
+          controller.refreshTronStakingApy(mockApyFetcher),
+        ).rejects.toThrow('Failed to fetch APY');
+
+        expect(controller.state.tron_staking).toBeNull();
+      });
+    });
+
+    describe('getTronStakingApy', () => {
+      it('returns APY when available', async () => {
+        const { controller } = await setupController();
+
+        await controller.refreshTronStakingApy(
+          jest.fn().mockResolvedValue('3.35'),
+        );
+
+        const result = controller.getTronStakingApy();
+        expect(result).toBe('3.35');
+      });
+
+      it('returns undefined when not available', async () => {
+        const { controller } = await setupController();
+
+        const result = controller.getTronStakingApy();
+        expect(result).toBeUndefined();
+      });
+    });
+  });
+
   describe('metadata', () => {
     it('includes expected state in debug snapshots', async () => {
       const { controller } = await setupController();
@@ -2611,9 +2692,10 @@ describe('EarnController', () => {
         'includeInStateLogs',
       );
 
-      // Compare `pooled_staking` separately to minimize size of snapshot
+      // Compare `pooled_staking` and `tron_staking` separately to minimize size of snapshot
       const {
         pooled_staking: derivedPooledStaking,
+        tron_staking: derivedTronStaking,
         ...derivedStateWithoutPooledStaking
       } = derivedState;
       expect(derivedPooledStaking).toStrictEqual({
@@ -2633,6 +2715,7 @@ describe('EarnController', () => {
         },
         isEligible: true,
       });
+      expect(derivedTronStaking).toBeNull();
       expect(derivedStateWithoutPooledStaking).toMatchInlineSnapshot(`
         Object {
           "lastUpdated": 0,
@@ -2702,9 +2785,10 @@ describe('EarnController', () => {
         'persist',
       );
 
-      // Compare `pooled_staking` separately to minimize size of snapshot
+      // Compare `pooled_staking` and `tron_staking` separately to minimize size of snapshot
       const {
         pooled_staking: derivedPooledStaking,
+        tron_staking: derivedTronStaking,
         ...derivedStateWithoutPooledStaking
       } = derivedState;
       expect(derivedPooledStaking).toStrictEqual({
@@ -2724,6 +2808,7 @@ describe('EarnController', () => {
         },
         isEligible: true,
       });
+      expect(derivedTronStaking).toBeNull();
       expect(derivedStateWithoutPooledStaking).toMatchInlineSnapshot(`
         Object {
           "lending": Object {
@@ -2792,9 +2877,10 @@ describe('EarnController', () => {
         'usedInUi',
       );
 
-      // Compare `pooled_staking` separately to minimize size of snapshot
+      // Compare `pooled_staking` and `tron_staking` separately to minimize size of snapshot
       const {
         pooled_staking: derivedPooledStaking,
+        tron_staking: derivedTronStaking,
         ...derivedStateWithoutPooledStaking
       } = derivedState;
       expect(derivedPooledStaking).toStrictEqual({
@@ -2814,6 +2900,7 @@ describe('EarnController', () => {
         },
         isEligible: true,
       });
+      expect(derivedTronStaking).toBeNull();
       expect(derivedStateWithoutPooledStaking).toMatchInlineSnapshot(`
         Object {
           "lending": Object {

packages/earn-controller/src/EarnController.ts

@@ -92,6 +92,16 @@ export type LendingState = {
   isEligible: boolean;
 };
 
+/**
+ * State for TRON staking.
+ */
+export type TronStakingState = {
+  /** The annual percentage yield as a decimal string (e.g., "3.35" for 3.35%) */
+  apy: string;
+  /** Timestamp of when the APY was last fetched */
+  lastUpdated: number;
+} | null;
+
 type StakingTransactionTypes =
   | TransactionType.stakingDeposit
   | TransactionType.stakingUnstake
@@ -128,6 +138,12 @@ const earnControllerMetadata: StateMetadata<EarnControllerState> = {
     includeInDebugSnapshot: false,
     usedInUi: true,
   },
+  tron_staking: {
+    includeInStateLogs: true,
+    persist: true,
+    includeInDebugSnapshot: false,
+    usedInUi: true,
+  },
   lastUpdated: {
     includeInStateLogs: true,
     persist: false,
@@ -138,8 +154,11 @@ const earnControllerMetadata: StateMetadata<EarnControllerState> = {
 
 // === State Types ===
 export type EarnControllerState = {
+  // eslint-disable-next-line @typescript-eslint/naming-convention
   pooled_staking: PooledStakingState;
   lending: LendingState;
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  tron_staking: TronStakingState;
   lastUpdated: number;
 };
 
@@ -209,6 +228,8 @@ export const DEFAULT_POOLED_STAKING_CHAIN_STATE = {
   vaultApyAverages: DEFAULT_POOLED_STAKING_VAULT_APY_AVERAGES,
 };
 
+export const DEFAULT_TRON_STAKING_STATE: TronStakingState = null;
+
 /**
  * Gets the default state for the EarnController.
  *
@@ -224,6 +245,7 @@ export function getDefaultEarnControllerState(): EarnControllerState {
       positions: [DEFAULT_LENDING_POSITION],
       isEligible: false,
     },
+    tron_staking: DEFAULT_TRON_STAKING_STATE,
     lastUpdated: 0,
   };
 }
@@ -806,6 +828,35 @@ export class EarnController extends BaseController<
     }
   }
 
+  /**
+   * Refreshes the APY for TRON staking.
+   * The consumer provides a fetcher function that returns the APY for TRON.
+   *
+   * @param apyFetcher - An async function that fetches and returns the APY as a decimal string.
+   * @returns A promise that resolves when the APY has been updated.
+   */
+  async refreshTronStakingApy(
+    apyFetcher: () => Promise<string>,
+  ): Promise<void> {
+    const apy = await apyFetcher();
+
+    this.update((state) => {
+      state.tron_staking = {
+        apy,
+        lastUpdated: Date.now(),
+      };
+    });
+  }
+
+  /**
+   * Gets the TRON staking APY.
+   *
+   * @returns The APY for TRON staking, or undefined if not available.
+   */
+  getTronStakingApy(): string | undefined {
+    return this.state.tron_staking?.apy;
+  }
+
   /**
    * Gets the lending position history for the current account.
    *

packages/earn-controller/src/index.ts

@@ -1,6 +1,7 @@
 export type {
   PooledStakingState,
   LendingState,
+  TronStakingState,
   LendingMarketWithPosition,
   LendingPositionWithMarket,
   LendingPositionWithMarketReference,
@@ -15,6 +16,7 @@ export type {
 export {
   controllerName,
   getDefaultEarnControllerState,
+  DEFAULT_TRON_STAKING_STATE,
   EarnController,
 } from './EarnController';
 
@@ -36,6 +38,8 @@ export {
   selectLendingMarketsByTokenAddress,
   selectLendingMarketsByChainIdAndOutputTokenAddress,
   selectLendingMarketsByChainIdAndTokenAddress,
+  selectTronStaking,
+  selectTronStakingApy,
 } from './selectors';
 
 export {

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

@@ -22,6 +22,8 @@ import {
   selectLendingMarketsByChainIdAndOutputTokenAddress,
   selectLendingMarketsByChainIdAndTokenAddress,
   selectIsLendingEligible,
+  selectTronStaking,
+  selectTronStakingApy,
 } from './selectors';
 
 describe('Earn Controller Selectors', () => {
@@ -135,6 +137,10 @@ describe('Earn Controller Selectors', () => {
       },
       isEligible: false,
     },
+    tron_staking: {
+      apy: '3.35',
+      lastUpdated: 1718000000000,
+    },
     lastUpdated: 0,
   };
 
@@ -413,4 +419,41 @@ describe('Earn Controller Selectors', () => {
       expect(result).toBe(false);
     });
   });
+
+  describe('TRON Staking Selectors', () => {
+    describe('selectTronStaking', () => {
+      it('should return the TRON staking state', () => {
+        const result = selectTronStaking(mockState);
+        expect(result).toStrictEqual({
+          apy: '3.35',
+          lastUpdated: 1718000000000,
+        });
+      });
+
+      it('should return null when no TRON staking data exists', () => {
+        const stateWithoutTronStaking = {
+          ...mockState,
+          tron_staking: null,
+        };
+        const result = selectTronStaking(stateWithoutTronStaking);
+        expect(result).toBeNull();
+      });
+    });
+
+    describe('selectTronStakingApy', () => {
+      it('should return the TRON staking APY', () => {
+        const result = selectTronStakingApy(mockState);
+        expect(result).toBe('3.35');
+      });
+
+      it('should return undefined when TRON staking is null', () => {
+        const stateWithoutTronStaking = {
+          ...mockState,
+          tron_staking: null,
+        };
+        const result = selectTronStakingApy(stateWithoutTronStaking);
+        expect(result).toBeUndefined();
+      });
+    });
+  });
 });