@metamask/assets-controllers 83.1.0 → 85.0.0

package/dist/MultichainBalancesController/MultichainBalancesController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"MultichainBalancesController.mjs","sourceRoot":"","sources":["../../src/MultichainBalancesController/MultichainBalancesController.ts"],"names":[],"mappings":";;;;;;AAMA,OAAO,EACL,cAAc,EAIf,kCAAkC;AACnC,OAAO,EAAE,gBAAgB,EAAE,8BAA8B;AAQzD,OAAO,EAAE,aAAa,EAAE,sCAAsC;AAG9D,OAAO,EAAE,WAAW,EAAE,8BAA8B;AASpD,MAAM,cAAc,GAAG,8BAA8B,CAAC;AAgBtD;;;;;;;GAOG;AACH,MAAM,UAAU,2CAA2C;IACzD,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;AAC1B,CAAC;AA4DD;;;;;;GAMG;AACH,MAAM,0BAA0B,GAAG;IACjC,QAAQ,EAAE;QACR,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;QAChB,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,4BAA6B,SAAQ,cAIjD;IACC,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,GAIX;QACC,KAAK,CAAC;YACJ,SAAS;YACT,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,0BAA0B;YACpC,KAAK,EAAE;gBACL,GAAG,2CAA2C,EAAE;gBAChD,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAEH,kDAAkD;QAClD,KAAK,MAAM,OAAO,IAAI,uBAAA,IAAI,2FAAc,MAAlB,IAAI,CAAgB,EAAE;YAC1C,uEAAuE;YACvE,mCAAmC;YACnC,KAAK,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SACrC;QAED,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,CAAC,OAAe,EAAE,EAAE,CAAC,uBAAA,IAAI,qGAAwB,MAA5B,IAAI,EAAyB,OAAO,CAAC,CAC3D,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,2CAA2C,EAC3C,CAAC,aAAiD,EAAE,EAAE,CACpD,uBAAA,IAAI,6GAAgC,MAApC,IAAI,EAAiC,aAAa,CAAC,CACtD,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,oDAAoD,EACpD,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;YACnB,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CACjD,CAAC,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC3B,SAAS;gBACT,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC;aACnB,CAAC,CACH,CAAC;YACF,MAAM,uBAAA,IAAI,8GAAiC,MAArC,IAAI,EAAkC,gBAAgB,CAAC,CAAC;QAChE,CAAC,CACF,CAAC;IACJ,CAAC;IAsGD;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,SAAiB;QACnC,MAAM,uBAAA,IAAI,4FAAe,MAAnB,IAAI,EAAgB,SAAS,EAAE,uBAAA,IAAI,gGAAmB,MAAvB,IAAI,EAAoB,SAAS,CAAC,CAAC,CAAC;IAC3E,CAAC;CA0IF;;AAtPC;;;;GAIG;AACH,KAAK,wEACH,QAGG;IAEH,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9C,4BAA4B,CAC7B,CAAC;IAEF,IAAI,CAAC,UAAU,EAAE;QACf,OAAO;KACR;IACD,MAAM,gBAAgB,GAAkD,EAAE,CAAC;IAE3E,KAAK,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,QAAQ,EAAE;QAC5C,MAAM,OAAO,GAAG,uBAAA,IAAI,yFAAY,MAAhB,IAAI,EAAa,SAAS,CAAC,CAAC;QAC5C,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;YACzB,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,0FAAa,MAAjB,IAAI,EAC/B,OAAO,CAAC,EAAE,EACV,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EACxB,MAAM,CACP,CAAC;YACF,gBAAgB,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC;SAC9C;KACF;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9C,OAAO;KACR;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAA+C,EAAE,EAAE;QAC9D,KAAK,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CACvD,gBAAgB,CACjB,EAAE;YACD,IACE,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EACnD;gBACA,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,eAAe,CAAC;aAC7C;iBAAM;gBACL,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;oBACrC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE;wBACvC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;qBAC/D;iBACF;aACF;SACF;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,KAAK,sDACH,SAAiB,EACjB,MAAuB;IAEvB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9C,4BAA4B,CAC7B,CAAC;IAEF,IAAI,CAAC,UAAU,EAAE;QACf,OAAO;KACR;IAED,IAAI;QACF,MAAM,OAAO,GAAG,uBAAA,IAAI,yFAAY,MAAhB,IAAI,EAAa,SAAS,CAAC,CAAC;QAE5C,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;YACzB,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,0FAAa,MAAjB,IAAI,EAC/B,OAAO,CAAC,EAAE,EACV,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EACxB,MAAM,CACP,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAA+C,EAAE,EAAE;gBAC9D,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC;YAC7C,CAAC,CAAC,CAAC;SACJ;KACF;IAAC,OAAO,KAAK,EAAE;QACd,kFAAkF;QAClF,mFAAmF;QACnF,sDAAsD;QACtD,OAAO,CAAC,KAAK,CACX,wCAAwC,SAAS,GAAG,EACpD,KAAK,CACN,CAAC;KACH;AACH,CAAC;IAkBC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,2CAA2C,CAC5C,CAAC;AACJ,CAAC;IAQC,MAAM,QAAQ,GAAG,uBAAA,IAAI,qGAAwB,MAA5B,IAAI,CAA0B,CAAC;IAChD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,uBAAA,IAAI,8FAAiB,MAArB,IAAI,EAAkB,OAAO,CAAC,CAAC,CAAC;AACtE,CAAC,6GAQkB,SAAiB;IAClC,2EAA2E;IAC3E,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC3C,qCAAqC,CACtC,CAAC;IAEF,OAAO,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;AACrD,CAAC,+FAQW,SAAiB;IAC3B,MAAM,OAAO,GAAgC,uBAAA,IAAI,2FAAc,MAAlB,IAAI,CAAgB,CAAC,IAAI,CACpE,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,KAAK,SAAS,CAC1D,CAAC;IAEF,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,SAAS,EAAE,CAAC,CAAC;KAClD;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,yGAQgB,OAAwB;IACvC,OAAO,CACL,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC;QAC/B,gDAAgD;QAChD,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CACpC,CAAC;AACJ,CAAC,uIAQC,aAAiD;IAEjD,IAAI,CAAC,MAAM,CAAC,CAAC,KAA+C,EAAE,EAAE;QAC9D,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,OAAO,CAC5C,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,EAAE;YAC7B,IAAI,SAAS,IAAI,KAAK,CAAC,QAAQ,EAAE;gBAC/B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC,CAAC;aACzD;QACH,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,KAAK,+DAAyB,SAAiB;IAC7C,IAAI,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;QACpC,IAAI,CAAC,MAAM,CAAC,CAAC,KAA+C,EAAE,EAAE;YAC9D,OAAO,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,oDACH,SAAiB,EACjB,MAAc,EACd,UAA2B;IAE3B,OAAO,MAAM,uBAAA,IAAI,wFAAW,MAAf,IAAI,EAAY,MAAM,CAAC,CAAC,kBAAkB,CACrD,SAAS,EACT,UAAU,CACX,CAAC;AACJ,CAAC,6FAQU,MAAc;IACvB,OAAO,IAAI,aAAa,CAAC;QACvB,IAAI,EAAE,KAAK,EAAE,OAAuB,EAAE,EAAE,CACtC,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,8BAA8B,EAAE;YAC/D,MAAM,EAAE,MAAgB;YACxB,MAAM,EAAE,UAAU;YAClB,OAAO,EAAE,WAAW,CAAC,gBAAgB;YACrC,OAAO;SACR,CAAC,CAAkB;KACvB,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type {\n  AccountsControllerAccountAddedEvent,\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerListMultichainAccountsAction,\n  AccountsControllerAccountBalancesUpdatesEvent,\n} from '@metamask/accounts-controller';\nimport {\n  BaseController,\n  type ControllerGetStateAction,\n  type ControllerStateChangeEvent,\n  type RestrictedMessenger,\n} from '@metamask/base-controller';\nimport { isEvmAccountType } from '@metamask/keyring-api';\nimport type {\n  Balance,\n  CaipAssetType,\n  AccountBalancesUpdatedEventPayload,\n} from '@metamask/keyring-api';\nimport type { KeyringControllerGetStateAction } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport { KeyringClient } from '@metamask/keyring-snap-client';\nimport type { HandleSnapRequest } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcRequest } from '@metamask/utils';\nimport type { Draft } from 'immer';\n\nimport type {\n  MultichainAssetsControllerGetStateAction,\n  MultichainAssetsControllerAccountAssetListUpdatedEvent,\n} from '../MultichainAssetsController';\n\nconst controllerName = 'MultichainBalancesController';\n\n/**\n * State used by the {@link MultichainBalancesController} to cache account balances.\n */\nexport type MultichainBalancesControllerState = {\n  balances: {\n    [account: string]: {\n      [asset: string]: {\n        amount: string;\n        unit: string;\n      };\n    };\n  };\n};\n\n/**\n * Constructs the default {@link MultichainBalancesController} 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 MultichainBalancesController} state.\n */\nexport function getDefaultMultichainBalancesControllerState(): MultichainBalancesControllerState {\n  return { balances: {} };\n}\n\n/**\n * Returns the state of the {@link MultichainBalancesController}.\n */\nexport type MultichainBalancesControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    MultichainBalancesControllerState\n  >;\n\n/**\n * Event emitted when the state of the {@link MultichainBalancesController} changes.\n */\nexport type MultichainBalancesControllerStateChange =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    MultichainBalancesControllerState\n  >;\n\n/**\n * Actions exposed by the {@link MultichainBalancesController}.\n */\nexport type MultichainBalancesControllerActions =\n  MultichainBalancesControllerGetStateAction;\n\n/**\n * Events emitted by {@link MultichainBalancesController}.\n */\nexport type MultichainBalancesControllerEvents =\n  MultichainBalancesControllerStateChange;\n\n/**\n * Actions that this controller is allowed to call.\n */\ntype AllowedActions =\n  | HandleSnapRequest\n  | AccountsControllerListMultichainAccountsAction\n  | MultichainAssetsControllerGetStateAction\n  | KeyringControllerGetStateAction;\n\n/**\n * Events that this controller is allowed to subscribe.\n */\ntype AllowedEvents =\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRemovedEvent\n  | AccountsControllerAccountBalancesUpdatesEvent\n  | MultichainAssetsControllerAccountAssetListUpdatedEvent;\n/**\n * Messenger type for the MultichainBalancesController.\n */\nexport type MultichainBalancesControllerMessenger = RestrictedMessenger<\n  typeof controllerName,\n  MultichainBalancesControllerActions | AllowedActions,\n  MultichainBalancesControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * {@link MultichainBalancesController}'s metadata.\n *\n * This allows us to choose if fields of the state should be persisted or not\n * using the `persist` flag; and if they can be sent to Sentry or not, using\n * the `anonymous` flag.\n */\nconst balancesControllerMetadata = {\n  balances: {\n    includeInStateLogs: false,\n    persist: true,\n    anonymous: false,\n    usedInUi: true,\n  },\n};\n\n/**\n * The MultichainBalancesController is responsible for fetching and caching account\n * balances.\n */\nexport class MultichainBalancesController extends BaseController<\n  typeof controllerName,\n  MultichainBalancesControllerState,\n  MultichainBalancesControllerMessenger\n> {\n  constructor({\n    messenger,\n    state = {},\n  }: {\n    messenger: MultichainBalancesControllerMessenger;\n    state?: Partial<MultichainBalancesControllerState>;\n  }) {\n    super({\n      messenger,\n      name: controllerName,\n      metadata: balancesControllerMetadata,\n      state: {\n        ...getDefaultMultichainBalancesControllerState(),\n        ...state,\n      },\n    });\n\n    // Fetch initial balances for all non-EVM accounts\n    for (const account of this.#listAccounts()) {\n      // Fetching the balance is asynchronous and we cannot use `await` here.\n      // eslint-disable-next-line no-void\n      void this.updateBalance(account.id);\n    }\n\n    this.messagingSystem.subscribe(\n      'AccountsController:accountRemoved',\n      (account: string) => this.#handleOnAccountRemoved(account),\n    );\n    this.messagingSystem.subscribe(\n      'AccountsController:accountBalancesUpdated',\n      (balanceUpdate: AccountBalancesUpdatedEventPayload) =>\n        this.#handleOnAccountBalancesUpdated(balanceUpdate),\n    );\n\n    this.messagingSystem.subscribe(\n      'MultichainAssetsController:accountAssetListUpdated',\n      async ({ assets }) => {\n        const newAccountAssets = Object.entries(assets).map(\n          ([accountId, { added }]) => ({\n            accountId,\n            assets: [...added],\n          }),\n        );\n        await this.#handleOnAccountAssetListUpdated(newAccountAssets);\n      },\n    );\n  }\n\n  /**\n   * Updates the balances for the given accounts.\n   *\n   * @param accounts - The accounts to update the balances for.\n   */\n  async #handleOnAccountAssetListUpdated(\n    accounts: {\n      accountId: string;\n      assets: CaipAssetType[];\n    }[],\n  ): Promise<void> {\n    const { isUnlocked } = this.messagingSystem.call(\n      'KeyringController:getState',\n    );\n\n    if (!isUnlocked) {\n      return;\n    }\n    const balancesToUpdate: MultichainBalancesControllerState['balances'] = {};\n\n    for (const { accountId, assets } of accounts) {\n      const account = this.#getAccount(accountId);\n      if (account.metadata.snap) {\n        const accountBalance = await this.#getBalances(\n          account.id,\n          account.metadata.snap.id,\n          assets,\n        );\n        balancesToUpdate[accountId] = accountBalance;\n      }\n    }\n\n    if (Object.keys(balancesToUpdate).length === 0) {\n      return;\n    }\n\n    this.update((state: Draft<MultichainBalancesControllerState>) => {\n      for (const [accountId, accountBalances] of Object.entries(\n        balancesToUpdate,\n      )) {\n        if (\n          !state.balances[accountId] ||\n          Object.keys(state.balances[accountId]).length === 0\n        ) {\n          state.balances[accountId] = accountBalances;\n        } else {\n          for (const assetId in accountBalances) {\n            if (!state.balances[accountId][assetId]) {\n              state.balances[accountId][assetId] = accountBalances[assetId];\n            }\n          }\n        }\n      }\n    });\n  }\n\n  /**\n   * Updates the balances of one account. This method doesn't return\n   * anything, but it updates the state of the controller.\n   *\n   * @param accountId - The account ID.\n   * @param assets - The list of asset types for this account to upadte.\n   */\n  async #updateBalance(\n    accountId: string,\n    assets: CaipAssetType[],\n  ): Promise<void> {\n    const { isUnlocked } = this.messagingSystem.call(\n      'KeyringController:getState',\n    );\n\n    if (!isUnlocked) {\n      return;\n    }\n\n    try {\n      const account = this.#getAccount(accountId);\n\n      if (account.metadata.snap) {\n        const accountBalance = await this.#getBalances(\n          account.id,\n          account.metadata.snap.id,\n          assets,\n        );\n\n        this.update((state: Draft<MultichainBalancesControllerState>) => {\n          state.balances[accountId] = accountBalance;\n        });\n      }\n    } catch (error) {\n      // FIXME: Maybe we shouldn't catch all errors here since this method is also being\n      // used in the public methods. This means if something else uses `updateBalance` it\n      // won't be able to catch and gets the error itself...\n      console.error(\n        `Failed to fetch balances for account ${accountId}:`,\n        error,\n      );\n    }\n  }\n\n  /**\n   * Updates the balances of one account. This method doesn't return\n   * anything, but it updates the state of the controller.\n   *\n   * @param accountId - The account ID.\n   */\n  async updateBalance(accountId: string): Promise<void> {\n    await this.#updateBalance(accountId, this.#listAccountAssets(accountId));\n  }\n\n  /**\n   * Lists the multichain accounts coming from the `AccountsController`.\n   *\n   * @returns A list of multichain accounts.\n   */\n  #listMultichainAccounts(): InternalAccount[] {\n    return this.messagingSystem.call(\n      'AccountsController:listMultichainAccounts',\n    );\n  }\n\n  /**\n   * Lists the accounts that we should get balances for.\n   *\n   * @returns A list of accounts that we should get balances for.\n   */\n  #listAccounts(): InternalAccount[] {\n    const accounts = this.#listMultichainAccounts();\n    return accounts.filter((account) => this.#isNonEvmAccount(account));\n  }\n\n  /**\n   * Lists the accounts assets.\n   *\n   * @param accountId - The account ID.\n   * @returns The list of assets for this account, returns an empty list if none.\n   */\n  #listAccountAssets(accountId: string): CaipAssetType[] {\n    // TODO: Add an action `MultichainAssetsController:getAccountAssets` maybe?\n    const assetsState = this.messagingSystem.call(\n      'MultichainAssetsController:getState',\n    );\n\n    return assetsState.accountsAssets[accountId] ?? [];\n  }\n\n  /**\n   * Get a non-EVM account from its ID.\n   *\n   * @param accountId - The account ID.\n   * @returns The non-EVM account.\n   */\n  #getAccount(accountId: string): InternalAccount {\n    const account: InternalAccount | undefined = this.#listAccounts().find(\n      (multichainAccount) => multichainAccount.id === accountId,\n    );\n\n    if (!account) {\n      throw new Error(`Unknown account: ${accountId}`);\n    }\n\n    return account;\n  }\n\n  /**\n   * Checks for non-EVM accounts.\n   *\n   * @param account - The new account to be checked.\n   * @returns True if the account is a non-EVM account, false otherwise.\n   */\n  #isNonEvmAccount(account: InternalAccount): boolean {\n    return (\n      !isEvmAccountType(account.type) &&\n      // Non-EVM accounts are backed by a Snap for now\n      account.metadata.snap !== undefined\n    );\n  }\n\n  /**\n   * Handles balance updates received from the AccountsController.\n   *\n   * @param balanceUpdate - The balance update event containing new balances.\n   */\n  #handleOnAccountBalancesUpdated(\n    balanceUpdate: AccountBalancesUpdatedEventPayload,\n  ): void {\n    this.update((state: Draft<MultichainBalancesControllerState>) => {\n      Object.entries(balanceUpdate.balances).forEach(\n        ([accountId, assetBalances]) => {\n          if (accountId in state.balances) {\n            Object.assign(state.balances[accountId], assetBalances);\n          }\n        },\n      );\n    });\n  }\n\n  /**\n   * Handles changes when a new account has been removed.\n   *\n   * @param accountId - The account ID being removed.\n   */\n  async #handleOnAccountRemoved(accountId: string): Promise<void> {\n    if (accountId in this.state.balances) {\n      this.update((state: Draft<MultichainBalancesControllerState>) => {\n        delete state.balances[accountId];\n      });\n    }\n  }\n\n  /**\n   * Get the balances for an account.\n   *\n   * @param accountId - ID of the account to get balances for.\n   * @param snapId - ID of the Snap which manages the account.\n   * @param assetTypes - Array of asset types to get balances for.\n   * @returns A map of asset types to balances.\n   */\n  async #getBalances(\n    accountId: string,\n    snapId: string,\n    assetTypes: CaipAssetType[],\n  ): Promise<Record<CaipAssetType, Balance>> {\n    return await this.#getClient(snapId).getAccountBalances(\n      accountId,\n      assetTypes,\n    );\n  }\n\n  /**\n   * Gets a `KeyringClient` for a Snap.\n   *\n   * @param snapId - ID of the Snap to get the client for.\n   * @returns A `KeyringClient` for the Snap.\n   */\n  #getClient(snapId: string): KeyringClient {\n    return new KeyringClient({\n      send: async (request: JsonRpcRequest) =>\n        (await this.messagingSystem.call('SnapController:handleRequest', {\n          snapId: snapId as SnapId,\n          origin: 'metamask',\n          handler: HandlerType.OnKeyringRequest,\n          request,\n        })) as Promise<Json>,\n    });\n  }\n}\n"]}
+{"version":3,"file":"MultichainBalancesController.mjs","sourceRoot":"","sources":["../../src/MultichainBalancesController/MultichainBalancesController.ts"],"names":[],"mappings":";;;;;;AAMA,OAAO,EACL,cAAc,EAIf,kCAAkC;AACnC,OAAO,EAAE,gBAAgB,EAAE,8BAA8B;AAQzD,OAAO,EAAE,aAAa,EAAE,sCAAsC;AAI9D,OAAO,EAAE,WAAW,EAAE,8BAA8B;AASpD,MAAM,cAAc,GAAG,8BAA8B,CAAC;AAgBtD;;;;;;;GAOG;AACH,MAAM,UAAU,2CAA2C;IACzD,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;AAC1B,CAAC;AA0DD;;;;;;GAMG;AACH,MAAM,0BAA0B,GAC9B;IACE,QAAQ,EAAE;QACR,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEJ;;;GAGG;AACH,MAAM,OAAO,4BAA6B,SAAQ,cAIjD;IACC,YAAY,EACV,SAAS,EACT,KAAK,GAAG,EAAE,GAIX;QACC,KAAK,CAAC;YACJ,SAAS;YACT,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,0BAA0B;YACpC,KAAK,EAAE;gBACL,GAAG,2CAA2C,EAAE;gBAChD,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAEH,kDAAkD;QAClD,KAAK,MAAM,OAAO,IAAI,uBAAA,IAAI,2FAAc,MAAlB,IAAI,CAAgB,EAAE;YAC1C,uEAAuE;YACvE,mCAAmC;YACnC,KAAK,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SACrC;QAED,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,mCAAmC,EACnC,CAAC,OAAe,EAAE,EAAE,CAAC,uBAAA,IAAI,qGAAwB,MAA5B,IAAI,EAAyB,OAAO,CAAC,CAC3D,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,2CAA2C,EAC3C,CAAC,aAAiD,EAAE,EAAE,CACpD,uBAAA,IAAI,6GAAgC,MAApC,IAAI,EAAiC,aAAa,CAAC,CACtD,CAAC;QAEF,IAAI,CAAC,SAAS,CAAC,SAAS,CACtB,oDAAoD,EACpD,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;YACnB,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CACjD,CAAC,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC3B,SAAS;gBACT,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC;aACnB,CAAC,CACH,CAAC;YACF,MAAM,uBAAA,IAAI,8GAAiC,MAArC,IAAI,EAAkC,gBAAgB,CAAC,CAAC;QAChE,CAAC,CACF,CAAC;IACJ,CAAC;IAkGD;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,SAAiB;QACnC,MAAM,uBAAA,IAAI,4FAAe,MAAnB,IAAI,EAAgB,SAAS,EAAE,uBAAA,IAAI,gGAAmB,MAAvB,IAAI,EAAoB,SAAS,CAAC,CAAC,CAAC;IAC3E,CAAC;CAwIF;;AAhPC;;;;GAIG;AACH,KAAK,wEACH,QAGG;IAEH,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAEzE,IAAI,CAAC,UAAU,EAAE;QACf,OAAO;KACR;IACD,MAAM,gBAAgB,GAAkD,EAAE,CAAC;IAE3E,KAAK,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,QAAQ,EAAE;QAC5C,MAAM,OAAO,GAAG,uBAAA,IAAI,yFAAY,MAAhB,IAAI,EAAa,SAAS,CAAC,CAAC;QAC5C,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;YACzB,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,0FAAa,MAAjB,IAAI,EAC/B,OAAO,CAAC,EAAE,EACV,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EACxB,MAAM,CACP,CAAC;YACF,gBAAgB,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC;SAC9C;KACF;IAED,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QAC9C,OAAO;KACR;IAED,IAAI,CAAC,MAAM,CAAC,CAAC,KAA+C,EAAE,EAAE;QAC9D,KAAK,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CACvD,gBAAgB,CACjB,EAAE;YACD,IACE,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EACnD;gBACA,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,eAAe,CAAC;aAC7C;iBAAM;gBACL,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE;oBACrC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE;wBACvC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;qBAC/D;iBACF;aACF;SACF;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,KAAK,sDACH,SAAiB,EACjB,MAAuB;IAEvB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAEzE,IAAI,CAAC,UAAU,EAAE;QACf,OAAO;KACR;IAED,IAAI;QACF,MAAM,OAAO,GAAG,uBAAA,IAAI,yFAAY,MAAhB,IAAI,EAAa,SAAS,CAAC,CAAC;QAE5C,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;YACzB,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,0FAAa,MAAjB,IAAI,EAC/B,OAAO,CAAC,EAAE,EACV,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EACxB,MAAM,CACP,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAA+C,EAAE,EAAE;gBAC9D,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC;YAC7C,CAAC,CAAC,CAAC;SACJ;KACF;IAAC,OAAO,KAAK,EAAE;QACd,kFAAkF;QAClF,mFAAmF;QACnF,sDAAsD;QACtD,OAAO,CAAC,KAAK,CACX,wCAAwC,SAAS,GAAG,EACpD,KAAK,CACN,CAAC;KACH;AACH,CAAC;IAkBC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;AAC1E,CAAC;IAQC,MAAM,QAAQ,GAAG,uBAAA,IAAI,qGAAwB,MAA5B,IAAI,CAA0B,CAAC;IAChD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,uBAAA,IAAI,8FAAiB,MAArB,IAAI,EAAkB,OAAO,CAAC,CAAC,CAAC;AACtE,CAAC,6GAQkB,SAAiB;IAClC,2EAA2E;IAC3E,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACrC,qCAAqC,CACtC,CAAC;IAEF,OAAO,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;AACrD,CAAC,+FAQW,SAAiB;IAC3B,MAAM,OAAO,GAAgC,uBAAA,IAAI,2FAAc,MAAlB,IAAI,CAAgB,CAAC,IAAI,CACpE,CAAC,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,KAAK,SAAS,CAC1D,CAAC;IAEF,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,SAAS,EAAE,CAAC,CAAC;KAClD;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,yGAQgB,OAAwB;IACvC,OAAO,CACL,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC;QAC/B,gDAAgD;QAChD,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CACpC,CAAC;AACJ,CAAC,uIAQC,aAAiD;IAEjD,IAAI,CAAC,MAAM,CAAC,CAAC,KAA+C,EAAE,EAAE;QAC9D,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,OAAO,CAC5C,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,EAAE;YAC7B,IAAI,SAAS,IAAI,KAAK,CAAC,QAAQ,EAAE;gBAC/B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC,CAAC;aACzD;QACH,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,KAAK,+DAAyB,SAAiB;IAC7C,IAAI,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;QACpC,IAAI,CAAC,MAAM,CAAC,CAAC,KAA+C,EAAE,EAAE;YAC9D,OAAO,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,oDACH,SAAiB,EACjB,MAAc,EACd,UAA2B;IAE3B,OAAO,MAAM,uBAAA,IAAI,wFAAW,MAAf,IAAI,EAAY,MAAM,CAAC,CAAC,kBAAkB,CACrD,SAAS,EACT,UAAU,CACX,CAAC;AACJ,CAAC,6FAQU,MAAc;IACvB,OAAO,IAAI,aAAa,CAAC;QACvB,IAAI,EAAE,KAAK,EAAE,OAAuB,EAAE,EAAE,CACtC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACzD,MAAM,EAAE,MAAgB;YACxB,MAAM,EAAE,UAAU;YAClB,OAAO,EAAE,WAAW,CAAC,gBAAgB;YACrC,OAAO;SACR,CAAC,CAAkB;KACvB,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type {\n  AccountsControllerAccountAddedEvent,\n  AccountsControllerAccountRemovedEvent,\n  AccountsControllerListMultichainAccountsAction,\n  AccountsControllerAccountBalancesUpdatesEvent,\n} from '@metamask/accounts-controller';\nimport {\n  BaseController,\n  type StateMetadata,\n  type ControllerGetStateAction,\n  type ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport { isEvmAccountType } from '@metamask/keyring-api';\nimport type {\n  Balance,\n  CaipAssetType,\n  AccountBalancesUpdatedEventPayload,\n} from '@metamask/keyring-api';\nimport type { KeyringControllerGetStateAction } from '@metamask/keyring-controller';\nimport type { InternalAccount } from '@metamask/keyring-internal-api';\nimport { KeyringClient } from '@metamask/keyring-snap-client';\nimport type { Messenger } from '@metamask/messenger';\nimport type { HandleSnapRequest } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport type { Json, JsonRpcRequest } from '@metamask/utils';\nimport type { Draft } from 'immer';\n\nimport type {\n  MultichainAssetsControllerGetStateAction,\n  MultichainAssetsControllerAccountAssetListUpdatedEvent,\n} from '../MultichainAssetsController';\n\nconst controllerName = 'MultichainBalancesController';\n\n/**\n * State used by the {@link MultichainBalancesController} to cache account balances.\n */\nexport type MultichainBalancesControllerState = {\n  balances: {\n    [account: string]: {\n      [asset: string]: {\n        amount: string;\n        unit: string;\n      };\n    };\n  };\n};\n\n/**\n * Constructs the default {@link MultichainBalancesController} 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 MultichainBalancesController} state.\n */\nexport function getDefaultMultichainBalancesControllerState(): MultichainBalancesControllerState {\n  return { balances: {} };\n}\n\n/**\n * Returns the state of the {@link MultichainBalancesController}.\n */\nexport type MultichainBalancesControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    MultichainBalancesControllerState\n  >;\n\n/**\n * Event emitted when the state of the {@link MultichainBalancesController} changes.\n */\nexport type MultichainBalancesControllerStateChange =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    MultichainBalancesControllerState\n  >;\n\n/**\n * Actions exposed by the {@link MultichainBalancesController}.\n */\nexport type MultichainBalancesControllerActions =\n  MultichainBalancesControllerGetStateAction;\n\n/**\n * Events emitted by {@link MultichainBalancesController}.\n */\nexport type MultichainBalancesControllerEvents =\n  MultichainBalancesControllerStateChange;\n\n/**\n * Actions that this controller is allowed to call.\n */\ntype AllowedActions =\n  | HandleSnapRequest\n  | AccountsControllerListMultichainAccountsAction\n  | MultichainAssetsControllerGetStateAction\n  | KeyringControllerGetStateAction;\n\n/**\n * Events that this controller is allowed to subscribe.\n */\ntype AllowedEvents =\n  | AccountsControllerAccountAddedEvent\n  | AccountsControllerAccountRemovedEvent\n  | AccountsControllerAccountBalancesUpdatesEvent\n  | MultichainAssetsControllerAccountAssetListUpdatedEvent;\n/**\n * Messenger type for the MultichainBalancesController.\n */\nexport type MultichainBalancesControllerMessenger = Messenger<\n  typeof controllerName,\n  MultichainBalancesControllerActions | AllowedActions,\n  MultichainBalancesControllerEvents | AllowedEvents\n>;\n\n/**\n * {@link MultichainBalancesController}'s metadata.\n *\n * This allows us to choose if fields of the state should be persisted or not\n * using the `persist` flag; and if they can be sent to Sentry or not, using\n * the `anonymous` flag.\n */\nconst balancesControllerMetadata: StateMetadata<MultichainBalancesControllerState> =\n  {\n    balances: {\n      includeInStateLogs: false,\n      persist: true,\n      includeInDebugSnapshot: false,\n      usedInUi: true,\n    },\n  };\n\n/**\n * The MultichainBalancesController is responsible for fetching and caching account\n * balances.\n */\nexport class MultichainBalancesController extends BaseController<\n  typeof controllerName,\n  MultichainBalancesControllerState,\n  MultichainBalancesControllerMessenger\n> {\n  constructor({\n    messenger,\n    state = {},\n  }: {\n    messenger: MultichainBalancesControllerMessenger;\n    state?: Partial<MultichainBalancesControllerState>;\n  }) {\n    super({\n      messenger,\n      name: controllerName,\n      metadata: balancesControllerMetadata,\n      state: {\n        ...getDefaultMultichainBalancesControllerState(),\n        ...state,\n      },\n    });\n\n    // Fetch initial balances for all non-EVM accounts\n    for (const account of this.#listAccounts()) {\n      // Fetching the balance is asynchronous and we cannot use `await` here.\n      // eslint-disable-next-line no-void\n      void this.updateBalance(account.id);\n    }\n\n    this.messenger.subscribe(\n      'AccountsController:accountRemoved',\n      (account: string) => this.#handleOnAccountRemoved(account),\n    );\n    this.messenger.subscribe(\n      'AccountsController:accountBalancesUpdated',\n      (balanceUpdate: AccountBalancesUpdatedEventPayload) =>\n        this.#handleOnAccountBalancesUpdated(balanceUpdate),\n    );\n\n    this.messenger.subscribe(\n      'MultichainAssetsController:accountAssetListUpdated',\n      async ({ assets }) => {\n        const newAccountAssets = Object.entries(assets).map(\n          ([accountId, { added }]) => ({\n            accountId,\n            assets: [...added],\n          }),\n        );\n        await this.#handleOnAccountAssetListUpdated(newAccountAssets);\n      },\n    );\n  }\n\n  /**\n   * Updates the balances for the given accounts.\n   *\n   * @param accounts - The accounts to update the balances for.\n   */\n  async #handleOnAccountAssetListUpdated(\n    accounts: {\n      accountId: string;\n      assets: CaipAssetType[];\n    }[],\n  ): Promise<void> {\n    const { isUnlocked } = this.messenger.call('KeyringController:getState');\n\n    if (!isUnlocked) {\n      return;\n    }\n    const balancesToUpdate: MultichainBalancesControllerState['balances'] = {};\n\n    for (const { accountId, assets } of accounts) {\n      const account = this.#getAccount(accountId);\n      if (account.metadata.snap) {\n        const accountBalance = await this.#getBalances(\n          account.id,\n          account.metadata.snap.id,\n          assets,\n        );\n        balancesToUpdate[accountId] = accountBalance;\n      }\n    }\n\n    if (Object.keys(balancesToUpdate).length === 0) {\n      return;\n    }\n\n    this.update((state: Draft<MultichainBalancesControllerState>) => {\n      for (const [accountId, accountBalances] of Object.entries(\n        balancesToUpdate,\n      )) {\n        if (\n          !state.balances[accountId] ||\n          Object.keys(state.balances[accountId]).length === 0\n        ) {\n          state.balances[accountId] = accountBalances;\n        } else {\n          for (const assetId in accountBalances) {\n            if (!state.balances[accountId][assetId]) {\n              state.balances[accountId][assetId] = accountBalances[assetId];\n            }\n          }\n        }\n      }\n    });\n  }\n\n  /**\n   * Updates the balances of one account. This method doesn't return\n   * anything, but it updates the state of the controller.\n   *\n   * @param accountId - The account ID.\n   * @param assets - The list of asset types for this account to upadte.\n   */\n  async #updateBalance(\n    accountId: string,\n    assets: CaipAssetType[],\n  ): Promise<void> {\n    const { isUnlocked } = this.messenger.call('KeyringController:getState');\n\n    if (!isUnlocked) {\n      return;\n    }\n\n    try {\n      const account = this.#getAccount(accountId);\n\n      if (account.metadata.snap) {\n        const accountBalance = await this.#getBalances(\n          account.id,\n          account.metadata.snap.id,\n          assets,\n        );\n\n        this.update((state: Draft<MultichainBalancesControllerState>) => {\n          state.balances[accountId] = accountBalance;\n        });\n      }\n    } catch (error) {\n      // FIXME: Maybe we shouldn't catch all errors here since this method is also being\n      // used in the public methods. This means if something else uses `updateBalance` it\n      // won't be able to catch and gets the error itself...\n      console.error(\n        `Failed to fetch balances for account ${accountId}:`,\n        error,\n      );\n    }\n  }\n\n  /**\n   * Updates the balances of one account. This method doesn't return\n   * anything, but it updates the state of the controller.\n   *\n   * @param accountId - The account ID.\n   */\n  async updateBalance(accountId: string): Promise<void> {\n    await this.#updateBalance(accountId, this.#listAccountAssets(accountId));\n  }\n\n  /**\n   * Lists the multichain accounts coming from the `AccountsController`.\n   *\n   * @returns A list of multichain accounts.\n   */\n  #listMultichainAccounts(): InternalAccount[] {\n    return this.messenger.call('AccountsController:listMultichainAccounts');\n  }\n\n  /**\n   * Lists the accounts that we should get balances for.\n   *\n   * @returns A list of accounts that we should get balances for.\n   */\n  #listAccounts(): InternalAccount[] {\n    const accounts = this.#listMultichainAccounts();\n    return accounts.filter((account) => this.#isNonEvmAccount(account));\n  }\n\n  /**\n   * Lists the accounts assets.\n   *\n   * @param accountId - The account ID.\n   * @returns The list of assets for this account, returns an empty list if none.\n   */\n  #listAccountAssets(accountId: string): CaipAssetType[] {\n    // TODO: Add an action `MultichainAssetsController:getAccountAssets` maybe?\n    const assetsState = this.messenger.call(\n      'MultichainAssetsController:getState',\n    );\n\n    return assetsState.accountsAssets[accountId] ?? [];\n  }\n\n  /**\n   * Get a non-EVM account from its ID.\n   *\n   * @param accountId - The account ID.\n   * @returns The non-EVM account.\n   */\n  #getAccount(accountId: string): InternalAccount {\n    const account: InternalAccount | undefined = this.#listAccounts().find(\n      (multichainAccount) => multichainAccount.id === accountId,\n    );\n\n    if (!account) {\n      throw new Error(`Unknown account: ${accountId}`);\n    }\n\n    return account;\n  }\n\n  /**\n   * Checks for non-EVM accounts.\n   *\n   * @param account - The new account to be checked.\n   * @returns True if the account is a non-EVM account, false otherwise.\n   */\n  #isNonEvmAccount(account: InternalAccount): boolean {\n    return (\n      !isEvmAccountType(account.type) &&\n      // Non-EVM accounts are backed by a Snap for now\n      account.metadata.snap !== undefined\n    );\n  }\n\n  /**\n   * Handles balance updates received from the AccountsController.\n   *\n   * @param balanceUpdate - The balance update event containing new balances.\n   */\n  #handleOnAccountBalancesUpdated(\n    balanceUpdate: AccountBalancesUpdatedEventPayload,\n  ): void {\n    this.update((state: Draft<MultichainBalancesControllerState>) => {\n      Object.entries(balanceUpdate.balances).forEach(\n        ([accountId, assetBalances]) => {\n          if (accountId in state.balances) {\n            Object.assign(state.balances[accountId], assetBalances);\n          }\n        },\n      );\n    });\n  }\n\n  /**\n   * Handles changes when a new account has been removed.\n   *\n   * @param accountId - The account ID being removed.\n   */\n  async #handleOnAccountRemoved(accountId: string): Promise<void> {\n    if (accountId in this.state.balances) {\n      this.update((state: Draft<MultichainBalancesControllerState>) => {\n        delete state.balances[accountId];\n      });\n    }\n  }\n\n  /**\n   * Get the balances for an account.\n   *\n   * @param accountId - ID of the account to get balances for.\n   * @param snapId - ID of the Snap which manages the account.\n   * @param assetTypes - Array of asset types to get balances for.\n   * @returns A map of asset types to balances.\n   */\n  async #getBalances(\n    accountId: string,\n    snapId: string,\n    assetTypes: CaipAssetType[],\n  ): Promise<Record<CaipAssetType, Balance>> {\n    return await this.#getClient(snapId).getAccountBalances(\n      accountId,\n      assetTypes,\n    );\n  }\n\n  /**\n   * Gets a `KeyringClient` for a Snap.\n   *\n   * @param snapId - ID of the Snap to get the client for.\n   * @returns A `KeyringClient` for the Snap.\n   */\n  #getClient(snapId: string): KeyringClient {\n    return new KeyringClient({\n      send: async (request: JsonRpcRequest) =>\n        (await this.messenger.call('SnapController:handleRequest', {\n          snapId: snapId as SnapId,\n          origin: 'metamask',\n          handler: HandlerType.OnKeyringRequest,\n          request,\n        })) as Promise<Json>,\n    });\n  }\n}\n"]}

