@metamask-previews/core-backend 5.1.1-preview-27e39dd44 → 5.1.1-preview-d7935cb09

package/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `ApiPlatformClientService` to expose `ApiPlatformClient` via the messenger without a controller ([#7928](https://github.com/MetaMask/core/pull/7928))
+  - Consumers call `messenger.call('ApiPlatformClientService:getApiPlatformClient')` to obtain the shared client for accounts, prices, token, and tokens APIs
+- Export TanStack Query options for all API endpoints via `get*QueryOptions` helpers ([#7928](https://github.com/MetaMask/core/pull/7928))
+  - Each fetch method (e.g. `fetchV5MultiAccountBalances`) has a corresponding `get*QueryOptions` (e.g. `getV5MultiAccountBalancesQueryOptions`) returning the same options object used internally
+  - Enables reuse with `useQuery`, `useInfiniteQuery`, `useSuspenseQuery`, and other TanStack Query APIs
+- Extend `FetchOptions` to allow TanStack Query options (e.g. `select`, `initialPageParam`, `retry`, `initialData`) to be passed through to `get*QueryOptions` and merged into the returned query options
+  - Export `getQueryOptionsOverrides` helper for stripping `queryKey`/`queryFn` from options when merging
+  - All API clients (accounts, prices, token, tokens) merge user overrides first, then apply `staleTime`/`gcTime` defaults so cache timing is consistent and extra options (e.g. `select`) are preserved
+
+### Changed
+
+- **BREAKING:** Merge `fetchV2BalancesWithOptions` into `fetchV2Balances` ([#7928](https://github.com/MetaMask/core/pull/7928))
+  - `fetchV2Balances(address, queryOptions?, options?)` now accepts the full query options: `networks`, `filterSupportedTokens`, `includeTokenAddresses`, `includeStakedAssets`
+  - `getV2BalancesQueryOptions` accepts the same full query options for use with TanStack Query
+  - `fetchV2BalancesWithOptions` and `getV2BalancesWithOptionsQueryOptions` have been removed; use `fetchV2Balances` and `getV2BalancesQueryOptions` with the desired options instead
+- **BREAKING:** Align v4 multi-account transactions with API ([#7928](https://github.com/MetaMask/core/pull/7928))
+  - First parameter renamed from `accountIds` to `accountAddresses` in `fetchV4MultiAccountTransactions` and `getV4MultiAccountTransactionsQueryOptions`
+  - Query options now include: `startTimestamp`, `endTimestamp`, `limit`, `after`, `before`, `maxLogsPerTx`, `lang` in addition to `networks`, `cursor`, `sortDirection`, `includeLogs`, `includeTxMetadata`
+  - `includeValueTransfers` has been removed from the options (not in API spec)
+- Accounts, prices, and tokens clients: `fetch*` and `get*QueryOptions` now short-circuit on empty required inputs (e.g. empty address, empty account IDs or asset lists) and return empty results without calling the API ([#7928](https://github.com/MetaMask/core/pull/7928))
+
 ## [5.1.1]
 
 ### Changed

package/README.md

@@ -449,80 +449,85 @@ const pricesClient = new PricesApiClient({
 
 ### API Clients
 
+Optional parameters: `options` is `FetchOptions` (e.g. `staleTime`, `gcTime`). `queryOptions` are API-specific filters (e.g. `networks`, `cursor`). Each `fetch*` method has a matching `get*QueryOptions` that returns the TanStack Query options object for use with `useQuery`, `useInfiniteQuery`, `useSuspenseQuery`, etc.
+
 #### AccountsApiClient
 
 Handles account-related operations including balances, transactions, NFTs, and token discovery.
 
-| Method                                                  | Description                                |
-| ------------------------------------------------------- | ------------------------------------------ |
-| `fetchV1SupportedNetworks()`                            | Get supported networks (v1)                |
-| `fetchV2SupportedNetworks()`                            | Get supported networks (v2)                |
-| `fetchV2ActiveNetworks(accountIds, options?)`           | Get active networks by CAIP-10 account IDs |
-| `fetchV2Balances(address, options?)`                    | Get balances for single address            |
-| `fetchV2BalancesWithOptions(address, options?)`         | Get balances with filters                  |
-| `fetchV4MultiAccountBalances(addresses, options?)`      | Get balances for multiple addresses        |
-| `fetchV5MultiAccountBalances(accountIds, options?)`     | Get balances using CAIP-10 IDs             |
-| `fetchV1TransactionByHash(chainId, txHash, options?)`   | Get transaction by hash                    |
-| `fetchV1AccountTransactions(address, options?)`         | Get account transactions                   |
-| `fetchV4MultiAccountTransactions(accountIds, options?)` | Get multi-account transactions             |
-| `fetchV1AccountRelationship(chainId, from, to)`         | Get address relationship                   |
-| `fetchV2AccountNfts(address, options?)`                 | Get account NFTs                           |
-| `fetchV2AccountTokens(address, options?)`               | Get detected ERC20 tokens                  |
-| `invalidateBalances()`                                  | Invalidate all balance cache               |
-| `invalidateAccounts()`                                  | Invalidate all account cache               |
+| Method                                                                                 | Description                                                                                                            |
+| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `fetchV1SupportedNetworks(options?)`                                                   | Get supported networks (v1)                                                                                            |
+| `fetchV2SupportedNetworks(options?)`                                                   | Get supported networks (v2)                                                                                            |
+| `fetchV2ActiveNetworks(accountIds, queryOptions?, options?)`                           | Get active networks by CAIP-10 account IDs                                                                             |
+| `fetchV2Balances(address, queryOptions?, options?)`                                    | Get balances for single address (supports networks, filterSupportedTokens, includeTokenAddresses, includeStakedAssets) |
+| `fetchV4MultiAccountBalances(addresses, queryOptions?, options?)`                      | Get balances for multiple addresses                                                                                    |
+| `fetchV5MultiAccountBalances(accountIds, queryOptions?, options?)`                     | Get balances using CAIP-10 IDs                                                                                         |
+| `fetchV1TransactionByHash(chainId, txHash, queryOptions?, options?)`                   | Get transaction by hash                                                                                                |
+| `fetchV1AccountTransactions(address, queryOptions?, options?)`                         | Get account transactions                                                                                               |
+| `fetchV4MultiAccountTransactions(accountAddresses, queryOptions?, options?)`           | Get multi-account transactions                                                                                         |
+| `fetchV1AccountRelationship(chainId, from, to, options?)`                              | Get address relationship                                                                                               |
+| `fetchV2AccountNfts(address, queryOptions?, options?)`                                 | Get account NFTs                                                                                                       |
+| `fetchV2AccountTokens(address, queryOptions?, options?)`                               | Get detected ERC20 tokens                                                                                              |
+| `getV1SupportedNetworksQueryOptions(options?)` … `getV2AccountTokensQueryOptions(...)` | Return TanStack Query options for each fetch (use with useQuery, useInfiniteQuery, etc.)                               |
+| `invalidateBalances()`                                                                 | Invalidate all balance cache                                                                                           |
+| `invalidateAccounts()`                                                                 | Invalidate all account cache                                                                                           |
 
 #### PricesApiClient
 
 Handles price-related operations including spot prices, exchange rates, and historical data.
 
-| Method                                                                  | Description                                      |
-| ----------------------------------------------------------------------- | ------------------------------------------------ |
-| `fetchPriceV1SupportedNetworks()`                                       | Get price-supported networks (v1)                |
-| `fetchPriceV2SupportedNetworks()`                                       | Get price-supported networks in CAIP format (v2) |
-| `fetchV1ExchangeRates(baseCurrency)`                                    | Get exchange rates for base currency             |
-| `fetchV1FiatExchangeRates()`                                            | Get fiat exchange rates                          |
-| `fetchV1CryptoExchangeRates()`                                          | Get crypto exchange rates                        |
-| `fetchV1SpotPricesByCoinIds(coinIds)`                                   | Get spot prices by CoinGecko IDs                 |
-| `fetchV1SpotPriceByCoinId(coinId, currency?)`                           | Get single coin spot price                       |
-| `fetchV1TokenPrices(chainId, addresses, options?)`                      | Get token prices on chain                        |
-| `fetchV1TokenPrice(chainId, address, currency?)`                        | Get single token price                           |
-| `fetchV2SpotPrices(chainId, addresses, options?)`                       | Get spot prices with market data                 |
-| `fetchV3SpotPrices(assetIds, options?)`                                 | Get spot prices by CAIP-19 asset IDs             |
-| `fetchV1HistoricalPricesByCoinId(coinId, options?)`                     | Get historical prices by CoinGecko ID            |
-| `fetchV1HistoricalPricesByTokenAddresses(chainId, addresses, options?)` | Get historical prices for tokens                 |
-| `fetchV1HistoricalPrices(chainId, address, options?)`                   | Get historical prices for single token           |
-| `fetchV3HistoricalPrices(chainId, assetType, options?)`                 | Get historical prices by CAIP-19                 |
-| `fetchV1HistoricalPriceGraphByCoinId(coinId, options?)`                 | Get price graph by CoinGecko ID                  |
-| `fetchV1HistoricalPriceGraphByTokenAddress(chainId, address, options?)` | Get price graph by token address                 |
-| `invalidatePrices()`                                                    | Invalidate all price cache                       |
+| Method                                                                                                           | Description                                      |
+| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
+| `fetchPriceV1SupportedNetworks(options?)`                                                                        | Get price-supported networks (v1)                |
+| `fetchPriceV2SupportedNetworks(options?)`                                                                        | Get price-supported networks in CAIP format (v2) |
+| `fetchV1ExchangeRates(baseCurrency, options?)`                                                                   | Get exchange rates for base currency             |
+| `fetchV1FiatExchangeRates(options?)`                                                                             | Get fiat exchange rates                          |
+| `fetchV1CryptoExchangeRates(options?)`                                                                           | Get crypto exchange rates                        |
+| `fetchV1SpotPricesByCoinIds(coinIds, options?)`                                                                  | Get spot prices by CoinGecko IDs                 |
+| `fetchV1SpotPriceByCoinId(coinId, currency?, options?)`                                                          | Get single coin spot price                       |
+| `fetchV1TokenPrices(chainId, addresses, queryOptions?, options?)`                                                | Get token prices on chain                        |
+| `fetchV1TokenPrice(chainId, address, currency?, options?)`                                                       | Get single token price                           |
+| `fetchV2SpotPrices(chainId, addresses, queryOptions?, options?)`                                                 | Get spot prices with market data                 |
+| `fetchV3SpotPrices(assetIds, queryOptions?, options?)`                                                           | Get spot prices by CAIP-19 asset IDs             |
+| `fetchV1HistoricalPricesByCoinId(coinId, queryOptions?, options?)`                                               | Get historical prices by CoinGecko ID            |
+| `fetchV1HistoricalPricesByTokenAddresses(chainId, addresses, queryOptions?, options?)`                           | Get historical prices for tokens                 |
+| `fetchV1HistoricalPrices(chainId, address, queryOptions?, options?)`                                             | Get historical prices for single token           |
+| `fetchV3HistoricalPrices(chainId, assetType, queryOptions?, options?)`                                           | Get historical prices by CAIP-19                 |
+| `fetchV1HistoricalPriceGraphByCoinId(coinId, queryOptions?, options?)`                                           | Get price graph by CoinGecko ID                  |
+| `fetchV1HistoricalPriceGraphByTokenAddress(chainId, address, queryOptions?, options?)`                           | Get price graph by token address                 |
+| `getPriceV1SupportedNetworksQueryOptions(options?)` … `getV1HistoricalPriceGraphByTokenAddressQueryOptions(...)` | Return TanStack Query options for each fetch     |
+| `invalidatePrices()`                                                                                             | Invalidate all price cache                       |
 
 #### TokenApiClient
 
 Handles token metadata, lists, and trending/popular token discovery.
 
-| Method                                             | Description                     |
-| -------------------------------------------------- | ------------------------------- |
-| `fetchNetworks()`                                  | Get all networks                |
-| `fetchNetworkByChainId(chainId)`                   | Get network by chain ID         |
-| `fetchTokenList(chainId, options?)`                | Get token list for chain        |
-| `fetchV1TokenMetadata(chainId, address, options?)` | Get token metadata              |
-| `fetchTokenDescription(chainId, address)`          | Get token description           |
-| `fetchV3TrendingTokens(chainIds, options?)`        | Get trending tokens             |
-| `fetchV3TopGainers(chainIds, options?)`            | Get top gainers/losers          |
-| `fetchV3PopularTokens(chainIds, options?)`         | Get popular tokens              |
-| `fetchTopAssets(chainId)`                          | Get top assets for chain        |
-| `fetchV1SuggestedOccurrenceFloors()`               | Get suggested occurrence floors |
+| Method                                                                                  | Description                                  |
+| --------------------------------------------------------------------------------------- | -------------------------------------------- |
+| `fetchNetworks(options?)`                                                               | Get all networks                             |
+| `fetchNetworkByChainId(chainId, options?)`                                              | Get network by chain ID                      |
+| `fetchTokenList(chainId, queryOptions?, options?)`                                      | Get token list for chain                     |
+| `fetchV1TokenMetadata(chainId, address, queryOptions?, options?)`                       | Get token metadata                           |
+| `fetchTokenDescription(chainId, address, options?)`                                     | Get token description                        |
+| `fetchV3TrendingTokens(chainIds, queryOptions?, options?)`                              | Get trending tokens                          |
+| `fetchV3TopGainers(chainIds, queryOptions?, options?)`                                  | Get top gainers/losers                       |
+| `fetchV3PopularTokens(chainIds, queryOptions?, options?)`                               | Get popular tokens                           |
+| `fetchTopAssets(chainId, options?)`                                                     | Get top assets for chain                     |
+| `fetchV1SuggestedOccurrenceFloors(options?)`                                            | Get suggested occurrence floors              |
+| `getNetworksQueryOptions(options?)` … `getV1SuggestedOccurrenceFloorsQueryOptions(...)` | Return TanStack Query options for each fetch |
 
 #### TokensApiClient
 
 Handles bulk token operations and supported network queries.
 
-| Method                            | Description                                                 |
-| --------------------------------- | ----------------------------------------------------------- |
-| `fetchTokenV1SupportedNetworks()` | Get token-supported networks (v1)                           |
-| `fetchTokenV2SupportedNetworks()` | Get token-supported networks with full/partial support (v2) |
-| `fetchV3Assets(assetIds)`         | Fetch assets by CAIP-19 IDs                                 |
-| `invalidateTokens()`              | Invalidate all token cache                                  |
+| Method                                                                               | Description                                                 |
+| ------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
+| `fetchTokenV1SupportedNetworks(options?)`                                            | Get token-supported networks (v1)                           |
+| `fetchTokenV2SupportedNetworks(options?)`                                            | Get token-supported networks with full/partial support (v2) |
+| `fetchV3Assets(assetIds, queryOptions?, fetchOptions?)`                              | Fetch assets by CAIP-19 IDs                                 |
+| `getTokenV1SupportedNetworksQueryOptions(options?)` … `getV3AssetsQueryOptions(...)` | Return TanStack Query options for each fetch                |
+| `invalidateTokens()`                                                                 | Invalidate all token cache                                  |
 
 ### Configuration
 

package/dist/ApiPlatformClientService-method-action-types.cjs

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

package/dist/ApiPlatformClientService-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiPlatformClientService-method-action-types.cjs","sourceRoot":"","sources":["../src/ApiPlatformClientService-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { ApiPlatformClientService } from './ApiPlatformClientService';\n\n/**\n * Returns the shared ApiPlatformClient instance.\n *\n * Use this via the messenger: `messenger.call('ApiPlatformClientService:getApiPlatformClient')`.\n *\n * @returns The ApiPlatformClient instance (accounts, prices, token, tokens).\n */\nexport type ApiPlatformClientServiceGetApiPlatformClientAction = {\n  type: `ApiPlatformClientService:getApiPlatformClient`;\n  handler: ApiPlatformClientService['getApiPlatformClient'];\n};\n\n/**\n * Union of all ApiPlatformClientService action types.\n */\nexport type ApiPlatformClientServiceMethodActions =\n  ApiPlatformClientServiceGetApiPlatformClientAction;\n"]}

package/dist/ApiPlatformClientService-method-action-types.d.cts

@@ -0,0 +1,21 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { ApiPlatformClientService } from "./ApiPlatformClientService.cjs";
+/**
+ * Returns the shared ApiPlatformClient instance.
+ *
+ * Use this via the messenger: `messenger.call('ApiPlatformClientService:getApiPlatformClient')`.
+ *
+ * @returns The ApiPlatformClient instance (accounts, prices, token, tokens).
+ */
+export type ApiPlatformClientServiceGetApiPlatformClientAction = {
+    type: `ApiPlatformClientService:getApiPlatformClient`;
+    handler: ApiPlatformClientService['getApiPlatformClient'];
+};
+/**
+ * Union of all ApiPlatformClientService action types.
+ */
+export type ApiPlatformClientServiceMethodActions = ApiPlatformClientServiceGetApiPlatformClientAction;
+//# sourceMappingURL=ApiPlatformClientService-method-action-types.d.cts.map

package/dist/ApiPlatformClientService-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiPlatformClientService-method-action-types.d.cts","sourceRoot":"","sources":["../src/ApiPlatformClientService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,uCAAmC;AAE3E;;;;;;GAMG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,wBAAwB,CAAC,sBAAsB,CAAC,CAAC;CAC3D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,kDAAkD,CAAC"}

package/dist/ApiPlatformClientService-method-action-types.d.mts

@@ -0,0 +1,21 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { ApiPlatformClientService } from "./ApiPlatformClientService.mjs";
+/**
+ * Returns the shared ApiPlatformClient instance.
+ *
+ * Use this via the messenger: `messenger.call('ApiPlatformClientService:getApiPlatformClient')`.
+ *
+ * @returns The ApiPlatformClient instance (accounts, prices, token, tokens).
+ */
+export type ApiPlatformClientServiceGetApiPlatformClientAction = {
+    type: `ApiPlatformClientService:getApiPlatformClient`;
+    handler: ApiPlatformClientService['getApiPlatformClient'];
+};
+/**
+ * Union of all ApiPlatformClientService action types.
+ */
+export type ApiPlatformClientServiceMethodActions = ApiPlatformClientServiceGetApiPlatformClientAction;
+//# sourceMappingURL=ApiPlatformClientService-method-action-types.d.mts.map

package/dist/ApiPlatformClientService-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiPlatformClientService-method-action-types.d.mts","sourceRoot":"","sources":["../src/ApiPlatformClientService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,wBAAwB,EAAE,uCAAmC;AAE3E;;;;;;GAMG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,wBAAwB,CAAC,sBAAsB,CAAC,CAAC;CAC3D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,kDAAkD,CAAC"}

package/dist/ApiPlatformClientService-method-action-types.mjs

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

package/dist/ApiPlatformClientService-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiPlatformClientService-method-action-types.mjs","sourceRoot":"","sources":["../src/ApiPlatformClientService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { ApiPlatformClientService } from './ApiPlatformClientService';\n\n/**\n * Returns the shared ApiPlatformClient instance.\n *\n * Use this via the messenger: `messenger.call('ApiPlatformClientService:getApiPlatformClient')`.\n *\n * @returns The ApiPlatformClient instance (accounts, prices, token, tokens).\n */\nexport type ApiPlatformClientServiceGetApiPlatformClientAction = {\n  type: `ApiPlatformClientService:getApiPlatformClient`;\n  handler: ApiPlatformClientService['getApiPlatformClient'];\n};\n\n/**\n * Union of all ApiPlatformClientService action types.\n */\nexport type ApiPlatformClientServiceMethodActions =\n  ApiPlatformClientServiceGetApiPlatformClientAction;\n"]}

package/dist/ApiPlatformClientService.cjs

@@ -0,0 +1,82 @@
+"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 _ApiPlatformClientService_messenger, _ApiPlatformClientService_client;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiPlatformClientService = exports.apiPlatformClientServiceName = void 0;
+const api_1 = require("./api/index.cjs");
+// === GENERAL ===
+/**
+ * The name of the {@link ApiPlatformClientService}, used to namespace the
+ * service's actions and events.
+ */
+exports.apiPlatformClientServiceName = 'ApiPlatformClientService';
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = ['getApiPlatformClient'];
+// === SERVICE DEFINITION ===
+/**
+ * Service that provides access to {@link ApiPlatformClient} via the messenger.
+ *
+ * Consumers obtain the client by calling the `ApiPlatformClientService:getApiPlatformClient`
+ * action, then use it for accounts, prices, token, and tokens API calls.
+ *
+ * @example
+ *
+ * ```ts
+ * import { Messenger } from '@metamask/messenger';
+ * import {
+ *   ApiPlatformClientService,
+ *   type ApiPlatformClientServiceActions,
+ *   type ApiPlatformClientServiceEvents,
+ * } from '@metamask/core-backend';
+ *
+ * const rootMessenger = new Messenger<'Root', ApiPlatformClientServiceActions, ApiPlatformClientServiceEvents>({ namespace: 'Root' });
+ * const serviceMessenger = new Messenger<
+ *   'ApiPlatformClientService',
+ *   ApiPlatformClientServiceActions,
+ *   ApiPlatformClientServiceEvents,
+ *   typeof rootMessenger
+ * >({ namespace: 'ApiPlatformClientService', parent: rootMessenger });
+ *
+ * new ApiPlatformClientService({
+ *   messenger: serviceMessenger,
+ *   clientProduct: 'metamask-extension',
+ *   getBearerToken: async () => token,
+ * });
+ *
+ * const client = rootMessenger.call('ApiPlatformClientService:getApiPlatformClient');
+ * const balances = await client.accounts.fetchV5MultiAccountBalances(accountIds);
+ * ```
+ */
+class ApiPlatformClientService {
+    constructor({ messenger, ...clientOptions }) {
+        _ApiPlatformClientService_messenger.set(this, void 0);
+        _ApiPlatformClientService_client.set(this, void 0);
+        this.name = exports.apiPlatformClientServiceName;
+        __classPrivateFieldSet(this, _ApiPlatformClientService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _ApiPlatformClientService_client, new api_1.ApiPlatformClient(clientOptions), "f");
+        __classPrivateFieldGet(this, _ApiPlatformClientService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Returns the shared ApiPlatformClient instance.
+     *
+     * Use this via the messenger: `messenger.call('ApiPlatformClientService:getApiPlatformClient')`.
+     *
+     * @returns The ApiPlatformClient instance (accounts, prices, token, tokens).
+     */
+    getApiPlatformClient() {
+        return __classPrivateFieldGet(this, _ApiPlatformClientService_client, "f");
+    }
+}
+exports.ApiPlatformClientService = ApiPlatformClientService;
+_ApiPlatformClientService_messenger = new WeakMap(), _ApiPlatformClientService_client = new WeakMap();
+//# sourceMappingURL=ApiPlatformClientService.cjs.map

package/dist/ApiPlatformClientService.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiPlatformClientService.cjs","sourceRoot":"","sources":["../src/ApiPlatformClientService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,yCAA0C;AAI1C,kBAAkB;AAElB;;;GAGG;AACU,QAAA,4BAA4B,GAAG,0BAA0B,CAAC;AAEvE,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,sBAAsB,CAAU,CAAC;AA2CpE,6BAA6B;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAa,wBAAwB;IAOnC,YAAY,EACV,SAAS,EACT,GAAG,aAAa,EACgB;QAPzB,sDAA8C;QAE9C,mDAA2B;QAMlC,IAAI,CAAC,IAAI,GAAG,oCAA4B,CAAC;QACzC,uBAAA,IAAI,uCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,oCAAW,IAAI,uBAAiB,CAAC,aAAa,CAAC,MAAA,CAAC;QAEpD,uBAAA,IAAI,2CAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,oBAAoB;QAClB,OAAO,uBAAA,IAAI,wCAAQ,CAAC;IACtB,CAAC;CACF;AA/BD,4DA+BC","sourcesContent":["import type { Messenger } from '@metamask/messenger';\n\nimport { ApiPlatformClient } from './api';\nimport type { ApiPlatformClientOptions } from './api';\nimport type { ApiPlatformClientServiceMethodActions } from './ApiPlatformClientService-method-action-types';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link ApiPlatformClientService}, used to namespace the\n * service's actions and events.\n */\nexport const apiPlatformClientServiceName = 'ApiPlatformClientService';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['getApiPlatformClient'] as const;\n\n/**\n * Actions that {@link ApiPlatformClientService} exposes to other consumers.\n */\nexport type ApiPlatformClientServiceActions =\n  ApiPlatformClientServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link ApiPlatformClientServiceMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link ApiPlatformClientService} exposes to other consumers.\n */\nexport type ApiPlatformClientServiceEvents = never;\n\n/**\n * Events from other messengers that {@link ApiPlatformClientService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link ApiPlatformClientService}.\n */\nexport type ApiPlatformClientServiceMessenger = Messenger<\n  typeof apiPlatformClientServiceName,\n  ApiPlatformClientServiceActions | AllowedActions,\n  ApiPlatformClientServiceEvents | AllowedEvents\n>;\n\n// === SERVICE OPTIONS ===\n\n/**\n * Options for constructing {@link ApiPlatformClientService}.\n */\nexport type ApiPlatformClientServiceOptions = {\n  /** The messenger suited for this service. */\n  messenger: ApiPlatformClientServiceMessenger;\n} & ApiPlatformClientOptions;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Service that provides access to {@link ApiPlatformClient} via the messenger.\n *\n * Consumers obtain the client by calling the `ApiPlatformClientService:getApiPlatformClient`\n * action, then use it for accounts, prices, token, and tokens API calls.\n *\n * @example\n *\n * ```ts\n * import { Messenger } from '@metamask/messenger';\n * import {\n *   ApiPlatformClientService,\n *   type ApiPlatformClientServiceActions,\n *   type ApiPlatformClientServiceEvents,\n * } from '@metamask/core-backend';\n *\n * const rootMessenger = new Messenger<'Root', ApiPlatformClientServiceActions, ApiPlatformClientServiceEvents>({ namespace: 'Root' });\n * const serviceMessenger = new Messenger<\n *   'ApiPlatformClientService',\n *   ApiPlatformClientServiceActions,\n *   ApiPlatformClientServiceEvents,\n *   typeof rootMessenger\n * >({ namespace: 'ApiPlatformClientService', parent: rootMessenger });\n *\n * new ApiPlatformClientService({\n *   messenger: serviceMessenger,\n *   clientProduct: 'metamask-extension',\n *   getBearerToken: async () => token,\n * });\n *\n * const client = rootMessenger.call('ApiPlatformClientService:getApiPlatformClient');\n * const balances = await client.accounts.fetchV5MultiAccountBalances(accountIds);\n * ```\n */\nexport class ApiPlatformClientService {\n  readonly name: typeof apiPlatformClientServiceName;\n\n  readonly #messenger: ApiPlatformClientServiceMessenger;\n\n  readonly #client: ApiPlatformClient;\n\n  constructor({\n    messenger,\n    ...clientOptions\n  }: ApiPlatformClientServiceOptions) {\n    this.name = apiPlatformClientServiceName;\n    this.#messenger = messenger;\n    this.#client = new ApiPlatformClient(clientOptions);\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Returns the shared ApiPlatformClient instance.\n   *\n   * Use this via the messenger: `messenger.call('ApiPlatformClientService:getApiPlatformClient')`.\n   *\n   * @returns The ApiPlatformClient instance (accounts, prices, token, tokens).\n   */\n  getApiPlatformClient(): ApiPlatformClient {\n    return this.#client;\n  }\n}\n"]}

package/dist/ApiPlatformClientService.d.cts

@@ -0,0 +1,86 @@
+import type { Messenger } from "@metamask/messenger";
+import { ApiPlatformClient } from "./api/index.cjs";
+import type { ApiPlatformClientOptions } from "./api/index.cjs";
+import type { ApiPlatformClientServiceMethodActions } from "./ApiPlatformClientService-method-action-types.cjs";
+/**
+ * The name of the {@link ApiPlatformClientService}, used to namespace the
+ * service's actions and events.
+ */
+export declare const apiPlatformClientServiceName = "ApiPlatformClientService";
+/**
+ * Actions that {@link ApiPlatformClientService} exposes to other consumers.
+ */
+export type ApiPlatformClientServiceActions = ApiPlatformClientServiceMethodActions;
+/**
+ * Actions from other messengers that {@link ApiPlatformClientServiceMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Events that {@link ApiPlatformClientService} exposes to other consumers.
+ */
+export type ApiPlatformClientServiceEvents = never;
+/**
+ * Events from other messengers that {@link ApiPlatformClientService} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger which is restricted to actions and events accessed by
+ * {@link ApiPlatformClientService}.
+ */
+export type ApiPlatformClientServiceMessenger = Messenger<typeof apiPlatformClientServiceName, ApiPlatformClientServiceActions | AllowedActions, ApiPlatformClientServiceEvents | AllowedEvents>;
+/**
+ * Options for constructing {@link ApiPlatformClientService}.
+ */
+export type ApiPlatformClientServiceOptions = {
+    /** The messenger suited for this service. */
+    messenger: ApiPlatformClientServiceMessenger;
+} & ApiPlatformClientOptions;
+/**
+ * Service that provides access to {@link ApiPlatformClient} via the messenger.
+ *
+ * Consumers obtain the client by calling the `ApiPlatformClientService:getApiPlatformClient`
+ * action, then use it for accounts, prices, token, and tokens API calls.
+ *
+ * @example
+ *
+ * ```ts
+ * import { Messenger } from '@metamask/messenger';
+ * import {
+ *   ApiPlatformClientService,
+ *   type ApiPlatformClientServiceActions,
+ *   type ApiPlatformClientServiceEvents,
+ * } from '@metamask/core-backend';
+ *
+ * const rootMessenger = new Messenger<'Root', ApiPlatformClientServiceActions, ApiPlatformClientServiceEvents>({ namespace: 'Root' });
+ * const serviceMessenger = new Messenger<
+ *   'ApiPlatformClientService',
+ *   ApiPlatformClientServiceActions,
+ *   ApiPlatformClientServiceEvents,
+ *   typeof rootMessenger
+ * >({ namespace: 'ApiPlatformClientService', parent: rootMessenger });
+ *
+ * new ApiPlatformClientService({
+ *   messenger: serviceMessenger,
+ *   clientProduct: 'metamask-extension',
+ *   getBearerToken: async () => token,
+ * });
+ *
+ * const client = rootMessenger.call('ApiPlatformClientService:getApiPlatformClient');
+ * const balances = await client.accounts.fetchV5MultiAccountBalances(accountIds);
+ * ```
+ */
+export declare class ApiPlatformClientService {
+    #private;
+    readonly name: typeof apiPlatformClientServiceName;
+    constructor({ messenger, ...clientOptions }: ApiPlatformClientServiceOptions);
+    /**
+     * Returns the shared ApiPlatformClient instance.
+     *
+     * Use this via the messenger: `messenger.call('ApiPlatformClientService:getApiPlatformClient')`.
+     *
+     * @returns The ApiPlatformClient instance (accounts, prices, token, tokens).
+     */
+    getApiPlatformClient(): ApiPlatformClient;
+}
+export {};
+//# sourceMappingURL=ApiPlatformClientService.d.cts.map

package/dist/ApiPlatformClientService.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiPlatformClientService.d.cts","sourceRoot":"","sources":["../src/ApiPlatformClientService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,iBAAiB,EAAE,wBAAc;AAC1C,OAAO,KAAK,EAAE,wBAAwB,EAAE,wBAAc;AACtD,OAAO,KAAK,EAAE,qCAAqC,EAAE,2DAAuD;AAI5G;;;GAGG;AACH,eAAO,MAAM,4BAA4B,6BAA6B,CAAC;AAMvE;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,qCAAqC,CAAC;AAExC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC;AAEnD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,4BAA4B,EACnC,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,6CAA6C;IAC7C,SAAS,EAAE,iCAAiC,CAAC;CAC9C,GAAG,wBAAwB,CAAC;AAI7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,wBAAwB;;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,4BAA4B,CAAC;gBAMvC,EACV,SAAS,EACT,GAAG,aAAa,EACjB,EAAE,+BAA+B;IAWlC;;;;;;OAMG;IACH,oBAAoB,IAAI,iBAAiB;CAG1C"}

package/dist/ApiPlatformClientService.d.mts

@@ -0,0 +1,86 @@
+import type { Messenger } from "@metamask/messenger";
+import { ApiPlatformClient } from "./api/index.mjs";
+import type { ApiPlatformClientOptions } from "./api/index.mjs";
+import type { ApiPlatformClientServiceMethodActions } from "./ApiPlatformClientService-method-action-types.mjs";
+/**
+ * The name of the {@link ApiPlatformClientService}, used to namespace the
+ * service's actions and events.
+ */
+export declare const apiPlatformClientServiceName = "ApiPlatformClientService";
+/**
+ * Actions that {@link ApiPlatformClientService} exposes to other consumers.
+ */
+export type ApiPlatformClientServiceActions = ApiPlatformClientServiceMethodActions;
+/**
+ * Actions from other messengers that {@link ApiPlatformClientServiceMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Events that {@link ApiPlatformClientService} exposes to other consumers.
+ */
+export type ApiPlatformClientServiceEvents = never;
+/**
+ * Events from other messengers that {@link ApiPlatformClientService} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger which is restricted to actions and events accessed by
+ * {@link ApiPlatformClientService}.
+ */
+export type ApiPlatformClientServiceMessenger = Messenger<typeof apiPlatformClientServiceName, ApiPlatformClientServiceActions | AllowedActions, ApiPlatformClientServiceEvents | AllowedEvents>;
+/**
+ * Options for constructing {@link ApiPlatformClientService}.
+ */
+export type ApiPlatformClientServiceOptions = {
+    /** The messenger suited for this service. */
+    messenger: ApiPlatformClientServiceMessenger;
+} & ApiPlatformClientOptions;
+/**
+ * Service that provides access to {@link ApiPlatformClient} via the messenger.
+ *
+ * Consumers obtain the client by calling the `ApiPlatformClientService:getApiPlatformClient`
+ * action, then use it for accounts, prices, token, and tokens API calls.
+ *
+ * @example
+ *
+ * ```ts
+ * import { Messenger } from '@metamask/messenger';
+ * import {
+ *   ApiPlatformClientService,
+ *   type ApiPlatformClientServiceActions,
+ *   type ApiPlatformClientServiceEvents,
+ * } from '@metamask/core-backend';
+ *
+ * const rootMessenger = new Messenger<'Root', ApiPlatformClientServiceActions, ApiPlatformClientServiceEvents>({ namespace: 'Root' });
+ * const serviceMessenger = new Messenger<
+ *   'ApiPlatformClientService',
+ *   ApiPlatformClientServiceActions,
+ *   ApiPlatformClientServiceEvents,
+ *   typeof rootMessenger
+ * >({ namespace: 'ApiPlatformClientService', parent: rootMessenger });
+ *
+ * new ApiPlatformClientService({
+ *   messenger: serviceMessenger,
+ *   clientProduct: 'metamask-extension',
+ *   getBearerToken: async () => token,
+ * });
+ *
+ * const client = rootMessenger.call('ApiPlatformClientService:getApiPlatformClient');
+ * const balances = await client.accounts.fetchV5MultiAccountBalances(accountIds);
+ * ```
+ */
+export declare class ApiPlatformClientService {
+    #private;
+    readonly name: typeof apiPlatformClientServiceName;
+    constructor({ messenger, ...clientOptions }: ApiPlatformClientServiceOptions);
+    /**
+     * Returns the shared ApiPlatformClient instance.
+     *
+     * Use this via the messenger: `messenger.call('ApiPlatformClientService:getApiPlatformClient')`.
+     *
+     * @returns The ApiPlatformClient instance (accounts, prices, token, tokens).
+     */
+    getApiPlatformClient(): ApiPlatformClient;
+}
+export {};
+//# sourceMappingURL=ApiPlatformClientService.d.mts.map

package/dist/ApiPlatformClientService.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiPlatformClientService.d.mts","sourceRoot":"","sources":["../src/ApiPlatformClientService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,iBAAiB,EAAE,wBAAc;AAC1C,OAAO,KAAK,EAAE,wBAAwB,EAAE,wBAAc;AACtD,OAAO,KAAK,EAAE,qCAAqC,EAAE,2DAAuD;AAI5G;;;GAGG;AACH,eAAO,MAAM,4BAA4B,6BAA6B,CAAC;AAMvE;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,qCAAqC,CAAC;AAExC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC;AAEnD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,4BAA4B,EACnC,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,6CAA6C;IAC7C,SAAS,EAAE,iCAAiC,CAAC;CAC9C,GAAG,wBAAwB,CAAC;AAI7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,wBAAwB;;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,4BAA4B,CAAC;gBAMvC,EACV,SAAS,EACT,GAAG,aAAa,EACjB,EAAE,+BAA+B;IAWlC;;;;;;OAMG;IACH,oBAAoB,IAAI,iBAAiB;CAG1C"}

package/dist/ApiPlatformClientService.mjs

@@ -0,0 +1,78 @@
+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 _ApiPlatformClientService_messenger, _ApiPlatformClientService_client;
+import { ApiPlatformClient } from "./api/index.mjs";
+// === GENERAL ===
+/**
+ * The name of the {@link ApiPlatformClientService}, used to namespace the
+ * service's actions and events.
+ */
+export const apiPlatformClientServiceName = 'ApiPlatformClientService';
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = ['getApiPlatformClient'];
+// === SERVICE DEFINITION ===
+/**
+ * Service that provides access to {@link ApiPlatformClient} via the messenger.
+ *
+ * Consumers obtain the client by calling the `ApiPlatformClientService:getApiPlatformClient`
+ * action, then use it for accounts, prices, token, and tokens API calls.
+ *
+ * @example
+ *
+ * ```ts
+ * import { Messenger } from '@metamask/messenger';
+ * import {
+ *   ApiPlatformClientService,
+ *   type ApiPlatformClientServiceActions,
+ *   type ApiPlatformClientServiceEvents,
+ * } from '@metamask/core-backend';
+ *
+ * const rootMessenger = new Messenger<'Root', ApiPlatformClientServiceActions, ApiPlatformClientServiceEvents>({ namespace: 'Root' });
+ * const serviceMessenger = new Messenger<
+ *   'ApiPlatformClientService',
+ *   ApiPlatformClientServiceActions,
+ *   ApiPlatformClientServiceEvents,
+ *   typeof rootMessenger
+ * >({ namespace: 'ApiPlatformClientService', parent: rootMessenger });
+ *
+ * new ApiPlatformClientService({
+ *   messenger: serviceMessenger,
+ *   clientProduct: 'metamask-extension',
+ *   getBearerToken: async () => token,
+ * });
+ *
+ * const client = rootMessenger.call('ApiPlatformClientService:getApiPlatformClient');
+ * const balances = await client.accounts.fetchV5MultiAccountBalances(accountIds);
+ * ```
+ */
+export class ApiPlatformClientService {
+    constructor({ messenger, ...clientOptions }) {
+        _ApiPlatformClientService_messenger.set(this, void 0);
+        _ApiPlatformClientService_client.set(this, void 0);
+        this.name = apiPlatformClientServiceName;
+        __classPrivateFieldSet(this, _ApiPlatformClientService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _ApiPlatformClientService_client, new ApiPlatformClient(clientOptions), "f");
+        __classPrivateFieldGet(this, _ApiPlatformClientService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Returns the shared ApiPlatformClient instance.
+     *
+     * Use this via the messenger: `messenger.call('ApiPlatformClientService:getApiPlatformClient')`.
+     *
+     * @returns The ApiPlatformClient instance (accounts, prices, token, tokens).
+     */
+    getApiPlatformClient() {
+        return __classPrivateFieldGet(this, _ApiPlatformClientService_client, "f");
+    }
+}
+_ApiPlatformClientService_messenger = new WeakMap(), _ApiPlatformClientService_client = new WeakMap();
+//# sourceMappingURL=ApiPlatformClientService.mjs.map