@metamask/assets-controllers 48.0.0 → 49.0.0

package/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [49.0.0]
+
+### Added
+
+- Add new `MultiChainTokensRatesController` ([#5175](https://github.com/MetaMask/core/pull/5175))
+  - A controller that manages multi‑chain token conversion rates within MetaMask. Its primary goal is to periodically poll for updated conversion rates of tokens associated with non‑EVM accounts (those using Snap metadata), ensuring that the conversion data remains up‑to‑date across supported chains.
+- Add `updateBalance` to MultichainBalancesController ([#5295](https://github.com/MetaMask/core/pull/5295))
+
+### Changed
+
+- **BREAKING:** MultichainBalancesController messenger must now allow `MultichainAssetsController:getState` action and `MultichainAssetsController:stateChange` event ([#5295](https://github.com/MetaMask/core/pull/5295))
+- Update `MultichainBalancesController` to get the full list of assets from `MultichainAssetsController` state instead of only requesting the native token ([#5295](https://github.com/MetaMask/core/pull/5295))
+- Bump `@metamask/base-controller` from `^7.1.1` to `^8.0.0` ([#5305](https://github.com/MetaMask/core/pull/5305))
+- Bump `@metamask/polling-controller` from `^12.0.2` to `^12.0.3` ([#5305](https://github.com/MetaMask/core/pull/5305))
+
+### Removed
+
+- **BREAKING:** `NETWORK_ASSETS_MAP`, `MultichainNetworks`, and `MultichainNativeAssets` are no longer exported ([#5295](https://github.com/MetaMask/core/pull/5295))
+
 ## [48.0.0]
 
 ### Added
@@ -1375,7 +1394,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Use Ethers for AssetsContractController ([#845](https://github.com/MetaMask/core/pull/845))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@48.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@49.0.0...HEAD
+[49.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@48.0.0...@metamask/assets-controllers@49.0.0
 [48.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@47.0.0...@metamask/assets-controllers@48.0.0
 [47.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@46.0.1...@metamask/assets-controllers@47.0.0
 [46.0.1]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@46.0.0...@metamask/assets-controllers@46.0.1

package/dist/MultichainAssetsRatesController/MultichainAssetsRatesController.cjs

@@ -0,0 +1,205 @@
+"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 _MultiChainAssetsRatesController_instances, _MultiChainAssetsRatesController_mutex, _MultiChainAssetsRatesController_currentCurrency, _MultiChainAssetsRatesController_accountsAssets, _MultiChainAssetsRatesController_isUnlocked, _MultiChainAssetsRatesController_isNonEvmAccount, _MultiChainAssetsRatesController_listMultichainAccounts, _MultiChainAssetsRatesController_listAccounts, _MultiChainAssetsRatesController_getAssetsForAccount, _MultiChainAssetsRatesController_buildConversions, _MultiChainAssetsRatesController_flattenRates, _MultiChainAssetsRatesController_buildUpdatedRates, _MultiChainAssetsRatesController_applyUpdatedRates, _MultiChainAssetsRatesController_handleSnapRequest;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiChainAssetsRatesController = exports.getDefaultMultichainAssetsRatesControllerState = void 0;
+const keyring_api_1 = require("@metamask/keyring-api");
+const polling_controller_1 = require("@metamask/polling-controller");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const async_mutex_1 = require("async-mutex");
+const constant_1 = require("./constant.cjs");
+/**
+ * The name of the MultiChainAssetsRatesController.
+ */
+const controllerName = 'MultiChainAssetsRatesController';
+/**
+ * Constructs the default {@link MultichainAssetsRatesController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link MultichainAssetsRatesController} state.
+ */
+function getDefaultMultichainAssetsRatesControllerState() {
+    return { conversionRates: {} };
+}
+exports.getDefaultMultichainAssetsRatesControllerState = getDefaultMultichainAssetsRatesControllerState;
+const metadata = {
+    conversionRates: { persist: true, anonymous: true },
+};
+/**
+ * Controller that manages multichain token conversion rates.
+ *
+ * This controller polls for token conversion rates and updates its state.
+ */
+class MultiChainAssetsRatesController extends (0, polling_controller_1.StaticIntervalPollingController)() {
+    /**
+     * Creates an instance of MultiChainAssetsRatesController.
+     *
+     * @param options - Constructor options.
+     * @param options.interval - The polling interval in milliseconds.
+     * @param options.state - The initial state.
+     * @param options.messenger - A reference to the messaging system.
+     */
+    constructor({ interval = 18000, state = {}, messenger, }) {
+        var _a, _b;
+        super({
+            name: controllerName,
+            messenger,
+            state: {
+                ...getDefaultMultichainAssetsRatesControllerState(),
+                ...state,
+            },
+            metadata,
+        });
+        _MultiChainAssetsRatesController_instances.add(this);
+        _MultiChainAssetsRatesController_mutex.set(this, new async_mutex_1.Mutex());
+        _MultiChainAssetsRatesController_currentCurrency.set(this, void 0);
+        _MultiChainAssetsRatesController_accountsAssets.set(this, void 0);
+        _MultiChainAssetsRatesController_isUnlocked.set(this, true);
+        this.setIntervalLength(interval);
+        // Subscribe to keyring lock/unlock events.
+        this.messagingSystem.subscribe('KeyringController:lock', () => {
+            __classPrivateFieldSet(this, _MultiChainAssetsRatesController_isUnlocked, false, "f");
+        });
+        this.messagingSystem.subscribe('KeyringController:unlock', () => {
+            __classPrivateFieldSet(this, _MultiChainAssetsRatesController_isUnlocked, true, "f");
+        });
+        (_a = this, { accountsAssets: ({ set value(_c) { __classPrivateFieldSet(_a, _MultiChainAssetsRatesController_accountsAssets, _c, "f"); } }).value } = this.messagingSystem.call('MultichainAssetsController:getState'));
+        (_b = this, { currentCurrency: ({ set value(_c) { __classPrivateFieldSet(_b, _MultiChainAssetsRatesController_currentCurrency, _c, "f"); } }).value } = this.messagingSystem.call('CurrencyRateController:getState'));
+        this.messagingSystem.subscribe('CurrencyRateController:stateChange', async (currencyRatesState) => {
+            __classPrivateFieldSet(this, _MultiChainAssetsRatesController_currentCurrency, currencyRatesState.currentCurrency, "f");
+            await this.updateAssetsRates();
+        });
+        this.messagingSystem.subscribe('MultichainAssetsController:stateChange', async (multiChainAssetsState) => {
+            __classPrivateFieldSet(this, _MultiChainAssetsRatesController_accountsAssets, multiChainAssetsState.accountsAssets, "f");
+            await this.updateAssetsRates();
+        });
+    }
+    /**
+     * Executes a poll by updating token conversion rates for the current account.
+     *
+     * @returns A promise that resolves when the polling completes.
+     */
+    async _executePoll() {
+        await this.updateAssetsRates();
+    }
+    /**
+     * Determines whether the controller is active.
+     *
+     * @returns True if the keyring is unlocked; otherwise, false.
+     */
+    get isActive() {
+        return __classPrivateFieldGet(this, _MultiChainAssetsRatesController_isUnlocked, "f");
+    }
+    /**
+     * Updates token conversion rates for each non-EVM account.
+     *
+     * @returns A promise that resolves when the rates are updated.
+     */
+    async updateAssetsRates() {
+        const releaseLock = await __classPrivateFieldGet(this, _MultiChainAssetsRatesController_mutex, "f").acquire();
+        return (async () => {
+            if (!this.isActive) {
+                return;
+            }
+            const accounts = __classPrivateFieldGet(this, _MultiChainAssetsRatesController_instances, "m", _MultiChainAssetsRatesController_listAccounts).call(this);
+            for (const account of accounts) {
+                const assets = __classPrivateFieldGet(this, _MultiChainAssetsRatesController_instances, "m", _MultiChainAssetsRatesController_getAssetsForAccount).call(this, account.id);
+                // Build the conversions array
+                const conversions = __classPrivateFieldGet(this, _MultiChainAssetsRatesController_instances, "m", _MultiChainAssetsRatesController_buildConversions).call(this, assets);
+                // Retrieve rates from Snap
+                const accountRates = await __classPrivateFieldGet(this, _MultiChainAssetsRatesController_instances, "m", _MultiChainAssetsRatesController_handleSnapRequest).call(this, {
+                    snapId: account?.metadata.snap?.id,
+                    handler: snaps_utils_1.HandlerType.OnAssetsConversion,
+                    params: conversions,
+                });
+                // Flatten nested rates if needed
+                const flattenedRates = __classPrivateFieldGet(this, _MultiChainAssetsRatesController_instances, "m", _MultiChainAssetsRatesController_flattenRates).call(this, accountRates);
+                // Build the updatedRates object for these assets
+                const updatedRates = __classPrivateFieldGet(this, _MultiChainAssetsRatesController_instances, "m", _MultiChainAssetsRatesController_buildUpdatedRates).call(this, assets, flattenedRates);
+                // Apply these updated rates to controller state
+                __classPrivateFieldGet(this, _MultiChainAssetsRatesController_instances, "m", _MultiChainAssetsRatesController_applyUpdatedRates).call(this, updatedRates);
+            }
+        })().finally(() => {
+            releaseLock();
+        });
+    }
+}
+exports.MultiChainAssetsRatesController = MultiChainAssetsRatesController;
+_MultiChainAssetsRatesController_mutex = new WeakMap(), _MultiChainAssetsRatesController_currentCurrency = new WeakMap(), _MultiChainAssetsRatesController_accountsAssets = new WeakMap(), _MultiChainAssetsRatesController_isUnlocked = new WeakMap(), _MultiChainAssetsRatesController_instances = new WeakSet(), _MultiChainAssetsRatesController_isNonEvmAccount = function _MultiChainAssetsRatesController_isNonEvmAccount(account) {
+    return (!(0, keyring_api_1.isEvmAccountType)(account.type) && account.metadata.snap !== undefined);
+}, _MultiChainAssetsRatesController_listMultichainAccounts = function _MultiChainAssetsRatesController_listMultichainAccounts() {
+    return this.messagingSystem.call('AccountsController:listMultichainAccounts');
+}, _MultiChainAssetsRatesController_listAccounts = function _MultiChainAssetsRatesController_listAccounts() {
+    const accounts = __classPrivateFieldGet(this, _MultiChainAssetsRatesController_instances, "m", _MultiChainAssetsRatesController_listMultichainAccounts).call(this);
+    return accounts.filter((account) => __classPrivateFieldGet(this, _MultiChainAssetsRatesController_instances, "m", _MultiChainAssetsRatesController_isNonEvmAccount).call(this, account));
+}, _MultiChainAssetsRatesController_getAssetsForAccount = function _MultiChainAssetsRatesController_getAssetsForAccount(accountId) {
+    return __classPrivateFieldGet(this, _MultiChainAssetsRatesController_accountsAssets, "f")?.[accountId] ?? [];
+}, _MultiChainAssetsRatesController_buildConversions = function _MultiChainAssetsRatesController_buildConversions(assets) {
+    const currency = constant_1.MAP_CAIP_CURRENCIES[__classPrivateFieldGet(this, _MultiChainAssetsRatesController_currentCurrency, "f")] ?? constant_1.MAP_CAIP_CURRENCIES.usd;
+    return {
+        conversions: assets.map((asset) => ({
+            from: asset,
+            to: currency,
+        })),
+    };
+}, _MultiChainAssetsRatesController_flattenRates = function _MultiChainAssetsRatesController_flattenRates(assetsConversionResponse) {
+    const { conversionRates } = assetsConversionResponse;
+    return Object.fromEntries(Object.entries(conversionRates).map(([asset, nestedObj]) => {
+        // e.g., nestedObj might look like: { "swift:0/iso4217:EUR": { rate, conversionTime } }
+        const singleValue = Object.values(nestedObj)[0];
+        return [asset, singleValue];
+    }));
+}, _MultiChainAssetsRatesController_buildUpdatedRates = function _MultiChainAssetsRatesController_buildUpdatedRates(assets, flattenedRates) {
+    const updatedRates = {};
+    for (const asset of assets) {
+        if (flattenedRates[asset]) {
+            updatedRates[asset] = {
+                ...flattenedRates[asset],
+                currency: constant_1.MAP_CAIP_CURRENCIES[__classPrivateFieldGet(this, _MultiChainAssetsRatesController_currentCurrency, "f")] ??
+                    constant_1.MAP_CAIP_CURRENCIES.usd,
+            };
+        }
+    }
+    return updatedRates;
+}, _MultiChainAssetsRatesController_applyUpdatedRates = function _MultiChainAssetsRatesController_applyUpdatedRates(updatedRates) {
+    this.update((state) => {
+        state.conversionRates = {
+            ...state.conversionRates,
+            ...updatedRates,
+        };
+    });
+}, _MultiChainAssetsRatesController_handleSnapRequest = 
+/**
+ * Forwards a Snap request to the SnapController.
+ *
+ * @param args - The request parameters.
+ * @param args.snapId - The ID of the Snap.
+ * @param args.handler - The handler type.
+ * @param args.params - The asset conversions.
+ * @returns A promise that resolves with the account rates.
+ */
+async function _MultiChainAssetsRatesController_handleSnapRequest({ snapId, handler, params, }) {
+    return this.messagingSystem.call('SnapController:handleRequest', {
+        snapId,
+        origin: 'metamask',
+        handler,
+        request: {
+            jsonrpc: '2.0',
+            method: handler,
+            params,
+        },
+    });
+};
+//# sourceMappingURL=MultichainAssetsRatesController.cjs.map

package/dist/MultichainAssetsRatesController/MultichainAssetsRatesController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultichainAssetsRatesController.cjs","sourceRoot":"","sources":["../../src/MultichainAssetsRatesController/MultichainAssetsRatesController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AASA,uDAA6E;AAM7E,qEAA+E;AAQ/E,uDAAoD;AACpD,6CAAoC;AAGpC,6CAAiD;AAYjD;;GAEG;AACH,MAAM,cAAc,GAAG,iCAAiC,CAAC;AA0BzD;;;;;;;GAOG;AACH,SAAgB,8CAA8C;IAC5D,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;AACjC,CAAC;AAFD,wGAEC;AA4DD,MAAM,QAAQ,GAAG;IACf,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACpD,CAAC;AAEF;;;;GAIG;AACH,MAAa,+BAAgC,SAAQ,IAAA,oDAA+B,GAInF;IASC;;;;;;;OAOG;IACH,YAAY,EACV,QAAQ,GAAG,KAAK,EAChB,KAAK,GAAG,EAAE,EACV,SAAS,GAKV;;QACC,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,8CAA8C,EAAE;gBACnD,GAAG,KAAK;aACT;YACD,QAAQ;SACT,CAAC,CAAC;;QAjCI,iDAAS,IAAI,mBAAK,EAAE,EAAC;QAE9B,mEAAuD;QAEvD,kEAAmE;QAEnE,sDAAc,IAAI,EAAC;QA6BjB,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAEjC,2CAA2C;QAC3C,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,EAAE;YAC5D,uBAAA,IAAI,+CAAe,KAAK,MAAA,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAC9D,uBAAA,IAAI,+CAAe,IAAI,MAAA,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,MAAmB,IAAI,EAAtB,EAAE,cAAc,qHAAsB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACnE,qCAAqC,CACtC,CAAC,CAAC;QAEH,MAAoB,IAAI,EAAvB,EAAE,eAAe,sHAAuB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CACrE,iCAAiC,CAClC,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,oCAAoC,EACpC,KAAK,EAAE,kBAAqC,EAAE,EAAE;YAC9C,uBAAA,IAAI,oDAAoB,kBAAkB,CAAC,eAAe,MAAA,CAAC;YAC3D,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACjC,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,wCAAwC,EACxC,KAAK,EAAE,qBAAsD,EAAE,EAAE;YAC/D,uBAAA,IAAI,mDAAmB,qBAAqB,CAAC,cAAc,MAAA,CAAC;YAC5D,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACjC,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ;QACV,OAAO,uBAAA,IAAI,mDAAY,CAAC;IAC1B,CAAC;IAmCD;;;;OAIG;IACH,KAAK,CAAC,iBAAiB;QACrB,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,8CAAO,CAAC,OAAO,EAAE,CAAC;QAEhD,OAAO,CAAC,KAAK,IAAI,EAAE;YACjB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;gBAClB,OAAO;aACR;YACD,MAAM,QAAQ,GAAG,uBAAA,IAAI,iGAAc,MAAlB,IAAI,CAAgB,CAAC;YAEtC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC9B,MAAM,MAAM,GAAG,uBAAA,IAAI,wGAAqB,MAAzB,IAAI,EAAsB,OAAO,CAAC,EAAE,CAAC,CAAC;gBAErD,8BAA8B;gBAC9B,MAAM,WAAW,GAAG,uBAAA,IAAI,qGAAkB,MAAtB,IAAI,EAAmB,MAAM,CAAC,CAAC;gBAEnD,2BAA2B;gBAC3B,MAAM,YAAY,GAAG,MAAM,uBAAA,IAAI,sGAAmB,MAAvB,IAAI,EAAoB;oBACjD,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE,EAAY;oBAC5C,OAAO,EAAE,yBAAW,CAAC,kBAAkB;oBACvC,MAAM,EAAE,WAAW;iBACpB,CAAC,CAAC;gBAEH,iCAAiC;gBACjC,MAAM,cAAc,GAAG,uBAAA,IAAI,iGAAc,MAAlB,IAAI,EAAe,YAAY,CAAC,CAAC;gBAExD,iDAAiD;gBACjD,MAAM,YAAY,GAAG,uBAAA,IAAI,sGAAmB,MAAvB,IAAI,EAAoB,MAAM,EAAE,cAAc,CAAC,CAAC;gBACrE,gDAAgD;gBAChD,uBAAA,IAAI,sGAAmB,MAAvB,IAAI,EAAoB,YAAY,CAAC,CAAC;aACvC;QACH,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;YAChB,WAAW,EAAE,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC;CAgIF;AApSD,0EAoSC;iaAjMkB,OAAwB;IACvC,OAAO,CACL,CAAC,IAAA,8BAAgB,EAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CACvE,CAAC;AACJ,CAAC;IAQC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,2CAA2C,CAC5C,CAAC;AACJ,CAAC;IAQC,MAAM,QAAQ,GAAG,uBAAA,IAAI,2GAAwB,MAA5B,IAAI,CAA0B,CAAC;IAChD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,uBAAA,IAAI,oGAAiB,MAArB,IAAI,EAAkB,OAAO,CAAC,CAAC,CAAC;AACtE,CAAC,uHAiDoB,SAAiB;IACpC,OAAO,uBAAA,IAAI,uDAAgB,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;AACjD,CAAC,iHAQiB,MAAuB;IACvC,MAAM,QAAQ,GACZ,8BAAmB,CAAC,uBAAA,IAAI,wDAAiB,CAAC,IAAI,8BAAmB,CAAC,GAAG,CAAC;IACxE,OAAO;QACL,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAClC,IAAI,EAAE,KAAK;YACX,EAAE,EAAE,QAAQ;SACb,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC,yGASC,wBAAoD;IAEpD,MAAM,EAAE,eAAe,EAAE,GAAG,wBAAwB,CAAC;IAErD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE;QACzD,uFAAuF;QACvF,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAC9B,CAAC,CAAC,CACH,CAAC;AACJ,CAAC,mHAWC,MAAuB,EACvB,cAA6D;IAE7D,MAAM,YAAY,GAGd,EAAE,CAAC;IAEP,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE;YACzB,YAAY,CAAC,KAAK,CAAC,GAAG;gBACpB,GAAI,cAAc,CAAC,KAAK,CAAqB;gBAC7C,QAAQ,EACN,8BAAmB,CAAC,uBAAA,IAAI,wDAAiB,CAAC;oBAC1C,8BAAmB,CAAC,GAAG;aAC1B,CAAC;SACH;KACF;IACD,OAAO,YAAY,CAAC;AACtB,CAAC,mHAQC,YAGC;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAAkD,EAAE,EAAE;QACjE,KAAK,CAAC,eAAe,GAAG;YACtB,GAAG,KAAK,CAAC,eAAe;YACxB,GAAG,YAAY;SAChB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,KAAK,6DAAoB,EACvB,MAAM,EACN,OAAO,EACP,MAAM,GAKP;IACC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,8BAA8B,EAAE;QAC/D,MAAM;QACN,MAAM,EAAE,UAAU;QAClB,OAAO;QACP,OAAO,EAAE;YACP,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,OAAO;YACf,MAAM;SACP;KACF,CAAwC,CAAC;AAC5C,CAAC","sourcesContent":["import type {\n  AccountsControllerListMultichainAccountsAction,\n  AccountsControllerAccountAddedEvent,\n} from '@metamask/accounts-controller';\nimport type {\n  RestrictedMessenger,\n  ControllerStateChangeEvent,\n  ControllerGetStateAction,\n} from '@metamask/base-controller';\nimport { type CaipAssetType, isEvmAccountType } from '@metamask/keyring-api';\nimport type {\n  KeyringControllerLockEvent,\n  KeyringControllerUnlockEvent,\n} from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type { HandleSnapRequest } from '@metamask/snaps-controllers';\nimport type {\n  SnapId,\n  AssetConversion,\n  OnAssetsConversionArguments,\n  OnAssetsConversionResponse,\n} from '@metamask/snaps-sdk';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport { Mutex } from 'async-mutex';\nimport type { Draft } from 'immer';\n\nimport { MAP_CAIP_CURRENCIES } from './constant';\nimport type {\n  CurrencyRateState,\n  CurrencyRateStateChange,\n  GetCurrencyRateState,\n} from '../CurrencyRateController';\nimport type {\n  MultichainAssetsControllerGetStateAction,\n  MultichainAssetsControllerState,\n  MultichainAssetsControllerStateChangeEvent,\n} from '../MultichainAssetsController';\n\n/**\n * The name of the MultiChainAssetsRatesController.\n */\nconst controllerName = 'MultiChainAssetsRatesController';\n\n/**\n * State used by the MultiChainAssetsRatesController to cache token conversion rates.\n */\nexport type MultichainAssetsRatesControllerState = {\n  conversionRates: Record<CaipAssetType, AssetConversion>;\n};\n\n/**\n * Returns the state of the MultiChainAssetsRatesController.\n */\nexport type MultichainAssetsRatesControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    MultichainAssetsRatesControllerState\n  >;\n\n/**\n * Action to update the rates of all supported tokens.\n */\nexport type MultichainAssetsRatesControllerUpdateRatesAction = {\n  type: `${typeof controllerName}:updateAssetsRates`;\n  handler: MultiChainAssetsRatesController['updateAssetsRates'];\n};\n\n/**\n * Constructs the default {@link MultichainAssetsRatesController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link MultichainAssetsRatesController} state.\n */\nexport function getDefaultMultichainAssetsRatesControllerState(): MultichainAssetsRatesControllerState {\n  return { conversionRates: {} };\n}\n\n/**\n * Event emitted when the state of the MultiChainAssetsRatesController changes.\n */\nexport type MultichainAssetsRatesControllerStateChange =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    MultichainAssetsRatesControllerState\n  >;\n\n/**\n * Actions exposed by the MultiChainAssetsRatesController.\n */\nexport type MultichainAssetsRatesControllerActions =\n  | MultichainAssetsRatesControllerGetStateAction\n  | MultichainAssetsRatesControllerUpdateRatesAction;\n\n/**\n * Events emitted by MultiChainAssetsRatesController.\n */\nexport type MultichainAssetsRatesControllerEvents =\n  MultichainAssetsRatesControllerStateChange;\n\n/**\n * Actions that this controller is allowed to call.\n */\nexport type AllowedActions =\n  | HandleSnapRequest\n  | AccountsControllerListMultichainAccountsAction\n  | GetCurrencyRateState\n  | MultichainAssetsControllerGetStateAction;\n/**\n * Events that this controller is allowed to subscribe to.\n */\nexport type AllowedEvents =\n  | KeyringControllerLockEvent\n  | KeyringControllerUnlockEvent\n  | AccountsControllerAccountAddedEvent\n  | CurrencyRateStateChange\n  | MultichainAssetsControllerStateChangeEvent;\n\n/**\n * Messenger type for the MultiChainAssetsRatesController.\n */\nexport type MultichainAssetsRatesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  MultichainAssetsRatesControllerActions | AllowedActions,\n  MultichainAssetsRatesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * The input for starting polling in MultiChainAssetsRatesController.\n */\nexport type MultiChainAssetsRatesPollingInput = {\n  accountId: string;\n};\n\nconst metadata = {\n  conversionRates: { persist: true, anonymous: true },\n};\n\n/**\n * Controller that manages multichain token conversion rates.\n *\n * This controller polls for token conversion rates and updates its state.\n */\nexport class MultiChainAssetsRatesController extends StaticIntervalPollingController<MultiChainAssetsRatesPollingInput>()<\n  typeof controllerName,\n  MultichainAssetsRatesControllerState,\n  MultichainAssetsRatesControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  #currentCurrency: CurrencyRateState['currentCurrency'];\n\n  #accountsAssets: MultichainAssetsControllerState['accountsAssets'];\n\n  #isUnlocked = true;\n\n  /**\n   * Creates an instance of MultiChainAssetsRatesController.\n   *\n   * @param options - Constructor options.\n   * @param options.interval - The polling interval in milliseconds.\n   * @param options.state - The initial state.\n   * @param options.messenger - A reference to the messaging system.\n   */\n  constructor({\n    interval = 18000,\n    state = {},\n    messenger,\n  }: {\n    interval?: number;\n    state?: Partial<MultichainAssetsRatesControllerState>;\n    messenger: MultichainAssetsRatesControllerMessenger;\n  }) {\n    super({\n      name: controllerName,\n      messenger,\n      state: {\n        ...getDefaultMultichainAssetsRatesControllerState(),\n        ...state,\n      },\n      metadata,\n    });\n\n    this.setIntervalLength(interval);\n\n    // Subscribe to keyring lock/unlock events.\n    this.messagingSystem.subscribe('KeyringController:lock', () => {\n      this.#isUnlocked = false;\n    });\n    this.messagingSystem.subscribe('KeyringController:unlock', () => {\n      this.#isUnlocked = true;\n    });\n\n    ({ accountsAssets: this.#accountsAssets } = this.messagingSystem.call(\n      'MultichainAssetsController:getState',\n    ));\n\n    ({ currentCurrency: this.#currentCurrency } = this.messagingSystem.call(\n      'CurrencyRateController:getState',\n    ));\n\n    this.messagingSystem.subscribe(\n      'CurrencyRateController:stateChange',\n      async (currencyRatesState: CurrencyRateState) => {\n        this.#currentCurrency = currencyRatesState.currentCurrency;\n        await this.updateAssetsRates();\n      },\n    );\n\n    this.messagingSystem.subscribe(\n      'MultichainAssetsController:stateChange',\n      async (multiChainAssetsState: MultichainAssetsControllerState) => {\n        this.#accountsAssets = multiChainAssetsState.accountsAssets;\n        await this.updateAssetsRates();\n      },\n    );\n  }\n\n  /**\n   * Executes a poll by updating token conversion rates for the current account.\n   *\n   * @returns A promise that resolves when the polling completes.\n   */\n  async _executePoll(): Promise<void> {\n    await this.updateAssetsRates();\n  }\n\n  /**\n   * Determines whether the controller is active.\n   *\n   * @returns True if the keyring is unlocked; otherwise, false.\n   */\n  get isActive(): boolean {\n    return this.#isUnlocked;\n  }\n\n  /**\n   * Checks if an account is a non-EVM account with a Snap.\n   *\n   * @param account - The account to check.\n   * @returns True if the account is non-EVM and has Snap metadata; otherwise, false.\n   */\n  #isNonEvmAccount(account: InternalAccount): boolean {\n    return (\n      !isEvmAccountType(account.type) && account.metadata.snap !== undefined\n    );\n  }\n\n  /**\n   * Retrieves all multichain accounts from the AccountsController.\n   *\n   * @returns An array of internal accounts.\n   */\n  #listMultichainAccounts(): InternalAccount[] {\n    return this.messagingSystem.call(\n      'AccountsController:listMultichainAccounts',\n    );\n  }\n\n  /**\n   * Filters and returns non-EVM accounts that should have balances.\n   *\n   * @returns An array of non-EVM internal accounts.\n   */\n  #listAccounts(): InternalAccount[] {\n    const accounts = this.#listMultichainAccounts();\n    return accounts.filter((account) => this.#isNonEvmAccount(account));\n  }\n\n  /**\n   * Updates token conversion rates for each non-EVM account.\n   *\n   * @returns A promise that resolves when the rates are updated.\n   */\n  async updateAssetsRates(): Promise<void> {\n    const releaseLock = await this.#mutex.acquire();\n\n    return (async () => {\n      if (!this.isActive) {\n        return;\n      }\n      const accounts = this.#listAccounts();\n\n      for (const account of accounts) {\n        const assets = this.#getAssetsForAccount(account.id);\n\n        // Build the conversions array\n        const conversions = this.#buildConversions(assets);\n\n        // Retrieve rates from Snap\n        const accountRates = await this.#handleSnapRequest({\n          snapId: account?.metadata.snap?.id as SnapId,\n          handler: HandlerType.OnAssetsConversion,\n          params: conversions,\n        });\n\n        // Flatten nested rates if needed\n        const flattenedRates = this.#flattenRates(accountRates);\n\n        // Build the updatedRates object for these assets\n        const updatedRates = this.#buildUpdatedRates(assets, flattenedRates);\n        // Apply these updated rates to controller state\n        this.#applyUpdatedRates(updatedRates);\n      }\n    })().finally(() => {\n      releaseLock();\n    });\n  }\n\n  /**\n   * Returns the array of CAIP-19 assets for the given account ID.\n   * If none are found, returns an empty array.\n   *\n   * @param accountId - The account ID to get the assets for.\n   * @returns An array of CAIP-19 assets.\n   */\n  #getAssetsForAccount(accountId: string): CaipAssetType[] {\n    return this.#accountsAssets?.[accountId] ?? [];\n  }\n\n  /**\n   * Builds a conversions array (from each asset → the current currency).\n   *\n   * @param assets - The assets to build the conversions for.\n   * @returns A conversions array.\n   */\n  #buildConversions(assets: CaipAssetType[]): OnAssetsConversionArguments {\n    const currency =\n      MAP_CAIP_CURRENCIES[this.#currentCurrency] ?? MAP_CAIP_CURRENCIES.usd;\n    return {\n      conversions: assets.map((asset) => ({\n        from: asset,\n        to: currency,\n      })),\n    };\n  }\n\n  /**\n   * Flattens any nested structure in the conversion rates returned by Snap.\n   *\n   * @param assetsConversionResponse - The conversion rates to flatten.\n   * @returns A flattened rates object.\n   */\n  #flattenRates(\n    assetsConversionResponse: OnAssetsConversionResponse,\n  ): Record<CaipAssetType, AssetConversion | null> {\n    const { conversionRates } = assetsConversionResponse;\n\n    return Object.fromEntries(\n      Object.entries(conversionRates).map(([asset, nestedObj]) => {\n        // e.g., nestedObj might look like: { \"swift:0/iso4217:EUR\": { rate, conversionTime } }\n        const singleValue = Object.values(nestedObj)[0];\n        return [asset, singleValue];\n      }),\n    );\n  }\n\n  /**\n   * Builds a rates object that covers all given assets, ensuring that\n   * any asset not returned by Snap is set to null for both `rate` and `conversionTime`.\n   *\n   * @param assets - The assets to build the rates for.\n   * @param flattenedRates - The rates to merge.\n   * @returns A rates object that covers all given assets.\n   */\n  #buildUpdatedRates(\n    assets: CaipAssetType[],\n    flattenedRates: Record<CaipAssetType, AssetConversion | null>,\n  ): Record<string, AssetConversion & { currency: CaipAssetType }> {\n    const updatedRates: Record<\n      CaipAssetType,\n      AssetConversion & { currency: CaipAssetType }\n    > = {};\n\n    for (const asset of assets) {\n      if (flattenedRates[asset]) {\n        updatedRates[asset] = {\n          ...(flattenedRates[asset] as AssetConversion),\n          currency:\n            MAP_CAIP_CURRENCIES[this.#currentCurrency] ??\n            MAP_CAIP_CURRENCIES.usd,\n        };\n      }\n    }\n    return updatedRates;\n  }\n\n  /**\n   * Merges the new rates into the controller’s state.\n   *\n   * @param updatedRates - The new rates to merge.\n   */\n  #applyUpdatedRates(\n    updatedRates: Record<\n      string,\n      { rate: string | null; conversionTime: number | null }\n    >,\n  ): void {\n    this.update((state: Draft<MultichainAssetsRatesControllerState>) => {\n      state.conversionRates = {\n        ...state.conversionRates,\n        ...updatedRates,\n      };\n    });\n  }\n\n  /**\n   * Forwards a Snap request to the SnapController.\n   *\n   * @param args - The request parameters.\n   * @param args.snapId - The ID of the Snap.\n   * @param args.handler - The handler type.\n   * @param args.params - The asset conversions.\n   * @returns A promise that resolves with the account rates.\n   */\n  async #handleSnapRequest({\n    snapId,\n    handler,\n    params,\n  }: {\n    snapId: SnapId;\n    handler: HandlerType;\n    params: OnAssetsConversionArguments;\n  }): Promise<OnAssetsConversionResponse> {\n    return this.messagingSystem.call('SnapController:handleRequest', {\n      snapId,\n      origin: 'metamask',\n      handler,\n      request: {\n        jsonrpc: '2.0',\n        method: handler,\n        params,\n      },\n    }) as Promise<OnAssetsConversionResponse>;\n  }\n}\n"]}

package/dist/MultichainAssetsRatesController/MultichainAssetsRatesController.d.cts

@@ -0,0 +1,124 @@
+import type { AccountsControllerListMultichainAccountsAction, AccountsControllerAccountAddedEvent } from "@metamask/accounts-controller";
+import type { RestrictedMessenger, ControllerStateChangeEvent, ControllerGetStateAction } from "@metamask/base-controller";
+import { type CaipAssetType } from "@metamask/keyring-api";
+import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
+import type { HandleSnapRequest } from "@metamask/snaps-controllers";
+import type { AssetConversion } from "@metamask/snaps-sdk";
+import type { CurrencyRateStateChange, GetCurrencyRateState } from "../CurrencyRateController.cjs";
+import type { MultichainAssetsControllerGetStateAction, MultichainAssetsControllerStateChangeEvent } from "../MultichainAssetsController/index.cjs";
+/**
+ * The name of the MultiChainAssetsRatesController.
+ */
+declare const controllerName = "MultiChainAssetsRatesController";
+/**
+ * State used by the MultiChainAssetsRatesController to cache token conversion rates.
+ */
+export type MultichainAssetsRatesControllerState = {
+    conversionRates: Record<CaipAssetType, AssetConversion>;
+};
+/**
+ * Returns the state of the MultiChainAssetsRatesController.
+ */
+export type MultichainAssetsRatesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, MultichainAssetsRatesControllerState>;
+/**
+ * Action to update the rates of all supported tokens.
+ */
+export type MultichainAssetsRatesControllerUpdateRatesAction = {
+    type: `${typeof controllerName}:updateAssetsRates`;
+    handler: MultiChainAssetsRatesController['updateAssetsRates'];
+};
+/**
+ * Constructs the default {@link MultichainAssetsRatesController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link MultichainAssetsRatesController} state.
+ */
+export declare function getDefaultMultichainAssetsRatesControllerState(): MultichainAssetsRatesControllerState;
+/**
+ * Event emitted when the state of the MultiChainAssetsRatesController changes.
+ */
+export type MultichainAssetsRatesControllerStateChange = ControllerStateChangeEvent<typeof controllerName, MultichainAssetsRatesControllerState>;
+/**
+ * Actions exposed by the MultiChainAssetsRatesController.
+ */
+export type MultichainAssetsRatesControllerActions = MultichainAssetsRatesControllerGetStateAction | MultichainAssetsRatesControllerUpdateRatesAction;
+/**
+ * Events emitted by MultiChainAssetsRatesController.
+ */
+export type MultichainAssetsRatesControllerEvents = MultichainAssetsRatesControllerStateChange;
+/**
+ * Actions that this controller is allowed to call.
+ */
+export type AllowedActions = HandleSnapRequest | AccountsControllerListMultichainAccountsAction | GetCurrencyRateState | MultichainAssetsControllerGetStateAction;
+/**
+ * Events that this controller is allowed to subscribe to.
+ */
+export type AllowedEvents = KeyringControllerLockEvent | KeyringControllerUnlockEvent | AccountsControllerAccountAddedEvent | CurrencyRateStateChange | MultichainAssetsControllerStateChangeEvent;
+/**
+ * Messenger type for the MultiChainAssetsRatesController.
+ */
+export type MultichainAssetsRatesControllerMessenger = RestrictedMessenger<typeof controllerName, MultichainAssetsRatesControllerActions | AllowedActions, MultichainAssetsRatesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * The input for starting polling in MultiChainAssetsRatesController.
+ */
+export type MultiChainAssetsRatesPollingInput = {
+    accountId: string;
+};
+declare const MultiChainAssetsRatesController_base: (abstract new (...args: any[]) => {
+    readonly "__#13@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#13@#intervalLength": number | undefined;
+    setIntervalLength(intervalLength: number): void;
+    getIntervalLength(): number | undefined;
+    _startPolling(input: MultiChainAssetsRatesPollingInput): void;
+    _stopPollingByPollingTokenSetId(key: string): void;
+    readonly "__#3@#pollingTokenSets": Map<string, Set<string>>;
+    "__#3@#callbacks": Map<string, Set<(input: MultiChainAssetsRatesPollingInput) => void>>;
+    _executePoll(input: MultiChainAssetsRatesPollingInput): Promise<void>;
+    startPolling(input: MultiChainAssetsRatesPollingInput): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingComplete(input: MultiChainAssetsRatesPollingInput, callback: (input: MultiChainAssetsRatesPollingInput) => void): void;
+}) & typeof import("@metamask/base-controller").BaseController;
+/**
+ * Controller that manages multichain token conversion rates.
+ *
+ * This controller polls for token conversion rates and updates its state.
+ */
+export declare class MultiChainAssetsRatesController extends MultiChainAssetsRatesController_base<typeof controllerName, MultichainAssetsRatesControllerState, MultichainAssetsRatesControllerMessenger> {
+    #private;
+    /**
+     * Creates an instance of MultiChainAssetsRatesController.
+     *
+     * @param options - Constructor options.
+     * @param options.interval - The polling interval in milliseconds.
+     * @param options.state - The initial state.
+     * @param options.messenger - A reference to the messaging system.
+     */
+    constructor({ interval, state, messenger, }: {
+        interval?: number;
+        state?: Partial<MultichainAssetsRatesControllerState>;
+        messenger: MultichainAssetsRatesControllerMessenger;
+    });
+    /**
+     * Executes a poll by updating token conversion rates for the current account.
+     *
+     * @returns A promise that resolves when the polling completes.
+     */
+    _executePoll(): Promise<void>;
+    /**
+     * Determines whether the controller is active.
+     *
+     * @returns True if the keyring is unlocked; otherwise, false.
+     */
+    get isActive(): boolean;
+    /**
+     * Updates token conversion rates for each non-EVM account.
+     *
+     * @returns A promise that resolves when the rates are updated.
+     */
+    updateAssetsRates(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=MultichainAssetsRatesController.d.cts.map

package/dist/MultichainAssetsRatesController/MultichainAssetsRatesController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultichainAssetsRatesController.d.cts","sourceRoot":"","sources":["../../src/MultichainAssetsRatesController/MultichainAssetsRatesController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8CAA8C,EAC9C,mCAAmC,EACpC,sCAAsC;AACvC,OAAO,KAAK,EACV,mBAAmB,EACnB,0BAA0B,EAC1B,wBAAwB,EACzB,kCAAkC;AACnC,OAAO,EAAE,KAAK,aAAa,EAAoB,8BAA8B;AAC7E,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AAGtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AACrE,OAAO,KAAK,EAEV,eAAe,EAGhB,4BAA4B;AAM7B,OAAO,KAAK,EAEV,uBAAuB,EACvB,oBAAoB,EACrB,sCAAkC;AACnC,OAAO,KAAK,EACV,wCAAwC,EAExC,0CAA0C,EAC3C,gDAAsC;AAEvC;;GAEG;AACH,QAAA,MAAM,cAAc,oCAAoC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,eAAe,EAAE,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;CACzD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6CAA6C,GACvD,wBAAwB,CACtB,OAAO,cAAc,EACrB,oCAAoC,CACrC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,GAAG,OAAO,cAAc,oBAAoB,CAAC;IACnD,OAAO,EAAE,+BAA+B,CAAC,mBAAmB,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,8CAA8C,IAAI,oCAAoC,CAErG;AAED;;GAEG;AACH,MAAM,MAAM,0CAA0C,GACpD,0BAA0B,CACxB,OAAO,cAAc,EACrB,oCAAoC,CACrC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAC9C,6CAA6C,GAC7C,gDAAgD,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,0CAA0C,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,iBAAiB,GACjB,8CAA8C,GAC9C,oBAAoB,GACpB,wCAAwC,CAAC;AAC7C;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,0BAA0B,GAC1B,4BAA4B,GAC5B,mCAAmC,GACnC,uBAAuB,GACvB,0CAA0C,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG,mBAAmB,CACxE,OAAO,cAAc,EACrB,sCAAsC,GAAG,cAAc,EACvD,qCAAqC,GAAG,aAAa,EACrD,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;;;;;;;;;;;;;;;;AAMF;;;;GAIG;AACH,qBAAa,+BAAgC,SAAQ,qCACnD,OAAO,cAAc,EACrB,oCAAoC,EACpC,wCAAwC,CACzC;;IASC;;;;;;;OAOG;gBACS,EACV,QAAgB,EAChB,KAAU,EACV,SAAS,GACV,EAAE;QACD,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,OAAO,CAAC,oCAAoC,CAAC,CAAC;QACtD,SAAS,EAAE,wCAAwC,CAAC;KACrD;IA8CD;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAInC;;;;OAIG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAmCD;;;;OAIG;IACG,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;CAiKzC"}

package/dist/MultichainAssetsRatesController/MultichainAssetsRatesController.d.mts

@@ -0,0 +1,124 @@
+import type { AccountsControllerListMultichainAccountsAction, AccountsControllerAccountAddedEvent } from "@metamask/accounts-controller";
+import type { RestrictedMessenger, ControllerStateChangeEvent, ControllerGetStateAction } from "@metamask/base-controller";
+import { type CaipAssetType } from "@metamask/keyring-api";
+import type { KeyringControllerLockEvent, KeyringControllerUnlockEvent } from "@metamask/keyring-controller";
+import type { HandleSnapRequest } from "@metamask/snaps-controllers";
+import type { AssetConversion } from "@metamask/snaps-sdk";
+import type { CurrencyRateStateChange, GetCurrencyRateState } from "../CurrencyRateController.mjs";
+import type { MultichainAssetsControllerGetStateAction, MultichainAssetsControllerStateChangeEvent } from "../MultichainAssetsController/index.mjs";
+/**
+ * The name of the MultiChainAssetsRatesController.
+ */
+declare const controllerName = "MultiChainAssetsRatesController";
+/**
+ * State used by the MultiChainAssetsRatesController to cache token conversion rates.
+ */
+export type MultichainAssetsRatesControllerState = {
+    conversionRates: Record<CaipAssetType, AssetConversion>;
+};
+/**
+ * Returns the state of the MultiChainAssetsRatesController.
+ */
+export type MultichainAssetsRatesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, MultichainAssetsRatesControllerState>;
+/**
+ * Action to update the rates of all supported tokens.
+ */
+export type MultichainAssetsRatesControllerUpdateRatesAction = {
+    type: `${typeof controllerName}:updateAssetsRates`;
+    handler: MultiChainAssetsRatesController['updateAssetsRates'];
+};
+/**
+ * Constructs the default {@link MultichainAssetsRatesController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link MultichainAssetsRatesController} state.
+ */
+export declare function getDefaultMultichainAssetsRatesControllerState(): MultichainAssetsRatesControllerState;
+/**
+ * Event emitted when the state of the MultiChainAssetsRatesController changes.
+ */
+export type MultichainAssetsRatesControllerStateChange = ControllerStateChangeEvent<typeof controllerName, MultichainAssetsRatesControllerState>;
+/**
+ * Actions exposed by the MultiChainAssetsRatesController.
+ */
+export type MultichainAssetsRatesControllerActions = MultichainAssetsRatesControllerGetStateAction | MultichainAssetsRatesControllerUpdateRatesAction;
+/**
+ * Events emitted by MultiChainAssetsRatesController.
+ */
+export type MultichainAssetsRatesControllerEvents = MultichainAssetsRatesControllerStateChange;
+/**
+ * Actions that this controller is allowed to call.
+ */
+export type AllowedActions = HandleSnapRequest | AccountsControllerListMultichainAccountsAction | GetCurrencyRateState | MultichainAssetsControllerGetStateAction;
+/**
+ * Events that this controller is allowed to subscribe to.
+ */
+export type AllowedEvents = KeyringControllerLockEvent | KeyringControllerUnlockEvent | AccountsControllerAccountAddedEvent | CurrencyRateStateChange | MultichainAssetsControllerStateChangeEvent;
+/**
+ * Messenger type for the MultiChainAssetsRatesController.
+ */
+export type MultichainAssetsRatesControllerMessenger = RestrictedMessenger<typeof controllerName, MultichainAssetsRatesControllerActions | AllowedActions, MultichainAssetsRatesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * The input for starting polling in MultiChainAssetsRatesController.
+ */
+export type MultiChainAssetsRatesPollingInput = {
+    accountId: string;
+};
+declare const MultiChainAssetsRatesController_base: (abstract new (...args: any[]) => {
+    readonly "__#13@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#13@#intervalLength": number | undefined;
+    setIntervalLength(intervalLength: number): void;
+    getIntervalLength(): number | undefined;
+    _startPolling(input: MultiChainAssetsRatesPollingInput): void;
+    _stopPollingByPollingTokenSetId(key: string): void;
+    readonly "__#3@#pollingTokenSets": Map<string, Set<string>>;
+    "__#3@#callbacks": Map<string, Set<(input: MultiChainAssetsRatesPollingInput) => void>>;
+    _executePoll(input: MultiChainAssetsRatesPollingInput): Promise<void>;
+    startPolling(input: MultiChainAssetsRatesPollingInput): string;
+    stopAllPolling(): void;
+    stopPollingByPollingToken(pollingToken: string): void;
+    onPollingComplete(input: MultiChainAssetsRatesPollingInput, callback: (input: MultiChainAssetsRatesPollingInput) => void): void;
+}) & typeof import("@metamask/base-controller").BaseController;
+/**
+ * Controller that manages multichain token conversion rates.
+ *
+ * This controller polls for token conversion rates and updates its state.
+ */
+export declare class MultiChainAssetsRatesController extends MultiChainAssetsRatesController_base<typeof controllerName, MultichainAssetsRatesControllerState, MultichainAssetsRatesControllerMessenger> {
+    #private;
+    /**
+     * Creates an instance of MultiChainAssetsRatesController.
+     *
+     * @param options - Constructor options.
+     * @param options.interval - The polling interval in milliseconds.
+     * @param options.state - The initial state.
+     * @param options.messenger - A reference to the messaging system.
+     */
+    constructor({ interval, state, messenger, }: {
+        interval?: number;
+        state?: Partial<MultichainAssetsRatesControllerState>;
+        messenger: MultichainAssetsRatesControllerMessenger;
+    });
+    /**
+     * Executes a poll by updating token conversion rates for the current account.
+     *
+     * @returns A promise that resolves when the polling completes.
+     */
+    _executePoll(): Promise<void>;
+    /**
+     * Determines whether the controller is active.
+     *
+     * @returns True if the keyring is unlocked; otherwise, false.
+     */
+    get isActive(): boolean;
+    /**
+     * Updates token conversion rates for each non-EVM account.
+     *
+     * @returns A promise that resolves when the rates are updated.
+     */
+    updateAssetsRates(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=MultichainAssetsRatesController.d.mts.map

package/dist/MultichainAssetsRatesController/MultichainAssetsRatesController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultichainAssetsRatesController.d.mts","sourceRoot":"","sources":["../../src/MultichainAssetsRatesController/MultichainAssetsRatesController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8CAA8C,EAC9C,mCAAmC,EACpC,sCAAsC;AACvC,OAAO,KAAK,EACV,mBAAmB,EACnB,0BAA0B,EAC1B,wBAAwB,EACzB,kCAAkC;AACnC,OAAO,EAAE,KAAK,aAAa,EAAoB,8BAA8B;AAC7E,OAAO,KAAK,EACV,0BAA0B,EAC1B,4BAA4B,EAC7B,qCAAqC;AAGtC,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AACrE,OAAO,KAAK,EAEV,eAAe,EAGhB,4BAA4B;AAM7B,OAAO,KAAK,EAEV,uBAAuB,EACvB,oBAAoB,EACrB,sCAAkC;AACnC,OAAO,KAAK,EACV,wCAAwC,EAExC,0CAA0C,EAC3C,gDAAsC;AAEvC;;GAEG;AACH,QAAA,MAAM,cAAc,oCAAoC,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,eAAe,EAAE,MAAM,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;CACzD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6CAA6C,GACvD,wBAAwB,CACtB,OAAO,cAAc,EACrB,oCAAoC,CACrC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,GAAG,OAAO,cAAc,oBAAoB,CAAC;IACnD,OAAO,EAAE,+BAA+B,CAAC,mBAAmB,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,8CAA8C,IAAI,oCAAoC,CAErG;AAED;;GAEG;AACH,MAAM,MAAM,0CAA0C,GACpD,0BAA0B,CACxB,OAAO,cAAc,EACrB,oCAAoC,CACrC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAC9C,6CAA6C,GAC7C,gDAAgD,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,0CAA0C,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,iBAAiB,GACjB,8CAA8C,GAC9C,oBAAoB,GACpB,wCAAwC,CAAC;AAC7C;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,0BAA0B,GAC1B,4BAA4B,GAC5B,mCAAmC,GACnC,uBAAuB,GACvB,0CAA0C,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG,mBAAmB,CACxE,OAAO,cAAc,EACrB,sCAAsC,GAAG,cAAc,EACvD,qCAAqC,GAAG,aAAa,EACrD,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;;;;;;;;;;;;;;;;AAMF;;;;GAIG;AACH,qBAAa,+BAAgC,SAAQ,qCACnD,OAAO,cAAc,EACrB,oCAAoC,EACpC,wCAAwC,CACzC;;IASC;;;;;;;OAOG;gBACS,EACV,QAAgB,EAChB,KAAU,EACV,SAAS,GACV,EAAE;QACD,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,OAAO,CAAC,oCAAoC,CAAC,CAAC;QACtD,SAAS,EAAE,wCAAwC,CAAC;KACrD;IA8CD;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAInC;;;;OAIG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAmCD;;;;OAIG;IACG,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;CAiKzC"}