package/dist/NftController.cjs

@@ -31,19 +31,19 @@ const nftControllerMetadata = {
     allNftContracts: {
         includeInStateLogs: false,
         persist: true,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     allNfts: {
         includeInStateLogs: false,
         persist: true,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: true,
     },
     ignoredNfts: {
         includeInStateLogs: false,
         persist: true,
-        anonymous: false,
+        includeInDebugSnapshot: false,
         usedInUi: false,
     },
 };
@@ -95,14 +95,14 @@ class NftController extends base_controller_1.BaseController {
         _NftController_useIpfsSubdomains.set(this, void 0);
         _NftController_isIpfsGatewayEnabled.set(this, void 0);
         _NftController_onNftAdded.set(this, void 0);
-        __classPrivateFieldSet(this, _NftController_selectedAccountId, this.messagingSystem.call('AccountsController:getSelectedAccount').id, "f");
+        __classPrivateFieldSet(this, _NftController_selectedAccountId, this.messenger.call('AccountsController:getSelectedAccount').id, "f");
         __classPrivateFieldSet(this, _NftController_ipfsGateway, ipfsGateway, "f");
         __classPrivateFieldSet(this, _NftController_displayNftMedia, displayNftMedia, "f");
         __classPrivateFieldSet(this, _NftController_useIpfsSubdomains, useIpfsSubdomains, "f");
         __classPrivateFieldSet(this, _NftController_isIpfsGatewayEnabled, isIpfsGatewayEnabled, "f");
         __classPrivateFieldSet(this, _NftController_onNftAdded, onNftAdded, "f");
-        this.messagingSystem.subscribe('PreferencesController:stateChange', __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_onPreferencesControllerStateChange).bind(this));
-        this.messagingSystem.subscribe('AccountsController:selectedEvmAccountChange', __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_onSelectedAccountChange).bind(this));
+        this.messenger.subscribe('PreferencesController:stateChange', __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_onPreferencesControllerStateChange).bind(this));
+        this.messenger.subscribe('AccountsController:selectedEvmAccountChange', __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_onSelectedAccountChange).bind(this));
     }
     getNftApi() {
         return `${controller_utils_1.NFT_API_BASE_URL}/tokens`;
@@ -170,7 +170,7 @@ class NftController extends base_controller_1.BaseController {
     async isNftOwner(ownerAddress, nftAddress, tokenId, networkClientId) {
         // Checks the ownership for ERC-721.
         try {
-            const owner = await this.messagingSystem.call('AssetsContractController:getERC721OwnerOf', nftAddress, tokenId, networkClientId);
+            const owner = await this.messenger.call('AssetsContractController:getERC721OwnerOf', nftAddress, tokenId, networkClientId);
             return ownerAddress.toLowerCase() === owner.toLowerCase();
         }
         catch {
@@ -178,7 +178,7 @@ class NftController extends base_controller_1.BaseController {
         }
         // Checks the ownership for ERC-1155.
         try {
-            const balance = await this.messagingSystem.call('AssetsContractController:getERC1155BalanceOf', ownerAddress, nftAddress, tokenId, networkClientId);
+            const balance = await this.messenger.call('AssetsContractController:getERC1155BalanceOf', ownerAddress, nftAddress, tokenId, networkClientId);
             return !balance.isZero();
         }
         catch {
@@ -242,7 +242,7 @@ class NftController extends base_controller_1.BaseController {
         });
         // If NFT contract was not added, do not add individual NFT
         const nftContract = newNftContracts.find((contract) => contract.address.toLowerCase() === checksumHexAddress.toLowerCase());
-        const { configuration: { chainId }, } = this.messagingSystem.call('NetworkController:getNetworkClientById', networkClientId);
+        const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
         // This is the case when the NFT is added manually and not detected automatically
         // TODO: An improvement would be to make the chainId a required field and return it when getting the NFT information
         if (!nftMetadata.chainId) {
@@ -273,7 +273,7 @@ class NftController extends base_controller_1.BaseController {
             // Get all unsanitized nft metadata
             const unsanitizedResults = await Promise.all(nftsWithChecksumAdr.map(async (nft) => {
                 // Each NFT should have a chainId; convert nft.chainId to networkClientId
-                const networkClientId = this.messagingSystem.call('NetworkController:findNetworkClientIdByChainId', (0, controller_utils_1.toHex)(nft.chainId));
+                const networkClientId = this.messenger.call('NetworkController:findNetworkClientIdByChainId', (0, controller_utils_1.toHex)(nft.chainId));
                 const resMetadata = networkClientId
                     ? await __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_getNftInformation).call(this, nft.address, nft.tokenId, networkClientId)
                     : undefined;
@@ -332,7 +332,7 @@ class NftController extends base_controller_1.BaseController {
      */
     removeNft(address, tokenId, networkClientId, { userAddress } = {}) {
         const addressToSearch = __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_getAddressOrSelectedAddress).call(this, userAddress);
-        const { configuration: { chainId }, } = this.messagingSystem.call('NetworkController:getNetworkClientById', networkClientId);
+        const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
         const checksumHexAddress = (0, controller_utils_1.toChecksumHexAddress)(address);
         __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_removeIndividualNft).call(this, checksumHexAddress, tokenId, {
             chainId,
@@ -359,7 +359,7 @@ class NftController extends base_controller_1.BaseController {
      */
     removeAndIgnoreNft(address, tokenId, networkClientId, { userAddress } = {}) {
         const addressToSearch = __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_getAddressOrSelectedAddress).call(this, userAddress);
-        const { configuration: { chainId }, } = this.messagingSystem.call('NetworkController:getNetworkClientById', networkClientId);
+        const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
         const checksumHexAddress = (0, controller_utils_1.toChecksumHexAddress)(address);
         __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_removeAndIgnoreIndividualNft).call(this, checksumHexAddress, tokenId, {
             chainId,
@@ -396,7 +396,7 @@ class NftController extends base_controller_1.BaseController {
      */
     async checkAndUpdateSingleNftOwnershipStatus(nft, batch, networkClientId, { userAddress } = {}) {
         const addressToSearch = __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_getAddressOrSelectedAddress).call(this, userAddress);
-        const { configuration: { chainId }, } = this.messagingSystem.call('NetworkController:getNetworkClientById', networkClientId);
+        const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
         const { address, tokenId } = nft;
         let isOwned = nft.isCurrentlyOwned;
         try {
@@ -443,7 +443,7 @@ class NftController extends base_controller_1.BaseController {
      */
     async checkAndUpdateAllNftsOwnershipStatus(networkClientId, { userAddress, } = {}) {
         const addressToSearch = __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_getAddressOrSelectedAddress).call(this, userAddress);
-        const { configuration: { chainId }, } = this.messagingSystem.call('NetworkController:getNetworkClientById', networkClientId);
+        const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
         const { allNfts } = this.state;
         const nfts = allNfts[addressToSearch]?.[chainId] || [];
         const updatedNfts = await Promise.all(nfts.map(async (nft) => {
@@ -468,7 +468,7 @@ class NftController extends base_controller_1.BaseController {
      */
     updateNftFavoriteStatus(address, tokenId, favorite, networkClientId, { userAddress, } = {}) {
         const addressToSearch = __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_getAddressOrSelectedAddress).call(this, userAddress);
-        const { configuration: { chainId }, } = this.messagingSystem.call('NetworkController:getNetworkClientById', networkClientId);
+        const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
         const { allNfts } = this.state;
         const nfts = [...(allNfts[addressToSearch]?.[chainId] || [])];
         const index = nfts.findIndex((nft) => nft.address === address && nft.tokenId === tokenId);
@@ -584,7 +584,7 @@ class NftController extends base_controller_1.BaseController {
         });
     }
     async _requestApproval(suggestedNftMeta) {
-        return this.messagingSystem.call('ApprovalController:addRequest', {
+        return this.messenger.call('ApprovalController:addRequest', {
             id: suggestedNftMeta.id,
             origin: suggestedNftMeta.origin,
             type: controller_utils_1.ApprovalType.WatchAsset,
@@ -623,7 +623,7 @@ _NftController_mutex = new WeakMap(), _NftController_selectedAccountId = new Wea
  * @param preferencesState.openSeaEnabled - Controls whether the NFT API is used (extension).
  */
 async function _NftController_onPreferencesControllerStateChange({ ipfsGateway, isIpfsGatewayEnabled, displayNftMedia, openSeaEnabled, }) {
-    const selectedAccount = this.messagingSystem.call('AccountsController:getSelectedAccount');
+    const selectedAccount = this.messenger.call('AccountsController:getSelectedAccount');
     __classPrivateFieldSet(this, _NftController_selectedAccountId, selectedAccount.id, "f");
     const newDisplayNftMedia = Boolean(displayNftMedia || openSeaEnabled);
     // Get current state values
@@ -827,7 +827,7 @@ async function _NftController_getNftInformationFromTokenURI(contractAddress, tok
 async function _NftController_getNftURIAndStandard(contractAddress, tokenId, networkClientId) {
     // try ERC721 uri
     try {
-        const uri = await this.messagingSystem.call('AssetsContractController:getERC721TokenURI', contractAddress, tokenId, networkClientId);
+        const uri = await this.messenger.call('AssetsContractController:getERC721TokenURI', contractAddress, tokenId, networkClientId);
         return [uri, controller_utils_1.ERC721];
     }
     catch {
@@ -835,7 +835,7 @@ async function _NftController_getNftURIAndStandard(contractAddress, tokenId, net
     }
     // try ERC1155 uri
     try {
-        const tokenURI = await this.messagingSystem.call('AssetsContractController:getERC1155TokenURI', contractAddress, tokenId, networkClientId);
+        const tokenURI = await this.messenger.call('AssetsContractController:getERC1155TokenURI', contractAddress, tokenId, networkClientId);
         /**
          * According to EIP1155 the URI value allows for ID substitution
          * in case the string `{id}` exists.
@@ -863,7 +863,7 @@ async function _NftController_getNftURIAndStandard(contractAddress, tokenId, net
  * @returns Promise resolving to the current NFT name and image.
  */
 async function _NftController_getNftInformation(contractAddress, tokenId, networkClientId) {
-    const { configuration: { chainId }, } = this.messagingSystem.call('NetworkController:getNetworkClientById', networkClientId);
+    const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
     const [blockchainMetadata, nftApiMetadata] = await Promise.all([
         (0, controller_utils_1.safelyExecute)(() => __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_getNftInformationFromTokenURI).call(this, contractAddress, tokenId, networkClientId)),
         __classPrivateFieldGet(this, _NftController_displayNftMedia, "f") && chainId === '0x1'
@@ -892,8 +892,8 @@ async function _NftController_getNftContractInformationFromContract(
 // TODO for calls to blockchain we need to explicitly pass the currentNetworkClientId since its relying on the provider
 contractAddress, networkClientId) {
     const [name, symbol] = await Promise.all([
-        this.messagingSystem.call('AssetsContractController:getERC721AssetName', contractAddress, networkClientId),
-        this.messagingSystem.call('AssetsContractController:getERC721AssetSymbol', contractAddress, networkClientId),
+        this.messenger.call('AssetsContractController:getERC721AssetName', contractAddress, networkClientId),
+        this.messenger.call('AssetsContractController:getERC721AssetSymbol', contractAddress, networkClientId),
     ]);
     return {
         collection: { name },
@@ -1022,7 +1022,7 @@ async function _NftController_addNftContract(networkClientId, { tokenAddress, us
     try {
         const checksumHexAddress = (0, controller_utils_1.toChecksumHexAddress)(tokenAddress);
         const { allNftContracts } = this.state;
-        const { configuration: { chainId }, } = this.messagingSystem.call('NetworkController:getNetworkClientById', networkClientId);
+        const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
         const nftContracts = allNftContracts[userAddress]?.[chainId] || [];
         const existingEntry = nftContracts.find((nftContract) => nftContract.address.toLowerCase() ===
             checksumHexAddress.toLowerCase());
@@ -1140,7 +1140,7 @@ async function _NftController_addNftContract(networkClientId, { tokenAddress, us
         return address;
     }
     // If the address is not defined (or empty), we fallback to the currently selected account's address
-    const selectedAccount = this.messagingSystem.call('AccountsController:getAccount', __classPrivateFieldGet(this, _NftController_selectedAccountId, "f"));
+    const selectedAccount = this.messenger.call('AccountsController:getAccount', __classPrivateFieldGet(this, _NftController_selectedAccountId, "f"));
     return selectedAccount?.address || '';
 }, _NftController_updateNftUpdateForAccount = 
 /**
@@ -1218,7 +1218,7 @@ async function _NftController_bulkSanitizeNftMetadata(metadataList) {
     }
     try {
         // Use bulkScanUrls to check all URLs at once
-        const bulkScanResponse = await this.messagingSystem.call('PhishingController:bulkScanUrls', urlsToCheck);
+        const bulkScanResponse = await this.messenger.call('PhishingController:bulkScanUrls', urlsToCheck);
         // Apply scan results to all metadata objects
         Object.entries(bulkScanResponse.results).forEach(([url, result]) => {
             if (result.recommendedAction === phishing_controller_1.RecommendedAction.Block) {