@metamask-previews/assets-controllers 109.4.1-preview-30b493585 → 109.4.1-preview-8abc30aca

package/CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add `DeFiPositionsControllerV2`, which fetches DeFi positions from the Accounts API v6 multiaccount balances endpoint and stores them in a client-ready shape under `allDeFiPositionsV2` ([#9503](https://github.com/MetaMask/core/pull/9503))
+  - Export `DeFiPositionsControllerV2` and supporting types
 - Add `isDeprecated` option to `TokenDetectionController` constructor ([#9362](https://github.com/MetaMask/core/pull/9362))
   - When `isDeprecated()` returns `true`, no network requests are sent and entry points bail early at `start`, `detectTokens`, `_executePoll`, `addDetectedTokensViaWs`, and `addDetectedTokensViaPolling`, so no token detection work runs while the controller is disabled.
   - The function is re-evaluated on each entry point so it can be toggled at runtime without reconstructing the controller.

package/dist/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DeFiPositionsControllerV2-method-action-types.cjs.map

package/dist/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeFiPositionsControllerV2-method-action-types.cjs","sourceRoot":"","sources":["../../src/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { DeFiPositionsControllerV2 } from './DeFiPositionsControllerV2';\n\n/**\n * Fetches DeFi positions for the selected account group. Each account key in\n * a ready response replaces that account's state (other accounts stay).\n * Accounts still indexing (`processingDefiPositions`) are skipped so prior\n * state is kept for them. No-ops when disabled or when the group has no\n * supported accounts. Caching / spam prevention is handled by the apiClient\n * TanStack Query cache (keyed by accounts + query options including\n * `vsCurrency`). Pass `{ forceRefresh: true }` to bypass the cache (e.g.\n * pull-to-refresh).\n *\n * @param options - Optional fetch modifiers.\n * @param options.forceRefresh - When true, bypass the apiClient cache and\n * fetch immediately.\n */\nexport type DeFiPositionsControllerV2FetchDeFiPositionsAction = {\n  type: `DeFiPositionsControllerV2:fetchDeFiPositions`;\n  handler: DeFiPositionsControllerV2['fetchDeFiPositions'];\n};\n\n/**\n * Union of all DeFiPositionsControllerV2 action types.\n */\nexport type DeFiPositionsControllerV2MethodActions =\n  DeFiPositionsControllerV2FetchDeFiPositionsAction;\n"]}

package/dist/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.d.cts

@@ -0,0 +1,28 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { DeFiPositionsControllerV2 } from "./DeFiPositionsControllerV2.cjs";
+/**
+ * Fetches DeFi positions for the selected account group. Each account key in
+ * a ready response replaces that account's state (other accounts stay).
+ * Accounts still indexing (`processingDefiPositions`) are skipped so prior
+ * state is kept for them. No-ops when disabled or when the group has no
+ * supported accounts. Caching / spam prevention is handled by the apiClient
+ * TanStack Query cache (keyed by accounts + query options including
+ * `vsCurrency`). Pass `{ forceRefresh: true }` to bypass the cache (e.g.
+ * pull-to-refresh).
+ *
+ * @param options - Optional fetch modifiers.
+ * @param options.forceRefresh - When true, bypass the apiClient cache and
+ * fetch immediately.
+ */
+export type DeFiPositionsControllerV2FetchDeFiPositionsAction = {
+    type: `DeFiPositionsControllerV2:fetchDeFiPositions`;
+    handler: DeFiPositionsControllerV2['fetchDeFiPositions'];
+};
+/**
+ * Union of all DeFiPositionsControllerV2 action types.
+ */
+export type DeFiPositionsControllerV2MethodActions = DeFiPositionsControllerV2FetchDeFiPositionsAction;
+//# sourceMappingURL=DeFiPositionsControllerV2-method-action-types.d.cts.map

package/dist/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeFiPositionsControllerV2-method-action-types.d.cts","sourceRoot":"","sources":["../../src/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,yBAAyB,EAAE,wCAAoC;AAE7E;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,yBAAyB,CAAC,oBAAoB,CAAC,CAAC;CAC1D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAChD,iDAAiD,CAAC"}

package/dist/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.d.mts

@@ -0,0 +1,28 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { DeFiPositionsControllerV2 } from "./DeFiPositionsControllerV2.mjs";
+/**
+ * Fetches DeFi positions for the selected account group. Each account key in
+ * a ready response replaces that account's state (other accounts stay).
+ * Accounts still indexing (`processingDefiPositions`) are skipped so prior
+ * state is kept for them. No-ops when disabled or when the group has no
+ * supported accounts. Caching / spam prevention is handled by the apiClient
+ * TanStack Query cache (keyed by accounts + query options including
+ * `vsCurrency`). Pass `{ forceRefresh: true }` to bypass the cache (e.g.
+ * pull-to-refresh).
+ *
+ * @param options - Optional fetch modifiers.
+ * @param options.forceRefresh - When true, bypass the apiClient cache and
+ * fetch immediately.
+ */
+export type DeFiPositionsControllerV2FetchDeFiPositionsAction = {
+    type: `DeFiPositionsControllerV2:fetchDeFiPositions`;
+    handler: DeFiPositionsControllerV2['fetchDeFiPositions'];
+};
+/**
+ * Union of all DeFiPositionsControllerV2 action types.
+ */
+export type DeFiPositionsControllerV2MethodActions = DeFiPositionsControllerV2FetchDeFiPositionsAction;
+//# sourceMappingURL=DeFiPositionsControllerV2-method-action-types.d.mts.map

package/dist/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeFiPositionsControllerV2-method-action-types.d.mts","sourceRoot":"","sources":["../../src/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,yBAAyB,EAAE,wCAAoC;AAE7E;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iDAAiD,GAAG;IAC9D,IAAI,EAAE,8CAA8C,CAAC;IACrD,OAAO,EAAE,yBAAyB,CAAC,oBAAoB,CAAC,CAAC;CAC1D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAChD,iDAAiD,CAAC"}

package/dist/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=DeFiPositionsControllerV2-method-action-types.mjs.map

package/dist/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeFiPositionsControllerV2-method-action-types.mjs","sourceRoot":"","sources":["../../src/DeFiPositionsController/DeFiPositionsControllerV2-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { DeFiPositionsControllerV2 } from './DeFiPositionsControllerV2';\n\n/**\n * Fetches DeFi positions for the selected account group. Each account key in\n * a ready response replaces that account's state (other accounts stay).\n * Accounts still indexing (`processingDefiPositions`) are skipped so prior\n * state is kept for them. No-ops when disabled or when the group has no\n * supported accounts. Caching / spam prevention is handled by the apiClient\n * TanStack Query cache (keyed by accounts + query options including\n * `vsCurrency`). Pass `{ forceRefresh: true }` to bypass the cache (e.g.\n * pull-to-refresh).\n *\n * @param options - Optional fetch modifiers.\n * @param options.forceRefresh - When true, bypass the apiClient cache and\n * fetch immediately.\n */\nexport type DeFiPositionsControllerV2FetchDeFiPositionsAction = {\n  type: `DeFiPositionsControllerV2:fetchDeFiPositions`;\n  handler: DeFiPositionsControllerV2['fetchDeFiPositions'];\n};\n\n/**\n * Union of all DeFiPositionsControllerV2 action types.\n */\nexport type DeFiPositionsControllerV2MethodActions =\n  DeFiPositionsControllerV2FetchDeFiPositionsAction;\n"]}

package/dist/DeFiPositionsController/DeFiPositionsControllerV2.cjs

@@ -0,0 +1,128 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _DeFiPositionsControllerV2_apiClient, _DeFiPositionsControllerV2_isEnabled, _DeFiPositionsControllerV2_getVsCurrency;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeFiPositionsControllerV2 = exports.getDefaultDeFiPositionsControllerV2State = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const build_defi_balances_query_1 = require("./build-defi-balances-query.cjs");
+const group_defi_positions_v6_1 = require("./group-defi-positions-v6.cjs");
+const controllerName = 'DeFiPositionsControllerV2';
+const MESSENGER_EXPOSED_METHODS = ['fetchDeFiPositions'];
+const controllerMetadata = {
+    allDeFiPositionsV2: {
+        includeInStateLogs: false,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
+};
+const getDefaultDeFiPositionsControllerV2State = () => {
+    return {
+        allDeFiPositionsV2: {},
+    };
+};
+exports.getDefaultDeFiPositionsControllerV2State = getDefaultDeFiPositionsControllerV2State;
+/**
+ * Controller that fetches DeFi positions for the selected account group from
+ * the Accounts API (v6 multiaccount balances) and stores them in the shape the
+ * client consumes directly.
+ *
+ * Deduplication and freshness are handled by the shared TanStack Query cache on
+ * {@link ApiPlatformClient} (balances default `staleTime` is 1 minute). Pass
+ * `{ forceRefresh: true }` to bypass that cache for pull-to-refresh.
+ */
+class DeFiPositionsControllerV2 extends base_controller_1.BaseController {
+    /**
+     * @param options - Constructor options.
+     * @param options.messenger - The controller messenger.
+     * @param options.apiClient - Accounts API client used to fetch balances/positions. Auth is handled by the client.
+     * @param options.isEnabled - Returns whether fetching is enabled (default: () => false).
+     * @param options.getVsCurrency - Returns the fiat currency for prices (default: () => 'usd').
+     * @param options.state - Initial controller state.
+     */
+    constructor({ messenger, apiClient, isEnabled, getVsCurrency, state, }) {
+        super({
+            name: controllerName,
+            metadata: controllerMetadata,
+            messenger,
+            state: {
+                ...(0, exports.getDefaultDeFiPositionsControllerV2State)(),
+                ...state,
+            },
+        });
+        _DeFiPositionsControllerV2_apiClient.set(this, void 0);
+        _DeFiPositionsControllerV2_isEnabled.set(this, void 0);
+        _DeFiPositionsControllerV2_getVsCurrency.set(this, void 0);
+        __classPrivateFieldSet(this, _DeFiPositionsControllerV2_apiClient, apiClient, "f");
+        __classPrivateFieldSet(this, _DeFiPositionsControllerV2_isEnabled, isEnabled, "f");
+        __classPrivateFieldSet(this, _DeFiPositionsControllerV2_getVsCurrency, getVsCurrency, "f");
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Fetches DeFi positions for the selected account group. Each account key in
+     * a ready response replaces that account's state (other accounts stay).
+     * Accounts still indexing (`processingDefiPositions`) are skipped so prior
+     * state is kept for them. No-ops when disabled or when the group has no
+     * supported accounts. Caching / spam prevention is handled by the apiClient
+     * TanStack Query cache (keyed by accounts + query options including
+     * `vsCurrency`). Pass `{ forceRefresh: true }` to bypass the cache (e.g.
+     * pull-to-refresh).
+     *
+     * @param options - Optional fetch modifiers.
+     * @param options.forceRefresh - When true, bypass the apiClient cache and
+     * fetch immediately.
+     */
+    async fetchDeFiPositions(options) {
+        if (!__classPrivateFieldGet(this, _DeFiPositionsControllerV2_isEnabled, "f").call(this)) {
+            return;
+        }
+        const selectedAccounts = this.messenger.call('AccountTreeController:getAccountsFromSelectedAccountGroup');
+        const { networks, internalAccountIdByCaip } = (0, build_defi_balances_query_1.buildDeFiBalancesQuery)(selectedAccounts);
+        if (internalAccountIdByCaip.size === 0 || networks.length === 0) {
+            return;
+        }
+        const accountIds = [...internalAccountIdByCaip.keys()];
+        const vsCurrency = __classPrivateFieldGet(this, _DeFiPositionsControllerV2_getVsCurrency, "f").call(this).toLowerCase();
+        try {
+            const response = await __classPrivateFieldGet(this, _DeFiPositionsControllerV2_apiClient, "f").accounts.fetchV6MultiAccountBalances(accountIds, {
+                networks,
+                includeDeFiBalances: true,
+                forceFetchDeFiPositions: true,
+                includePrices: true,
+                vsCurrency,
+            }, {
+                // staleTime: 0 makes TanStack treat the cache as stale for this call.
+                ...(options?.forceRefresh ? { staleTime: 0 } : {}),
+            });
+            // Skip accounts still indexing — their balances are not a valid snapshot.
+            const readyAccounts = response.accounts.filter((account) => !account.processingDefiPositions);
+            if (readyAccounts.length === 0) {
+                return;
+            }
+            const positionsByAccount = (0, group_defi_positions_v6_1.groupDeFiPositionsV6)({ ...response, accounts: readyAccounts }, internalAccountIdByCaip);
+            // Last valid response wins per ready account; processing / other accounts
+            // stay untouched.
+            this.update((state) => {
+                for (const [accountId, positions] of Object.entries(positionsByAccount)) {
+                    state.allDeFiPositionsV2[accountId] = positions;
+                }
+            });
+        }
+        catch (error) {
+            console.error('Failed to fetch DeFi positions', error);
+        }
+    }
+}
+exports.DeFiPositionsControllerV2 = DeFiPositionsControllerV2;
+_DeFiPositionsControllerV2_apiClient = new WeakMap(), _DeFiPositionsControllerV2_isEnabled = new WeakMap(), _DeFiPositionsControllerV2_getVsCurrency = new WeakMap();
+//# sourceMappingURL=DeFiPositionsControllerV2.cjs.map

package/dist/DeFiPositionsController/DeFiPositionsControllerV2.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeFiPositionsControllerV2.cjs","sourceRoot":"","sources":["../../src/DeFiPositionsController/DeFiPositionsControllerV2.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,+DAA2D;AAS3D,+EAAqE;AAGrE,2EAAiE;AAEjE,MAAM,cAAc,GAAG,2BAA2B,CAAC;AAEnD,MAAM,yBAAyB,GAAG,CAAC,oBAAoB,CAAU,CAAC;AAmBlE,MAAM,kBAAkB,GAAkD;IACxE,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEK,MAAM,wCAAwC,GACnD,GAAmC,EAAE;IACnC,OAAO;QACL,kBAAkB,EAAE,EAAE;KACvB,CAAC;AACJ,CAAC,CAAC;AALS,QAAA,wCAAwC,4CAKjD;AA0CJ;;;;;;;;GAQG;AACH,MAAa,yBAA0B,SAAQ,gCAI9C;IAOC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,SAAS,EACT,SAAS,EACT,aAAa,EACb,KAAK,GAON;QACC,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,kBAAkB;YAC5B,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,IAAA,gDAAwC,GAAE;gBAC7C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAnCI,uDAA8B;QAE9B,uDAA0B;QAE1B,2DAA6B;QAiCpC,uBAAA,IAAI,wCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,wCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,4CAAkB,aAAa,MAAA,CAAC;QAEpC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,kBAAkB,CAAC,OAExB;QACC,IAAI,CAAC,uBAAA,IAAI,4CAAW,MAAf,IAAI,CAAa,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAC1C,2DAA2D,CAC5D,CAAC;QAEF,MAAM,EAAE,QAAQ,EAAE,uBAAuB,EAAE,GACzC,IAAA,kDAAsB,EAAC,gBAAgB,CAAC,CAAC;QAE3C,IAAI,uBAAuB,CAAC,IAAI,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChE,OAAO;QACT,CAAC;QAED,MAAM,UAAU,GAAG,CAAC,GAAG,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC;QACvD,MAAM,UAAU,GAAG,uBAAA,IAAI,gDAAe,MAAnB,IAAI,CAAiB,CAAC,WAAW,EAAE,CAAC;QAEvD,IAAI,CAAC;YACH,MAAM,QAAQ,GACZ,MAAM,uBAAA,IAAI,4CAAW,CAAC,QAAQ,CAAC,2BAA2B,CACxD,UAAU,EACV;gBACE,QAAQ;gBACR,mBAAmB,EAAE,IAAI;gBACzB,uBAAuB,EAAE,IAAI;gBAC7B,aAAa,EAAE,IAAI;gBACnB,UAAU;aACX,EACD;gBACE,sEAAsE;gBACtE,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACnD,CACF,CAAC;YAEJ,0EAA0E;YAC1E,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAC5C,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,uBAAuB,CAC9C,CAAC;YACF,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,OAAO;YACT,CAAC;YAED,MAAM,kBAAkB,GAAG,IAAA,8CAAoB,EAC7C,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,EACxC,uBAAuB,CACxB,CAAC;YAEF,0EAA0E;YAC1E,kBAAkB;YAClB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CACjD,kBAAkB,CACnB,EAAE,CAAC;oBACF,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;gBAClD,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,KAAK,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;CACF;AAlID,8DAkIC","sourcesContent":["import type { AccountTreeControllerGetAccountsFromSelectedAccountGroupAction } from '@metamask/account-tree-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangedEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport type { ApiPlatformClient } from '@metamask/core-backend';\nimport type { Messenger } from '@metamask/messenger';\n\nimport { buildDeFiBalancesQuery } from './build-defi-balances-query';\nimport type { DeFiPositionsControllerV2MethodActions } from './DeFiPositionsControllerV2-method-action-types';\nimport type { DeFiPositionsByAccount } from './group-defi-positions-v6';\nimport { groupDeFiPositionsV6 } from './group-defi-positions-v6';\n\nconst controllerName = 'DeFiPositionsControllerV2';\n\nconst MESSENGER_EXPOSED_METHODS = ['fetchDeFiPositions'] as const;\n\nexport type DeFiPositionsControllerV2State = {\n  /**\n   * DeFi positions keyed by internal MetaMask account ID (`InternalAccount.id`,\n   * the same key AssetsController uses). Each account maps to a flat list of\n   * protocol groups shown in the DeFi tab, each carrying its own `chainId` for\n   * filtering plus the details-page sections embedded inside it. This is\n   * exactly the shape the client consumes, so no further transformation is\n   * needed on read.\n   *\n   * Named `allDeFiPositionsV2` (rather than `allDeFiPositions`) so it can live\n   * alongside the legacy `DeFiPositionsController` in clients that flatten every\n   * controller's state into a single object (e.g. the extension background),\n   * without colliding on the shared `allDeFiPositions` key.\n   */\n  allDeFiPositionsV2: DeFiPositionsByAccount;\n};\n\nconst controllerMetadata: StateMetadata<DeFiPositionsControllerV2State> = {\n  allDeFiPositionsV2: {\n    includeInStateLogs: false,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n};\n\nexport const getDefaultDeFiPositionsControllerV2State =\n  (): DeFiPositionsControllerV2State => {\n    return {\n      allDeFiPositionsV2: {},\n    };\n  };\n\nexport type DeFiPositionsControllerV2GetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  DeFiPositionsControllerV2State\n>;\n\nexport type DeFiPositionsControllerV2Actions =\n  | DeFiPositionsControllerV2GetStateAction\n  | DeFiPositionsControllerV2MethodActions;\n\nexport type DeFiPositionsControllerV2StateChangedEvent =\n  ControllerStateChangedEvent<\n    typeof controllerName,\n    DeFiPositionsControllerV2State\n  >;\n\nexport type DeFiPositionsControllerV2Events =\n  DeFiPositionsControllerV2StateChangedEvent;\n\n/**\n * The external actions available to the {@link DeFiPositionsControllerV2}.\n */\nexport type AllowedActions =\n  AccountTreeControllerGetAccountsFromSelectedAccountGroupAction;\n\n/**\n * The external events available to the {@link DeFiPositionsControllerV2}.\n *\n * None yet — clients must call `fetchDeFiPositions` (and optionally\n * `{ forceRefresh: true }`) on their own triggers. Likely future subscriptions:\n * `AccountTreeController:selectedAccountGroupChange`,\n * `TransactionController:transactionConfirmed`, and `KeyringController:lock`.\n */\nexport type AllowedEvents = never;\n\nexport type DeFiPositionsControllerV2Messenger = Messenger<\n  typeof controllerName,\n  DeFiPositionsControllerV2Actions | AllowedActions,\n  DeFiPositionsControllerV2Events | AllowedEvents\n>;\n\n/**\n * Controller that fetches DeFi positions for the selected account group from\n * the Accounts API (v6 multiaccount balances) and stores them in the shape the\n * client consumes directly.\n *\n * Deduplication and freshness are handled by the shared TanStack Query cache on\n * {@link ApiPlatformClient} (balances default `staleTime` is 1 minute). Pass\n * `{ forceRefresh: true }` to bypass that cache for pull-to-refresh.\n */\nexport class DeFiPositionsControllerV2 extends BaseController<\n  typeof controllerName,\n  DeFiPositionsControllerV2State,\n  DeFiPositionsControllerV2Messenger\n> {\n  readonly #apiClient: ApiPlatformClient;\n\n  readonly #isEnabled: () => boolean;\n\n  readonly #getVsCurrency: () => string;\n\n  /**\n   * @param options - Constructor options.\n   * @param options.messenger - The controller messenger.\n   * @param options.apiClient - Accounts API client used to fetch balances/positions. Auth is handled by the client.\n   * @param options.isEnabled - Returns whether fetching is enabled (default: () => false).\n   * @param options.getVsCurrency - Returns the fiat currency for prices (default: () => 'usd').\n   * @param options.state - Initial controller state.\n   */\n  constructor({\n    messenger,\n    apiClient,\n    isEnabled,\n    getVsCurrency,\n    state,\n  }: {\n    messenger: DeFiPositionsControllerV2Messenger;\n    apiClient: ApiPlatformClient;\n    isEnabled: () => boolean;\n    getVsCurrency: () => string;\n    state?: Partial<DeFiPositionsControllerV2State>;\n  }) {\n    super({\n      name: controllerName,\n      metadata: controllerMetadata,\n      messenger,\n      state: {\n        ...getDefaultDeFiPositionsControllerV2State(),\n        ...state,\n      },\n    });\n\n    this.#apiClient = apiClient;\n    this.#isEnabled = isEnabled;\n    this.#getVsCurrency = getVsCurrency;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Fetches DeFi positions for the selected account group. Each account key in\n   * a ready response replaces that account's state (other accounts stay).\n   * Accounts still indexing (`processingDefiPositions`) are skipped so prior\n   * state is kept for them. No-ops when disabled or when the group has no\n   * supported accounts. Caching / spam prevention is handled by the apiClient\n   * TanStack Query cache (keyed by accounts + query options including\n   * `vsCurrency`). Pass `{ forceRefresh: true }` to bypass the cache (e.g.\n   * pull-to-refresh).\n   *\n   * @param options - Optional fetch modifiers.\n   * @param options.forceRefresh - When true, bypass the apiClient cache and\n   * fetch immediately.\n   */\n  async fetchDeFiPositions(options?: {\n    forceRefresh?: boolean;\n  }): Promise<void> {\n    if (!this.#isEnabled()) {\n      return;\n    }\n\n    const selectedAccounts = this.messenger.call(\n      'AccountTreeController:getAccountsFromSelectedAccountGroup',\n    );\n\n    const { networks, internalAccountIdByCaip } =\n      buildDeFiBalancesQuery(selectedAccounts);\n\n    if (internalAccountIdByCaip.size === 0 || networks.length === 0) {\n      return;\n    }\n\n    const accountIds = [...internalAccountIdByCaip.keys()];\n    const vsCurrency = this.#getVsCurrency().toLowerCase();\n\n    try {\n      const response =\n        await this.#apiClient.accounts.fetchV6MultiAccountBalances(\n          accountIds,\n          {\n            networks,\n            includeDeFiBalances: true,\n            forceFetchDeFiPositions: true,\n            includePrices: true,\n            vsCurrency,\n          },\n          {\n            // staleTime: 0 makes TanStack treat the cache as stale for this call.\n            ...(options?.forceRefresh ? { staleTime: 0 } : {}),\n          },\n        );\n\n      // Skip accounts still indexing — their balances are not a valid snapshot.\n      const readyAccounts = response.accounts.filter(\n        (account) => !account.processingDefiPositions,\n      );\n      if (readyAccounts.length === 0) {\n        return;\n      }\n\n      const positionsByAccount = groupDeFiPositionsV6(\n        { ...response, accounts: readyAccounts },\n        internalAccountIdByCaip,\n      );\n\n      // Last valid response wins per ready account; processing / other accounts\n      // stay untouched.\n      this.update((state) => {\n        for (const [accountId, positions] of Object.entries(\n          positionsByAccount,\n        )) {\n          state.allDeFiPositionsV2[accountId] = positions;\n        }\n      });\n    } catch (error) {\n      console.error('Failed to fetch DeFi positions', error);\n    }\n  }\n}\n"]}

package/dist/DeFiPositionsController/DeFiPositionsControllerV2.d.cts

@@ -0,0 +1,89 @@
+import type { AccountTreeControllerGetAccountsFromSelectedAccountGroupAction } from "@metamask/account-tree-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { ControllerGetStateAction, ControllerStateChangedEvent } from "@metamask/base-controller";
+import type { ApiPlatformClient } from "@metamask/core-backend";
+import type { Messenger } from "@metamask/messenger";
+import type { DeFiPositionsControllerV2MethodActions } from "./DeFiPositionsControllerV2-method-action-types.cjs";
+import type { DeFiPositionsByAccount } from "./group-defi-positions-v6.cjs";
+declare const controllerName = "DeFiPositionsControllerV2";
+export type DeFiPositionsControllerV2State = {
+    /**
+     * DeFi positions keyed by internal MetaMask account ID (`InternalAccount.id`,
+     * the same key AssetsController uses). Each account maps to a flat list of
+     * protocol groups shown in the DeFi tab, each carrying its own `chainId` for
+     * filtering plus the details-page sections embedded inside it. This is
+     * exactly the shape the client consumes, so no further transformation is
+     * needed on read.
+     *
+     * Named `allDeFiPositionsV2` (rather than `allDeFiPositions`) so it can live
+     * alongside the legacy `DeFiPositionsController` in clients that flatten every
+     * controller's state into a single object (e.g. the extension background),
+     * without colliding on the shared `allDeFiPositions` key.
+     */
+    allDeFiPositionsV2: DeFiPositionsByAccount;
+};
+export declare const getDefaultDeFiPositionsControllerV2State: () => DeFiPositionsControllerV2State;
+export type DeFiPositionsControllerV2GetStateAction = ControllerGetStateAction<typeof controllerName, DeFiPositionsControllerV2State>;
+export type DeFiPositionsControllerV2Actions = DeFiPositionsControllerV2GetStateAction | DeFiPositionsControllerV2MethodActions;
+export type DeFiPositionsControllerV2StateChangedEvent = ControllerStateChangedEvent<typeof controllerName, DeFiPositionsControllerV2State>;
+export type DeFiPositionsControllerV2Events = DeFiPositionsControllerV2StateChangedEvent;
+/**
+ * The external actions available to the {@link DeFiPositionsControllerV2}.
+ */
+export type AllowedActions = AccountTreeControllerGetAccountsFromSelectedAccountGroupAction;
+/**
+ * The external events available to the {@link DeFiPositionsControllerV2}.
+ *
+ * None yet — clients must call `fetchDeFiPositions` (and optionally
+ * `{ forceRefresh: true }`) on their own triggers. Likely future subscriptions:
+ * `AccountTreeController:selectedAccountGroupChange`,
+ * `TransactionController:transactionConfirmed`, and `KeyringController:lock`.
+ */
+export type AllowedEvents = never;
+export type DeFiPositionsControllerV2Messenger = Messenger<typeof controllerName, DeFiPositionsControllerV2Actions | AllowedActions, DeFiPositionsControllerV2Events | AllowedEvents>;
+/**
+ * Controller that fetches DeFi positions for the selected account group from
+ * the Accounts API (v6 multiaccount balances) and stores them in the shape the
+ * client consumes directly.
+ *
+ * Deduplication and freshness are handled by the shared TanStack Query cache on
+ * {@link ApiPlatformClient} (balances default `staleTime` is 1 minute). Pass
+ * `{ forceRefresh: true }` to bypass that cache for pull-to-refresh.
+ */
+export declare class DeFiPositionsControllerV2 extends BaseController<typeof controllerName, DeFiPositionsControllerV2State, DeFiPositionsControllerV2Messenger> {
+    #private;
+    /**
+     * @param options - Constructor options.
+     * @param options.messenger - The controller messenger.
+     * @param options.apiClient - Accounts API client used to fetch balances/positions. Auth is handled by the client.
+     * @param options.isEnabled - Returns whether fetching is enabled (default: () => false).
+     * @param options.getVsCurrency - Returns the fiat currency for prices (default: () => 'usd').
+     * @param options.state - Initial controller state.
+     */
+    constructor({ messenger, apiClient, isEnabled, getVsCurrency, state, }: {
+        messenger: DeFiPositionsControllerV2Messenger;
+        apiClient: ApiPlatformClient;
+        isEnabled: () => boolean;
+        getVsCurrency: () => string;
+        state?: Partial<DeFiPositionsControllerV2State>;
+    });
+    /**
+     * Fetches DeFi positions for the selected account group. Each account key in
+     * a ready response replaces that account's state (other accounts stay).
+     * Accounts still indexing (`processingDefiPositions`) are skipped so prior
+     * state is kept for them. No-ops when disabled or when the group has no
+     * supported accounts. Caching / spam prevention is handled by the apiClient
+     * TanStack Query cache (keyed by accounts + query options including
+     * `vsCurrency`). Pass `{ forceRefresh: true }` to bypass the cache (e.g.
+     * pull-to-refresh).
+     *
+     * @param options - Optional fetch modifiers.
+     * @param options.forceRefresh - When true, bypass the apiClient cache and
+     * fetch immediately.
+     */
+    fetchDeFiPositions(options?: {
+        forceRefresh?: boolean;
+    }): Promise<void>;
+}
+export {};
+//# sourceMappingURL=DeFiPositionsControllerV2.d.cts.map

package/dist/DeFiPositionsController/DeFiPositionsControllerV2.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeFiPositionsControllerV2.d.cts","sourceRoot":"","sources":["../../src/DeFiPositionsController/DeFiPositionsControllerV2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,8DAA8D,EAAE,0CAA0C;AACxH,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAE5B,kCAAkC;AACnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,+BAA+B;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EAAE,sCAAsC,EAAE,4DAAwD;AAC9G,OAAO,KAAK,EAAE,sBAAsB,EAAE,sCAAkC;AAGxE,QAAA,MAAM,cAAc,8BAA8B,CAAC;AAInD,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;;;;;;;;;;OAYG;IACH,kBAAkB,EAAE,sBAAsB,CAAC;CAC5C,CAAC;AAWF,eAAO,MAAM,wCAAwC,QAC/C,8BAIH,CAAC;AAEJ,MAAM,MAAM,uCAAuC,GAAG,wBAAwB,CAC5E,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEF,MAAM,MAAM,gCAAgC,GACxC,uCAAuC,GACvC,sCAAsC,CAAC;AAE3C,MAAM,MAAM,0CAA0C,GACpD,2BAA2B,CACzB,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEJ,MAAM,MAAM,+BAA+B,GACzC,0CAA0C,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,cAAc,GACxB,8DAA8D,CAAC;AAEjE;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC;AAElC,MAAM,MAAM,kCAAkC,GAAG,SAAS,CACxD,OAAO,cAAc,EACrB,gCAAgC,GAAG,cAAc,EACjD,+BAA+B,GAAG,aAAa,CAChD,CAAC;AAEF;;;;;;;;GAQG;AACH,qBAAa,yBAA0B,SAAQ,cAAc,CAC3D,OAAO,cAAc,EACrB,8BAA8B,EAC9B,kCAAkC,CACnC;;IAOC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,SAAS,EACT,SAAS,EACT,aAAa,EACb,KAAK,GACN,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,SAAS,EAAE,iBAAiB,CAAC;QAC7B,SAAS,EAAE,MAAM,OAAO,CAAC;QACzB,aAAa,EAAE,MAAM,MAAM,CAAC;QAC5B,KAAK,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAqBD;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE;QACjC,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,OAAO,CAAC,IAAI,CAAC;CA8DlB"}

package/dist/DeFiPositionsController/DeFiPositionsControllerV2.d.mts

@@ -0,0 +1,89 @@
+import type { AccountTreeControllerGetAccountsFromSelectedAccountGroupAction } from "@metamask/account-tree-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { ControllerGetStateAction, ControllerStateChangedEvent } from "@metamask/base-controller";
+import type { ApiPlatformClient } from "@metamask/core-backend";
+import type { Messenger } from "@metamask/messenger";
+import type { DeFiPositionsControllerV2MethodActions } from "./DeFiPositionsControllerV2-method-action-types.mjs";
+import type { DeFiPositionsByAccount } from "./group-defi-positions-v6.mjs";
+declare const controllerName = "DeFiPositionsControllerV2";
+export type DeFiPositionsControllerV2State = {
+    /**
+     * DeFi positions keyed by internal MetaMask account ID (`InternalAccount.id`,
+     * the same key AssetsController uses). Each account maps to a flat list of
+     * protocol groups shown in the DeFi tab, each carrying its own `chainId` for
+     * filtering plus the details-page sections embedded inside it. This is
+     * exactly the shape the client consumes, so no further transformation is
+     * needed on read.
+     *
+     * Named `allDeFiPositionsV2` (rather than `allDeFiPositions`) so it can live
+     * alongside the legacy `DeFiPositionsController` in clients that flatten every
+     * controller's state into a single object (e.g. the extension background),
+     * without colliding on the shared `allDeFiPositions` key.
+     */
+    allDeFiPositionsV2: DeFiPositionsByAccount;
+};
+export declare const getDefaultDeFiPositionsControllerV2State: () => DeFiPositionsControllerV2State;
+export type DeFiPositionsControllerV2GetStateAction = ControllerGetStateAction<typeof controllerName, DeFiPositionsControllerV2State>;
+export type DeFiPositionsControllerV2Actions = DeFiPositionsControllerV2GetStateAction | DeFiPositionsControllerV2MethodActions;
+export type DeFiPositionsControllerV2StateChangedEvent = ControllerStateChangedEvent<typeof controllerName, DeFiPositionsControllerV2State>;
+export type DeFiPositionsControllerV2Events = DeFiPositionsControllerV2StateChangedEvent;
+/**
+ * The external actions available to the {@link DeFiPositionsControllerV2}.
+ */
+export type AllowedActions = AccountTreeControllerGetAccountsFromSelectedAccountGroupAction;
+/**
+ * The external events available to the {@link DeFiPositionsControllerV2}.
+ *
+ * None yet — clients must call `fetchDeFiPositions` (and optionally
+ * `{ forceRefresh: true }`) on their own triggers. Likely future subscriptions:
+ * `AccountTreeController:selectedAccountGroupChange`,
+ * `TransactionController:transactionConfirmed`, and `KeyringController:lock`.
+ */
+export type AllowedEvents = never;
+export type DeFiPositionsControllerV2Messenger = Messenger<typeof controllerName, DeFiPositionsControllerV2Actions | AllowedActions, DeFiPositionsControllerV2Events | AllowedEvents>;
+/**
+ * Controller that fetches DeFi positions for the selected account group from
+ * the Accounts API (v6 multiaccount balances) and stores them in the shape the
+ * client consumes directly.
+ *
+ * Deduplication and freshness are handled by the shared TanStack Query cache on
+ * {@link ApiPlatformClient} (balances default `staleTime` is 1 minute). Pass
+ * `{ forceRefresh: true }` to bypass that cache for pull-to-refresh.
+ */
+export declare class DeFiPositionsControllerV2 extends BaseController<typeof controllerName, DeFiPositionsControllerV2State, DeFiPositionsControllerV2Messenger> {
+    #private;
+    /**
+     * @param options - Constructor options.
+     * @param options.messenger - The controller messenger.
+     * @param options.apiClient - Accounts API client used to fetch balances/positions. Auth is handled by the client.
+     * @param options.isEnabled - Returns whether fetching is enabled (default: () => false).
+     * @param options.getVsCurrency - Returns the fiat currency for prices (default: () => 'usd').
+     * @param options.state - Initial controller state.
+     */
+    constructor({ messenger, apiClient, isEnabled, getVsCurrency, state, }: {
+        messenger: DeFiPositionsControllerV2Messenger;
+        apiClient: ApiPlatformClient;
+        isEnabled: () => boolean;
+        getVsCurrency: () => string;
+        state?: Partial<DeFiPositionsControllerV2State>;
+    });
+    /**
+     * Fetches DeFi positions for the selected account group. Each account key in
+     * a ready response replaces that account's state (other accounts stay).
+     * Accounts still indexing (`processingDefiPositions`) are skipped so prior
+     * state is kept for them. No-ops when disabled or when the group has no
+     * supported accounts. Caching / spam prevention is handled by the apiClient
+     * TanStack Query cache (keyed by accounts + query options including
+     * `vsCurrency`). Pass `{ forceRefresh: true }` to bypass the cache (e.g.
+     * pull-to-refresh).
+     *
+     * @param options - Optional fetch modifiers.
+     * @param options.forceRefresh - When true, bypass the apiClient cache and
+     * fetch immediately.
+     */
+    fetchDeFiPositions(options?: {
+        forceRefresh?: boolean;
+    }): Promise<void>;
+}
+export {};
+//# sourceMappingURL=DeFiPositionsControllerV2.d.mts.map

package/dist/DeFiPositionsController/DeFiPositionsControllerV2.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeFiPositionsControllerV2.d.mts","sourceRoot":"","sources":["../../src/DeFiPositionsController/DeFiPositionsControllerV2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,8DAA8D,EAAE,0CAA0C;AACxH,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAE5B,kCAAkC;AACnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,+BAA+B;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EAAE,sCAAsC,EAAE,4DAAwD;AAC9G,OAAO,KAAK,EAAE,sBAAsB,EAAE,sCAAkC;AAGxE,QAAA,MAAM,cAAc,8BAA8B,CAAC;AAInD,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;;;;;;;;;;OAYG;IACH,kBAAkB,EAAE,sBAAsB,CAAC;CAC5C,CAAC;AAWF,eAAO,MAAM,wCAAwC,QAC/C,8BAIH,CAAC;AAEJ,MAAM,MAAM,uCAAuC,GAAG,wBAAwB,CAC5E,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEF,MAAM,MAAM,gCAAgC,GACxC,uCAAuC,GACvC,sCAAsC,CAAC;AAE3C,MAAM,MAAM,0CAA0C,GACpD,2BAA2B,CACzB,OAAO,cAAc,EACrB,8BAA8B,CAC/B,CAAC;AAEJ,MAAM,MAAM,+BAA+B,GACzC,0CAA0C,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,cAAc,GACxB,8DAA8D,CAAC;AAEjE;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC;AAElC,MAAM,MAAM,kCAAkC,GAAG,SAAS,CACxD,OAAO,cAAc,EACrB,gCAAgC,GAAG,cAAc,EACjD,+BAA+B,GAAG,aAAa,CAChD,CAAC;AAEF;;;;;;;;GAQG;AACH,qBAAa,yBAA0B,SAAQ,cAAc,CAC3D,OAAO,cAAc,EACrB,8BAA8B,EAC9B,kCAAkC,CACnC;;IAOC;;;;;;;OAOG;gBACS,EACV,SAAS,EACT,SAAS,EACT,SAAS,EACT,aAAa,EACb,KAAK,GACN,EAAE;QACD,SAAS,EAAE,kCAAkC,CAAC;QAC9C,SAAS,EAAE,iBAAiB,CAAC;QAC7B,SAAS,EAAE,MAAM,OAAO,CAAC;QACzB,aAAa,EAAE,MAAM,MAAM,CAAC;QAC5B,KAAK,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC,CAAC;KACjD;IAqBD;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE;QACjC,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,OAAO,CAAC,IAAI,CAAC;CA8DlB"}

package/dist/DeFiPositionsController/DeFiPositionsControllerV2.mjs

@@ -0,0 +1,123 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _DeFiPositionsControllerV2_apiClient, _DeFiPositionsControllerV2_isEnabled, _DeFiPositionsControllerV2_getVsCurrency;
+import { BaseController } from "@metamask/base-controller";
+import { buildDeFiBalancesQuery } from "./build-defi-balances-query.mjs";
+import { groupDeFiPositionsV6 } from "./group-defi-positions-v6.mjs";
+const controllerName = 'DeFiPositionsControllerV2';
+const MESSENGER_EXPOSED_METHODS = ['fetchDeFiPositions'];
+const controllerMetadata = {
+    allDeFiPositionsV2: {
+        includeInStateLogs: false,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: true,
+    },
+};
+export const getDefaultDeFiPositionsControllerV2State = () => {
+    return {
+        allDeFiPositionsV2: {},
+    };
+};
+/**
+ * Controller that fetches DeFi positions for the selected account group from
+ * the Accounts API (v6 multiaccount balances) and stores them in the shape the
+ * client consumes directly.
+ *
+ * Deduplication and freshness are handled by the shared TanStack Query cache on
+ * {@link ApiPlatformClient} (balances default `staleTime` is 1 minute). Pass
+ * `{ forceRefresh: true }` to bypass that cache for pull-to-refresh.
+ */
+export class DeFiPositionsControllerV2 extends BaseController {
+    /**
+     * @param options - Constructor options.
+     * @param options.messenger - The controller messenger.
+     * @param options.apiClient - Accounts API client used to fetch balances/positions. Auth is handled by the client.
+     * @param options.isEnabled - Returns whether fetching is enabled (default: () => false).
+     * @param options.getVsCurrency - Returns the fiat currency for prices (default: () => 'usd').
+     * @param options.state - Initial controller state.
+     */
+    constructor({ messenger, apiClient, isEnabled, getVsCurrency, state, }) {
+        super({
+            name: controllerName,
+            metadata: controllerMetadata,
+            messenger,
+            state: {
+                ...getDefaultDeFiPositionsControllerV2State(),
+                ...state,
+            },
+        });
+        _DeFiPositionsControllerV2_apiClient.set(this, void 0);
+        _DeFiPositionsControllerV2_isEnabled.set(this, void 0);
+        _DeFiPositionsControllerV2_getVsCurrency.set(this, void 0);
+        __classPrivateFieldSet(this, _DeFiPositionsControllerV2_apiClient, apiClient, "f");
+        __classPrivateFieldSet(this, _DeFiPositionsControllerV2_isEnabled, isEnabled, "f");
+        __classPrivateFieldSet(this, _DeFiPositionsControllerV2_getVsCurrency, getVsCurrency, "f");
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Fetches DeFi positions for the selected account group. Each account key in
+     * a ready response replaces that account's state (other accounts stay).
+     * Accounts still indexing (`processingDefiPositions`) are skipped so prior
+     * state is kept for them. No-ops when disabled or when the group has no
+     * supported accounts. Caching / spam prevention is handled by the apiClient
+     * TanStack Query cache (keyed by accounts + query options including
+     * `vsCurrency`). Pass `{ forceRefresh: true }` to bypass the cache (e.g.
+     * pull-to-refresh).
+     *
+     * @param options - Optional fetch modifiers.
+     * @param options.forceRefresh - When true, bypass the apiClient cache and
+     * fetch immediately.
+     */
+    async fetchDeFiPositions(options) {
+        if (!__classPrivateFieldGet(this, _DeFiPositionsControllerV2_isEnabled, "f").call(this)) {
+            return;
+        }
+        const selectedAccounts = this.messenger.call('AccountTreeController:getAccountsFromSelectedAccountGroup');
+        const { networks, internalAccountIdByCaip } = buildDeFiBalancesQuery(selectedAccounts);
+        if (internalAccountIdByCaip.size === 0 || networks.length === 0) {
+            return;
+        }
+        const accountIds = [...internalAccountIdByCaip.keys()];
+        const vsCurrency = __classPrivateFieldGet(this, _DeFiPositionsControllerV2_getVsCurrency, "f").call(this).toLowerCase();
+        try {
+            const response = await __classPrivateFieldGet(this, _DeFiPositionsControllerV2_apiClient, "f").accounts.fetchV6MultiAccountBalances(accountIds, {
+                networks,
+                includeDeFiBalances: true,
+                forceFetchDeFiPositions: true,
+                includePrices: true,
+                vsCurrency,
+            }, {
+                // staleTime: 0 makes TanStack treat the cache as stale for this call.
+                ...(options?.forceRefresh ? { staleTime: 0 } : {}),
+            });
+            // Skip accounts still indexing — their balances are not a valid snapshot.
+            const readyAccounts = response.accounts.filter((account) => !account.processingDefiPositions);
+            if (readyAccounts.length === 0) {
+                return;
+            }
+            const positionsByAccount = groupDeFiPositionsV6({ ...response, accounts: readyAccounts }, internalAccountIdByCaip);
+            // Last valid response wins per ready account; processing / other accounts
+            // stay untouched.
+            this.update((state) => {
+                for (const [accountId, positions] of Object.entries(positionsByAccount)) {
+                    state.allDeFiPositionsV2[accountId] = positions;
+                }
+            });
+        }
+        catch (error) {
+            console.error('Failed to fetch DeFi positions', error);
+        }
+    }
+}
+_DeFiPositionsControllerV2_apiClient = new WeakMap(), _DeFiPositionsControllerV2_isEnabled = new WeakMap(), _DeFiPositionsControllerV2_getVsCurrency = new WeakMap();
+//# sourceMappingURL=DeFiPositionsControllerV2.mjs.map

package/dist/DeFiPositionsController/DeFiPositionsControllerV2.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeFiPositionsControllerV2.mjs","sourceRoot":"","sources":["../../src/DeFiPositionsController/DeFiPositionsControllerV2.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAS3D,OAAO,EAAE,sBAAsB,EAAE,wCAAoC;AAGrE,OAAO,EAAE,oBAAoB,EAAE,sCAAkC;AAEjE,MAAM,cAAc,GAAG,2BAA2B,CAAC;AAEnD,MAAM,yBAAyB,GAAG,CAAC,oBAAoB,CAAU,CAAC;AAmBlE,MAAM,kBAAkB,GAAkD;IACxE,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,wCAAwC,GACnD,GAAmC,EAAE;IACnC,OAAO;QACL,kBAAkB,EAAE,EAAE;KACvB,CAAC;AACJ,CAAC,CAAC;AA0CJ;;;;;;;;GAQG;AACH,MAAM,OAAO,yBAA0B,SAAQ,cAI9C;IAOC;;;;;;;OAOG;IACH,YAAY,EACV,SAAS,EACT,SAAS,EACT,SAAS,EACT,aAAa,EACb,KAAK,GAON;QACC,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,kBAAkB;YAC5B,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,wCAAwC,EAAE;gBAC7C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QAnCI,uDAA8B;QAE9B,uDAA0B;QAE1B,2DAA6B;QAiCpC,uBAAA,IAAI,wCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,wCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,4CAAkB,aAAa,MAAA,CAAC;QAEpC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,kBAAkB,CAAC,OAExB;QACC,IAAI,CAAC,uBAAA,IAAI,4CAAW,MAAf,IAAI,CAAa,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAC1C,2DAA2D,CAC5D,CAAC;QAEF,MAAM,EAAE,QAAQ,EAAE,uBAAuB,EAAE,GACzC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;QAE3C,IAAI,uBAAuB,CAAC,IAAI,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChE,OAAO;QACT,CAAC;QAED,MAAM,UAAU,GAAG,CAAC,GAAG,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC;QACvD,MAAM,UAAU,GAAG,uBAAA,IAAI,gDAAe,MAAnB,IAAI,CAAiB,CAAC,WAAW,EAAE,CAAC;QAEvD,IAAI,CAAC;YACH,MAAM,QAAQ,GACZ,MAAM,uBAAA,IAAI,4CAAW,CAAC,QAAQ,CAAC,2BAA2B,CACxD,UAAU,EACV;gBACE,QAAQ;gBACR,mBAAmB,EAAE,IAAI;gBACzB,uBAAuB,EAAE,IAAI;gBAC7B,aAAa,EAAE,IAAI;gBACnB,UAAU;aACX,EACD;gBACE,sEAAsE;gBACtE,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACnD,CACF,CAAC;YAEJ,0EAA0E;YAC1E,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAC5C,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,uBAAuB,CAC9C,CAAC;YACF,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC/B,OAAO;YACT,CAAC;YAED,MAAM,kBAAkB,GAAG,oBAAoB,CAC7C,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,EACxC,uBAAuB,CACxB,CAAC;YAEF,0EAA0E;YAC1E,kBAAkB;YAClB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CACjD,kBAAkB,CACnB,EAAE,CAAC;oBACF,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;gBAClD,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,KAAK,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;CACF","sourcesContent":["import type { AccountTreeControllerGetAccountsFromSelectedAccountGroupAction } from '@metamask/account-tree-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangedEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport type { ApiPlatformClient } from '@metamask/core-backend';\nimport type { Messenger } from '@metamask/messenger';\n\nimport { buildDeFiBalancesQuery } from './build-defi-balances-query';\nimport type { DeFiPositionsControllerV2MethodActions } from './DeFiPositionsControllerV2-method-action-types';\nimport type { DeFiPositionsByAccount } from './group-defi-positions-v6';\nimport { groupDeFiPositionsV6 } from './group-defi-positions-v6';\n\nconst controllerName = 'DeFiPositionsControllerV2';\n\nconst MESSENGER_EXPOSED_METHODS = ['fetchDeFiPositions'] as const;\n\nexport type DeFiPositionsControllerV2State = {\n  /**\n   * DeFi positions keyed by internal MetaMask account ID (`InternalAccount.id`,\n   * the same key AssetsController uses). Each account maps to a flat list of\n   * protocol groups shown in the DeFi tab, each carrying its own `chainId` for\n   * filtering plus the details-page sections embedded inside it. This is\n   * exactly the shape the client consumes, so no further transformation is\n   * needed on read.\n   *\n   * Named `allDeFiPositionsV2` (rather than `allDeFiPositions`) so it can live\n   * alongside the legacy `DeFiPositionsController` in clients that flatten every\n   * controller's state into a single object (e.g. the extension background),\n   * without colliding on the shared `allDeFiPositions` key.\n   */\n  allDeFiPositionsV2: DeFiPositionsByAccount;\n};\n\nconst controllerMetadata: StateMetadata<DeFiPositionsControllerV2State> = {\n  allDeFiPositionsV2: {\n    includeInStateLogs: false,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: true,\n  },\n};\n\nexport const getDefaultDeFiPositionsControllerV2State =\n  (): DeFiPositionsControllerV2State => {\n    return {\n      allDeFiPositionsV2: {},\n    };\n  };\n\nexport type DeFiPositionsControllerV2GetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  DeFiPositionsControllerV2State\n>;\n\nexport type DeFiPositionsControllerV2Actions =\n  | DeFiPositionsControllerV2GetStateAction\n  | DeFiPositionsControllerV2MethodActions;\n\nexport type DeFiPositionsControllerV2StateChangedEvent =\n  ControllerStateChangedEvent<\n    typeof controllerName,\n    DeFiPositionsControllerV2State\n  >;\n\nexport type DeFiPositionsControllerV2Events =\n  DeFiPositionsControllerV2StateChangedEvent;\n\n/**\n * The external actions available to the {@link DeFiPositionsControllerV2}.\n */\nexport type AllowedActions =\n  AccountTreeControllerGetAccountsFromSelectedAccountGroupAction;\n\n/**\n * The external events available to the {@link DeFiPositionsControllerV2}.\n *\n * None yet — clients must call `fetchDeFiPositions` (and optionally\n * `{ forceRefresh: true }`) on their own triggers. Likely future subscriptions:\n * `AccountTreeController:selectedAccountGroupChange`,\n * `TransactionController:transactionConfirmed`, and `KeyringController:lock`.\n */\nexport type AllowedEvents = never;\n\nexport type DeFiPositionsControllerV2Messenger = Messenger<\n  typeof controllerName,\n  DeFiPositionsControllerV2Actions | AllowedActions,\n  DeFiPositionsControllerV2Events | AllowedEvents\n>;\n\n/**\n * Controller that fetches DeFi positions for the selected account group from\n * the Accounts API (v6 multiaccount balances) and stores them in the shape the\n * client consumes directly.\n *\n * Deduplication and freshness are handled by the shared TanStack Query cache on\n * {@link ApiPlatformClient} (balances default `staleTime` is 1 minute). Pass\n * `{ forceRefresh: true }` to bypass that cache for pull-to-refresh.\n */\nexport class DeFiPositionsControllerV2 extends BaseController<\n  typeof controllerName,\n  DeFiPositionsControllerV2State,\n  DeFiPositionsControllerV2Messenger\n> {\n  readonly #apiClient: ApiPlatformClient;\n\n  readonly #isEnabled: () => boolean;\n\n  readonly #getVsCurrency: () => string;\n\n  /**\n   * @param options - Constructor options.\n   * @param options.messenger - The controller messenger.\n   * @param options.apiClient - Accounts API client used to fetch balances/positions. Auth is handled by the client.\n   * @param options.isEnabled - Returns whether fetching is enabled (default: () => false).\n   * @param options.getVsCurrency - Returns the fiat currency for prices (default: () => 'usd').\n   * @param options.state - Initial controller state.\n   */\n  constructor({\n    messenger,\n    apiClient,\n    isEnabled,\n    getVsCurrency,\n    state,\n  }: {\n    messenger: DeFiPositionsControllerV2Messenger;\n    apiClient: ApiPlatformClient;\n    isEnabled: () => boolean;\n    getVsCurrency: () => string;\n    state?: Partial<DeFiPositionsControllerV2State>;\n  }) {\n    super({\n      name: controllerName,\n      metadata: controllerMetadata,\n      messenger,\n      state: {\n        ...getDefaultDeFiPositionsControllerV2State(),\n        ...state,\n      },\n    });\n\n    this.#apiClient = apiClient;\n    this.#isEnabled = isEnabled;\n    this.#getVsCurrency = getVsCurrency;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Fetches DeFi positions for the selected account group. Each account key in\n   * a ready response replaces that account's state (other accounts stay).\n   * Accounts still indexing (`processingDefiPositions`) are skipped so prior\n   * state is kept for them. No-ops when disabled or when the group has no\n   * supported accounts. Caching / spam prevention is handled by the apiClient\n   * TanStack Query cache (keyed by accounts + query options including\n   * `vsCurrency`). Pass `{ forceRefresh: true }` to bypass the cache (e.g.\n   * pull-to-refresh).\n   *\n   * @param options - Optional fetch modifiers.\n   * @param options.forceRefresh - When true, bypass the apiClient cache and\n   * fetch immediately.\n   */\n  async fetchDeFiPositions(options?: {\n    forceRefresh?: boolean;\n  }): Promise<void> {\n    if (!this.#isEnabled()) {\n      return;\n    }\n\n    const selectedAccounts = this.messenger.call(\n      'AccountTreeController:getAccountsFromSelectedAccountGroup',\n    );\n\n    const { networks, internalAccountIdByCaip } =\n      buildDeFiBalancesQuery(selectedAccounts);\n\n    if (internalAccountIdByCaip.size === 0 || networks.length === 0) {\n      return;\n    }\n\n    const accountIds = [...internalAccountIdByCaip.keys()];\n    const vsCurrency = this.#getVsCurrency().toLowerCase();\n\n    try {\n      const response =\n        await this.#apiClient.accounts.fetchV6MultiAccountBalances(\n          accountIds,\n          {\n            networks,\n            includeDeFiBalances: true,\n            forceFetchDeFiPositions: true,\n            includePrices: true,\n            vsCurrency,\n          },\n          {\n            // staleTime: 0 makes TanStack treat the cache as stale for this call.\n            ...(options?.forceRefresh ? { staleTime: 0 } : {}),\n          },\n        );\n\n      // Skip accounts still indexing — their balances are not a valid snapshot.\n      const readyAccounts = response.accounts.filter(\n        (account) => !account.processingDefiPositions,\n      );\n      if (readyAccounts.length === 0) {\n        return;\n      }\n\n      const positionsByAccount = groupDeFiPositionsV6(\n        { ...response, accounts: readyAccounts },\n        internalAccountIdByCaip,\n      );\n\n      // Last valid response wins per ready account; processing / other accounts\n      // stay untouched.\n      this.update((state) => {\n        for (const [accountId, positions] of Object.entries(\n          positionsByAccount,\n        )) {\n          state.allDeFiPositionsV2[accountId] = positions;\n        }\n      });\n    } catch (error) {\n      console.error('Failed to fetch DeFi positions', error);\n    }\n  }\n}\n"]}