@metamask/assets-controllers 45.1.1 → 46.0.0

package/CHANGELOG.md

@@ -7,6 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [46.0.0]
+
+### Added
+
+- Add new `MultichainBalancesController` ([#4965](https://github.com/MetaMask/core/pull/4965))
+  - This controller has been migrated from the MetaMask extension codebase.
+- Added utility function `getKeyByValue` ([#5099](https://github.com/MetaMask/core/pull/5099))
+
+### Changed
+
+- **BREAKING:** Bump `@metamask/accounts-controller` peer dependency from `^20.0.0` to `^21.0.0` ([#5140](https://github.com/MetaMask/core/pull/5140))
+- Bump `@metamask/base-controller` from `^7.0.0` to `^7.1.1` ([#5079](https://github.com/MetaMask/core/pull/5079)), ([#5135](https://github.com/MetaMask/core/pull/5135))
+- Bump `@metamask/keyring-api` from `^12.0.0` to `^13.0.0` ([#5066](https://github.com/MetaMask/core/pull/5066))
+- Bump `@metamask/utils` to `^11.0.1` ([#5080](https://github.com/MetaMask/core/pull/5080))
+- Bump `@metamask/rpc-errors` to `^7.0.2` ([#5080](https://github.com/MetaMask/core/pull/5080))
+
+### Fixed
+
+- Fix Mantle price when calling `fetchMultiExchangeRate` ([#5099](https://github.com/MetaMask/core/pull/5099))
+- Fix multicall revert in `TokenBalancesController` ([#5083](https://github.com/MetaMask/core/pull/5083))
+  - `TokenBalancesController` was fixed to fetch erc20 token balances even if there's an invalid token in state whose address does not point to a smart contract.
+- Fix state changes for `ignoreTokens` for non-selected networks ([#5014](https://github.com/MetaMask/core/pull/5014))
+
+## [45.1.2]
+
+### Changed
+
+- Remove use of `@metamask/keyring-api` ([#4695](https://github.com/MetaMask/core/pull/4695))
+  - `@metamask/providers` and `webextension-polyfill` peer dependencies are no longer required.
+- Use new `@metamask/keyring-internal-api@^1.0.0` ([#4695](https://github.com/MetaMask/core/pull/4695))
+  - This package has been split out from the Keyring API. Its types are compatible with the `@metamask/keyring-api` package used previously.
+
 ## [45.1.1]
 
 ### Changed
@@ -1291,7 +1323,9 @@ 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@45.1.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@46.0.0...HEAD
+[46.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@45.1.2...@metamask/assets-controllers@46.0.0
+[45.1.2]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@45.1.1...@metamask/assets-controllers@45.1.2
 [45.1.1]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@45.1.0...@metamask/assets-controllers@45.1.1
 [45.1.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@45.0.0...@metamask/assets-controllers@45.1.0
 [45.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@44.1.0...@metamask/assets-controllers@45.0.0

package/dist/AccountTrackerController.d.cts

@@ -65,8 +65,8 @@ type AccountTrackerPollingInput = {
     networkClientId: NetworkClientId;
 };
 declare const AccountTrackerController_base: (abstract new (...args: any[]) => {
-    readonly "__#11@#intervalIds": Record<string, NodeJS.Timeout>;
-    "__#11@#intervalLength": number | undefined;
+    readonly "__#13@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#13@#intervalLength": number | undefined;
     setIntervalLength(intervalLength: number): void;
     getIntervalLength(): number | undefined;
     _startPolling(input: AccountTrackerPollingInput): void;

package/dist/AccountTrackerController.d.mts

@@ -65,8 +65,8 @@ type AccountTrackerPollingInput = {
     networkClientId: NetworkClientId;
 };
 declare const AccountTrackerController_base: (abstract new (...args: any[]) => {
-    readonly "__#11@#intervalIds": Record<string, NodeJS.Timeout>;
-    "__#11@#intervalLength": number | undefined;
+    readonly "__#13@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#13@#intervalLength": number | undefined;
     setIntervalLength(intervalLength: number): void;
     getIntervalLength(): number | undefined;
     _startPolling(input: AccountTrackerPollingInput): void;

package/dist/CurrencyRateController.d.cts

@@ -29,8 +29,8 @@ type CurrencyRatePollingInput = {
     nativeCurrencies: string[];
 };
 declare const CurrencyRateController_base: (abstract new (...args: any[]) => {
-    readonly "__#11@#intervalIds": Record<string, NodeJS.Timeout>;
-    "__#11@#intervalLength": number | undefined;
+    readonly "__#13@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#13@#intervalLength": number | undefined;
     setIntervalLength(intervalLength: number): void;
     getIntervalLength(): number | undefined;
     _startPolling(input: CurrencyRatePollingInput): void;

package/dist/CurrencyRateController.d.mts

@@ -29,8 +29,8 @@ type CurrencyRatePollingInput = {
     nativeCurrencies: string[];
 };
 declare const CurrencyRateController_base: (abstract new (...args: any[]) => {
-    readonly "__#11@#intervalIds": Record<string, NodeJS.Timeout>;
-    "__#11@#intervalLength": number | undefined;
+    readonly "__#13@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#13@#intervalLength": number | undefined;
     setIntervalLength(intervalLength: number): void;
     getIntervalLength(): number | undefined;
     _startPolling(input: CurrencyRatePollingInput): void;

package/dist/MultichainBalancesController/BalancesTracker.cjs

@@ -0,0 +1,122 @@
+"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 _BalancesTracker_instances, _BalancesTracker_poller, _BalancesTracker_updateBalance, _BalancesTracker_balances, _BalancesTracker_isBalanceOutdated;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BalancesTracker = void 0;
+const Poller_1 = require("./Poller.cjs");
+const BALANCES_TRACKING_INTERVAL = 5000; // Every 5s in milliseconds.
+class BalancesTracker {
+    constructor(updateBalanceCallback) {
+        _BalancesTracker_instances.add(this);
+        _BalancesTracker_poller.set(this, void 0);
+        _BalancesTracker_updateBalance.set(this, void 0);
+        _BalancesTracker_balances.set(this, {});
+        __classPrivateFieldSet(this, _BalancesTracker_updateBalance, updateBalanceCallback, "f");
+        __classPrivateFieldSet(this, _BalancesTracker_poller, new Poller_1.Poller(() => this.updateBalances(), BALANCES_TRACKING_INTERVAL), "f");
+    }
+    /**
+     * Starts the tracking process.
+     */
+    start() {
+        __classPrivateFieldGet(this, _BalancesTracker_poller, "f").start();
+    }
+    /**
+     * Stops the tracking process.
+     */
+    stop() {
+        __classPrivateFieldGet(this, _BalancesTracker_poller, "f").stop();
+    }
+    /**
+     * Checks if an account ID is being tracked.
+     *
+     * @param accountId - The account ID.
+     * @returns True if the account is being tracked, false otherwise.
+     */
+    isTracked(accountId) {
+        return Object.prototype.hasOwnProperty.call(__classPrivateFieldGet(this, _BalancesTracker_balances, "f"), accountId);
+    }
+    /**
+     * Asserts that an account ID is being tracked.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    assertBeingTracked(accountId) {
+        if (!this.isTracked(accountId)) {
+            throw new Error(`Account is not being tracked: ${accountId}`);
+        }
+    }
+    /**
+     * Starts tracking a new account ID. This method has no effect on already tracked
+     * accounts.
+     *
+     * @param accountId - The account ID.
+     * @param blockTime - The block time (used when refreshing the account balances).
+     */
+    track(accountId, blockTime) {
+        // Do not overwrite current info if already being tracked!
+        if (!this.isTracked(accountId)) {
+            __classPrivateFieldGet(this, _BalancesTracker_balances, "f")[accountId] = {
+                lastUpdated: 0,
+                blockTime,
+            };
+        }
+    }
+    /**
+     * Stops tracking a tracked account ID.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    untrack(accountId) {
+        this.assertBeingTracked(accountId);
+        delete __classPrivateFieldGet(this, _BalancesTracker_balances, "f")[accountId];
+    }
+    /**
+     * Update the balances for a tracked account ID.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    async updateBalance(accountId) {
+        this.assertBeingTracked(accountId);
+        // We check if the balance is outdated (by comparing to the block time associated
+        // with this kind of account).
+        //
+        // This might not be super accurate, but we could probably compute this differently
+        // and try to sync with the "real block time"!
+        const info = __classPrivateFieldGet(this, _BalancesTracker_balances, "f")[accountId];
+        if (__classPrivateFieldGet(this, _BalancesTracker_instances, "m", _BalancesTracker_isBalanceOutdated).call(this, info)) {
+            await __classPrivateFieldGet(this, _BalancesTracker_updateBalance, "f").call(this, accountId);
+            __classPrivateFieldGet(this, _BalancesTracker_balances, "f")[accountId].lastUpdated = Date.now();
+        }
+    }
+    /**
+     * Update the balances of all tracked accounts (only if the balances
+     * is considered outdated).
+     */
+    async updateBalances() {
+        await Promise.allSettled(Object.keys(__classPrivateFieldGet(this, _BalancesTracker_balances, "f")).map(async (accountId) => {
+            await this.updateBalance(accountId);
+        }));
+    }
+}
+exports.BalancesTracker = BalancesTracker;
+_BalancesTracker_poller = new WeakMap(), _BalancesTracker_updateBalance = new WeakMap(), _BalancesTracker_balances = new WeakMap(), _BalancesTracker_instances = new WeakSet(), _BalancesTracker_isBalanceOutdated = function _BalancesTracker_isBalanceOutdated({ lastUpdated, blockTime }) {
+    return (
+    // Never been updated:
+    lastUpdated === 0 ||
+        // Outdated:
+        Date.now() - lastUpdated >= blockTime);
+};
+//# sourceMappingURL=BalancesTracker.cjs.map

package/dist/MultichainBalancesController/BalancesTracker.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"BalancesTracker.cjs","sourceRoot":"","sources":["../../src/MultichainBalancesController/BalancesTracker.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,yCAAkC;AAOlC,MAAM,0BAA0B,GAAG,IAAI,CAAC,CAAC,4BAA4B;AAErE,MAAa,eAAe;IAO1B,YAAY,qBAA2D;;QANvE,0CAAgB;QAEhB,iDAAqD;QAErD,oCAAyC,EAAE,EAAC;QAG1C,uBAAA,IAAI,kCAAkB,qBAAqB,MAAA,CAAC;QAE5C,uBAAA,IAAI,2BAAW,IAAI,eAAM,CACvB,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,EAC3B,0BAA0B,CAC3B,MAAA,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK;QACH,uBAAA,IAAI,+BAAQ,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,uBAAA,IAAI,+BAAQ,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,SAAiB;QACzB,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,uBAAA,IAAI,iCAAU,EAAE,SAAS,CAAC,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,SAAiB;QAClC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,iCAAiC,SAAS,EAAE,CAAC,CAAC;SAC/D;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAiB,EAAE,SAAiB;QACxC,0DAA0D;QAC1D,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;YAC9B,uBAAA,IAAI,iCAAU,CAAC,SAAS,CAAC,GAAG;gBAC1B,WAAW,EAAE,CAAC;gBACd,SAAS;aACV,CAAC;SACH;IACH,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,SAAiB;QACvB,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACnC,OAAO,uBAAA,IAAI,iCAAU,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,SAAiB;QACnC,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAEnC,iFAAiF;QACjF,8BAA8B;QAC9B,EAAE;QACF,mFAAmF;QACnF,8CAA8C;QAC9C,MAAM,IAAI,GAAG,uBAAA,IAAI,iCAAU,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,uBAAA,IAAI,sEAAmB,MAAvB,IAAI,EAAoB,IAAI,CAAC,EAAE;YACjC,MAAM,uBAAA,IAAI,sCAAe,MAAnB,IAAI,EAAgB,SAAS,CAAC,CAAC;YACrC,uBAAA,IAAI,iCAAU,CAAC,SAAS,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;SACpD;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,OAAO,CAAC,UAAU,CACtB,MAAM,CAAC,IAAI,CAAC,uBAAA,IAAI,iCAAU,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YAClD,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QACtC,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CAkBF;AAjID,0CAiIC;iQARoB,EAAE,WAAW,EAAE,SAAS,EAAe;IACxD,OAAO;IACL,sBAAsB;IACtB,WAAW,KAAK,CAAC;QACjB,YAAY;QACZ,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,IAAI,SAAS,CACtC,CAAC;AACJ,CAAC","sourcesContent":["import { Poller } from './Poller';\n\ntype BalanceInfo = {\n  lastUpdated: number;\n  blockTime: number;\n};\n\nconst BALANCES_TRACKING_INTERVAL = 5000; // Every 5s in milliseconds.\n\nexport class BalancesTracker {\n  #poller: Poller;\n\n  #updateBalance: (accountId: string) => Promise<void>;\n\n  #balances: Record<string, BalanceInfo> = {};\n\n  constructor(updateBalanceCallback: (accountId: string) => Promise<void>) {\n    this.#updateBalance = updateBalanceCallback;\n\n    this.#poller = new Poller(\n      () => this.updateBalances(),\n      BALANCES_TRACKING_INTERVAL,\n    );\n  }\n\n  /**\n   * Starts the tracking process.\n   */\n  start(): void {\n    this.#poller.start();\n  }\n\n  /**\n   * Stops the tracking process.\n   */\n  stop(): void {\n    this.#poller.stop();\n  }\n\n  /**\n   * Checks if an account ID is being tracked.\n   *\n   * @param accountId - The account ID.\n   * @returns True if the account is being tracked, false otherwise.\n   */\n  isTracked(accountId: string) {\n    return Object.prototype.hasOwnProperty.call(this.#balances, accountId);\n  }\n\n  /**\n   * Asserts that an account ID is being tracked.\n   *\n   * @param accountId - The account ID.\n   * @throws If the account ID is not being tracked.\n   */\n  assertBeingTracked(accountId: string) {\n    if (!this.isTracked(accountId)) {\n      throw new Error(`Account is not being tracked: ${accountId}`);\n    }\n  }\n\n  /**\n   * Starts tracking a new account ID. This method has no effect on already tracked\n   * accounts.\n   *\n   * @param accountId - The account ID.\n   * @param blockTime - The block time (used when refreshing the account balances).\n   */\n  track(accountId: string, blockTime: number) {\n    // Do not overwrite current info if already being tracked!\n    if (!this.isTracked(accountId)) {\n      this.#balances[accountId] = {\n        lastUpdated: 0,\n        blockTime,\n      };\n    }\n  }\n\n  /**\n   * Stops tracking a tracked account ID.\n   *\n   * @param accountId - The account ID.\n   * @throws If the account ID is not being tracked.\n   */\n  untrack(accountId: string) {\n    this.assertBeingTracked(accountId);\n    delete this.#balances[accountId];\n  }\n\n  /**\n   * Update the balances for a tracked account ID.\n   *\n   * @param accountId - The account ID.\n   * @throws If the account ID is not being tracked.\n   */\n  async updateBalance(accountId: string) {\n    this.assertBeingTracked(accountId);\n\n    // We check if the balance is outdated (by comparing to the block time associated\n    // with this kind of account).\n    //\n    // This might not be super accurate, but we could probably compute this differently\n    // and try to sync with the \"real block time\"!\n    const info = this.#balances[accountId];\n    if (this.#isBalanceOutdated(info)) {\n      await this.#updateBalance(accountId);\n      this.#balances[accountId].lastUpdated = Date.now();\n    }\n  }\n\n  /**\n   * Update the balances of all tracked accounts (only if the balances\n   * is considered outdated).\n   */\n  async updateBalances() {\n    await Promise.allSettled(\n      Object.keys(this.#balances).map(async (accountId) => {\n        await this.updateBalance(accountId);\n      }),\n    );\n  }\n\n  /**\n   * Checks if the balance is outdated according to the provided data.\n   *\n   * @param param - The balance info.\n   * @param param.lastUpdated - The last updated timestamp.\n   * @param param.blockTime - The block time.\n   * @returns True if the balance is outdated, false otherwise.\n   */\n  #isBalanceOutdated({ lastUpdated, blockTime }: BalanceInfo): boolean {\n    return (\n      // Never been updated:\n      lastUpdated === 0 ||\n      // Outdated:\n      Date.now() - lastUpdated >= blockTime\n    );\n  }\n}\n"]}

package/dist/MultichainBalancesController/BalancesTracker.d.cts

@@ -0,0 +1,54 @@
+export declare class BalancesTracker {
+    #private;
+    constructor(updateBalanceCallback: (accountId: string) => Promise<void>);
+    /**
+     * Starts the tracking process.
+     */
+    start(): void;
+    /**
+     * Stops the tracking process.
+     */
+    stop(): void;
+    /**
+     * Checks if an account ID is being tracked.
+     *
+     * @param accountId - The account ID.
+     * @returns True if the account is being tracked, false otherwise.
+     */
+    isTracked(accountId: string): boolean;
+    /**
+     * Asserts that an account ID is being tracked.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    assertBeingTracked(accountId: string): void;
+    /**
+     * Starts tracking a new account ID. This method has no effect on already tracked
+     * accounts.
+     *
+     * @param accountId - The account ID.
+     * @param blockTime - The block time (used when refreshing the account balances).
+     */
+    track(accountId: string, blockTime: number): void;
+    /**
+     * Stops tracking a tracked account ID.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    untrack(accountId: string): void;
+    /**
+     * Update the balances for a tracked account ID.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    updateBalance(accountId: string): Promise<void>;
+    /**
+     * Update the balances of all tracked accounts (only if the balances
+     * is considered outdated).
+     */
+    updateBalances(): Promise<void>;
+}
+//# sourceMappingURL=BalancesTracker.d.cts.map

package/dist/MultichainBalancesController/BalancesTracker.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BalancesTracker.d.cts","sourceRoot":"","sources":["../../src/MultichainBalancesController/BalancesTracker.ts"],"names":[],"mappings":"AASA,qBAAa,eAAe;;gBAOd,qBAAqB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IASvE;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACH,IAAI,IAAI,IAAI;IAIZ;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM;IAI3B;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM;IAMpC;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAU1C;;;;;OAKG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM;IAKzB;;;;;OAKG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM;IAerC;;;OAGG;IACG,cAAc;CAwBrB"}

package/dist/MultichainBalancesController/BalancesTracker.d.mts

@@ -0,0 +1,54 @@
+export declare class BalancesTracker {
+    #private;
+    constructor(updateBalanceCallback: (accountId: string) => Promise<void>);
+    /**
+     * Starts the tracking process.
+     */
+    start(): void;
+    /**
+     * Stops the tracking process.
+     */
+    stop(): void;
+    /**
+     * Checks if an account ID is being tracked.
+     *
+     * @param accountId - The account ID.
+     * @returns True if the account is being tracked, false otherwise.
+     */
+    isTracked(accountId: string): boolean;
+    /**
+     * Asserts that an account ID is being tracked.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    assertBeingTracked(accountId: string): void;
+    /**
+     * Starts tracking a new account ID. This method has no effect on already tracked
+     * accounts.
+     *
+     * @param accountId - The account ID.
+     * @param blockTime - The block time (used when refreshing the account balances).
+     */
+    track(accountId: string, blockTime: number): void;
+    /**
+     * Stops tracking a tracked account ID.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    untrack(accountId: string): void;
+    /**
+     * Update the balances for a tracked account ID.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    updateBalance(accountId: string): Promise<void>;
+    /**
+     * Update the balances of all tracked accounts (only if the balances
+     * is considered outdated).
+     */
+    updateBalances(): Promise<void>;
+}
+//# sourceMappingURL=BalancesTracker.d.mts.map

package/dist/MultichainBalancesController/BalancesTracker.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BalancesTracker.d.mts","sourceRoot":"","sources":["../../src/MultichainBalancesController/BalancesTracker.ts"],"names":[],"mappings":"AASA,qBAAa,eAAe;;gBAOd,qBAAqB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;IASvE;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACH,IAAI,IAAI,IAAI;IAIZ;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM;IAI3B;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM;IAMpC;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAU1C;;;;;OAKG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM;IAKzB;;;;;OAKG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM;IAerC;;;OAGG;IACG,cAAc;CAwBrB"}

package/dist/MultichainBalancesController/BalancesTracker.mjs

@@ -0,0 +1,118 @@
+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 _BalancesTracker_instances, _BalancesTracker_poller, _BalancesTracker_updateBalance, _BalancesTracker_balances, _BalancesTracker_isBalanceOutdated;
+import { Poller } from "./Poller.mjs";
+const BALANCES_TRACKING_INTERVAL = 5000; // Every 5s in milliseconds.
+export class BalancesTracker {
+    constructor(updateBalanceCallback) {
+        _BalancesTracker_instances.add(this);
+        _BalancesTracker_poller.set(this, void 0);
+        _BalancesTracker_updateBalance.set(this, void 0);
+        _BalancesTracker_balances.set(this, {});
+        __classPrivateFieldSet(this, _BalancesTracker_updateBalance, updateBalanceCallback, "f");
+        __classPrivateFieldSet(this, _BalancesTracker_poller, new Poller(() => this.updateBalances(), BALANCES_TRACKING_INTERVAL), "f");
+    }
+    /**
+     * Starts the tracking process.
+     */
+    start() {
+        __classPrivateFieldGet(this, _BalancesTracker_poller, "f").start();
+    }
+    /**
+     * Stops the tracking process.
+     */
+    stop() {
+        __classPrivateFieldGet(this, _BalancesTracker_poller, "f").stop();
+    }
+    /**
+     * Checks if an account ID is being tracked.
+     *
+     * @param accountId - The account ID.
+     * @returns True if the account is being tracked, false otherwise.
+     */
+    isTracked(accountId) {
+        return Object.prototype.hasOwnProperty.call(__classPrivateFieldGet(this, _BalancesTracker_balances, "f"), accountId);
+    }
+    /**
+     * Asserts that an account ID is being tracked.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    assertBeingTracked(accountId) {
+        if (!this.isTracked(accountId)) {
+            throw new Error(`Account is not being tracked: ${accountId}`);
+        }
+    }
+    /**
+     * Starts tracking a new account ID. This method has no effect on already tracked
+     * accounts.
+     *
+     * @param accountId - The account ID.
+     * @param blockTime - The block time (used when refreshing the account balances).
+     */
+    track(accountId, blockTime) {
+        // Do not overwrite current info if already being tracked!
+        if (!this.isTracked(accountId)) {
+            __classPrivateFieldGet(this, _BalancesTracker_balances, "f")[accountId] = {
+                lastUpdated: 0,
+                blockTime,
+            };
+        }
+    }
+    /**
+     * Stops tracking a tracked account ID.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    untrack(accountId) {
+        this.assertBeingTracked(accountId);
+        delete __classPrivateFieldGet(this, _BalancesTracker_balances, "f")[accountId];
+    }
+    /**
+     * Update the balances for a tracked account ID.
+     *
+     * @param accountId - The account ID.
+     * @throws If the account ID is not being tracked.
+     */
+    async updateBalance(accountId) {
+        this.assertBeingTracked(accountId);
+        // We check if the balance is outdated (by comparing to the block time associated
+        // with this kind of account).
+        //
+        // This might not be super accurate, but we could probably compute this differently
+        // and try to sync with the "real block time"!
+        const info = __classPrivateFieldGet(this, _BalancesTracker_balances, "f")[accountId];
+        if (__classPrivateFieldGet(this, _BalancesTracker_instances, "m", _BalancesTracker_isBalanceOutdated).call(this, info)) {
+            await __classPrivateFieldGet(this, _BalancesTracker_updateBalance, "f").call(this, accountId);
+            __classPrivateFieldGet(this, _BalancesTracker_balances, "f")[accountId].lastUpdated = Date.now();
+        }
+    }
+    /**
+     * Update the balances of all tracked accounts (only if the balances
+     * is considered outdated).
+     */
+    async updateBalances() {
+        await Promise.allSettled(Object.keys(__classPrivateFieldGet(this, _BalancesTracker_balances, "f")).map(async (accountId) => {
+            await this.updateBalance(accountId);
+        }));
+    }
+}
+_BalancesTracker_poller = new WeakMap(), _BalancesTracker_updateBalance = new WeakMap(), _BalancesTracker_balances = new WeakMap(), _BalancesTracker_instances = new WeakSet(), _BalancesTracker_isBalanceOutdated = function _BalancesTracker_isBalanceOutdated({ lastUpdated, blockTime }) {
+    return (
+    // Never been updated:
+    lastUpdated === 0 ||
+        // Outdated:
+        Date.now() - lastUpdated >= blockTime);
+};
+//# sourceMappingURL=BalancesTracker.mjs.map

package/dist/MultichainBalancesController/BalancesTracker.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"BalancesTracker.mjs","sourceRoot":"","sources":["../../src/MultichainBalancesController/BalancesTracker.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,qBAAiB;AAOlC,MAAM,0BAA0B,GAAG,IAAI,CAAC,CAAC,4BAA4B;AAErE,MAAM,OAAO,eAAe;IAO1B,YAAY,qBAA2D;;QANvE,0CAAgB;QAEhB,iDAAqD;QAErD,oCAAyC,EAAE,EAAC;QAG1C,uBAAA,IAAI,kCAAkB,qBAAqB,MAAA,CAAC;QAE5C,uBAAA,IAAI,2BAAW,IAAI,MAAM,CACvB,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,EAC3B,0BAA0B,CAC3B,MAAA,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK;QACH,uBAAA,IAAI,+BAAQ,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,uBAAA,IAAI,+BAAQ,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,SAAiB;QACzB,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,uBAAA,IAAI,iCAAU,EAAE,SAAS,CAAC,CAAC;IACzE,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,SAAiB;QAClC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,iCAAiC,SAAS,EAAE,CAAC,CAAC;SAC/D;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAiB,EAAE,SAAiB;QACxC,0DAA0D;QAC1D,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;YAC9B,uBAAA,IAAI,iCAAU,CAAC,SAAS,CAAC,GAAG;gBAC1B,WAAW,EAAE,CAAC;gBACd,SAAS;aACV,CAAC;SACH;IACH,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,SAAiB;QACvB,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACnC,OAAO,uBAAA,IAAI,iCAAU,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,SAAiB;QACnC,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAEnC,iFAAiF;QACjF,8BAA8B;QAC9B,EAAE;QACF,mFAAmF;QACnF,8CAA8C;QAC9C,MAAM,IAAI,GAAG,uBAAA,IAAI,iCAAU,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,uBAAA,IAAI,sEAAmB,MAAvB,IAAI,EAAoB,IAAI,CAAC,EAAE;YACjC,MAAM,uBAAA,IAAI,sCAAe,MAAnB,IAAI,EAAgB,SAAS,CAAC,CAAC;YACrC,uBAAA,IAAI,iCAAU,CAAC,SAAS,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;SACpD;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,OAAO,CAAC,UAAU,CACtB,MAAM,CAAC,IAAI,CAAC,uBAAA,IAAI,iCAAU,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YAClD,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QACtC,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CAkBF;iQARoB,EAAE,WAAW,EAAE,SAAS,EAAe;IACxD,OAAO;IACL,sBAAsB;IACtB,WAAW,KAAK,CAAC;QACjB,YAAY;QACZ,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,IAAI,SAAS,CACtC,CAAC;AACJ,CAAC","sourcesContent":["import { Poller } from './Poller';\n\ntype BalanceInfo = {\n  lastUpdated: number;\n  blockTime: number;\n};\n\nconst BALANCES_TRACKING_INTERVAL = 5000; // Every 5s in milliseconds.\n\nexport class BalancesTracker {\n  #poller: Poller;\n\n  #updateBalance: (accountId: string) => Promise<void>;\n\n  #balances: Record<string, BalanceInfo> = {};\n\n  constructor(updateBalanceCallback: (accountId: string) => Promise<void>) {\n    this.#updateBalance = updateBalanceCallback;\n\n    this.#poller = new Poller(\n      () => this.updateBalances(),\n      BALANCES_TRACKING_INTERVAL,\n    );\n  }\n\n  /**\n   * Starts the tracking process.\n   */\n  start(): void {\n    this.#poller.start();\n  }\n\n  /**\n   * Stops the tracking process.\n   */\n  stop(): void {\n    this.#poller.stop();\n  }\n\n  /**\n   * Checks if an account ID is being tracked.\n   *\n   * @param accountId - The account ID.\n   * @returns True if the account is being tracked, false otherwise.\n   */\n  isTracked(accountId: string) {\n    return Object.prototype.hasOwnProperty.call(this.#balances, accountId);\n  }\n\n  /**\n   * Asserts that an account ID is being tracked.\n   *\n   * @param accountId - The account ID.\n   * @throws If the account ID is not being tracked.\n   */\n  assertBeingTracked(accountId: string) {\n    if (!this.isTracked(accountId)) {\n      throw new Error(`Account is not being tracked: ${accountId}`);\n    }\n  }\n\n  /**\n   * Starts tracking a new account ID. This method has no effect on already tracked\n   * accounts.\n   *\n   * @param accountId - The account ID.\n   * @param blockTime - The block time (used when refreshing the account balances).\n   */\n  track(accountId: string, blockTime: number) {\n    // Do not overwrite current info if already being tracked!\n    if (!this.isTracked(accountId)) {\n      this.#balances[accountId] = {\n        lastUpdated: 0,\n        blockTime,\n      };\n    }\n  }\n\n  /**\n   * Stops tracking a tracked account ID.\n   *\n   * @param accountId - The account ID.\n   * @throws If the account ID is not being tracked.\n   */\n  untrack(accountId: string) {\n    this.assertBeingTracked(accountId);\n    delete this.#balances[accountId];\n  }\n\n  /**\n   * Update the balances for a tracked account ID.\n   *\n   * @param accountId - The account ID.\n   * @throws If the account ID is not being tracked.\n   */\n  async updateBalance(accountId: string) {\n    this.assertBeingTracked(accountId);\n\n    // We check if the balance is outdated (by comparing to the block time associated\n    // with this kind of account).\n    //\n    // This might not be super accurate, but we could probably compute this differently\n    // and try to sync with the \"real block time\"!\n    const info = this.#balances[accountId];\n    if (this.#isBalanceOutdated(info)) {\n      await this.#updateBalance(accountId);\n      this.#balances[accountId].lastUpdated = Date.now();\n    }\n  }\n\n  /**\n   * Update the balances of all tracked accounts (only if the balances\n   * is considered outdated).\n   */\n  async updateBalances() {\n    await Promise.allSettled(\n      Object.keys(this.#balances).map(async (accountId) => {\n        await this.updateBalance(accountId);\n      }),\n    );\n  }\n\n  /**\n   * Checks if the balance is outdated according to the provided data.\n   *\n   * @param param - The balance info.\n   * @param param.lastUpdated - The last updated timestamp.\n   * @param param.blockTime - The block time.\n   * @returns True if the balance is outdated, false otherwise.\n   */\n  #isBalanceOutdated({ lastUpdated, blockTime }: BalanceInfo): boolean {\n    return (\n      // Never been updated:\n      lastUpdated === 0 ||\n      // Outdated:\n      Date.now() - lastUpdated >= blockTime\n    );\n  }\n}\n"]}