@metamask-previews/assets-controller 20.2.3-preview-08f21d38a → 20.2.3-preview-2ad7fb9
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.
- package/CHANGELOG.md +19 -0
- package/README.md +6 -0
- package/dist/AssetsController.d.ts +11 -2
- package/dist/AssetsController.d.ts.map +1 -1
- package/dist/AssetsController.js +55 -7
- package/dist/AssetsController.js.map +1 -1
- package/dist/accounts-api-balances-service/accounts-api-balances-service-method-action-types.d.ts +22 -0
- package/dist/accounts-api-balances-service/accounts-api-balances-service-method-action-types.d.ts.map +1 -0
- package/dist/accounts-api-balances-service/accounts-api-balances-service-method-action-types.js +6 -0
- package/dist/accounts-api-balances-service/accounts-api-balances-service-method-action-types.js.map +1 -0
- package/dist/accounts-api-balances-service/accounts-api-balances-service.d.ts +140 -0
- package/dist/accounts-api-balances-service/accounts-api-balances-service.d.ts.map +1 -0
- package/dist/accounts-api-balances-service/accounts-api-balances-service.js +280 -0
- package/dist/accounts-api-balances-service/accounts-api-balances-service.js.map +1 -0
- package/dist/accounts-api-balances-service/structs.d.ts +208 -0
- package/dist/accounts-api-balances-service/structs.d.ts.map +1 -0
- package/dist/accounts-api-balances-service/structs.js +92 -0
- package/dist/accounts-api-balances-service/structs.js.map +1 -0
- package/dist/assetsFetchTracker.d.ts +31 -0
- package/dist/assetsFetchTracker.d.ts.map +1 -0
- package/dist/assetsFetchTracker.js +85 -0
- package/dist/assetsFetchTracker.js.map +1 -0
- package/dist/data-sources/AccountsApiDataSource.d.ts +20 -3
- package/dist/data-sources/AccountsApiDataSource.d.ts.map +1 -1
- package/dist/data-sources/AccountsApiDataSource.js +66 -4
- package/dist/data-sources/AccountsApiDataSource.js.map +1 -1
- package/dist/index.d.ts +6 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -1
- package/dist/selectors/fetchStatus.d.ts +36 -0
- package/dist/selectors/fetchStatus.d.ts.map +1 -0
- package/dist/selectors/fetchStatus.js +44 -0
- package/dist/selectors/fetchStatus.js.map +1 -0
- package/dist/types.d.ts +17 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +3 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Add the `assetsFetchStatus` state field, tracking fetch status per account and per phase (`fast`, `background`) with `fetchStatus`, `errors` and `updatedAt`, plus the exported types `AssetsFetchPhase`, `AssetsFetchPhaseStatus` and `AssetsFetchStatus` ([#11375](https://github.com/MetaMask/core/pull/11375))
|
|
13
|
+
- Add the `isAccountFetching` and `getAccountFetchErrors` selectors ([#11375](https://github.com/MetaMask/core/pull/11375))
|
|
14
|
+
- `getAccountFetchErrors` returns the errors of the `fast` and `background` phases separately.
|
|
15
|
+
- Add the `AccountsApiBalancesService` data service for Accounts API v5 and v6 multi account balances, plus its exported messenger, action, event and `FetchBalancesOptions` and `BalancesResponse` types ([#11377](https://github.com/MetaMask/core/pull/11377))
|
|
16
|
+
- It is built on `@metamask/base-data-service` and has no persistence.
|
|
17
|
+
- Clients must not add it to a `DATA_SERVICES` list.
|
|
18
|
+
- Add the `useAccountsApiBalancesService` option to `AssetsControllerOptions` and to the `AccountsApiDataSource` options, default `false` ([#11377](https://github.com/MetaMask/core/pull/11377))
|
|
19
|
+
- When `true`, balances are fetched through `AccountsApiBalancesService:fetchBalances` instead of the API platform client.
|
|
20
|
+
- Clients must register the service and delegate `AccountsApiBalancesService:fetchBalances` to the `AssetsController` messenger before enabling it.
|
|
21
|
+
- Add the `onBalancesQueryStateChange` callback to `AccountsApiDataSourceConfig` ([#11377](https://github.com/MetaMask/core/pull/11377))
|
|
22
|
+
- Add the `@metamask/base-data-service@^2.1.0` and `@metamask/superstruct@^3.4.1` dependencies ([#11377](https://github.com/MetaMask/core/pull/11377))
|
|
23
|
+
|
|
24
|
+
### Changed
|
|
25
|
+
|
|
26
|
+
- `AssetsControllerMessenger` and `AccountsApiDataSourceAllowedActions` now allow `AccountsApiBalancesService:fetchBalances` ([#11377](https://github.com/MetaMask/core/pull/11377))
|
|
27
|
+
- Clients only need to delegate it when `useAccountsApiBalancesService` is `true`.
|
|
28
|
+
|
|
10
29
|
## [20.2.3]
|
|
11
30
|
|
|
12
31
|
### Changed
|
package/README.md
CHANGED
|
@@ -10,6 +10,12 @@ or
|
|
|
10
10
|
|
|
11
11
|
`npm install @metamask/assets-controller`
|
|
12
12
|
|
|
13
|
+
## `AccountsApiBalancesService`
|
|
14
|
+
|
|
15
|
+
`AccountsApiBalancesService` is a data service (built on `@metamask/base-data-service`) that fetches multi account balances from the Accounts API v5 and v6 endpoints.
|
|
16
|
+
|
|
17
|
+
It is deliberately kept out of any client `DATA_SERVICES` list and has no persistence. Its `:cacheUpdated` events carry the full balances response, so forwarding them to a UI would serialize every response across the process boundary. Consume it through the messenger from the background only.
|
|
18
|
+
|
|
13
19
|
## Contributing
|
|
14
20
|
|
|
15
21
|
This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).
|
|
@@ -18,6 +18,7 @@ import type { PreferencesControllerStateChangeEvent } from '@metamask/preference
|
|
|
18
18
|
import type { RemoteFeatureFlagControllerGetStateAction, RemoteFeatureFlagControllerStateChangeEvent } from '@metamask/remote-feature-flag-controller';
|
|
19
19
|
import type { SnapControllerGetRunnableSnapsAction, SnapControllerHandleRequestAction, SnapControllerSnapInstalledEvent } from '@metamask/snaps-controllers';
|
|
20
20
|
import type { TransactionControllerTransactionConfirmedEvent, TransactionControllerUnapprovedTransactionAddedEvent } from '@metamask/transaction-controller';
|
|
21
|
+
import type { AccountsApiBalancesServiceFetchBalancesAction } from './accounts-api-balances-service/accounts-api-balances-service-method-action-types.js';
|
|
21
22
|
import type { AssetsControllerMethodActions } from './AssetsController-method-action-types.js';
|
|
22
23
|
import type { AccountsApiDataSourceConfig } from './data-sources/AccountsApiDataSource.js';
|
|
23
24
|
import type { PriceDataSourceConfig } from './data-sources/PriceDataSource.js';
|
|
@@ -73,7 +74,7 @@ export type AssetsControllerPriceChangedEvent = {
|
|
|
73
74
|
}];
|
|
74
75
|
};
|
|
75
76
|
export type AssetsControllerEvents = AssetsControllerStateChangeEvent | AssetsControllerBalanceChangedEvent | AssetsControllerPriceChangedEvent;
|
|
76
|
-
type AllowedActions = AccountsControllerGetSelectedAccountAction | AccountTreeControllerGetAccountsFromSelectedAccountGroupAction | AccountTreeControllerIsInitializedAction | ClientControllerGetStateAction | KeyringControllerIsUnlockedAction | NetworkControllerGetStateAction | NetworkControllerGetNetworkClientByIdAction | ConfigRegistryControllerGetNetworkConfigByCaip2ChainIdAction | NetworkEnablementControllerGetStateAction | SnapControllerGetRunnableSnapsAction | SnapControllerHandleRequestAction | GetPermissions | PhishingControllerBulkScanTokensAction | RemoteFeatureFlagControllerGetStateAction;
|
|
77
|
+
type AllowedActions = AccountsControllerGetSelectedAccountAction | AccountTreeControllerGetAccountsFromSelectedAccountGroupAction | AccountTreeControllerIsInitializedAction | ClientControllerGetStateAction | KeyringControllerIsUnlockedAction | NetworkControllerGetStateAction | NetworkControllerGetNetworkClientByIdAction | ConfigRegistryControllerGetNetworkConfigByCaip2ChainIdAction | NetworkEnablementControllerGetStateAction | SnapControllerGetRunnableSnapsAction | SnapControllerHandleRequestAction | GetPermissions | PhishingControllerBulkScanTokensAction | RemoteFeatureFlagControllerGetStateAction | AccountsApiBalancesServiceFetchBalancesAction;
|
|
77
78
|
type AllowedEvents = AccountTreeControllerSelectedAccountGroupChangeEvent | AccountTreeControllerInitializedEvent | AccountTreeControllerUninitializedEvent | ClientControllerStateChangeEvent | KeyringControllerLockEvent | KeyringControllerUnlockEvent | PreferencesControllerStateChangeEvent | TransactionControllerUnapprovedTransactionAddedEvent | TransactionControllerTransactionConfirmedEvent | MultichainTransactionsControllerTransactionConfirmedEvent | NetworkControllerStateChangeEvent | NetworkControllerNetworkAddedEvent | NetworkControllerNetworkDidChangeEvent | NetworkControllerNetworkRemovedEvent | NetworkEnablementControllerEvents | AccountsControllerAccountBalancesUpdatedEvent | PermissionControllerStateChange | SnapControllerSnapInstalledEvent | AccountActivityServiceBalanceUpdatedEvent | AccountActivityServiceStatusChangedEvent | RemoteFeatureFlagControllerStateChangeEvent;
|
|
78
79
|
export type AssetsControllerMessenger = Messenger<typeof CONTROLLER_NAME, AssetsControllerActions | AllowedActions, AssetsControllerEvents | AllowedEvents>;
|
|
79
80
|
export type AssetsControllerOptions = {
|
|
@@ -122,6 +123,14 @@ export type AssetsControllerOptions = {
|
|
|
122
123
|
captureException?: (error: Error) => void;
|
|
123
124
|
/** Optional configuration for AccountsApiDataSource. */
|
|
124
125
|
accountsApiDataSourceConfig?: AccountsApiDataSourceConfig;
|
|
126
|
+
/**
|
|
127
|
+
* When true, AccountsApiDataSource fetches v5 and v6 balances through the
|
|
128
|
+
* `AccountsApiBalancesService:fetchBalances` messenger action instead of
|
|
129
|
+
* `queryApiClient`. Set it only after registering an
|
|
130
|
+
* `AccountsApiBalancesService` and delegating that action to this
|
|
131
|
+
* controller's messenger. Defaults to false.
|
|
132
|
+
*/
|
|
133
|
+
useAccountsApiBalancesService?: boolean;
|
|
125
134
|
/** Optional configuration for PriceDataSource. */
|
|
126
135
|
priceDataSourceConfig?: PriceDataSourceConfig;
|
|
127
136
|
/** Optional configuration for StakedBalanceDataSource. */
|
|
@@ -168,7 +177,7 @@ export type AssetsControllerOptions = {
|
|
|
168
177
|
*/
|
|
169
178
|
export declare class AssetsController extends BaseController<typeof CONTROLLER_NAME, AssetsControllerState, AssetsControllerMessenger> {
|
|
170
179
|
#private;
|
|
171
|
-
constructor({ messenger, state, defaultUpdateInterval, isEnabled, isBasicFunctionality, subscribeToBasicFunctionalityChange, queryApiClient, rpcDataSourceConfig, trace, captureException, accountsApiDataSourceConfig, priceDataSourceConfig, stakedBalanceDataSourceConfig, isOnboarded, tempMigrateAssetsInfoMetadataAssets3346, }: AssetsControllerOptions);
|
|
180
|
+
constructor({ messenger, state, defaultUpdateInterval, isEnabled, isBasicFunctionality, subscribeToBasicFunctionalityChange, queryApiClient, rpcDataSourceConfig, trace, captureException, accountsApiDataSourceConfig, useAccountsApiBalancesService, priceDataSourceConfig, stakedBalanceDataSourceConfig, isOnboarded, tempMigrateAssetsInfoMetadataAssets3346, }: AssetsControllerOptions);
|
|
172
181
|
/**
|
|
173
182
|
* Returns the callback passed to data sources for reporting active chain updates.
|
|
174
183
|
* Used by tests to simulate a data source reporting chain changes.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AssetsController.d.ts","sourceRoot":"","sources":["../src/AssetsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8DAA8D,EAC9D,qCAAqC,EACrC,wCAAwC,EACxC,oDAAoD,EACpD,uCAAuC,EACxC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAE,0CAA0C,EAAE,MAAM,+BAA+B,CAAC;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EACV,8BAA8B,EAC9B,gCAAgC,EACjC,MAAM,6BAA6B,CAAC;AAErC,OAAO,KAAK,EAAE,4DAA4D,EAAE,MAAM,sCAAsC,CAAC;AACzH,OAAO,KAAK,EAAE,aAAa,EAAgB,MAAM,4BAA4B,CAAC;AAC9E,OAAO,KAAK,EACV,iBAAiB,EACjB,yCAAyC,EACzC,wCAAwC,EACxC,iBAAiB,EAClB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iCAAiC,EACjC,0BAA0B,EAC1B,4BAA4B,EAC7B,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,yDAAyD,EAAE,MAAM,8CAA8C,CAAC;AAC9H,OAAO,KAAK,EACV,2CAA2C,EAC3C,+BAA+B,EAC/B,kCAAkC,EAClC,sCAAsC,EACtC,oCAAoC,EAEpC,iCAAiC,EAClC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EACV,yCAAyC,EACzC,iCAAiC,EAElC,MAAM,yCAAyC,CAAC;AACjD,OAAO,KAAK,EACV,cAAc,EACd,+BAA+B,EAChC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,sCAAsC,EAAE,MAAM,+BAA+B,CAAC;AACvF,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,kCAAkC,CAAC;AAC9F,OAAO,KAAK,EACV,yCAAyC,EACzC,2CAA2C,EAC5C,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EACV,oCAAoC,EACpC,iCAAiC,EACjC,gCAAgC,EACjC,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,8CAA8C,EAC9C,oDAAoD,EAErD,MAAM,kCAAkC,CAAC;
|
|
1
|
+
{"version":3,"file":"AssetsController.d.ts","sourceRoot":"","sources":["../src/AssetsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,8DAA8D,EAC9D,qCAAqC,EACrC,wCAAwC,EACxC,oDAAoD,EACpD,uCAAuC,EACxC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAE,0CAA0C,EAAE,MAAM,+BAA+B,CAAC;AAChG,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EACV,8BAA8B,EAC9B,gCAAgC,EACjC,MAAM,6BAA6B,CAAC;AAErC,OAAO,KAAK,EAAE,4DAA4D,EAAE,MAAM,sCAAsC,CAAC;AACzH,OAAO,KAAK,EAAE,aAAa,EAAgB,MAAM,4BAA4B,CAAC;AAC9E,OAAO,KAAK,EACV,iBAAiB,EACjB,yCAAyC,EACzC,wCAAwC,EACxC,iBAAiB,EAClB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iCAAiC,EACjC,0BAA0B,EAC1B,4BAA4B,EAC7B,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,yDAAyD,EAAE,MAAM,8CAA8C,CAAC;AAC9H,OAAO,KAAK,EACV,2CAA2C,EAC3C,+BAA+B,EAC/B,kCAAkC,EAClC,sCAAsC,EACtC,oCAAoC,EAEpC,iCAAiC,EAClC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EACV,yCAAyC,EACzC,iCAAiC,EAElC,MAAM,yCAAyC,CAAC;AACjD,OAAO,KAAK,EACV,cAAc,EACd,+BAA+B,EAChC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,sCAAsC,EAAE,MAAM,+BAA+B,CAAC;AACvF,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,kCAAkC,CAAC;AAC9F,OAAO,KAAK,EACV,yCAAyC,EACzC,2CAA2C,EAC5C,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EACV,oCAAoC,EACpC,iCAAiC,EACjC,gCAAgC,EACjC,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,8CAA8C,EAC9C,oDAAoD,EAErD,MAAM,kCAAkC,CAAC;AAc1C,OAAO,KAAK,EAAE,6CAA6C,EAAE,MAAM,sFAAsF,CAAC;AAC1J,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAQ/F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AAI3F,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAE/E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,OAAO,KAAK,EAAE,6CAA6C,EAAE,MAAM,kCAAkC,CAAC;AAEtG,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAoB/F,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAavF,OAAO,KAAK,EACV,SAAS,EACT,qBAAqB,EAGrB,OAAO,EACP,aAAa,EACb,aAAa,EAEb,UAAU,EACV,YAAY,EAGZ,SAAS,EACT,QAAQ,EACR,WAAW,EACX,YAAY,EAEZ,KAAK,EACN,MAAM,YAAY,CAAC;AAkBpB,OAAO,KAAK,EACV,yBAAyB,EACzB,0BAA0B,EAC3B,MAAM,kBAAkB,CAAC;AAa1B;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAMF,QAAA,MAAM,eAAe,EAAG,kBAA2B,CAAC;AA6CpD,YAAY,EAAE,qBAAqB,EAAE,CAAC;AAEtC;;;;;;GAMG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAcvE;AAMD,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,OAAO,eAAe,EACtB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,8BAA8B,GAC9B,6BAA6B,CAAC;AAElC,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,eAAe,EACtB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,GAAG,OAAO,eAAe,iBAAiB,CAAC;IACjD,OAAO,EAAE;QACP;YACE,SAAS,EAAE,SAAS,CAAC;YACrB,OAAO,EAAE,aAAa,CAAC;YACvB,cAAc,EAAE,MAAM,CAAC;YACvB,SAAS,EAAE,MAAM,CAAC;SACnB;KACF,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,GAAG,OAAO,eAAe,eAAe,CAAC;IAC/C,OAAO,EAAE,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE,UAAU,CAAC,CAAA;KAAE,CAAC,CAAC;CAC1D,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAC9B,gCAAgC,GAChC,mCAAmC,GACnC,iCAAiC,CAAC;AAEtC,KAAK,cAAc,GAEf,0CAA0C,GAC1C,8DAA8D,GAC9D,wCAAwC,GACxC,8BAA8B,GAC9B,iCAAiC,GAEjC,+BAA+B,GAC/B,2CAA2C,GAC3C,4DAA4D,GAE5D,yCAAyC,GAEzC,oCAAoC,GACpC,iCAAiC,GACjC,cAAc,GAEd,sCAAsC,GAEtC,yCAAyC,GAEzC,6CAA6C,CAAC;AAElD,KAAK,aAAa,GAEd,oDAAoD,GACpD,qCAAqC,GACrC,uCAAuC,GACvC,gCAAgC,GAChC,0BAA0B,GAC1B,4BAA4B,GAC5B,qCAAqC,GACrC,oDAAoD,GACpD,8CAA8C,GAE9C,yDAAyD,GAEzD,iCAAiC,GAIjC,kCAAkC,GAClC,sCAAsC,GACtC,oCAAoC,GAEpC,iCAAiC,GAEjC,6CAA6C,GAC7C,+BAA+B,GAC/B,gCAAgC,GAEhC,yCAAyC,GACzC,wCAAwC,GAGxC,2CAA2C,CAAC;AAEhD,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,OAAO,eAAe,EACtB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,CACvC,CAAC;AAMF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACvC,gEAAgE;IAChE,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,OAAO,CAAC;IAC1B;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,MAAM,OAAO,CAAC;IACrC;;;;;;;OAOG;IACH,mCAAmC,CAAC,EAAE,CACpC,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,KACjC,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;IACzB;;;OAGG;IACH,cAAc,EAAE,iBAAiB,CAAC;IAClC,gDAAgD;IAChD,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;;OAIG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC1C,wDAAwD;IACxD,2BAA2B,CAAC,EAAE,2BAA2B,CAAC;IAC1D;;;;;;OAMG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC,kDAAkD;IAClD,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C,0DAA0D;IAC1D,6BAA6B,CAAC,EAAE,6BAA6B,CAAC;IAC9D;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC;IAE5B;;;OAGG;IACH,uCAAuC,CAAC,EAAE,MAAM,wBAAwB,CAAC;CAC1E,CAAC;AAuPF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,eAAe,EACtB,qBAAqB,EACrB,yBAAyB,CAC1B;;IAyNC,YAAY,EACV,SAAS,EACT,KAAU,EACV,qBAAmD,EACnD,SAA+B,EAC/B,oBAAoB,EACpB,mCAAmC,EACnC,cAAc,EACd,mBAAmB,EACnB,KAAK,EACL,gBAAgB,EAChB,2BAA2B,EAC3B,6BAAqC,EACrC,qBAAqB,EACrB,6BAA6B,EAC7B,WAAW,EACX,uCAAuC,GACxC,EAAE,uBAAuB,EAsJzB;IA6cD;;;;;OAKG;IACH,wBAAwB,IAAI,CAC1B,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,OAAO,EAAE,EACvB,cAAc,EAAE,OAAO,EAAE,KACtB,IAAI,CAER;IA2CK,SAAS,CACb,QAAQ,EAAE,eAAe,EAAE,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;QACrB,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;QACzB,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB;;;;;WAKG;QACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAC5B,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;KACxB,GACA,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC,CAwB1D;IAED;;;;;;;;;;;;OAYG;IACG,gBAAgB,CAAC,QAAQ,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAc/D;IA2ZK,gBAAgB,CACpB,QAAQ,EAAE,eAAe,EAAE,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;QACrB,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;QACzB,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,GACA,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC,CAqBjE;IAED,gBAAgB,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa,GAAG,SAAS,CAElE;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,mBAAmB,CACjB,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,aAAa,GACrB,KAAK,GAAG,SAAS,CAWnB;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,qBAAqB,CACnB,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,aAAa,EAAE,GACxB,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,CAqB9B;IAED;;;;;;;;;;;;;;OAcG;IACH,uBAAuB,CACrB,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,OAAO,GACb,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,CA8B9B;IAqCK,cAAc,CAClB,QAAQ,EAAE,eAAe,EAAE,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;QACrB,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;QACzB,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,GACA,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAmB5C;IAED;;;;;;;;OAQG;IACH,yBAAyB,IAAI,yBAAyB,CAWrD;IAED;;;;;;;;OAQG;IACH,yBAAyB,IAAI,0BAA0B,CActD;IAMD;;;;;;;;;;;;;OAaG;IACG,cAAc,CAClB,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,aAAa,EACtB,eAAe,CAAC,EAAE,oBAAoB,GACrC,OAAO,CAAC,IAAI,CAAC,CA2Ef;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,IAAI,CAoBpE;IAED;;;;;OAKG;IACH,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,aAAa,EAAE,CAErD;IAMD;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CActC;IAED;;;;;;;OAOG;IACG,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CA6BvD;IA0BD;;;;OAIG;IACH,mBAAmB,CAAC,gBAAgB,EAAE,iBAAiB,GAAG,IAAI,CA8B7D;IAMD;;;;;;OAMG;IACH,oBAAoB,CAAC,QAAQ,EAAE,eAAe,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAkC3E;IAED;;OAEG;IACH,sBAAsB,IAAI,IAAI,CAS7B;IA23BD;;;;;;;OAOG;IACH,8BAA8B,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CAGtD;IAkqBD;;;;;;;;;OASG;IACG,kBAAkB,CACtB,QAAQ,EAAE,YAAY,EACtB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,IAAI,CAAC,CAYf;IAsMD,OAAO,IAAI,IAAI,CAoDd;CACF"}
|
package/dist/AssetsController.js
CHANGED
|
@@ -34,10 +34,11 @@ var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn,
|
|
|
34
34
|
};
|
|
35
35
|
import { BaseController } from '@metamask/base-controller';
|
|
36
36
|
import { clientControllerSelectors } from '@metamask/client-controller';
|
|
37
|
-
import { isCaipChainId, isStrictHexString, KnownCaipNamespace, parseCaipAssetType, parseCaipChainId, } from '@metamask/utils';
|
|
37
|
+
import { getErrorMessage, isCaipChainId, isStrictHexString, KnownCaipNamespace, parseCaipAssetType, parseCaipChainId, } from '@metamask/utils';
|
|
38
38
|
import { Mutex } from 'async-mutex';
|
|
39
39
|
import { BigNumber as BigNumberJS } from 'bignumber.js';
|
|
40
40
|
import { isEqual } from 'lodash-es';
|
|
41
|
+
import { AssetsFetchTracker } from './assetsFetchTracker.js';
|
|
41
42
|
import { AccountActivityDataSource } from './data-sources/AccountActivityDataSource.js';
|
|
42
43
|
import { AccountsApiDataSource } from './data-sources/AccountsApiDataSource.js';
|
|
43
44
|
import { isStakingContractAssetId } from './data-sources/evm-rpc-services/index.js';
|
|
@@ -171,10 +172,27 @@ const stateMetadata = {
|
|
|
171
172
|
includeInDebugSnapshot: true,
|
|
172
173
|
usedInUi: true,
|
|
173
174
|
},
|
|
175
|
+
assetsFetchStatus: {
|
|
176
|
+
persist: false,
|
|
177
|
+
includeInStateLogs: true,
|
|
178
|
+
includeInDebugSnapshot: true,
|
|
179
|
+
usedInUi: true,
|
|
180
|
+
},
|
|
174
181
|
};
|
|
175
182
|
// ============================================================================
|
|
176
183
|
// HELPER FUNCTIONS
|
|
177
184
|
// ============================================================================
|
|
185
|
+
/**
|
|
186
|
+
* Map every chain to the message of an error thrown while fetching them.
|
|
187
|
+
*
|
|
188
|
+
* @param chainIds - The chains the failed fetch covered.
|
|
189
|
+
* @param error - The thrown error.
|
|
190
|
+
* @returns The per chain errors.
|
|
191
|
+
*/
|
|
192
|
+
function buildChainErrors(chainIds, error) {
|
|
193
|
+
const message = getErrorMessage(error);
|
|
194
|
+
return Object.fromEntries(chainIds.map((chainId) => [chainId, message]));
|
|
195
|
+
}
|
|
178
196
|
function extractChainId(assetId) {
|
|
179
197
|
const parsed = parseCaipAssetType(assetId);
|
|
180
198
|
return parsed.chainId;
|
|
@@ -355,6 +373,10 @@ let AssetsController = (() => {
|
|
|
355
373
|
#captureException;
|
|
356
374
|
/** Whether we have already reported first init fetch for this session (reset on #stop). */
|
|
357
375
|
#firstInitFetchReported = false;
|
|
376
|
+
/** Tracks per account fetch status of the fast and background phases. */
|
|
377
|
+
#fetchTracker = new AssetsFetchTracker((recipe) => this.update((state) => {
|
|
378
|
+
recipe(state);
|
|
379
|
+
}));
|
|
358
380
|
/** Whether we have already reported state size for this session (reset on #stop). */
|
|
359
381
|
#stateSizeReported = false;
|
|
360
382
|
/**
|
|
@@ -497,7 +519,7 @@ let AssetsController = (() => {
|
|
|
497
519
|
#unsubscribeBasicFunctionality = null;
|
|
498
520
|
#queryApiClient;
|
|
499
521
|
#onActiveChainsUpdated;
|
|
500
|
-
constructor({ messenger, state = {}, defaultUpdateInterval = DEFAULT_POLLING_INTERVAL_MS, isEnabled = () => true, isBasicFunctionality, subscribeToBasicFunctionalityChange, queryApiClient, rpcDataSourceConfig, trace, captureException, accountsApiDataSourceConfig, priceDataSourceConfig, stakedBalanceDataSourceConfig, isOnboarded, tempMigrateAssetsInfoMetadataAssets3346, }) {
|
|
522
|
+
constructor({ messenger, state = {}, defaultUpdateInterval = DEFAULT_POLLING_INTERVAL_MS, isEnabled = () => true, isBasicFunctionality, subscribeToBasicFunctionalityChange, queryApiClient, rpcDataSourceConfig, trace, captureException, accountsApiDataSourceConfig, useAccountsApiBalancesService = false, priceDataSourceConfig, stakedBalanceDataSourceConfig, isOnboarded, tempMigrateAssetsInfoMetadataAssets3346, }) {
|
|
501
523
|
super({
|
|
502
524
|
name: CONTROLLER_NAME,
|
|
503
525
|
messenger,
|
|
@@ -545,6 +567,7 @@ let AssetsController = (() => {
|
|
|
545
567
|
queryApiClient,
|
|
546
568
|
onActiveChainsUpdated: this.#onActiveChainsUpdated,
|
|
547
569
|
...accountsApiDataSourceConfig,
|
|
570
|
+
useAccountsApiBalancesService,
|
|
548
571
|
isBalanceV6Enabled: () => this.#isBalanceV6Enabled(),
|
|
549
572
|
getAssetsState: () => this.state,
|
|
550
573
|
getAssetVisibility: this.#getAssetVisibility.bind(this),
|
|
@@ -1116,14 +1139,14 @@ let AssetsController = (() => {
|
|
|
1116
1139
|
tokenDataSource: this.#tokenDataSource,
|
|
1117
1140
|
priceDataSource: this.#priceDataSource,
|
|
1118
1141
|
}, { isBasicFunctionality, includeCustomAssetGraduation: true });
|
|
1119
|
-
const fastResponse = await this.#runFastFetchV5({
|
|
1142
|
+
const fastResponse = await this.#trackFastPhase(accounts, chainIds, () => this.#runFastFetchV5({
|
|
1120
1143
|
accounts,
|
|
1121
1144
|
chainIds,
|
|
1122
1145
|
request,
|
|
1123
1146
|
pipelineTrace,
|
|
1124
1147
|
fastSources,
|
|
1125
1148
|
isBasicFunctionality,
|
|
1126
|
-
});
|
|
1149
|
+
}));
|
|
1127
1150
|
this.#firstInitFetchReported = true;
|
|
1128
1151
|
this.#runBackgroundFetch({
|
|
1129
1152
|
accounts,
|
|
@@ -1145,14 +1168,14 @@ let AssetsController = (() => {
|
|
|
1145
1168
|
isBasicFunctionality,
|
|
1146
1169
|
includeCustomAssetGraduation: false,
|
|
1147
1170
|
});
|
|
1148
|
-
const fastResponse = await this.#runFastFetchV6({
|
|
1171
|
+
const fastResponse = await this.#trackFastPhase(accounts, chainIds, () => this.#runFastFetchV6({
|
|
1149
1172
|
accounts,
|
|
1150
1173
|
chainIds,
|
|
1151
1174
|
request,
|
|
1152
1175
|
pipelineTrace,
|
|
1153
1176
|
fastSources,
|
|
1154
1177
|
isBasicFunctionality,
|
|
1155
|
-
});
|
|
1178
|
+
}));
|
|
1156
1179
|
this.#firstInitFetchReported = true;
|
|
1157
1180
|
this.#runBackgroundFetch({
|
|
1158
1181
|
accounts,
|
|
@@ -1162,6 +1185,26 @@ let AssetsController = (() => {
|
|
|
1162
1185
|
isBasicFunctionality,
|
|
1163
1186
|
});
|
|
1164
1187
|
}
|
|
1188
|
+
/**
|
|
1189
|
+
* Run the fast phase while tracking its fetch status for the accounts.
|
|
1190
|
+
*
|
|
1191
|
+
* @param accounts - Accounts in this fetch.
|
|
1192
|
+
* @param chainIds - Chains in this fetch, used to report a thrown error.
|
|
1193
|
+
* @param run - Runs the fast phase.
|
|
1194
|
+
* @returns The fast phase response.
|
|
1195
|
+
*/
|
|
1196
|
+
async #trackFastPhase(accounts, chainIds, run) {
|
|
1197
|
+
const end = this.#fetchTracker.begin(accounts.map((account) => account.id), 'fast');
|
|
1198
|
+
try {
|
|
1199
|
+
const response = await run();
|
|
1200
|
+
end({ errors: response.errors });
|
|
1201
|
+
return response;
|
|
1202
|
+
}
|
|
1203
|
+
catch (error) {
|
|
1204
|
+
end({ errors: buildChainErrors(chainIds, error) });
|
|
1205
|
+
throw error;
|
|
1206
|
+
}
|
|
1207
|
+
}
|
|
1165
1208
|
async #runFastFetchV5({ accounts, chainIds, request, pipelineTrace, fastSources, isBasicFunctionality, }) {
|
|
1166
1209
|
const { response } = await withTrace({
|
|
1167
1210
|
name: TRACE_FETCH_PIPELINE,
|
|
@@ -1238,6 +1281,7 @@ let AssetsController = (() => {
|
|
|
1238
1281
|
? [this.#snapDataSource, this.#rpcDataSource]
|
|
1239
1282
|
: [this.#rpcDataSource];
|
|
1240
1283
|
const slowRequest = { ...request, chainIds };
|
|
1284
|
+
const end = this.#fetchTracker.begin(accounts.map((account) => account.id), 'background');
|
|
1241
1285
|
withTrace({
|
|
1242
1286
|
name: TRACE_BACKGROUND_FETCH,
|
|
1243
1287
|
trace: pipelineTrace,
|
|
@@ -1263,8 +1307,12 @@ let AssetsController = (() => {
|
|
|
1263
1307
|
trace: pipelineTrace,
|
|
1264
1308
|
});
|
|
1265
1309
|
await this.#updateState(response);
|
|
1310
|
+
end({ errors: response.errors });
|
|
1266
1311
|
},
|
|
1267
|
-
}).catch((error) =>
|
|
1312
|
+
}).catch((error) => {
|
|
1313
|
+
end({ errors: buildChainErrors(chainIds, error) });
|
|
1314
|
+
log('Background pipeline failed', { error });
|
|
1315
|
+
});
|
|
1268
1316
|
}
|
|
1269
1317
|
#emitFastFetchTraces({ accounts, chainIds, result, durationMs, isBasicFunctionality, parentContext, pipelineTrace, }) {
|
|
1270
1318
|
emitTrace({
|