@metamask/assets-controllers 43.0.0 → 43.1.0

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [43.1.0]
+
+### Added
+
+- Add Solana to the polled exchange rates ([#4914](https://github.com/MetaMask/core/pull/4914))
+
 ## [43.0.0]
 
 ### Added
@@ -1204,7 +1210,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@43.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@43.1.0...HEAD
+[43.1.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@43.0.0...@metamask/assets-controllers@43.1.0
 [43.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@42.0.0...@metamask/assets-controllers@43.0.0
 [42.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@41.0.0...@metamask/assets-controllers@42.0.0
 [41.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@40.0.0...@metamask/assets-controllers@41.0.0

package/dist/RatesController/RatesController.cjs

@@ -17,9 +17,16 @@ const base_controller_1 = require("@metamask/base-controller");
 const async_mutex_1 = require("async-mutex");
 const crypto_compare_service_1 = require("../crypto-compare-service/index.cjs");
 exports.name = 'RatesController';
+/**
+ * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible
+ * with CryptoCompare's API which is the default source for the rates.
+ *
+ * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint
+ */
 var Cryptocurrency;
 (function (Cryptocurrency) {
     Cryptocurrency["Btc"] = "btc";
+    Cryptocurrency["Solana"] = "sol";
 })(Cryptocurrency || (exports.Cryptocurrency = Cryptocurrency = {}));
 const DEFAULT_INTERVAL = 180000;
 const metadata = {
@@ -34,8 +41,12 @@ const defaultState = {
             conversionDate: 0,
             conversionRate: 0,
         },
+        [Cryptocurrency.Solana]: {
+            conversionDate: 0,
+            conversionRate: 0,
+        },
     },
-    cryptocurrencies: [Cryptocurrency.Btc],
+    cryptocurrencies: [Cryptocurrency.Btc, Cryptocurrency.Solana],
 };
 class RatesController extends base_controller_1.BaseController {
     /**

package/dist/RatesController/RatesController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"RatesController.cjs","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAC3D,6CAAoC;AAGpC,gFAA+F;AAQlF,QAAA,IAAI,GAAG,iBAAiB,CAAC;AAEtC,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,6BAAW,CAAA;AACb,CAAC,EAFW,cAAc,8BAAd,cAAc,QAEzB;AAED,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,QAAQ,GAAG;IACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAChD,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACzC,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACrD,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,YAAY,EAAE,KAAK;IACnB,KAAK,EAAE;QACL,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YACpB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;KACF;IACD,gBAAgB,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC;CACvC,CAAC;AAEF,MAAa,eAAgB,SAAQ,gCAIpC;IAWC;;;;;;;;;OASG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAsB,GAAG,+CAAwB,GAC1B;QACvB,KAAK,CAAC;YACJ,IAAI,EAAJ,YAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAhCI,iCAAS,IAAI,mBAAK,EAAE,EAAC;QAErB,0DAAwB;QAExB,kDAAgB;QAEzB,kDAAwB;QAExB,8CAAwC;QAyBtC,uBAAA,IAAI,mCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,2CAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,mCAAmB,QAAQ,MAAA,CAAC;IAClC,CAAC;IAsED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,uBAAA,IAAI,mCAAY,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,YAAI,iBAAiB,CAAC,CAAC;QAEvD,uBAAA,IAAI,+BAAe,WAAW,CAAC,GAAG,EAAE;YAClC,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,EAAE,uBAAA,IAAI,uCAAgB,CAAC,MAAA,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,uBAAA,IAAI,mCAAY,EAAE;YACrB,OAAO;SACR;QAED,aAAa,CAAC,uBAAA,IAAI,mCAAY,CAAC,CAAC;QAChC,uBAAA,IAAI,+BAAe,SAAS,MAAA,CAAC;QAC7B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,YAAI,iBAAiB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACxC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,gBAAkC;QAElC,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,gBAAgB;iBACjB,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,YAAoB;QACxC,IAAI,YAAY,KAAK,EAAE,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC5D;QAED,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,YAAY;iBACb,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;IAC5B,CAAC;CACF;AA5LD,0CA4LC;;AAjJC;;;;;;;;;;;;;;GAcG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,KAAK,oCAAc,QAAiB;IAClC,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,8BAAO,CAAC,OAAO,EAAE,CAAC;IAChD,IAAI;QACF,OAAO,QAAQ,EAAE,CAAC;KACnB;YAAS;QACR,WAAW,EAAE,CAAC;KACf;AACH,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,KAAK,IAAI,EAAE;QAC9B,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtD,MAAM,QAAQ,GAGV,MAAM,uBAAA,IAAI,+CAAwB,MAA5B,IAAI,EACZ,YAAY,EACZ,gBAAgB,EAChB,uBAAA,IAAI,uCAAgB,CACrB,CAAC;QAEF,MAAM,YAAY,GAAoB,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC/D,YAAY,CAAC,cAAc,CAAC,GAAG;gBAC7B,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;gBAC1B,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC;gBACpC,GAAG,CAAC,uBAAA,IAAI,uCAAgB,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;aAC/D,CAAC;SACH;QAED,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;YAC3D,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport { Mutex } from 'async-mutex';\nimport type { Draft } from 'immer';\n\nimport { fetchMultiExchangeRate as defaultFetchExchangeRate } from '../crypto-compare-service';\nimport type {\n  ConversionRates,\n  RatesControllerState,\n  RatesControllerOptions,\n  RatesControllerMessenger,\n} from './types';\n\nexport const name = 'RatesController';\n\nexport enum Cryptocurrency {\n  Btc = 'btc',\n}\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst metadata = {\n  fiatCurrency: { persist: true, anonymous: true },\n  rates: { persist: true, anonymous: true },\n  cryptocurrencies: { persist: true, anonymous: true },\n};\n\nconst defaultState = {\n  fiatCurrency: 'usd',\n  rates: {\n    [Cryptocurrency.Btc]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n  },\n  cryptocurrencies: [Cryptocurrency.Btc],\n};\n\nexport class RatesController extends BaseController<\n  typeof name,\n  RatesControllerState,\n  RatesControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #fetchMultiExchangeRate;\n\n  readonly #includeUsdRate;\n\n  #intervalLength: number;\n\n  #intervalId: NodeJS.Timeout | undefined;\n\n  /**\n   * Creates a RatesController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.includeUsdRate - Keep track of the USD rate in addition to the current currency rate.\n   * @param options.interval - The polling interval, in milliseconds.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.fetchMultiExchangeRate - Fetches the exchange rate from an external API. This option is primarily meant for use in unit tests.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state,\n    includeUsdRate,\n    fetchMultiExchangeRate = defaultFetchExchangeRate,\n  }: RatesControllerOptions) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#includeUsdRate = includeUsdRate;\n    this.#fetchMultiExchangeRate = fetchMultiExchangeRate;\n    this.#intervalLength = interval;\n  }\n\n  /**\n   * Executes a function `callback` within a mutex lock to ensure that only one instance of `callback` runs at a time across all invocations of `#withLock`.\n   * This method is useful for synchronizing access to a resource or section of code that should not be executed concurrently.\n   *\n   * @template R - The return type of the function `callback`.\n   * @param callback - A callback to execute once the lock is acquired. This callback can be synchronous or asynchronous.\n   * @returns A promise that resolves to the result of the function `callback`. The promise is fulfilled once `callback` has completed execution.\n   * @example\n   * async function criticalLogic() {\n   *   // Critical logic code goes here.\n   * }\n   *\n   * // Execute criticalLogic within a lock.\n   * const result = await this.#withLock(criticalLogic);\n   */\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  async #withLock<R>(callback: () => R) {\n    const releaseLock = await this.#mutex.acquire();\n    try {\n      return callback();\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Executes the polling operation to update rates.\n   */\n  async #executePoll(): Promise<void> {\n    await this.#updateRates();\n  }\n\n  /**\n   * Updates the rates by fetching new data.\n   */\n  async #updateRates(): Promise<void> {\n    await this.#withLock(async () => {\n      const { fiatCurrency, cryptocurrencies } = this.state;\n      const response: Record<\n        Cryptocurrency,\n        Record<string, number>\n      > = await this.#fetchMultiExchangeRate(\n        fiatCurrency,\n        cryptocurrencies,\n        this.#includeUsdRate,\n      );\n\n      const updatedRates: ConversionRates = {};\n      for (const [cryptocurrency, values] of Object.entries(response)) {\n        updatedRates[cryptocurrency] = {\n          conversionDate: Date.now(),\n          conversionRate: values[fiatCurrency],\n          ...(this.#includeUsdRate && { usdConversionRate: values.usd }),\n        };\n      }\n\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            rates: updatedRates,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Starts the polling process.\n   */\n  async start(): Promise<void> {\n    if (this.#intervalId) {\n      return;\n    }\n\n    this.messagingSystem.publish(`${name}:pollingStarted`);\n\n    this.#intervalId = setInterval(() => {\n      this.#executePoll().catch(console.error);\n    }, this.#intervalLength);\n  }\n\n  /**\n   * Stops the polling process.\n   */\n  async stop(): Promise<void> {\n    if (!this.#intervalId) {\n      return;\n    }\n\n    clearInterval(this.#intervalId);\n    this.#intervalId = undefined;\n    this.messagingSystem.publish(`${name}:pollingStopped`);\n  }\n\n  /**\n   * Returns the current list of cryptocurrency.\n   * @returns The cryptocurrency list.\n   */\n  getCryptocurrencyList(): Cryptocurrency[] {\n    const { cryptocurrencies } = this.state;\n    return cryptocurrencies;\n  }\n\n  /**\n   * Sets the list of supported cryptocurrencies.\n   * @param cryptocurrencies - The list of supported cryptocurrencies.\n   */\n  async setCryptocurrencyList(\n    cryptocurrencies: Cryptocurrency[],\n  ): Promise<void> {\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            cryptocurrencies,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Sets the internal fiat currency and update rates accordingly.\n   * @param fiatCurrency - The fiat currency.\n   */\n  async setFiatCurrency(fiatCurrency: string): Promise<void> {\n    if (fiatCurrency === '') {\n      throw new Error('The currency can not be an empty string');\n    }\n\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            fiatCurrency,\n          };\n        },\n      );\n    });\n    await this.#updateRates();\n  }\n}\n"]}
+{"version":3,"file":"RatesController.cjs","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAC3D,6CAAoC;AAGpC,gFAA+F;AAQlF,QAAA,IAAI,GAAG,iBAAiB,CAAC;AAEtC;;;;;GAKG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,gCAAc,CAAA;AAChB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAED,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,QAAQ,GAAG;IACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAChD,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACzC,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACrD,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,YAAY,EAAE,KAAK;IACnB,KAAK,EAAE;QACL,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YACpB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;QACD,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YACvB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;KACF;IACD,gBAAgB,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC;CAC9D,CAAC;AAEF,MAAa,eAAgB,SAAQ,gCAIpC;IAWC;;;;;;;;;OASG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAsB,GAAG,+CAAwB,GAC1B;QACvB,KAAK,CAAC;YACJ,IAAI,EAAJ,YAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAhCI,iCAAS,IAAI,mBAAK,EAAE,EAAC;QAErB,0DAAwB;QAExB,kDAAgB;QAEzB,kDAAwB;QAExB,8CAAwC;QAyBtC,uBAAA,IAAI,mCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,2CAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,mCAAmB,QAAQ,MAAA,CAAC;IAClC,CAAC;IAsED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,uBAAA,IAAI,mCAAY,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,YAAI,iBAAiB,CAAC,CAAC;QAEvD,uBAAA,IAAI,+BAAe,WAAW,CAAC,GAAG,EAAE;YAClC,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,EAAE,uBAAA,IAAI,uCAAgB,CAAC,MAAA,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,uBAAA,IAAI,mCAAY,EAAE;YACrB,OAAO;SACR;QAED,aAAa,CAAC,uBAAA,IAAI,mCAAY,CAAC,CAAC;QAChC,uBAAA,IAAI,+BAAe,SAAS,MAAA,CAAC;QAC7B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,YAAI,iBAAiB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACxC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,gBAAkC;QAElC,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,gBAAgB;iBACjB,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,YAAoB;QACxC,IAAI,YAAY,KAAK,EAAE,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC5D;QAED,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,YAAY;iBACb,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;IAC5B,CAAC;CACF;AA5LD,0CA4LC;;AAjJC;;;;;;;;;;;;;;GAcG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,KAAK,oCAAc,QAAiB;IAClC,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,8BAAO,CAAC,OAAO,EAAE,CAAC;IAChD,IAAI;QACF,OAAO,QAAQ,EAAE,CAAC;KACnB;YAAS;QACR,WAAW,EAAE,CAAC;KACf;AACH,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,KAAK,IAAI,EAAE;QAC9B,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtD,MAAM,QAAQ,GAGV,MAAM,uBAAA,IAAI,+CAAwB,MAA5B,IAAI,EACZ,YAAY,EACZ,gBAAgB,EAChB,uBAAA,IAAI,uCAAgB,CACrB,CAAC;QAEF,MAAM,YAAY,GAAoB,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC/D,YAAY,CAAC,cAAc,CAAC,GAAG;gBAC7B,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;gBAC1B,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC;gBACpC,GAAG,CAAC,uBAAA,IAAI,uCAAgB,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;aAC/D,CAAC;SACH;QAED,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;YAC3D,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport { Mutex } from 'async-mutex';\nimport type { Draft } from 'immer';\n\nimport { fetchMultiExchangeRate as defaultFetchExchangeRate } from '../crypto-compare-service';\nimport type {\n  ConversionRates,\n  RatesControllerState,\n  RatesControllerOptions,\n  RatesControllerMessenger,\n} from './types';\n\nexport const name = 'RatesController';\n\n/**\n * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible\n * with CryptoCompare's API which is the default source for the rates.\n *\n * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint\n */\nexport enum Cryptocurrency {\n  Btc = 'btc',\n  Solana = 'sol',\n}\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst metadata = {\n  fiatCurrency: { persist: true, anonymous: true },\n  rates: { persist: true, anonymous: true },\n  cryptocurrencies: { persist: true, anonymous: true },\n};\n\nconst defaultState = {\n  fiatCurrency: 'usd',\n  rates: {\n    [Cryptocurrency.Btc]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n    [Cryptocurrency.Solana]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n  },\n  cryptocurrencies: [Cryptocurrency.Btc, Cryptocurrency.Solana],\n};\n\nexport class RatesController extends BaseController<\n  typeof name,\n  RatesControllerState,\n  RatesControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #fetchMultiExchangeRate;\n\n  readonly #includeUsdRate;\n\n  #intervalLength: number;\n\n  #intervalId: NodeJS.Timeout | undefined;\n\n  /**\n   * Creates a RatesController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.includeUsdRate - Keep track of the USD rate in addition to the current currency rate.\n   * @param options.interval - The polling interval, in milliseconds.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.fetchMultiExchangeRate - Fetches the exchange rate from an external API. This option is primarily meant for use in unit tests.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state,\n    includeUsdRate,\n    fetchMultiExchangeRate = defaultFetchExchangeRate,\n  }: RatesControllerOptions) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#includeUsdRate = includeUsdRate;\n    this.#fetchMultiExchangeRate = fetchMultiExchangeRate;\n    this.#intervalLength = interval;\n  }\n\n  /**\n   * Executes a function `callback` within a mutex lock to ensure that only one instance of `callback` runs at a time across all invocations of `#withLock`.\n   * This method is useful for synchronizing access to a resource or section of code that should not be executed concurrently.\n   *\n   * @template R - The return type of the function `callback`.\n   * @param callback - A callback to execute once the lock is acquired. This callback can be synchronous or asynchronous.\n   * @returns A promise that resolves to the result of the function `callback`. The promise is fulfilled once `callback` has completed execution.\n   * @example\n   * async function criticalLogic() {\n   *   // Critical logic code goes here.\n   * }\n   *\n   * // Execute criticalLogic within a lock.\n   * const result = await this.#withLock(criticalLogic);\n   */\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  async #withLock<R>(callback: () => R) {\n    const releaseLock = await this.#mutex.acquire();\n    try {\n      return callback();\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Executes the polling operation to update rates.\n   */\n  async #executePoll(): Promise<void> {\n    await this.#updateRates();\n  }\n\n  /**\n   * Updates the rates by fetching new data.\n   */\n  async #updateRates(): Promise<void> {\n    await this.#withLock(async () => {\n      const { fiatCurrency, cryptocurrencies } = this.state;\n      const response: Record<\n        Cryptocurrency,\n        Record<string, number>\n      > = await this.#fetchMultiExchangeRate(\n        fiatCurrency,\n        cryptocurrencies,\n        this.#includeUsdRate,\n      );\n\n      const updatedRates: ConversionRates = {};\n      for (const [cryptocurrency, values] of Object.entries(response)) {\n        updatedRates[cryptocurrency] = {\n          conversionDate: Date.now(),\n          conversionRate: values[fiatCurrency],\n          ...(this.#includeUsdRate && { usdConversionRate: values.usd }),\n        };\n      }\n\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            rates: updatedRates,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Starts the polling process.\n   */\n  async start(): Promise<void> {\n    if (this.#intervalId) {\n      return;\n    }\n\n    this.messagingSystem.publish(`${name}:pollingStarted`);\n\n    this.#intervalId = setInterval(() => {\n      this.#executePoll().catch(console.error);\n    }, this.#intervalLength);\n  }\n\n  /**\n   * Stops the polling process.\n   */\n  async stop(): Promise<void> {\n    if (!this.#intervalId) {\n      return;\n    }\n\n    clearInterval(this.#intervalId);\n    this.#intervalId = undefined;\n    this.messagingSystem.publish(`${name}:pollingStopped`);\n  }\n\n  /**\n   * Returns the current list of cryptocurrency.\n   * @returns The cryptocurrency list.\n   */\n  getCryptocurrencyList(): Cryptocurrency[] {\n    const { cryptocurrencies } = this.state;\n    return cryptocurrencies;\n  }\n\n  /**\n   * Sets the list of supported cryptocurrencies.\n   * @param cryptocurrencies - The list of supported cryptocurrencies.\n   */\n  async setCryptocurrencyList(\n    cryptocurrencies: Cryptocurrency[],\n  ): Promise<void> {\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            cryptocurrencies,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Sets the internal fiat currency and update rates accordingly.\n   * @param fiatCurrency - The fiat currency.\n   */\n  async setFiatCurrency(fiatCurrency: string): Promise<void> {\n    if (fiatCurrency === '') {\n      throw new Error('The currency can not be an empty string');\n    }\n\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            fiatCurrency,\n          };\n        },\n      );\n    });\n    await this.#updateRates();\n  }\n}\n"]}

package/dist/RatesController/RatesController.d.cts

@@ -1,8 +1,15 @@
 import { BaseController } from "@metamask/base-controller";
 import type { RatesControllerState, RatesControllerOptions, RatesControllerMessenger } from "./types.cjs";
 export declare const name = "RatesController";
+/**
+ * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible
+ * with CryptoCompare's API which is the default source for the rates.
+ *
+ * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint
+ */
 export declare enum Cryptocurrency {
-    Btc = "btc"
+    Btc = "btc",
+    Solana = "sol"
 }
 export declare class RatesController extends BaseController<typeof name, RatesControllerState, RatesControllerMessenger> {
     #private;

package/dist/RatesController/RatesController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"RatesController.d.cts","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACzB,oBAAgB;AAEjB,eAAO,MAAM,IAAI,oBAAoB,CAAC;AAEtC,oBAAY,cAAc;IACxB,GAAG,QAAQ;CACZ;AAqBD,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,IAAI,EACX,oBAAoB,EACpB,wBAAwB,CACzB;;IAWC;;;;;;;;;OASG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAiD,GAClD,EAAE,sBAAsB;IAgFzB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B;;;OAGG;IACH,qBAAqB,IAAI,cAAc,EAAE;IAKzC;;;OAGG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,cAAc,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB3D"}
+{"version":3,"file":"RatesController.d.cts","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACzB,oBAAgB;AAEjB,eAAO,MAAM,IAAI,oBAAoB,CAAC;AAEtC;;;;;GAKG;AACH,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,MAAM,QAAQ;CACf;AAyBD,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,IAAI,EACX,oBAAoB,EACpB,wBAAwB,CACzB;;IAWC;;;;;;;;;OASG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAiD,GAClD,EAAE,sBAAsB;IAgFzB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B;;;OAGG;IACH,qBAAqB,IAAI,cAAc,EAAE;IAKzC;;;OAGG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,cAAc,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB3D"}

package/dist/RatesController/RatesController.d.mts

@@ -1,8 +1,15 @@
 import { BaseController } from "@metamask/base-controller";
 import type { RatesControllerState, RatesControllerOptions, RatesControllerMessenger } from "./types.mjs";
 export declare const name = "RatesController";
+/**
+ * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible
+ * with CryptoCompare's API which is the default source for the rates.
+ *
+ * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint
+ */
 export declare enum Cryptocurrency {
-    Btc = "btc"
+    Btc = "btc",
+    Solana = "sol"
 }
 export declare class RatesController extends BaseController<typeof name, RatesControllerState, RatesControllerMessenger> {
     #private;

package/dist/RatesController/RatesController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"RatesController.d.mts","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACzB,oBAAgB;AAEjB,eAAO,MAAM,IAAI,oBAAoB,CAAC;AAEtC,oBAAY,cAAc;IACxB,GAAG,QAAQ;CACZ;AAqBD,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,IAAI,EACX,oBAAoB,EACpB,wBAAwB,CACzB;;IAWC;;;;;;;;;OASG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAiD,GAClD,EAAE,sBAAsB;IAgFzB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B;;;OAGG;IACH,qBAAqB,IAAI,cAAc,EAAE;IAKzC;;;OAGG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,cAAc,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB3D"}
+{"version":3,"file":"RatesController.d.mts","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,KAAK,EAEV,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACzB,oBAAgB;AAEjB,eAAO,MAAM,IAAI,oBAAoB,CAAC;AAEtC;;;;;GAKG;AACH,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,MAAM,QAAQ;CACf;AAyBD,qBAAa,eAAgB,SAAQ,cAAc,CACjD,OAAO,IAAI,EACX,oBAAoB,EACpB,wBAAwB,CACzB;;IAWC;;;;;;;;;OASG;gBACS,EACV,QAA2B,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAiD,GAClD,EAAE,sBAAsB;IAgFzB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAY5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B;;;OAGG;IACH,qBAAqB,IAAI,cAAc,EAAE;IAKzC;;;OAGG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,cAAc,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAiB3D"}

package/dist/RatesController/RatesController.mjs

@@ -14,9 +14,16 @@ import { BaseController } from "@metamask/base-controller";
 import { Mutex } from "async-mutex";
 import { fetchMultiExchangeRate as defaultFetchExchangeRate } from "../crypto-compare-service/index.mjs";
 export const name = 'RatesController';
+/**
+ * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible
+ * with CryptoCompare's API which is the default source for the rates.
+ *
+ * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint
+ */
 export var Cryptocurrency;
 (function (Cryptocurrency) {
     Cryptocurrency["Btc"] = "btc";
+    Cryptocurrency["Solana"] = "sol";
 })(Cryptocurrency || (Cryptocurrency = {}));
 const DEFAULT_INTERVAL = 180000;
 const metadata = {
@@ -31,8 +38,12 @@ const defaultState = {
             conversionDate: 0,
             conversionRate: 0,
         },
+        [Cryptocurrency.Solana]: {
+            conversionDate: 0,
+            conversionRate: 0,
+        },
     },
-    cryptocurrencies: [Cryptocurrency.Btc],
+    cryptocurrencies: [Cryptocurrency.Btc, Cryptocurrency.Solana],
 };
 export class RatesController extends BaseController {
     /**

package/dist/RatesController/RatesController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"RatesController.mjs","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAAE,KAAK,EAAE,oBAAoB;AAGpC,OAAO,EAAE,sBAAsB,IAAI,wBAAwB,EAAE,4CAAkC;AAQ/F,MAAM,CAAC,MAAM,IAAI,GAAG,iBAAiB,CAAC;AAEtC,MAAM,CAAN,IAAY,cAEX;AAFD,WAAY,cAAc;IACxB,6BAAW,CAAA;AACb,CAAC,EAFW,cAAc,KAAd,cAAc,QAEzB;AAED,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,QAAQ,GAAG;IACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAChD,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACzC,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACrD,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,YAAY,EAAE,KAAK;IACnB,KAAK,EAAE;QACL,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YACpB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;KACF;IACD,gBAAgB,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC;CACvC,CAAC;AAEF,MAAM,OAAO,eAAgB,SAAQ,cAIpC;IAWC;;;;;;;;;OASG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAsB,GAAG,wBAAwB,GAC1B;QACvB,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAhCI,iCAAS,IAAI,KAAK,EAAE,EAAC;QAErB,0DAAwB;QAExB,kDAAgB;QAEzB,kDAAwB;QAExB,8CAAwC;QAyBtC,uBAAA,IAAI,mCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,2CAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,mCAAmB,QAAQ,MAAA,CAAC;IAClC,CAAC;IAsED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,uBAAA,IAAI,mCAAY,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;QAEvD,uBAAA,IAAI,+BAAe,WAAW,CAAC,GAAG,EAAE;YAClC,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,EAAE,uBAAA,IAAI,uCAAgB,CAAC,MAAA,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,uBAAA,IAAI,mCAAY,EAAE;YACrB,OAAO;SACR;QAED,aAAa,CAAC,uBAAA,IAAI,mCAAY,CAAC,CAAC;QAChC,uBAAA,IAAI,+BAAe,SAAS,MAAA,CAAC;QAC7B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACxC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,gBAAkC;QAElC,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,gBAAgB;iBACjB,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,YAAoB;QACxC,IAAI,YAAY,KAAK,EAAE,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC5D;QAED,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,YAAY;iBACb,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;IAC5B,CAAC;CACF;;AAjJC;;;;;;;;;;;;;;GAcG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,KAAK,oCAAc,QAAiB;IAClC,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,8BAAO,CAAC,OAAO,EAAE,CAAC;IAChD,IAAI;QACF,OAAO,QAAQ,EAAE,CAAC;KACnB;YAAS;QACR,WAAW,EAAE,CAAC;KACf;AACH,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,KAAK,IAAI,EAAE;QAC9B,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtD,MAAM,QAAQ,GAGV,MAAM,uBAAA,IAAI,+CAAwB,MAA5B,IAAI,EACZ,YAAY,EACZ,gBAAgB,EAChB,uBAAA,IAAI,uCAAgB,CACrB,CAAC;QAEF,MAAM,YAAY,GAAoB,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC/D,YAAY,CAAC,cAAc,CAAC,GAAG;gBAC7B,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;gBAC1B,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC;gBACpC,GAAG,CAAC,uBAAA,IAAI,uCAAgB,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;aAC/D,CAAC;SACH;QAED,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;YAC3D,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport { Mutex } from 'async-mutex';\nimport type { Draft } from 'immer';\n\nimport { fetchMultiExchangeRate as defaultFetchExchangeRate } from '../crypto-compare-service';\nimport type {\n  ConversionRates,\n  RatesControllerState,\n  RatesControllerOptions,\n  RatesControllerMessenger,\n} from './types';\n\nexport const name = 'RatesController';\n\nexport enum Cryptocurrency {\n  Btc = 'btc',\n}\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst metadata = {\n  fiatCurrency: { persist: true, anonymous: true },\n  rates: { persist: true, anonymous: true },\n  cryptocurrencies: { persist: true, anonymous: true },\n};\n\nconst defaultState = {\n  fiatCurrency: 'usd',\n  rates: {\n    [Cryptocurrency.Btc]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n  },\n  cryptocurrencies: [Cryptocurrency.Btc],\n};\n\nexport class RatesController extends BaseController<\n  typeof name,\n  RatesControllerState,\n  RatesControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #fetchMultiExchangeRate;\n\n  readonly #includeUsdRate;\n\n  #intervalLength: number;\n\n  #intervalId: NodeJS.Timeout | undefined;\n\n  /**\n   * Creates a RatesController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.includeUsdRate - Keep track of the USD rate in addition to the current currency rate.\n   * @param options.interval - The polling interval, in milliseconds.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.fetchMultiExchangeRate - Fetches the exchange rate from an external API. This option is primarily meant for use in unit tests.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state,\n    includeUsdRate,\n    fetchMultiExchangeRate = defaultFetchExchangeRate,\n  }: RatesControllerOptions) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#includeUsdRate = includeUsdRate;\n    this.#fetchMultiExchangeRate = fetchMultiExchangeRate;\n    this.#intervalLength = interval;\n  }\n\n  /**\n   * Executes a function `callback` within a mutex lock to ensure that only one instance of `callback` runs at a time across all invocations of `#withLock`.\n   * This method is useful for synchronizing access to a resource or section of code that should not be executed concurrently.\n   *\n   * @template R - The return type of the function `callback`.\n   * @param callback - A callback to execute once the lock is acquired. This callback can be synchronous or asynchronous.\n   * @returns A promise that resolves to the result of the function `callback`. The promise is fulfilled once `callback` has completed execution.\n   * @example\n   * async function criticalLogic() {\n   *   // Critical logic code goes here.\n   * }\n   *\n   * // Execute criticalLogic within a lock.\n   * const result = await this.#withLock(criticalLogic);\n   */\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  async #withLock<R>(callback: () => R) {\n    const releaseLock = await this.#mutex.acquire();\n    try {\n      return callback();\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Executes the polling operation to update rates.\n   */\n  async #executePoll(): Promise<void> {\n    await this.#updateRates();\n  }\n\n  /**\n   * Updates the rates by fetching new data.\n   */\n  async #updateRates(): Promise<void> {\n    await this.#withLock(async () => {\n      const { fiatCurrency, cryptocurrencies } = this.state;\n      const response: Record<\n        Cryptocurrency,\n        Record<string, number>\n      > = await this.#fetchMultiExchangeRate(\n        fiatCurrency,\n        cryptocurrencies,\n        this.#includeUsdRate,\n      );\n\n      const updatedRates: ConversionRates = {};\n      for (const [cryptocurrency, values] of Object.entries(response)) {\n        updatedRates[cryptocurrency] = {\n          conversionDate: Date.now(),\n          conversionRate: values[fiatCurrency],\n          ...(this.#includeUsdRate && { usdConversionRate: values.usd }),\n        };\n      }\n\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            rates: updatedRates,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Starts the polling process.\n   */\n  async start(): Promise<void> {\n    if (this.#intervalId) {\n      return;\n    }\n\n    this.messagingSystem.publish(`${name}:pollingStarted`);\n\n    this.#intervalId = setInterval(() => {\n      this.#executePoll().catch(console.error);\n    }, this.#intervalLength);\n  }\n\n  /**\n   * Stops the polling process.\n   */\n  async stop(): Promise<void> {\n    if (!this.#intervalId) {\n      return;\n    }\n\n    clearInterval(this.#intervalId);\n    this.#intervalId = undefined;\n    this.messagingSystem.publish(`${name}:pollingStopped`);\n  }\n\n  /**\n   * Returns the current list of cryptocurrency.\n   * @returns The cryptocurrency list.\n   */\n  getCryptocurrencyList(): Cryptocurrency[] {\n    const { cryptocurrencies } = this.state;\n    return cryptocurrencies;\n  }\n\n  /**\n   * Sets the list of supported cryptocurrencies.\n   * @param cryptocurrencies - The list of supported cryptocurrencies.\n   */\n  async setCryptocurrencyList(\n    cryptocurrencies: Cryptocurrency[],\n  ): Promise<void> {\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            cryptocurrencies,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Sets the internal fiat currency and update rates accordingly.\n   * @param fiatCurrency - The fiat currency.\n   */\n  async setFiatCurrency(fiatCurrency: string): Promise<void> {\n    if (fiatCurrency === '') {\n      throw new Error('The currency can not be an empty string');\n    }\n\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            fiatCurrency,\n          };\n        },\n      );\n    });\n    await this.#updateRates();\n  }\n}\n"]}
+{"version":3,"file":"RatesController.mjs","sourceRoot":"","sources":["../../src/RatesController/RatesController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,EAAE,KAAK,EAAE,oBAAoB;AAGpC,OAAO,EAAE,sBAAsB,IAAI,wBAAwB,EAAE,4CAAkC;AAQ/F,MAAM,CAAC,MAAM,IAAI,GAAG,iBAAiB,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,gCAAc,CAAA;AAChB,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AAED,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEhC,MAAM,QAAQ,GAAG;IACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAChD,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACzC,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACrD,CAAC;AAEF,MAAM,YAAY,GAAG;IACnB,YAAY,EAAE,KAAK;IACnB,KAAK,EAAE;QACL,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YACpB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;QACD,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YACvB,cAAc,EAAE,CAAC;YACjB,cAAc,EAAE,CAAC;SAClB;KACF;IACD,gBAAgB,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC;CAC9D,CAAC;AAEF,MAAM,OAAO,eAAgB,SAAQ,cAIpC;IAWC;;;;;;;;;OASG;IACH,YAAY,EACV,QAAQ,GAAG,gBAAgB,EAC3B,SAAS,EACT,KAAK,EACL,cAAc,EACd,sBAAsB,GAAG,wBAAwB,GAC1B;QACvB,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,EAAE,EAAE,GAAG,YAAY,EAAE,GAAG,KAAK,EAAE;SACrC,CAAC,CAAC;;QAhCI,iCAAS,IAAI,KAAK,EAAE,EAAC;QAErB,0DAAwB;QAExB,kDAAgB;QAEzB,kDAAwB;QAExB,8CAAwC;QAyBtC,uBAAA,IAAI,mCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,2CAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,mCAAmB,QAAQ,MAAA,CAAC;IAClC,CAAC;IAsED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,uBAAA,IAAI,mCAAY,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;QAEvD,uBAAA,IAAI,+BAAe,WAAW,CAAC,GAAG,EAAE;YAClC,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC,EAAE,uBAAA,IAAI,uCAAgB,CAAC,MAAA,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,uBAAA,IAAI,mCAAY,EAAE;YACrB,OAAO;SACR;QAED,aAAa,CAAC,uBAAA,IAAI,mCAAY,CAAC,CAAC;QAChC,uBAAA,IAAI,+BAAe,SAAS,MAAA,CAAC;QAC7B,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,IAAI,iBAAiB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACxC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,gBAAkC;QAElC,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,gBAAgB;iBACjB,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,YAAoB;QACxC,IAAI,YAAY,KAAK,EAAE,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC5D;QAED,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,GAAG,EAAE;YACxB,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;gBAC3D,OAAO;oBACL,GAAG,KAAK;oBACR,YAAY;iBACb,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;IAC5B,CAAC;CACF;;AAjJC;;;;;;;;;;;;;;GAcG;AACH,gFAAgF;AAChF,gEAAgE;AAChE,KAAK,oCAAc,QAAiB;IAClC,MAAM,WAAW,GAAG,MAAM,uBAAA,IAAI,8BAAO,CAAC,OAAO,EAAE,CAAC;IAChD,IAAI;QACF,OAAO,QAAQ,EAAE,CAAC;KACnB;YAAS;QACR,WAAW,EAAE,CAAC;KACf;AACH,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,gEAAa,MAAjB,IAAI,CAAe,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,KAAK;IACH,MAAM,uBAAA,IAAI,6DAAU,MAAd,IAAI,EAAW,KAAK,IAAI,EAAE;QAC9B,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtD,MAAM,QAAQ,GAGV,MAAM,uBAAA,IAAI,+CAAwB,MAA5B,IAAI,EACZ,YAAY,EACZ,gBAAgB,EAChB,uBAAA,IAAI,uCAAgB,CACrB,CAAC;QAEF,MAAM,YAAY,GAAoB,EAAE,CAAC;QACzC,KAAK,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC/D,YAAY,CAAC,cAAc,CAAC,GAAG;gBAC7B,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;gBAC1B,cAAc,EAAE,MAAM,CAAC,YAAY,CAAC;gBACpC,GAAG,CAAC,uBAAA,IAAI,uCAAgB,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;aAC/D,CAAC;SACH;QAED,IAAI,CAAC,MAAM,CACT,CAAC,KAAkC,EAAwB,EAAE;YAC3D,OAAO;gBACL,GAAG,KAAK;gBACR,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport { Mutex } from 'async-mutex';\nimport type { Draft } from 'immer';\n\nimport { fetchMultiExchangeRate as defaultFetchExchangeRate } from '../crypto-compare-service';\nimport type {\n  ConversionRates,\n  RatesControllerState,\n  RatesControllerOptions,\n  RatesControllerMessenger,\n} from './types';\n\nexport const name = 'RatesController';\n\n/**\n * Supported cryptocurrencies that can be used as a base currency. The value needs to be compatible\n * with CryptoCompare's API which is the default source for the rates.\n *\n * See: https://min-api.cryptocompare.com/documentation?key=Price&cat=multipleSymbolsPriceEndpoint\n */\nexport enum Cryptocurrency {\n  Btc = 'btc',\n  Solana = 'sol',\n}\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst metadata = {\n  fiatCurrency: { persist: true, anonymous: true },\n  rates: { persist: true, anonymous: true },\n  cryptocurrencies: { persist: true, anonymous: true },\n};\n\nconst defaultState = {\n  fiatCurrency: 'usd',\n  rates: {\n    [Cryptocurrency.Btc]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n    [Cryptocurrency.Solana]: {\n      conversionDate: 0,\n      conversionRate: 0,\n    },\n  },\n  cryptocurrencies: [Cryptocurrency.Btc, Cryptocurrency.Solana],\n};\n\nexport class RatesController extends BaseController<\n  typeof name,\n  RatesControllerState,\n  RatesControllerMessenger\n> {\n  readonly #mutex = new Mutex();\n\n  readonly #fetchMultiExchangeRate;\n\n  readonly #includeUsdRate;\n\n  #intervalLength: number;\n\n  #intervalId: NodeJS.Timeout | undefined;\n\n  /**\n   * Creates a RatesController instance.\n   *\n   * @param options - Constructor options.\n   * @param options.includeUsdRate - Keep track of the USD rate in addition to the current currency rate.\n   * @param options.interval - The polling interval, in milliseconds.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.state - Initial state to set on this controller.\n   * @param options.fetchMultiExchangeRate - Fetches the exchange rate from an external API. This option is primarily meant for use in unit tests.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    state,\n    includeUsdRate,\n    fetchMultiExchangeRate = defaultFetchExchangeRate,\n  }: RatesControllerOptions) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: { ...defaultState, ...state },\n    });\n    this.#includeUsdRate = includeUsdRate;\n    this.#fetchMultiExchangeRate = fetchMultiExchangeRate;\n    this.#intervalLength = interval;\n  }\n\n  /**\n   * Executes a function `callback` within a mutex lock to ensure that only one instance of `callback` runs at a time across all invocations of `#withLock`.\n   * This method is useful for synchronizing access to a resource or section of code that should not be executed concurrently.\n   *\n   * @template R - The return type of the function `callback`.\n   * @param callback - A callback to execute once the lock is acquired. This callback can be synchronous or asynchronous.\n   * @returns A promise that resolves to the result of the function `callback`. The promise is fulfilled once `callback` has completed execution.\n   * @example\n   * async function criticalLogic() {\n   *   // Critical logic code goes here.\n   * }\n   *\n   * // Execute criticalLogic within a lock.\n   * const result = await this.#withLock(criticalLogic);\n   */\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  async #withLock<R>(callback: () => R) {\n    const releaseLock = await this.#mutex.acquire();\n    try {\n      return callback();\n    } finally {\n      releaseLock();\n    }\n  }\n\n  /**\n   * Executes the polling operation to update rates.\n   */\n  async #executePoll(): Promise<void> {\n    await this.#updateRates();\n  }\n\n  /**\n   * Updates the rates by fetching new data.\n   */\n  async #updateRates(): Promise<void> {\n    await this.#withLock(async () => {\n      const { fiatCurrency, cryptocurrencies } = this.state;\n      const response: Record<\n        Cryptocurrency,\n        Record<string, number>\n      > = await this.#fetchMultiExchangeRate(\n        fiatCurrency,\n        cryptocurrencies,\n        this.#includeUsdRate,\n      );\n\n      const updatedRates: ConversionRates = {};\n      for (const [cryptocurrency, values] of Object.entries(response)) {\n        updatedRates[cryptocurrency] = {\n          conversionDate: Date.now(),\n          conversionRate: values[fiatCurrency],\n          ...(this.#includeUsdRate && { usdConversionRate: values.usd }),\n        };\n      }\n\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            rates: updatedRates,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Starts the polling process.\n   */\n  async start(): Promise<void> {\n    if (this.#intervalId) {\n      return;\n    }\n\n    this.messagingSystem.publish(`${name}:pollingStarted`);\n\n    this.#intervalId = setInterval(() => {\n      this.#executePoll().catch(console.error);\n    }, this.#intervalLength);\n  }\n\n  /**\n   * Stops the polling process.\n   */\n  async stop(): Promise<void> {\n    if (!this.#intervalId) {\n      return;\n    }\n\n    clearInterval(this.#intervalId);\n    this.#intervalId = undefined;\n    this.messagingSystem.publish(`${name}:pollingStopped`);\n  }\n\n  /**\n   * Returns the current list of cryptocurrency.\n   * @returns The cryptocurrency list.\n   */\n  getCryptocurrencyList(): Cryptocurrency[] {\n    const { cryptocurrencies } = this.state;\n    return cryptocurrencies;\n  }\n\n  /**\n   * Sets the list of supported cryptocurrencies.\n   * @param cryptocurrencies - The list of supported cryptocurrencies.\n   */\n  async setCryptocurrencyList(\n    cryptocurrencies: Cryptocurrency[],\n  ): Promise<void> {\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            cryptocurrencies,\n          };\n        },\n      );\n    });\n  }\n\n  /**\n   * Sets the internal fiat currency and update rates accordingly.\n   * @param fiatCurrency - The fiat currency.\n   */\n  async setFiatCurrency(fiatCurrency: string): Promise<void> {\n    if (fiatCurrency === '') {\n      throw new Error('The currency can not be an empty string');\n    }\n\n    await this.#withLock(() => {\n      this.update(\n        (state: Draft<RatesControllerState>): RatesControllerState => {\n          return {\n            ...state,\n            fiatCurrency,\n          };\n        },\n      );\n    });\n    await this.#updateRates();\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/assets-controllers",
-  "version": "43.0.0",
+  "version": "43.1.0",
   "description": "Controllers which manage interactions involving ERC-20, ERC-721, and ERC-1155 tokens (including NFTs)",
   "keywords": [
     "MetaMask",