@metamask/assets-controllers 45.1.1 → 46.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/CHANGELOG.md +35 -1
  2. package/dist/AccountTrackerController.d.cts +2 -2
  3. package/dist/AccountTrackerController.d.mts +2 -2
  4. package/dist/CurrencyRateController.d.cts +2 -2
  5. package/dist/CurrencyRateController.d.mts +2 -2
  6. package/dist/MultichainBalancesController/BalancesTracker.cjs +122 -0
  7. package/dist/MultichainBalancesController/BalancesTracker.cjs.map +1 -0
  8. package/dist/MultichainBalancesController/BalancesTracker.d.cts +54 -0
  9. package/dist/MultichainBalancesController/BalancesTracker.d.cts.map +1 -0
  10. package/dist/MultichainBalancesController/BalancesTracker.d.mts +54 -0
  11. package/dist/MultichainBalancesController/BalancesTracker.d.mts.map +1 -0
  12. package/dist/MultichainBalancesController/BalancesTracker.mjs +118 -0
  13. package/dist/MultichainBalancesController/BalancesTracker.mjs.map +1 -0
  14. package/dist/MultichainBalancesController/MultichainBalancesController.cjs +194 -0
  15. package/dist/MultichainBalancesController/MultichainBalancesController.cjs.map +1 -0
  16. package/dist/MultichainBalancesController/MultichainBalancesController.d.cts +94 -0
  17. package/dist/MultichainBalancesController/MultichainBalancesController.d.cts.map +1 -0
  18. package/dist/MultichainBalancesController/MultichainBalancesController.d.mts +94 -0
  19. package/dist/MultichainBalancesController/MultichainBalancesController.d.mts.map +1 -0
  20. package/dist/MultichainBalancesController/MultichainBalancesController.mjs +189 -0
  21. package/dist/MultichainBalancesController/MultichainBalancesController.mjs.map +1 -0
  22. package/dist/MultichainBalancesController/Poller.cjs +45 -0
  23. package/dist/MultichainBalancesController/Poller.cjs.map +1 -0
  24. package/dist/MultichainBalancesController/Poller.d.cts +7 -0
  25. package/dist/MultichainBalancesController/Poller.d.cts.map +1 -0
  26. package/dist/MultichainBalancesController/Poller.d.mts +7 -0
  27. package/dist/MultichainBalancesController/Poller.d.mts.map +1 -0
  28. package/dist/MultichainBalancesController/Poller.mjs +41 -0
  29. package/dist/MultichainBalancesController/Poller.mjs.map +1 -0
  30. package/dist/MultichainBalancesController/constants.cjs +45 -0
  31. package/dist/MultichainBalancesController/constants.cjs.map +1 -0
  32. package/dist/MultichainBalancesController/constants.d.cts +29 -0
  33. package/dist/MultichainBalancesController/constants.d.cts.map +1 -0
  34. package/dist/MultichainBalancesController/constants.d.mts +29 -0
  35. package/dist/MultichainBalancesController/constants.d.mts.map +1 -0
  36. package/dist/MultichainBalancesController/constants.mjs +42 -0
  37. package/dist/MultichainBalancesController/constants.mjs.map +1 -0
  38. package/dist/MultichainBalancesController/error.cjs +18 -0
  39. package/dist/MultichainBalancesController/error.cjs.map +1 -0
  40. package/dist/MultichainBalancesController/error.d.cts +7 -0
  41. package/dist/MultichainBalancesController/error.d.cts.map +1 -0
  42. package/dist/MultichainBalancesController/error.d.mts +7 -0
  43. package/dist/MultichainBalancesController/error.d.mts.map +1 -0
  44. package/dist/MultichainBalancesController/error.mjs +13 -0
  45. package/dist/MultichainBalancesController/error.mjs.map +1 -0
  46. package/dist/MultichainBalancesController/index.cjs +13 -0
  47. package/dist/MultichainBalancesController/index.cjs.map +1 -0
  48. package/dist/MultichainBalancesController/index.d.cts +5 -0
  49. package/dist/MultichainBalancesController/index.d.cts.map +1 -0
  50. package/dist/MultichainBalancesController/index.d.mts +5 -0
  51. package/dist/MultichainBalancesController/index.d.mts.map +1 -0
  52. package/dist/MultichainBalancesController/index.mjs +4 -0
  53. package/dist/MultichainBalancesController/index.mjs.map +1 -0
  54. package/dist/MultichainBalancesController/utils.cjs +73 -0
  55. package/dist/MultichainBalancesController/utils.cjs.map +1 -0
  56. package/dist/MultichainBalancesController/utils.d.cts +36 -0
  57. package/dist/MultichainBalancesController/utils.d.cts.map +1 -0
  58. package/dist/MultichainBalancesController/utils.d.mts +36 -0
  59. package/dist/MultichainBalancesController/utils.d.mts.map +1 -0
  60. package/dist/MultichainBalancesController/utils.mjs +66 -0
  61. package/dist/MultichainBalancesController/utils.mjs.map +1 -0
  62. package/dist/NftController.cjs.map +1 -1
  63. package/dist/NftController.mjs.map +1 -1
  64. package/dist/TokenBalancesController.d.cts +2 -2
  65. package/dist/TokenBalancesController.d.mts +2 -2
  66. package/dist/TokenDetectionController.d.cts +2 -2
  67. package/dist/TokenDetectionController.d.mts +2 -2
  68. package/dist/TokenListController.d.cts +2 -2
  69. package/dist/TokenListController.d.mts +2 -2
  70. package/dist/TokenRatesController.cjs.map +1 -1
  71. package/dist/TokenRatesController.d.cts +2 -2
  72. package/dist/TokenRatesController.d.mts +2 -2
  73. package/dist/TokenRatesController.mjs.map +1 -1
  74. package/dist/TokensController.cjs +6 -4
  75. package/dist/TokensController.cjs.map +1 -1
  76. package/dist/TokensController.d.cts.map +1 -1
  77. package/dist/TokensController.d.mts.map +1 -1
  78. package/dist/TokensController.mjs +6 -4
  79. package/dist/TokensController.mjs.map +1 -1
  80. package/dist/assetsUtil.cjs +16 -1
  81. package/dist/assetsUtil.cjs.map +1 -1
  82. package/dist/assetsUtil.d.cts +7 -0
  83. package/dist/assetsUtil.d.cts.map +1 -1
  84. package/dist/assetsUtil.d.mts +7 -0
  85. package/dist/assetsUtil.d.mts.map +1 -1
  86. package/dist/assetsUtil.mjs +14 -0
  87. package/dist/assetsUtil.mjs.map +1 -1
  88. package/dist/crypto-compare-service/crypto-compare.cjs +5 -2
  89. package/dist/crypto-compare-service/crypto-compare.cjs.map +1 -1
  90. package/dist/crypto-compare-service/crypto-compare.d.cts.map +1 -1
  91. package/dist/crypto-compare-service/crypto-compare.d.mts.map +1 -1
  92. package/dist/crypto-compare-service/crypto-compare.mjs +5 -2
  93. package/dist/crypto-compare-service/crypto-compare.mjs.map +1 -1
  94. package/dist/index.cjs +10 -1
  95. package/dist/index.cjs.map +1 -1
  96. package/dist/index.d.cts +3 -1
  97. package/dist/index.d.cts.map +1 -1
  98. package/dist/index.d.mts +3 -1
  99. package/dist/index.d.mts.map +1 -1
  100. package/dist/index.mjs +4 -1
  101. package/dist/index.mjs.map +1 -1
  102. package/dist/multicall.cjs +16 -3
  103. package/dist/multicall.cjs.map +1 -1
  104. package/dist/multicall.d.cts.map +1 -1
  105. package/dist/multicall.d.mts.map +1 -1
  106. package/dist/multicall.mjs +16 -3
  107. package/dist/multicall.mjs.map +1 -1
  108. package/package.json +17 -11
