chore(runway): cherry-pick feat: integrate earn-controller 12.0.0 to fix broken pooled-staking deposits and withdrawals (#28819)

- feat: integrate earn-controller 12.0.0 to fix broken pooled-staking
deposits and withdrawals cp-7.73.0 (#28737)

<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**
This PR bumps the `@metamask/earn-controller` dependency to version
`12.0.0`. This is required to address a release blocking bug where
pooled-staking deposits and withdrawals are blocked.

<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

## **Changelog**

<!--
If this PR is not End-User-Facing and should not show up in the
CHANGELOG, you can choose to either:
1. Write `CHANGELOG entry: null`
2. Label with `no-changelog`

If this PR is End-User-Facing, please write a short User-Facing
description in the past tense like:
`CHANGELOG entry: Added a new tab for users to see their NFTs`
`CHANGELOG entry: Fixed a bug that was causing some NFTs to flicker`

(This helps the Release Engineer do their job more quickly and
accurately)
-->

CHANGELOG entry: bumped @metamask/earn-controller to 12.0.0 and fixed
breaking changes

## **Related issues**

Fixes:
- [MUSD-619: Users are unable to stake ETH or lend from token details
page](https://consensyssoftware.atlassian.net/browse/MUSD-619)

## **Manual testing steps**

```gherkin
Feature: Ethereum Pooled-Staking

  Scenario: user wants to stake ETH
    Given user has no staked ETH

    When user visits Ethereum's asset details screen
    Then the "Stake" button is rendered in the empty state CTA
    
   Scenario: user wants to unstake ETH
    Given user has staked ETH

    When user visits Ethereum's asset details screen
    Then the "Unstake" button is rendered in the empty state CTA
```

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->
The Stake and Unstake buttons would not render due to EarnController
initialization failures.

### **After**

<!-- [screenshots/recordings] -->



https://github.com/user-attachments/assets/ba0d15a5-d95a-47c6-8809-0bd64c4a4626

## **Pre-merge author checklist**

- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding

Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I've included tests if applicable
- [x] I've documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I've applied the right labels on the PR (see [labeling

guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.


<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> Medium risk because it upgrades a core dependency
(`@metamask/earn-controller`) and changes EarnController
initialization/messenger delegation, which can affect staking/lending
flows at runtime.
> 
> **Overview**
> Upgrades `@metamask/earn-controller` from `^10.0.0` to `^12.0.0`
(lockfile updated accordingly).
> 
> Updates EarnController wiring to match the new API: removes the
dedicated init messenger, delegates `NetworkController:getState` (and
`AccountTreeController:stateChange`) through the main EarnController
messenger, and changes `earnControllerInit` to construct the controller
without `selectedNetworkClientId` and explicitly call
`controller.init()`.
> 
> Adjusts mocks/fixtures/snapshots to include the new `EarnController`
state key `tron_staking: null` so tests and initial background state
stay in sync.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
da2c3bf. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
[0770e7b](0770e7b)

---------

Co-authored-by: Matthew Grainger <46547583+Matt561@users.noreply.github.com>
Co-authored-by: Matthew Grainger <matthew.grainger@consensys.net>

Author: runway-github[bot]

app/components/UI/Earn/__mocks__/earnMockData.ts

@@ -190,6 +190,7 @@ export const getMockEarnControllerState = ({
 }: Partial<GetMockEarnControllerStateOptions> = {}) => ({
   pooled_staking: getMockEarnControllerPooledStakingState(pooledStaking),
   lending: getMockEarnControllerLendingState(lending),
+  tron_staking: null,
   lastUpdated: 0,
 });
 

app/components/UI/Earn/hooks/useEarnSelector.test.ts

@@ -39,6 +39,7 @@ describe('useEarnSelector', () => {
       markets: [],
       positions: [],
     },
+    tron_staking: null,
     lastUpdated: 0,
   };
 

app/core/Engine/controllers/earn-controller-init.test.ts

@@ -1,31 +1,20 @@
 import { buildControllerInitRequestMock } from '../utils/test-utils';
 import { ExtendedMessenger } from '../../ExtendedMessenger';
-import {
-  getEarnControllerMessenger,
-  EarnControllerInitMessenger,
-  getEarnControllerInitMessenger,
-} from '../messengers/earn-controller-messenger';
-import { ControllerInitRequest } from '../types';
+import { getEarnControllerMessenger } from '../messengers/earn-controller-messenger';
 import { earnControllerInit } from './earn-controller-init';
-import {
-  EarnController,
-  type EarnControllerMessenger,
-} from '@metamask/earn-controller';
+import { EarnController } from '@metamask/earn-controller';
 import { MOCK_ANY_NAMESPACE, MockAnyNamespace } from '@metamask/messenger';
 
 jest.mock('@metamask/earn-controller');
 
-function getInitRequestMock(): jest.Mocked<
-  ControllerInitRequest<EarnControllerMessenger, EarnControllerInitMessenger>
-> {
+function getInitRequestMock() {
   const baseMessenger = new ExtendedMessenger<MockAnyNamespace, never>({
     namespace: MOCK_ANY_NAMESPACE,
   });
 
   const requestMock = {
     ...buildControllerInitRequestMock(baseMessenger),
     controllerMessenger: getEarnControllerMessenger(baseMessenger),
-    initMessenger: getEarnControllerInitMessenger(baseMessenger),
   };
 
   // @ts-expect-error: Partial mock.
@@ -39,11 +28,6 @@ function getInitRequestMock(): jest.Mocked<
     throw new Error(`Controller "${name}" not found.`);
   });
 
-  // @ts-expect-error: Partial mock.
-  baseMessenger.registerActionHandler('NetworkController:getState', () => ({
-    selectedNetworkClientId: 'mainnet',
-  }));
-
   return requestMock;
 }
 
@@ -60,7 +44,11 @@ describe('EarnControllerInit', () => {
     expect(controllerMock).toHaveBeenCalledWith({
       messenger: expect.any(Object),
       addTransactionFn: expect.any(Function),
-      selectedNetworkClientId: 'mainnet',
     });
   });
+
+  it('calls init() on the controller after construction', () => {
+    const { controller } = earnControllerInit(getInitRequestMock());
+    expect(controller.init).toHaveBeenCalledTimes(1);
+  });
 });

app/core/Engine/controllers/earn-controller-init.ts

@@ -3,7 +3,6 @@ import {
   EarnController,
   EarnControllerMessenger,
 } from '@metamask/earn-controller';
-import { EarnControllerInitMessenger } from '../messengers/earn-controller-messenger';
 
 /**
  * Initialize the earn controller.
@@ -14,20 +13,19 @@ import { EarnControllerInitMessenger } from '../messengers/earn-controller-messe
  */
 export const earnControllerInit: ControllerInitFunction<
   EarnController,
-  EarnControllerMessenger,
-  EarnControllerInitMessenger
-> = ({ controllerMessenger, initMessenger, getController }) => {
-  const networkState = initMessenger.call('NetworkController:getState');
+  EarnControllerMessenger
+> = ({ controllerMessenger, getController }) => {
   const transactionController = getController('TransactionController');
 
   const controller = new EarnController({
     messenger: controllerMessenger,
     addTransactionFn: transactionController.addTransaction.bind(
       transactionController,
     ),
-    selectedNetworkClientId: networkState.selectedNetworkClientId,
   });
 
+  controller.init();
+
   return {
     controller,
   };

app/core/Engine/messengers/earn-controller-messenger.test.ts

@@ -5,17 +5,12 @@ import {
   MOCK_ANY_NAMESPACE,
   type MockAnyNamespace,
 } from '@metamask/messenger';
-import {
-  getEarnControllerMessenger,
-  getEarnControllerInitMessenger,
-  EarnControllerInitMessenger,
-} from './earn-controller-messenger';
+import { getEarnControllerMessenger } from './earn-controller-messenger';
 import { EarnControllerMessenger } from '@metamask/earn-controller';
 
 type RootMessenger = Messenger<
   MockAnyNamespace,
-  | MessengerActions<EarnControllerMessenger>
-  | MessengerActions<EarnControllerInitMessenger>,
+  MessengerActions<EarnControllerMessenger>,
   MessengerEvents<EarnControllerMessenger>
 >;
 
@@ -33,13 +28,3 @@ describe('getEarnControllerMessenger', () => {
     expect(earnControllerMessenger).toBeInstanceOf(Messenger);
   });
 });
-
-describe('getEarnControllerInitMessenger', () => {
-  it('returns a messenger', () => {
-    const rootMessenger: RootMessenger = getRootMessenger();
-    const earnControllerInitMessenger =
-      getEarnControllerInitMessenger(rootMessenger);
-
-    expect(earnControllerInitMessenger).toBeInstanceOf(Messenger);
-  });
-});

app/core/Engine/messengers/earn-controller-messenger.ts

@@ -4,7 +4,6 @@ import {
   MessengerEvents,
 } from '@metamask/messenger';
 import { EarnControllerMessenger } from '@metamask/earn-controller';
-import { NetworkControllerGetStateAction } from '@metamask/network-controller';
 import { RootMessenger } from '../types';
 
 /**
@@ -28,10 +27,12 @@ export function getEarnControllerMessenger(
   });
   rootMessenger.delegate({
     actions: [
+      'NetworkController:getState',
       'NetworkController:getNetworkClientById',
       'AccountTreeController:getAccountsFromSelectedAccountGroup',
     ],
     events: [
+      'AccountTreeController:stateChange',
       'AccountTreeController:selectedAccountGroupChange',
       'TransactionController:transactionConfirmed',
       'NetworkController:networkDidChange',
@@ -40,34 +41,3 @@ export function getEarnControllerMessenger(
   });
   return messenger;
 }
-
-type AllowedInitializationActions = NetworkControllerGetStateAction;
-
-export type EarnControllerInitMessenger = ReturnType<
-  typeof getEarnControllerInitMessenger
->;
-
-/**
- * Get a messenger restricted to the actions and events that the
- * earn controller initialization is allowed to handle.
- *
- * @param messenger - The controller messenger to restrict.
- * @returns The restricted controller messenger.
- */
-export function getEarnControllerInitMessenger(rootMessenger: RootMessenger) {
-  const messenger = new Messenger<
-    'EarnControllerInitialization',
-    AllowedInitializationActions,
-    never,
-    RootMessenger
-  >({
-    namespace: 'EarnControllerInitialization',
-    parent: rootMessenger,
-  });
-  rootMessenger.delegate({
-    actions: ['NetworkController:getState'],
-    events: [],
-    messenger,
-  });
-  return messenger;
-}

app/core/Engine/messengers/index.ts

@@ -111,10 +111,7 @@ import {
   getUserStorageControllerInitMessenger,
 } from './identity/user-storage-controller-messenger';
 import { getAuthenticationControllerMessenger } from './identity/authentication-controller-messenger';
-import {
-  getEarnControllerInitMessenger,
-  getEarnControllerMessenger,
-} from './earn-controller-messenger';
+import { getEarnControllerMessenger } from './earn-controller-messenger';
 import { getGeolocationApiServiceMessenger } from './geolocation-api-service-messenger';
 import { getGeolocationControllerMessenger } from './geolocation-controller-messenger';
 import { getRewardsDataServiceMessenger } from './rewards-data-service-messenger';
@@ -194,7 +191,7 @@ export const CONTROLLER_MESSENGERS = {
   },
   EarnController: {
     getMessenger: getEarnControllerMessenger,
-    getInitMessenger: getEarnControllerInitMessenger,
+    getInitMessenger: noop,
   },
   GeolocationApiService: {
     getMessenger: getGeolocationApiServiceMessenger,

app/util/logs/__snapshots__/index.test.ts.snap

@@ -145,6 +145,7 @@ exports[`logs :: generateStateLogs Sanitized SeedlessOnboardingController State
         "pooled_staking": {
           "isEligible": false,
         },
+        "tron_staking": null,
       },
       "GasFeeController": {
         "estimatedGasFeeTimeBounds": {},
@@ -967,6 +968,7 @@ exports[`logs :: generateStateLogs generates a valid json export 1`] = `
         "pooled_staking": {
           "isEligible": false,
         },
+        "tron_staking": null,
       },
       "GasFeeController": {
         "estimatedGasFeeTimeBounds": {},

app/util/test/initial-background-state.json

@@ -695,7 +695,8 @@
         }
       ],
       "isEligible": false
-    }
+    },
+    "tron_staking": null
   },
   "DeFiPositionsController": {
     "allDeFiPositions": {},

package.json

@@ -239,7 +239,7 @@
     "@metamask/design-system-react-native": "^0.12.0",
     "@metamask/design-system-twrnc-preset": "^0.3.0",
     "@metamask/design-tokens": "^8.2.2",
-    "@metamask/earn-controller": "^10.0.0",
+    "@metamask/earn-controller": "^12.0.0",
     "@metamask/eip-5792-middleware": "^2.0.0",
     "@metamask/eip1193-permission-middleware": "^1.0.2",
     "@metamask/ens-resolver-snap": "^1.1.0",