@metamask/assets-controllers 30.0.0 → 31.0.0

package/CHANGELOG.md

@@ -7,6 +7,85 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [31.0.0]
+
+### Added
+
+- **BREAKING:** The `NftDetectionController` now takes a `messenger`, which can be used for communication ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - This messenger must allow the following actions `ApprovalController:addRequest`, `NetworkController:getState`, `NetworkController:getNetworkClientById`, and `PreferencesController:getState`, and must allow the events `PreferencesController:stateChange` and `NetworkController:stateChange`
+- Add `NftDetectionControllerMessenger` type ([#4312](https://github.com/MetaMask/core/pull/4312))
+- Add `NftControllerGetStateAction`, `NftControllerActions`, `NftControllerStateChangeEvent`, and `NftControllerEvents` types ([#4310](https://github.com/MetaMask/core/pull/4310))
+- Add `NftController:getState` and `NftController:stateChange` as an available action and event to the `NftController` messenger ([#4310](https://github.com/MetaMask/core/pull/4310))
+
+### Changed
+
+- **BREAKING:** Change `TokensController` to inherit from `BaseController` rather than `BaseControllerV1` ([#4304](https://github.com/MetaMask/core/pull/4304))
+  - The constructor now takes a single options object rather than three arguments, and all properties in `config` are now part of options.
+- **BREAKING:** Rename `TokensState` type to `TokensControllerState` ([#4304](https://github.com/MetaMask/core/pull/4304))
+- **BREAKING:** Make all `TokensController` methods and properties starting with `_` private ([#4304](https://github.com/MetaMask/core/pull/4304))
+- **BREAKING:** Convert `Token` from `interface` to `type` ([#4304](https://github.com/MetaMask/core/pull/4304))
+- **BREAKING:** Replace `balanceError` property in `Token` with `hasBalanceError`; update `TokenBalancesController` so that it no longer captures the error resulting from getting the balance of an ERC-20 token ([#4304](https://github.com/MetaMask/core/pull/4304))
+- **BREAKING:** Change `NftDetectionController` to inherit from `StaticIntervalPollingController` rather than `StaticIntervalPollingControllerV1` ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - The constructor now takes a single options object rather than three arguments, and all properties in `config` are now part of options.
+- **BREAKING:** Convert `ApiNft`, `ApiNftContract`, `ApiNftLastSale`, and `ApiNftCreator` from `interface` to `type` ([#4312](https://github.com/MetaMask/core/pull/4312))
+- **BREAKING:** Change `NftController` to inherit from `BaseController` rather than `BaseControllerV1` ([#4310](https://github.com/MetaMask/core/pull/4310))
+  - The constructor now takes a single options object rather than three arguments, and all properties in `config` are now part of options.
+- **BREAKING:** Convert `Nft`, `NftContract`, and `NftMetadata` from `interface` to `type` ([#4310](https://github.com/MetaMask/core/pull/4310))
+- **BREAKING:** Rename `NftState` to `NftControllerState`, and convert to `type` ([#4310](https://github.com/MetaMask/core/pull/4310))
+- **BREAKING:** Rename `getDefaultNftState` to `getDefaultNftControllerState` ([#4310](https://github.com/MetaMask/core/pull/4310))
+- **BREAKING:** Bump dependency and peer dependency `@metamask/accounts-controller` to `^15.0.0` ([#4342](https://github.com/MetaMask/core/pull/4342))
+- **BREAKING:** Bump dependency and peer dependency `@metamask/approval-controller` to `^6.0.2` ([#4342](https://github.com/MetaMask/core/pull/4342))
+- **BREAKING:** Bump dependency and peer dependency `@metamask/keyring-controller` to `^16.1.0` ([#4342](https://github.com/MetaMask/core/pull/4342))
+- **BREAKING:** Bump dependency and peer dependency `@metamask/network-controller` to `^18.1.3` ([#4342](https://github.com/MetaMask/core/pull/4342))
+- **BREAKING:** Bump dependency and peer dependency `@metamask/preferences-controller` to `^12.0.0` ([#4342](https://github.com/MetaMask/core/pull/4342))
+- Change `NftDetectionController` method `detectNfts` so that `userAddress` option is optional ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - This will default to the currently selected address as kept by PreferencesController.
+- Bump `async-mutex` to `^0.5.0` ([#4335](https://github.com/MetaMask/core/pull/4335))
+- Bump `@metamask/polling-controller` to `^7.0.0` ([#4342](https://github.com/MetaMask/core/pull/4342))
+
+### Removed
+
+- **BREAKING:** Remove `config` property and `configure` method from `TokensController` ([#4304](https://github.com/MetaMask/core/pull/4304))
+  - The `TokensController` now takes a single options object which can be used for configuration, and configuration is now kept internally.
+- **BREAKING:** Remove `notify`, `subscribe`, and `unsubscribe` methods from `TokensController` ([#4304](https://github.com/MetaMask/core/pull/4304))
+  - Use the controller messenger for subscribing to and publishing events instead.
+- **BREAKING:** Remove `TokensConfig` type ([#4304](https://github.com/MetaMask/core/pull/4304))
+  - These properties have been merged into the options that `TokensController` takes.
+- **BREAKING:** Remove `config` property and `configure` method from `TokensController` ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - `TokensController` now takes a single options object which can be used for configuration, and configuration is now kept internally.
+- **BREAKING:** Remove `notify`, `subscribe`, and `unsubscribe` methods from `NftDetectionController` ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - Use the controller messenger for subscribing to and publishing events instead.
+- **BREAKING:** Remove `chainId` as a `NftDetectionController` constructor argument ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - The controller will now read the `networkClientId` from the NetworkController state through the messenger when needed.
+- **BREAKING:** Remove `getNetworkClientById` as a `NftDetectionController` constructor argument ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - The controller will now call `NetworkController:getNetworkClientId` through the messenger object.
+- **BREAKING:** Remove `onPreferencesStateChange` as a `NftDetectionController` constructor argument ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - The controller will now call `PreferencesController:stateChange` through the messenger object.
+- **BREAKING:** Remove `onNetworkStateChange` as a `NftDetectionController` constructor argument ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - The controller will now read the `networkClientId` from the NetworkController state through the messenger when needed.
+- **BREAKING:** Remove `getOpenSeaApiKey` as a `NftDetectionController` constructor argument ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - This was never used.
+- **BREAKING:** Remove `getNftApi` as a `NftDetectionController` constructor argument ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - This was never used.
+- **BREAKING:** Remove `NftDetectionConfig` type ([#4312](https://github.com/MetaMask/core/pull/4312))
+  - These properties have been merged into the options that `NftDetectionController` takes.
+- **BREAKING:** Remove `config` property and `configure` method from `NftController` ([#4310](https://github.com/MetaMask/core/pull/4310))
+  - `NftController` now takes a single options object which can be used for configuration, and configuration is now kept internally.
+- **BREAKING:** Remove `notify`, `subscribe`, and `unsubscribe` methods from `NftController` ([#4310](https://github.com/MetaMask/core/pull/4310))
+  - Use the controller messenger for subscribing to and publishing events instead.
+- **BREAKING:** Remove `onPreferencesStateChange` as a `NftController` constructor argument ([#4310](https://github.com/MetaMask/core/pull/4310))
+  - The controller will now call `PreferencesController:stateChange` through the messenger object.
+- **BREAKING:** Remove `onNetworkStateChange` as a `NftController` constructor argument ([#4310](https://github.com/MetaMask/core/pull/4310))
+  - The controller will now call `NetworkController:stateChange` through the messenger object.
+- **BREAKING:** Remove `NftConfig` type ([#4310](https://github.com/MetaMask/core/pull/4310))
+  - These properties have been merged into the options that `NftController` takes.
+- **BREAKING:** Remove `config` property and `configure` method from `NftController` ([#4310](https://github.com/MetaMask/core/pull/4310))
+  - `NftController` now takes a single options object which can be used for configuration, and configuration is now kept internally.
+- **BREAKING:** Remove `hub` property from `NftController` ([#4310](https://github.com/MetaMask/core/pull/4310))
+  - Use the controller messenger for subscribing to and publishing events instead.
+- **BREAKING:** Modify `TokenListController` so that tokens fetched from the API and stored in state will no longer have `storage` and `erc20` properties ([#4235](https://github.com/MetaMask/core/pull/4235))
+  - These properties were never officially supported, but they were present in state anyway.
+
 ## [30.0.0]
 
 ### Added
@@ -796,7 +875,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Use Ethers for AssetsContractController ([#845](https://github.com/MetaMask/core/pull/845))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@30.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@31.0.0...HEAD
+[31.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@30.0.0...@metamask/assets-controllers@31.0.0
 [30.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@29.0.0...@metamask/assets-controllers@30.0.0
 [29.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@28.0.0...@metamask/assets-controllers@29.0.0
 [28.0.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@27.2.0...@metamask/assets-controllers@28.0.0

package/dist/AccountTrackerController.js

@@ -1,10 +1,10 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkV4ZO3F2Sjs = require('./chunk-V4ZO3F2S.js');
+var _chunkGU53EI7Ajs = require('./chunk-GU53EI7A.js');
 require('./chunk-Z4BLTVTB.js');
 
 
 
-exports.AccountTrackerController = _chunkV4ZO3F2Sjs.AccountTrackerController; exports.default = _chunkV4ZO3F2Sjs.AccountTrackerController_default;
+exports.AccountTrackerController = _chunkGU53EI7Ajs.AccountTrackerController; exports.default = _chunkGU53EI7Ajs.AccountTrackerController_default;
 //# sourceMappingURL=AccountTrackerController.js.map

package/dist/AccountTrackerController.mjs

@@ -1,7 +1,7 @@
 import {
   AccountTrackerController,
   AccountTrackerController_default
-} from "./chunk-PAJTKWEC.mjs";
+} from "./chunk-65PB33TE.mjs";
 import "./chunk-XUI43LEZ.mjs";
 export {
   AccountTrackerController,

package/dist/AssetsContractController.js

@@ -3,7 +3,7 @@
 
 
 
-var _chunk4ODKGWYQjs = require('./chunk-4ODKGWYQ.js');
+var _chunkQHWKLZUCjs = require('./chunk-QHWKLZUC.js');
 require('./chunk-U3DJJN4X.js');
 require('./chunk-B5YY22QQ.js');
 require('./chunk-BOTVAG4A.js');
@@ -14,5 +14,5 @@ require('./chunk-Z4BLTVTB.js');
 
 
 
-exports.AssetsContractController = _chunk4ODKGWYQjs.AssetsContractController; exports.MISSING_PROVIDER_ERROR = _chunk4ODKGWYQjs.MISSING_PROVIDER_ERROR; exports.SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID = _chunk4ODKGWYQjs.SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID; exports.default = _chunk4ODKGWYQjs.AssetsContractController_default;
+exports.AssetsContractController = _chunkQHWKLZUCjs.AssetsContractController; exports.MISSING_PROVIDER_ERROR = _chunkQHWKLZUCjs.MISSING_PROVIDER_ERROR; exports.SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID = _chunkQHWKLZUCjs.SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID; exports.default = _chunkQHWKLZUCjs.AssetsContractController_default;
 //# sourceMappingURL=AssetsContractController.js.map

package/dist/AssetsContractController.mjs

@@ -3,7 +3,7 @@ import {
   AssetsContractController_default,
   MISSING_PROVIDER_ERROR,
   SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID
-} from "./chunk-MHN7CJCZ.mjs";
+} from "./chunk-HLCGZGPA.mjs";
 import "./chunk-ASA5RLBY.mjs";
 import "./chunk-D3K5MPMW.mjs";
 import "./chunk-LZ5ZGQEX.mjs";

package/dist/NftController.js

@@ -2,7 +2,7 @@
 
 
 
-var _chunkLAU6ZDZRjs = require('./chunk-LAU6ZDZR.js');
+var _chunkCGLUTXI7js = require('./chunk-CGLUTXI7.js');
 require('./chunk-RGHTNZQ6.js');
 require('./chunk-NEXY7SE2.js');
 require('./chunk-Z4BLTVTB.js');
@@ -10,5 +10,5 @@ require('./chunk-Z4BLTVTB.js');
 
 
 
-exports.NftController = _chunkLAU6ZDZRjs.NftController; exports.default = _chunkLAU6ZDZRjs.NftController_default; exports.getDefaultNftState = _chunkLAU6ZDZRjs.getDefaultNftState;
+exports.NftController = _chunkCGLUTXI7js.NftController; exports.default = _chunkCGLUTXI7js.NftController_default; exports.getDefaultNftControllerState = _chunkCGLUTXI7js.getDefaultNftControllerState;
 //# sourceMappingURL=NftController.js.map

package/dist/NftController.mjs

@@ -1,14 +1,14 @@
 import {
   NftController,
   NftController_default,
-  getDefaultNftState
-} from "./chunk-46UZDIXW.mjs";
+  getDefaultNftControllerState
+} from "./chunk-62T7RKU3.mjs";
 import "./chunk-CP3HC7AQ.mjs";
 import "./chunk-Q5JRBGWO.mjs";
 import "./chunk-XUI43LEZ.mjs";
 export {
   NftController,
   NftController_default as default,
-  getDefaultNftState
+  getDefaultNftControllerState
 };
 //# sourceMappingURL=NftController.mjs.map

package/dist/NftDetectionController.js

@@ -2,12 +2,12 @@
 
 
 
-var _chunkFMZML3V5js = require('./chunk-FMZML3V5.js');
+var _chunkQFDTOEYRjs = require('./chunk-QFDTOEYR.js');
 require('./chunk-RGHTNZQ6.js');
 require('./chunk-Z4BLTVTB.js');
 
 
 
 
-exports.BlockaidResultType = _chunkFMZML3V5js.BlockaidResultType; exports.NftDetectionController = _chunkFMZML3V5js.NftDetectionController; exports.default = _chunkFMZML3V5js.NftDetectionController_default;
+exports.BlockaidResultType = _chunkQFDTOEYRjs.BlockaidResultType; exports.NftDetectionController = _chunkQFDTOEYRjs.NftDetectionController; exports.default = _chunkQFDTOEYRjs.NftDetectionController_default;
 //# sourceMappingURL=NftDetectionController.js.map

package/dist/NftDetectionController.mjs

@@ -2,7 +2,7 @@ import {
   BlockaidResultType,
   NftDetectionController,
   NftDetectionController_default
-} from "./chunk-KOKB6U4Z.mjs";
+} from "./chunk-543CC74T.mjs";
 import "./chunk-CP3HC7AQ.mjs";
 import "./chunk-XUI43LEZ.mjs";
 export {

package/dist/TokenBalancesController.js

@@ -2,11 +2,11 @@
 
 
 
-var _chunkLD4GC7ORjs = require('./chunk-LD4GC7OR.js');
+var _chunkIBK6AXPPjs = require('./chunk-IBK6AXPP.js');
 require('./chunk-Z4BLTVTB.js');
 
 
 
 
-exports.TokenBalancesController = _chunkLD4GC7ORjs.TokenBalancesController; exports.default = _chunkLD4GC7ORjs.TokenBalancesController_default; exports.getDefaultTokenBalancesState = _chunkLD4GC7ORjs.getDefaultTokenBalancesState;
+exports.TokenBalancesController = _chunkIBK6AXPPjs.TokenBalancesController; exports.default = _chunkIBK6AXPPjs.TokenBalancesController_default; exports.getDefaultTokenBalancesState = _chunkIBK6AXPPjs.getDefaultTokenBalancesState;
 //# sourceMappingURL=TokenBalancesController.js.map

package/dist/TokenBalancesController.mjs

@@ -2,7 +2,7 @@ import {
   TokenBalancesController,
   TokenBalancesController_default,
   getDefaultTokenBalancesState
-} from "./chunk-4LY47RPI.mjs";
+} from "./chunk-WCCLSUOI.mjs";
 import "./chunk-XUI43LEZ.mjs";
 export {
   TokenBalancesController,

package/dist/TokenListController.js

@@ -2,13 +2,13 @@
 
 
 
-var _chunk5F5EQAX5js = require('./chunk-5F5EQAX5.js');
-require('./chunk-3R43XIIX.js');
+var _chunkJUI3XNEFjs = require('./chunk-JUI3XNEF.js');
+require('./chunk-PYMUBJQX.js');
 require('./chunk-NEXY7SE2.js');
 require('./chunk-Z4BLTVTB.js');
 
 
 
 
-exports.TokenListController = _chunk5F5EQAX5js.TokenListController; exports.default = _chunk5F5EQAX5js.TokenListController_default; exports.getDefaultTokenListState = _chunk5F5EQAX5js.getDefaultTokenListState;
+exports.TokenListController = _chunkJUI3XNEFjs.TokenListController; exports.default = _chunkJUI3XNEFjs.TokenListController_default; exports.getDefaultTokenListState = _chunkJUI3XNEFjs.getDefaultTokenListState;
 //# sourceMappingURL=TokenListController.js.map

package/dist/TokenListController.mjs

@@ -2,8 +2,8 @@ import {
   TokenListController,
   TokenListController_default,
   getDefaultTokenListState
-} from "./chunk-XHMM35YT.mjs";
-import "./chunk-Z3OQU4XW.mjs";
+} from "./chunk-A2DDWXMS.mjs";
+import "./chunk-5W5OO2Q5.mjs";
 import "./chunk-Q5JRBGWO.mjs";
 import "./chunk-XUI43LEZ.mjs";
 export {

package/dist/TokenRatesController.js

@@ -1,7 +1,7 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunk6W5EQ3JQjs = require('./chunk-6W5EQ3JQ.js');
+var _chunkUEDNQBJNjs = require('./chunk-UEDNQBJN.js');
 require('./chunk-Z6TBQQE5.js');
 require('./chunk-7K6PSEAA.js');
 require('./chunk-WB6KJX4N.js');
@@ -10,5 +10,5 @@ require('./chunk-Z4BLTVTB.js');
 
 
 
-exports.TokenRatesController = _chunk6W5EQ3JQjs.TokenRatesController; exports.default = _chunk6W5EQ3JQjs.TokenRatesController_default;
+exports.TokenRatesController = _chunkUEDNQBJNjs.TokenRatesController; exports.default = _chunkUEDNQBJNjs.TokenRatesController_default;
 //# sourceMappingURL=TokenRatesController.js.map

package/dist/TokenRatesController.mjs

@@ -1,7 +1,7 @@
 import {
   TokenRatesController,
   TokenRatesController_default
-} from "./chunk-X4FFNQHE.mjs";
+} from "./chunk-E4ECCGJV.mjs";
 import "./chunk-Y35SM7TO.mjs";
 import "./chunk-TTH3ES66.mjs";
 import "./chunk-CNKVITJO.mjs";

package/dist/TokensController.js

@@ -2,15 +2,15 @@
 
 
 
-var _chunkMBCN3MNXjs = require('./chunk-MBCN3MNX.js');
+var _chunk4AC3X2U5js = require('./chunk-4AC3X2U5.js');
 require('./chunk-B5YY22QQ.js');
 require('./chunk-BOTVAG4A.js');
-require('./chunk-3R43XIIX.js');
+require('./chunk-PYMUBJQX.js');
 require('./chunk-NEXY7SE2.js');
 require('./chunk-Z4BLTVTB.js');
 
 
 
 
-exports.TokensController = _chunkMBCN3MNXjs.TokensController; exports.default = _chunkMBCN3MNXjs.TokensController_default; exports.getDefaultTokensState = _chunkMBCN3MNXjs.getDefaultTokensState;
+exports.TokensController = _chunk4AC3X2U5js.TokensController; exports.default = _chunk4AC3X2U5js.TokensController_default; exports.getDefaultTokensState = _chunk4AC3X2U5js.getDefaultTokensState;
 //# sourceMappingURL=TokensController.js.map

package/dist/TokensController.mjs

@@ -2,10 +2,10 @@ import {
   TokensController,
   TokensController_default,
   getDefaultTokensState
-} from "./chunk-7MMEHAKG.mjs";
+} from "./chunk-73F3SN5O.mjs";
 import "./chunk-D3K5MPMW.mjs";
 import "./chunk-LZ5ZGQEX.mjs";
-import "./chunk-Z3OQU4XW.mjs";
+import "./chunk-5W5OO2Q5.mjs";
 import "./chunk-Q5JRBGWO.mjs";
 import "./chunk-XUI43LEZ.mjs";
 export {