@@ -0,0 +1,194 @@
1
+ "use strict";
2
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
3
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
4
+ 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");
5
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
6
+ };
7
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
8
+ if (kind === "m") throw new TypeError("Private method is not writable");
9
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
10
+ 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");
11
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
12
+ };
13
+ var _MultichainBalancesController_instances, _MultichainBalancesController_tracker, _MultichainBalancesController_listMultichainAccounts, _MultichainBalancesController_listAccounts, _MultichainBalancesController_getAccount, _MultichainBalancesController_updateBalance, _MultichainBalancesController_isNonEvmAccount, _MultichainBalancesController_handleOnAccountAdded, _MultichainBalancesController_handleOnAccountRemoved, _MultichainBalancesController_getBalances, _MultichainBalancesController_getClient;
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.MultichainBalancesController = exports.getDefaultMultichainBalancesControllerState = void 0;
16
+ const base_controller_1 = require("@metamask/base-controller");
17
+ const keyring_api_1 = require("@metamask/keyring-api");
18
+ const keyring_snap_client_1 = require("@metamask/keyring-snap-client");
19
+ const snaps_utils_1 = require("@metamask/snaps-utils");
20
+ const _1 = require("./index.cjs");
21
+ const utils_1 = require("./utils.cjs");
22
+ const controllerName = 'MultichainBalancesController';
23
+ /**
24
+ * Constructs the default {@link MultichainBalancesController} state. This allows
25
+ * consumers to provide a partial state object when initializing the controller
26
+ * and also helps in constructing complete state objects for this controller in
27
+ * tests.
28
+ *
29
+ * @returns The default {@link MultichainBalancesController} state.
30
+ */
31
+ function getDefaultMultichainBalancesControllerState() {
32
+ return { balances: {} };
33
+ }
34
+ exports.getDefaultMultichainBalancesControllerState = getDefaultMultichainBalancesControllerState;
35
+ /**
36
+ * {@link MultichainBalancesController}'s metadata.
37
+ *
38
+ * This allows us to choose if fields of the state should be persisted or not
39
+ * using the `persist` flag; and if they can be sent to Sentry or not, using
40
+ * the `anonymous` flag.
41
+ */
42
+ const balancesControllerMetadata = {
43
+ balances: {
44
+ persist: true,
45
+ anonymous: false,
46
+ },
47
+ };
48
+ /**
49
+ * The MultichainBalancesController is responsible for fetching and caching account
50
+ * balances.
51
+ */
52
+ class MultichainBalancesController extends base_controller_1.BaseController {
53
+ constructor({ messenger, state = {}, }) {
54
+ super({
55
+ messenger,
56
+ name: controllerName,
57
+ metadata: balancesControllerMetadata,
58
+ state: {
59
+ ...getDefaultMultichainBalancesControllerState(),
60
+ ...state,
61
+ },
62
+ });
63
+ _MultichainBalancesController_instances.add(this);
64
+ _MultichainBalancesController_tracker.set(this, void 0);
65
+ __classPrivateFieldSet(this, _MultichainBalancesController_tracker, new _1.BalancesTracker(async (accountId) => await __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_updateBalance).call(this, accountId)), "f");
66
+ // Register all non-EVM accounts into the tracker
67
+ for (const account of __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_listAccounts).call(this)) {
68
+ if (__classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_isNonEvmAccount).call(this, account)) {
69
+ __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").track(account.id, (0, utils_1.getBlockTimeForAccount)(account.type));
70
+ }
71
+ }
72
+ this.messagingSystem.subscribe('AccountsController:accountAdded', (account) => __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_handleOnAccountAdded).call(this, account));
73
+ this.messagingSystem.subscribe('AccountsController:accountRemoved', (account) => __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_handleOnAccountRemoved).call(this, account));
74
+ }
75
+ /**
76
+ * Starts the polling process.
77
+ */
78
+ start() {
79
+ __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").start();
80
+ }
81
+ /**
82
+ * Stops the polling process.
83
+ */
84
+ stop() {
85
+ __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").stop();
86
+ }
87
+ /**
88
+ * Updates the balances of one account. This method doesn't return
89
+ * anything, but it updates the state of the controller.
90
+ *
91
+ * @param accountId - The account ID.
92
+ */
93
+ async updateBalance(accountId) {
94
+ // NOTE: No need to track the account here, since we start tracking those when
95
+ // the "AccountsController:accountAdded" is fired.
96
+ await __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").updateBalance(accountId);
97
+ }
98
+ /**
99
+ * Updates the balances of all supported accounts. This method doesn't return
100
+ * anything, but it updates the state of the controller.
101
+ */
102
+ async updateBalances() {
103
+ await __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").updateBalances();
104
+ }
105
+ }
106
+ exports.MultichainBalancesController = MultichainBalancesController;
107
+ _MultichainBalancesController_tracker = new WeakMap(), _MultichainBalancesController_instances = new WeakSet(), _MultichainBalancesController_listMultichainAccounts = function _MultichainBalancesController_listMultichainAccounts() {
108
+ return this.messagingSystem.call('AccountsController:listMultichainAccounts');
109
+ }, _MultichainBalancesController_listAccounts = function _MultichainBalancesController_listAccounts() {
110
+ const accounts = __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_listMultichainAccounts).call(this);
111
+ return accounts.filter((account) => __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_isNonEvmAccount).call(this, account));
112
+ }, _MultichainBalancesController_getAccount = function _MultichainBalancesController_getAccount(accountId) {
113
+ const account = __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_listAccounts).call(this).find((multichainAccount) => multichainAccount.id === accountId);
114
+ if (!account) {
115
+ throw new Error(`Unknown account: ${accountId}`);
116
+ }
117
+ return account;
118
+ }, _MultichainBalancesController_updateBalance =
119
+ /**
120
+ * Updates the balances of one account. This method doesn't return
121
+ * anything, but it updates the state of the controller.
122
+ *
123
+ * @param accountId - The account ID.
124
+ */
125
+ async function _MultichainBalancesController_updateBalance(accountId) {
126
+ const account = __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_getAccount).call(this, accountId);
127
+ if (account.metadata.snap) {
128
+ const scope = (0, utils_1.getScopeForAccount)(account);
129
+ const assetTypes = _1.NETWORK_ASSETS_MAP[scope];
130
+ const accountBalance = await __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_getBalances).call(this, account.id, account.metadata.snap.id, assetTypes);
131
+ this.update((state) => {
132
+ state.balances[accountId] = accountBalance;
133
+ });
134
+ }
135
+ }, _MultichainBalancesController_isNonEvmAccount = function _MultichainBalancesController_isNonEvmAccount(account) {
136
+ return (!(0, keyring_api_1.isEvmAccountType)(account.type) &&
137
+ // Non-EVM accounts are backed by a Snap for now
138
+ account.metadata.snap !== undefined);
139
+ }, _MultichainBalancesController_handleOnAccountAdded =
140
+ /**
141
+ * Handles changes when a new account has been added.
142
+ *
143
+ * @param account - The new account being added.
144
+ */
145
+ async function _MultichainBalancesController_handleOnAccountAdded(account) {
146
+ if (!__classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_isNonEvmAccount).call(this, account)) {
147
+ // Nothing to do here for EVM accounts
148
+ return;
149
+ }
150
+ __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").track(account.id, (0, utils_1.getBlockTimeForAccount)(account.type));
151
+ // NOTE: Unfortunately, we cannot update the balance right away here, because
152
+ // messenger's events are running synchronously and fetching the balance is
153
+ // asynchronous.
154
+ // Updating the balance here would resume at some point but the event emitter
155
+ // will not `await` this (so we have no real control "when" the balance will
156
+ // really be updated), see:
157
+ // - https://github.com/MetaMask/core/blob/v213.0.0/packages/accounts-controller/src/AccountsController.ts#L1036-L1039
158
+ }, _MultichainBalancesController_handleOnAccountRemoved =
159
+ /**
160
+ * Handles changes when a new account has been removed.
161
+ *
162
+ * @param accountId - The account ID being removed.
163
+ */
164
+ async function _MultichainBalancesController_handleOnAccountRemoved(accountId) {
165
+ if (__classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").isTracked(accountId)) {
166
+ __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").untrack(accountId);
167
+ }
168
+ if (accountId in this.state.balances) {
169
+ this.update((state) => {
170
+ delete state.balances[accountId];
171
+ });
172
+ }
173
+ }, _MultichainBalancesController_getBalances =
174
+ /**
175
+ * Get the balances for an account.
176
+ *
177
+ * @param accountId - ID of the account to get balances for.
178
+ * @param snapId - ID of the Snap which manages the account.
179
+ * @param assetTypes - Array of asset types to get balances for.
180
+ * @returns A map of asset types to balances.
181
+ */
182
+ async function _MultichainBalancesController_getBalances(accountId, snapId, assetTypes) {
183
+ return await __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_getClient).call(this, snapId).getAccountBalances(accountId, assetTypes);
184
+ }, _MultichainBalancesController_getClient = function _MultichainBalancesController_getClient(snapId) {
185
+ return new keyring_snap_client_1.KeyringClient({
186
+ send: async (request) => (await this.messagingSystem.call('SnapController:handleRequest', {
187
+ snapId: snapId,
188
+ origin: 'metamask',
189
+ handler: snaps_utils_1.HandlerType.OnKeyringRequest,
190
+ request,
191
+ })),
192
+ });
193
+ };
194
+ //# sourceMappingURL=MultichainBalancesController.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"MultichainBalancesController.cjs","sourceRoot":"","sources":["../../src/MultichainBalancesController/MultichainBalancesController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,+DAKmC;AACnC,uDAAyD;AAGzD,uEAA8D;AAG9D,uDAAoD;AAIpD,kCAAwD;AACxD,uCAAqE;AAErE,MAAM,cAAc,GAAG,8BAA8B,CAAC;AAgBtD;;;;;;;GAOG;AACH,SAAgB,2CAA2C;IACzD,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;AAC1B,CAAC;AAFD,kGAEC;AAmED;;;;;;GAMG;AACH,MAAM,0BAA0B,GAAG;IACjC,QAAQ,EAAE;QACR,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,KAAK;KACjB;CACF,CAAC;AAEF;;;GAGG;AACH,MAAa,4BAA6B,SAAQ,gCAIjD;IAGC,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;;QAjBL,wDAA0B;QAmBxB,uBAAA,IAAI,yCAAY,IAAI,kBAAe,CACjC,KAAK,EAAE,SAAiB,EAAE,EAAE,CAAC,MAAM,uBAAA,IAAI,4FAAe,MAAnB,IAAI,EAAgB,SAAS,CAAC,CAClE,MAAA,CAAC;QAEF,iDAAiD;QACjD,KAAK,MAAM,OAAO,IAAI,uBAAA,IAAI,2FAAc,MAAlB,IAAI,CAAgB,EAAE;YAC1C,IAAI,uBAAA,IAAI,8FAAiB,MAArB,IAAI,EAAkB,OAAO,CAAC,EAAE;gBAClC,uBAAA,IAAI,6CAAS,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,IAAA,8BAAsB,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;aACvE;SACF;QAED,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,iCAAiC,EACjC,CAAC,OAAO,EAAE,EAAE,CAAC,uBAAA,IAAI,mGAAsB,MAA1B,IAAI,EAAuB,OAAO,CAAC,CACjD,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,CAAC,OAAO,EAAE,EAAE,CAAC,uBAAA,IAAI,qGAAwB,MAA5B,IAAI,EAAyB,OAAO,CAAC,CACnD,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK;QACH,uBAAA,IAAI,6CAAS,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,uBAAA,IAAI,6CAAS,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,SAAiB;QACnC,8EAA8E;QAC9E,kDAAkD;QAClD,MAAM,uBAAA,IAAI,6CAAS,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,uBAAA,IAAI,6CAAS,CAAC,cAAc,EAAE,CAAC;IACvC,CAAC;CA4JF;AAzOD,oEAyOC;;IApJG,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAC9B,2CAA2C,CAC5C,CAAC;AACJ,CAAC;IAQC,MAAM,QAAQ,GAAG,uBAAA,IAAI,qGAAwB,MAA5B,IAAI,CAA0B,CAAC;IAEhD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,uBAAA,IAAI,8FAAiB,MAArB,IAAI,EAAkB,OAAO,CAAC,CAAC,CAAC;AACtE,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;AAED;;;;;GAKG;AAEH,KAAK,sDAAgB,SAAiB;IACpC,MAAM,OAAO,GAAG,uBAAA,IAAI,yFAAY,MAAhB,IAAI,EAAa,SAAS,CAAC,CAAC;IAE5C,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;QACzB,MAAM,KAAK,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,qBAAkB,CAAC,KAAK,CAAC,CAAC;QAE7C,MAAM,cAAc,GAAG,MAAM,uBAAA,IAAI,0FAAa,MAAjB,IAAI,EAC/B,OAAO,CAAC,EAAE,EACV,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EACxB,UAAU,CACX,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAA+C,EAAE,EAAE;YAC9D,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC;QAC7C,CAAC,CAAC,CAAC;KACJ;AACH,CAAC,yGAQgB,OAAwB;IACvC,OAAO,CACL,CAAC,IAAA,8BAAgB,EAAC,OAAO,CAAC,IAAI,CAAC;QAC/B,gDAAgD;QAChD,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,CACpC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,KAAK,6DAAuB,OAAwB;IAClD,IAAI,CAAC,uBAAA,IAAI,8FAAiB,MAArB,IAAI,EAAkB,OAAO,CAAC,EAAE;QACnC,sCAAsC;QACtC,OAAO;KACR;IAED,uBAAA,IAAI,6CAAS,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,IAAA,8BAAsB,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,6EAA6E;IAC7E,2EAA2E;IAC3E,gBAAgB;IAChB,6EAA6E;IAC7E,4EAA4E;IAC5E,2BAA2B;IAC3B,sHAAsH;AACxH,CAAC;AAED;;;;GAIG;AACH,KAAK,+DAAyB,SAAiB;IAC7C,IAAI,uBAAA,IAAI,6CAAS,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE;QACtC,uBAAA,IAAI,6CAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;KAClC;IAED,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,mCAAa,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,yBAAW,CAAC,gBAAgB;YACrC,OAAO;SACR,CAAC,CAAkB;KACvB,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type {\n AccountsControllerAccountAddedEvent,\n AccountsControllerAccountRemovedEvent,\n AccountsControllerListMultichainAccountsAction,\n} from '@metamask/accounts-controller';\nimport {\n BaseController,\n type ControllerGetStateAction,\n type ControllerStateChangeEvent,\n type RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport { isEvmAccountType } from '@metamask/keyring-api';\nimport type { Balance, CaipAssetType } from '@metamask/keyring-api';\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 { BalancesTracker, NETWORK_ASSETS_MAP } from '.';\nimport { getScopeForAccount, getBlockTimeForAccount } from './utils';\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 * Updates the balances of all supported accounts.\n */\nexport type MultichainBalancesControllerUpdateBalancesAction = {\n type: `${typeof controllerName}:updateBalances`;\n handler: MultichainBalancesController['updateBalances'];\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 | MultichainBalancesControllerUpdateBalancesAction;\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\n/**\n * Events that this controller is allowed to subscribe.\n */\ntype AllowedEvents =\n | AccountsControllerAccountAddedEvent\n | AccountsControllerAccountRemovedEvent;\n\n/**\n * Messenger type for the MultichainBalancesController.\n */\nexport type MultichainBalancesControllerMessenger =\n RestrictedControllerMessenger<\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 persist: true,\n anonymous: false,\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 #tracker: BalancesTracker;\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 this.#tracker = new BalancesTracker(\n async (accountId: string) => await this.#updateBalance(accountId),\n );\n\n // Register all non-EVM accounts into the tracker\n for (const account of this.#listAccounts()) {\n if (this.#isNonEvmAccount(account)) {\n this.#tracker.track(account.id, getBlockTimeForAccount(account.type));\n }\n }\n\n this.messagingSystem.subscribe(\n 'AccountsController:accountAdded',\n (account) => this.#handleOnAccountAdded(account),\n );\n this.messagingSystem.subscribe(\n 'AccountsController:accountRemoved',\n (account) => this.#handleOnAccountRemoved(account),\n );\n }\n\n /**\n * Starts the polling process.\n */\n start(): void {\n this.#tracker.start();\n }\n\n /**\n * Stops the polling process.\n */\n stop(): void {\n this.#tracker.stop();\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 // NOTE: No need to track the account here, since we start tracking those when\n // the \"AccountsController:accountAdded\" is fired.\n await this.#tracker.updateBalance(accountId);\n }\n\n /**\n * Updates the balances of all supported accounts. This method doesn't return\n * anything, but it updates the state of the controller.\n */\n async updateBalances(): Promise<void> {\n await this.#tracker.updateBalances();\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\n return accounts.filter((account) => this.#isNonEvmAccount(account));\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 * 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\n async #updateBalance(accountId: string) {\n const account = this.#getAccount(accountId);\n\n if (account.metadata.snap) {\n const scope = getScopeForAccount(account);\n const assetTypes = NETWORK_ASSETS_MAP[scope];\n\n const accountBalance = await this.#getBalances(\n account.id,\n account.metadata.snap.id,\n assetTypes,\n );\n\n this.update((state: Draft<MultichainBalancesControllerState>) => {\n state.balances[accountId] = accountBalance;\n });\n }\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 changes when a new account has been added.\n *\n * @param account - The new account being added.\n */\n async #handleOnAccountAdded(account: InternalAccount): Promise<void> {\n if (!this.#isNonEvmAccount(account)) {\n // Nothing to do here for EVM accounts\n return;\n }\n\n this.#tracker.track(account.id, getBlockTimeForAccount(account.type));\n // NOTE: Unfortunately, we cannot update the balance right away here, because\n // messenger's events are running synchronously and fetching the balance is\n // asynchronous.\n // Updating the balance here would resume at some point but the event emitter\n // will not `await` this (so we have no real control \"when\" the balance will\n // really be updated), see:\n // - https://github.com/MetaMask/core/blob/v213.0.0/packages/accounts-controller/src/AccountsController.ts#L1036-L1039\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 (this.#tracker.isTracked(accountId)) {\n this.#tracker.untrack(accountId);\n }\n\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"]}
@@ -0,0 +1,94 @@
1
+ import type { AccountsControllerAccountAddedEvent, AccountsControllerAccountRemovedEvent, AccountsControllerListMultichainAccountsAction } from "@metamask/accounts-controller";
2
+ import { BaseController, type ControllerGetStateAction, type ControllerStateChangeEvent, type RestrictedControllerMessenger } from "@metamask/base-controller";
3
+ import type { HandleSnapRequest } from "@metamask/snaps-controllers";
4
+ declare const controllerName = "MultichainBalancesController";
5
+ /**
6
+ * State used by the {@link MultichainBalancesController} to cache account balances.
7
+ */
8
+ export type MultichainBalancesControllerState = {
9
+ balances: {
10
+ [account: string]: {
11
+ [asset: string]: {
12
+ amount: string;
13
+ unit: string;
14
+ };
15
+ };
16
+ };
17
+ };
18
+ /**
19
+ * Constructs the default {@link MultichainBalancesController} state. This allows
20
+ * consumers to provide a partial state object when initializing the controller
21
+ * and also helps in constructing complete state objects for this controller in
22
+ * tests.
23
+ *
24
+ * @returns The default {@link MultichainBalancesController} state.
25
+ */
26
+ export declare function getDefaultMultichainBalancesControllerState(): MultichainBalancesControllerState;
27
+ /**
28
+ * Returns the state of the {@link MultichainBalancesController}.
29
+ */
30
+ export type MultichainBalancesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, MultichainBalancesControllerState>;
31
+ /**
32
+ * Updates the balances of all supported accounts.
33
+ */
34
+ export type MultichainBalancesControllerUpdateBalancesAction = {
35
+ type: `${typeof controllerName}:updateBalances`;
36
+ handler: MultichainBalancesController['updateBalances'];
37
+ };
38
+ /**
39
+ * Event emitted when the state of the {@link MultichainBalancesController} changes.
40
+ */
41
+ export type MultichainBalancesControllerStateChange = ControllerStateChangeEvent<typeof controllerName, MultichainBalancesControllerState>;
42
+ /**
43
+ * Actions exposed by the {@link MultichainBalancesController}.
44
+ */
45
+ export type MultichainBalancesControllerActions = MultichainBalancesControllerGetStateAction | MultichainBalancesControllerUpdateBalancesAction;
46
+ /**
47
+ * Events emitted by {@link MultichainBalancesController}.
48
+ */
49
+ export type MultichainBalancesControllerEvents = MultichainBalancesControllerStateChange;
50
+ /**
51
+ * Actions that this controller is allowed to call.
52
+ */
53
+ type AllowedActions = HandleSnapRequest | AccountsControllerListMultichainAccountsAction;
54
+ /**
55
+ * Events that this controller is allowed to subscribe.
56
+ */
57
+ type AllowedEvents = AccountsControllerAccountAddedEvent | AccountsControllerAccountRemovedEvent;
58
+ /**
59
+ * Messenger type for the MultichainBalancesController.
60
+ */
61
+ export type MultichainBalancesControllerMessenger = RestrictedControllerMessenger<typeof controllerName, MultichainBalancesControllerActions | AllowedActions, MultichainBalancesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
62
+ /**
63
+ * The MultichainBalancesController is responsible for fetching and caching account
64
+ * balances.
65
+ */
66
+ export declare class MultichainBalancesController extends BaseController<typeof controllerName, MultichainBalancesControllerState, MultichainBalancesControllerMessenger> {
67
+ #private;
68
+ constructor({ messenger, state, }: {
69
+ messenger: MultichainBalancesControllerMessenger;
70
+ state?: Partial<MultichainBalancesControllerState>;
71
+ });
72
+ /**
73
+ * Starts the polling process.
74
+ */
75
+ start(): void;
76
+ /**
77
+ * Stops the polling process.
78
+ */
79
+ stop(): void;
80
+ /**
81
+ * Updates the balances of one account. This method doesn't return
82
+ * anything, but it updates the state of the controller.
83
+ *
84
+ * @param accountId - The account ID.
85
+ */
86
+ updateBalance(accountId: string): Promise<void>;
87
+ /**
88
+ * Updates the balances of all supported accounts. This method doesn't return
89
+ * anything, but it updates the state of the controller.
90
+ */
91
+ updateBalances(): Promise<void>;
92
+ }
93
+ export {};
94
+ //# sourceMappingURL=MultichainBalancesController.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"MultichainBalancesController.d.cts","sourceRoot":"","sources":["../../src/MultichainBalancesController/MultichainBalancesController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EACrC,8CAA8C,EAC/C,sCAAsC;AACvC,OAAO,EACL,cAAc,EACd,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,6BAA6B,EACnC,kCAAkC;AAKnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AASrE,QAAA,MAAM,cAAc,iCAAiC,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,QAAQ,EAAE;QACR,CAAC,OAAO,EAAE,MAAM,GAAG;YACjB,CAAC,KAAK,EAAE,MAAM,GAAG;gBACf,MAAM,EAAE,MAAM,CAAC;gBACf,IAAI,EAAE,MAAM,CAAC;aACd,CAAC;SACH,CAAC;KACH,CAAC;CACH,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,2CAA2C,IAAI,iCAAiC,CAE/F;AAED;;GAEG;AACH,MAAM,MAAM,0CAA0C,GACpD,wBAAwB,CACtB,OAAO,cAAc,EACrB,iCAAiC,CAClC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,GAAG,OAAO,cAAc,iBAAiB,CAAC;IAChD,OAAO,EAAE,4BAA4B,CAAC,gBAAgB,CAAC,CAAC;CACzD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uCAAuC,GACjD,0BAA0B,CACxB,OAAO,cAAc,EACrB,iCAAiC,CAClC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC3C,0CAA0C,GAC1C,gDAAgD,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAC5C,uCAAuC,CAAC;AAE1C;;GAEG;AACH,KAAK,cAAc,GACf,iBAAiB,GACjB,8CAA8C,CAAC;AAEnD;;GAEG;AACH,KAAK,aAAa,GACd,mCAAmC,GACnC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,6BAA6B,CAC3B,OAAO,cAAc,EACrB,mCAAmC,GAAG,cAAc,EACpD,kCAAkC,GAAG,aAAa,EAClD,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAgBJ;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,cAAc,CAC9D,OAAO,cAAc,EACrB,iCAAiC,EACjC,qCAAqC,CACtC;;gBAGa,EACV,SAAS,EACT,KAAU,GACX,EAAE;QACD,SAAS,EAAE,qCAAqC,CAAC;QACjD,KAAK,CAAC,EAAE,OAAO,CAAC,iCAAiC,CAAC,CAAC;KACpD;IAgCD;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACH,IAAI,IAAI,IAAI;IAIZ;;;;;OAKG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CA8JtC"}
@@ -0,0 +1,94 @@
1
+ import type { AccountsControllerAccountAddedEvent, AccountsControllerAccountRemovedEvent, AccountsControllerListMultichainAccountsAction } from "@metamask/accounts-controller";
2
+ import { BaseController, type ControllerGetStateAction, type ControllerStateChangeEvent, type RestrictedControllerMessenger } from "@metamask/base-controller";
3
+ import type { HandleSnapRequest } from "@metamask/snaps-controllers";
4
+ declare const controllerName = "MultichainBalancesController";
5
+ /**
6
+ * State used by the {@link MultichainBalancesController} to cache account balances.
7
+ */
8
+ export type MultichainBalancesControllerState = {
9
+ balances: {
10
+ [account: string]: {
11
+ [asset: string]: {
12
+ amount: string;
13
+ unit: string;
14
+ };
15
+ };
16
+ };
17
+ };
18
+ /**
19
+ * Constructs the default {@link MultichainBalancesController} state. This allows
20
+ * consumers to provide a partial state object when initializing the controller
21
+ * and also helps in constructing complete state objects for this controller in
22
+ * tests.
23
+ *
24
+ * @returns The default {@link MultichainBalancesController} state.
25
+ */
26
+ export declare function getDefaultMultichainBalancesControllerState(): MultichainBalancesControllerState;
27
+ /**
28
+ * Returns the state of the {@link MultichainBalancesController}.
29
+ */
30
+ export type MultichainBalancesControllerGetStateAction = ControllerGetStateAction<typeof controllerName, MultichainBalancesControllerState>;
31
+ /**
32
+ * Updates the balances of all supported accounts.
33
+ */
34
+ export type MultichainBalancesControllerUpdateBalancesAction = {
35
+ type: `${typeof controllerName}:updateBalances`;
36
+ handler: MultichainBalancesController['updateBalances'];
37
+ };
38
+ /**
39
+ * Event emitted when the state of the {@link MultichainBalancesController} changes.
40
+ */
41
+ export type MultichainBalancesControllerStateChange = ControllerStateChangeEvent<typeof controllerName, MultichainBalancesControllerState>;
42
+ /**
43
+ * Actions exposed by the {@link MultichainBalancesController}.
44
+ */
45
+ export type MultichainBalancesControllerActions = MultichainBalancesControllerGetStateAction | MultichainBalancesControllerUpdateBalancesAction;
46
+ /**
47
+ * Events emitted by {@link MultichainBalancesController}.
48
+ */
49
+ export type MultichainBalancesControllerEvents = MultichainBalancesControllerStateChange;
50
+ /**
51
+ * Actions that this controller is allowed to call.
52
+ */
53
+ type AllowedActions = HandleSnapRequest | AccountsControllerListMultichainAccountsAction;
54
+ /**
55
+ * Events that this controller is allowed to subscribe.
56
+ */
57
+ type AllowedEvents = AccountsControllerAccountAddedEvent | AccountsControllerAccountRemovedEvent;
58
+ /**
59
+ * Messenger type for the MultichainBalancesController.
60
+ */
61
+ export type MultichainBalancesControllerMessenger = RestrictedControllerMessenger<typeof controllerName, MultichainBalancesControllerActions | AllowedActions, MultichainBalancesControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
62
+ /**
63
+ * The MultichainBalancesController is responsible for fetching and caching account
64
+ * balances.
65
+ */
66
+ export declare class MultichainBalancesController extends BaseController<typeof controllerName, MultichainBalancesControllerState, MultichainBalancesControllerMessenger> {
67
+ #private;
68
+ constructor({ messenger, state, }: {
69
+ messenger: MultichainBalancesControllerMessenger;
70
+ state?: Partial<MultichainBalancesControllerState>;
71
+ });
72
+ /**
73
+ * Starts the polling process.
74
+ */
75
+ start(): void;
76
+ /**
77
+ * Stops the polling process.
78
+ */
79
+ stop(): void;
80
+ /**
81
+ * Updates the balances of one account. This method doesn't return
82
+ * anything, but it updates the state of the controller.
83
+ *
84
+ * @param accountId - The account ID.
85
+ */
86
+ updateBalance(accountId: string): Promise<void>;
87
+ /**
88
+ * Updates the balances of all supported accounts. This method doesn't return
89
+ * anything, but it updates the state of the controller.
90
+ */
91
+ updateBalances(): Promise<void>;
92
+ }
93
+ export {};
94
+ //# sourceMappingURL=MultichainBalancesController.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"MultichainBalancesController.d.mts","sourceRoot":"","sources":["../../src/MultichainBalancesController/MultichainBalancesController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mCAAmC,EACnC,qCAAqC,EACrC,8CAA8C,EAC/C,sCAAsC;AACvC,OAAO,EACL,cAAc,EACd,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,6BAA6B,EACnC,kCAAkC;AAKnC,OAAO,KAAK,EAAE,iBAAiB,EAAE,oCAAoC;AASrE,QAAA,MAAM,cAAc,iCAAiC,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,QAAQ,EAAE;QACR,CAAC,OAAO,EAAE,MAAM,GAAG;YACjB,CAAC,KAAK,EAAE,MAAM,GAAG;gBACf,MAAM,EAAE,MAAM,CAAC;gBACf,IAAI,EAAE,MAAM,CAAC;aACd,CAAC;SACH,CAAC;KACH,CAAC;CACH,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,2CAA2C,IAAI,iCAAiC,CAE/F;AAED;;GAEG;AACH,MAAM,MAAM,0CAA0C,GACpD,wBAAwB,CACtB,OAAO,cAAc,EACrB,iCAAiC,CAClC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,GAAG,OAAO,cAAc,iBAAiB,CAAC;IAChD,OAAO,EAAE,4BAA4B,CAAC,gBAAgB,CAAC,CAAC;CACzD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uCAAuC,GACjD,0BAA0B,CACxB,OAAO,cAAc,EACrB,iCAAiC,CAClC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC3C,0CAA0C,GAC1C,gDAAgD,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAC5C,uCAAuC,CAAC;AAE1C;;GAEG;AACH,KAAK,cAAc,GACf,iBAAiB,GACjB,8CAA8C,CAAC;AAEnD;;GAEG;AACH,KAAK,aAAa,GACd,mCAAmC,GACnC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,6BAA6B,CAC3B,OAAO,cAAc,EACrB,mCAAmC,GAAG,cAAc,EACpD,kCAAkC,GAAG,aAAa,EAClD,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAgBJ;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,cAAc,CAC9D,OAAO,cAAc,EACrB,iCAAiC,EACjC,qCAAqC,CACtC;;gBAGa,EACV,SAAS,EACT,KAAU,GACX,EAAE;QACD,SAAS,EAAE,qCAAqC,CAAC;QACjD,KAAK,CAAC,EAAE,OAAO,CAAC,iCAAiC,CAAC,CAAC;KACpD;IAgCD;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACH,IAAI,IAAI,IAAI;IAIZ;;;;;OAKG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CA8JtC"}
@@ -0,0 +1,189 @@
1
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
+ 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");
4
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
+ };
6
+ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
7
+ if (kind === "m") throw new TypeError("Private method is not writable");
8
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
9
+ 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");
10
+ return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
11
+ };
12
+ var _MultichainBalancesController_instances, _MultichainBalancesController_tracker, _MultichainBalancesController_listMultichainAccounts, _MultichainBalancesController_listAccounts, _MultichainBalancesController_getAccount, _MultichainBalancesController_updateBalance, _MultichainBalancesController_isNonEvmAccount, _MultichainBalancesController_handleOnAccountAdded, _MultichainBalancesController_handleOnAccountRemoved, _MultichainBalancesController_getBalances, _MultichainBalancesController_getClient;
13
+ import { BaseController } from "@metamask/base-controller";
14
+ import { isEvmAccountType } from "@metamask/keyring-api";
15
+ import { KeyringClient } from "@metamask/keyring-snap-client";
16
+ import { HandlerType } from "@metamask/snaps-utils";
17
+ import { BalancesTracker, NETWORK_ASSETS_MAP } from "./index.mjs";
18
+ import { getScopeForAccount, getBlockTimeForAccount } from "./utils.mjs";
19
+ const controllerName = 'MultichainBalancesController';
20
+ /**
21
+ * Constructs the default {@link MultichainBalancesController} state. This allows
22
+ * consumers to provide a partial state object when initializing the controller
23
+ * and also helps in constructing complete state objects for this controller in
24
+ * tests.
25
+ *
26
+ * @returns The default {@link MultichainBalancesController} state.
27
+ */
28
+ export function getDefaultMultichainBalancesControllerState() {
29
+ return { balances: {} };
30
+ }
31
+ /**
32
+ * {@link MultichainBalancesController}'s metadata.
33
+ *
34
+ * This allows us to choose if fields of the state should be persisted or not
35
+ * using the `persist` flag; and if they can be sent to Sentry or not, using
36
+ * the `anonymous` flag.
37
+ */
38
+ const balancesControllerMetadata = {
39
+ balances: {
40
+ persist: true,
41
+ anonymous: false,
42
+ },
43
+ };
44
+ /**
45
+ * The MultichainBalancesController is responsible for fetching and caching account
46
+ * balances.
47
+ */
48
+ export class MultichainBalancesController extends BaseController {
49
+ constructor({ messenger, state = {}, }) {
50
+ super({
51
+ messenger,
52
+ name: controllerName,
53
+ metadata: balancesControllerMetadata,
54
+ state: {
55
+ ...getDefaultMultichainBalancesControllerState(),
56
+ ...state,
57
+ },
58
+ });
59
+ _MultichainBalancesController_instances.add(this);
60
+ _MultichainBalancesController_tracker.set(this, void 0);
61
+ __classPrivateFieldSet(this, _MultichainBalancesController_tracker, new BalancesTracker(async (accountId) => await __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_updateBalance).call(this, accountId)), "f");
62
+ // Register all non-EVM accounts into the tracker
63
+ for (const account of __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_listAccounts).call(this)) {
64
+ if (__classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_isNonEvmAccount).call(this, account)) {
65
+ __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").track(account.id, getBlockTimeForAccount(account.type));
66
+ }
67
+ }
68
+ this.messagingSystem.subscribe('AccountsController:accountAdded', (account) => __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_handleOnAccountAdded).call(this, account));
69
+ this.messagingSystem.subscribe('AccountsController:accountRemoved', (account) => __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_handleOnAccountRemoved).call(this, account));
70
+ }
71
+ /**
72
+ * Starts the polling process.
73
+ */
74
+ start() {
75
+ __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").start();
76
+ }
77
+ /**
78
+ * Stops the polling process.
79
+ */
80
+ stop() {
81
+ __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").stop();
82
+ }
83
+ /**
84
+ * Updates the balances of one account. This method doesn't return
85
+ * anything, but it updates the state of the controller.
86
+ *
87
+ * @param accountId - The account ID.
88
+ */
89
+ async updateBalance(accountId) {
90
+ // NOTE: No need to track the account here, since we start tracking those when
91
+ // the "AccountsController:accountAdded" is fired.
92
+ await __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").updateBalance(accountId);
93
+ }
94
+ /**
95
+ * Updates the balances of all supported accounts. This method doesn't return
96
+ * anything, but it updates the state of the controller.
97
+ */
98
+ async updateBalances() {
99
+ await __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").updateBalances();
100
+ }
101
+ }
102
+ _MultichainBalancesController_tracker = new WeakMap(), _MultichainBalancesController_instances = new WeakSet(), _MultichainBalancesController_listMultichainAccounts = function _MultichainBalancesController_listMultichainAccounts() {
103
+ return this.messagingSystem.call('AccountsController:listMultichainAccounts');
104
+ }, _MultichainBalancesController_listAccounts = function _MultichainBalancesController_listAccounts() {
105
+ const accounts = __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_listMultichainAccounts).call(this);
106
+ return accounts.filter((account) => __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_isNonEvmAccount).call(this, account));
107
+ }, _MultichainBalancesController_getAccount = function _MultichainBalancesController_getAccount(accountId) {
108
+ const account = __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_listAccounts).call(this).find((multichainAccount) => multichainAccount.id === accountId);
109
+ if (!account) {
110
+ throw new Error(`Unknown account: ${accountId}`);
111
+ }
112
+ return account;
113
+ }, _MultichainBalancesController_updateBalance =
114
+ /**
115
+ * Updates the balances of one account. This method doesn't return
116
+ * anything, but it updates the state of the controller.
117
+ *
118
+ * @param accountId - The account ID.
119
+ */
120
+ async function _MultichainBalancesController_updateBalance(accountId) {
121
+ const account = __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_getAccount).call(this, accountId);
122
+ if (account.metadata.snap) {
123
+ const scope = getScopeForAccount(account);
124
+ const assetTypes = NETWORK_ASSETS_MAP[scope];
125
+ const accountBalance = await __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_getBalances).call(this, account.id, account.metadata.snap.id, assetTypes);
126
+ this.update((state) => {
127
+ state.balances[accountId] = accountBalance;
128
+ });
129
+ }
130
+ }, _MultichainBalancesController_isNonEvmAccount = function _MultichainBalancesController_isNonEvmAccount(account) {
131
+ return (!isEvmAccountType(account.type) &&
132
+ // Non-EVM accounts are backed by a Snap for now
133
+ account.metadata.snap !== undefined);
134
+ }, _MultichainBalancesController_handleOnAccountAdded =
135
+ /**
136
+ * Handles changes when a new account has been added.
137
+ *
138
+ * @param account - The new account being added.
139
+ */
140
+ async function _MultichainBalancesController_handleOnAccountAdded(account) {
141
+ if (!__classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_isNonEvmAccount).call(this, account)) {
142
+ // Nothing to do here for EVM accounts
143
+ return;
144
+ }
145
+ __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").track(account.id, getBlockTimeForAccount(account.type));
146
+ // NOTE: Unfortunately, we cannot update the balance right away here, because
147
+ // messenger's events are running synchronously and fetching the balance is
148
+ // asynchronous.
149
+ // Updating the balance here would resume at some point but the event emitter
150
+ // will not `await` this (so we have no real control "when" the balance will
151
+ // really be updated), see:
152
+ // - https://github.com/MetaMask/core/blob/v213.0.0/packages/accounts-controller/src/AccountsController.ts#L1036-L1039
153
+ }, _MultichainBalancesController_handleOnAccountRemoved =
154
+ /**
155
+ * Handles changes when a new account has been removed.
156
+ *
157
+ * @param accountId - The account ID being removed.
158
+ */
159
+ async function _MultichainBalancesController_handleOnAccountRemoved(accountId) {
160
+ if (__classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").isTracked(accountId)) {
161
+ __classPrivateFieldGet(this, _MultichainBalancesController_tracker, "f").untrack(accountId);
162
+ }
163
+ if (accountId in this.state.balances) {
164
+ this.update((state) => {
165
+ delete state.balances[accountId];
166
+ });
167
+ }
168
+ }, _MultichainBalancesController_getBalances =
169
+ /**
170
+ * Get the balances for an account.
171
+ *
172
+ * @param accountId - ID of the account to get balances for.
173
+ * @param snapId - ID of the Snap which manages the account.
174
+ * @param assetTypes - Array of asset types to get balances for.
175
+ * @returns A map of asset types to balances.
176
+ */
177
+ async function _MultichainBalancesController_getBalances(accountId, snapId, assetTypes) {
178
+ return await __classPrivateFieldGet(this, _MultichainBalancesController_instances, "m", _MultichainBalancesController_getClient).call(this, snapId).getAccountBalances(accountId, assetTypes);
179
+ }, _MultichainBalancesController_getClient = function _MultichainBalancesController_getClient(snapId) {
180
+ return new KeyringClient({
181
+ send: async (request) => (await this.messagingSystem.call('SnapController:handleRequest', {
182
+ snapId: snapId,
183
+ origin: 'metamask',
184
+ handler: HandlerType.OnKeyringRequest,
185
+ request,
186
+ })),
187
+ });
188
+ };
189
+ //# sourceMappingURL=MultichainBalancesController.mjs.map