@metamask-previews/assets-controllers 29.0.0-preview-ff0abae → 30.0.0-preview-4a95e5f

package/CHANGELOG.md

@@ -7,15 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Uncategorized
+## [30.0.0]
 
+### Added
+
+- Adds a new field `marketData` to the state of `TokenRatesController` ([#4206](https://github.com/MetaMask/core/pull/4206))
+- Adds a new `RatesController` to manage prices for non-EVM blockchains ([#4242](https://github.com/MetaMask/core/pull/4242))
+
+### Changed
+
+- **BREAKING:** Changed price and token API endpoints from `*.metafi.codefi.network` to `*.api.cx.metamask.io` ([#4301](https://github.com/MetaMask/core/pull/4301))
+- When fetching token list for Linea Mainnet, use `occurrenceFloor` parameter of 1 instead of 3, and filter tokens to those with a `lineaTeam` aggregator or more than 3 aggregators ([#4253](https://github.com/MetaMask/core/pull/4253))
 - **BREAKING:** The NftController messenger must now allow the `NetworkController:getNetworkClientById` action ([#4305](https://github.com/MetaMask/core/pull/4305))
-- NftControllerMessenger now makes use of `selectedNetworkClientId` when responding to changes in NetworkController state to capture the currently selected chain rather than `providerConfig` ([#4305](https://github.com/MetaMask/core/pull/4305))
-  - This should be functionally equivalent, but is being noted anyway.
-- NftDetectionController now makes use of `selectedNetworkClientId` when responding to changes in NetworkController state to capture the currently selected chain rather than `providerConfig` ([#4307](https://github.com/MetaMask/core/pull/4307))
-  - This should be functionally equivalent, but is being noted anyway.
-- TokenRatesController now makes use of `selectedNetworkClientId` when responding to changes in NetworkController state to capture the currently selected chain rather than `providerConfig` ([#4317](https://github.com/MetaMask/core/pull/4317))
-  - This should be functionally equivalent, but is being noted anyway.
+- **BREAKING:** Bump dependency and peer dependency `@metamask/network-controller` to `^18.1.2` ([#4332](https://github.com/MetaMask/core/pull/4332))
+- Bump `@metamask/keyring-api` to `^6.1.1` ([#4262](https://github.com/MetaMask/core/pull/4262))
+
+### Removed
+
+- **BREAKING:** Removed `contractExchangeRates` and `contractExchangeRatesByChainId` from the state of `TokenRatesController` ([#4206](https://github.com/MetaMask/core/pull/4206))
+
+### Fixed
+
+- Only update NFT state when metadata actually changes ([#4143](https://github.com/MetaMask/core/pull/4143))
 
 ## [29.0.0]
 
@@ -783,7 +796,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@29.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@30.0.0...HEAD
+[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
 [27.2.0]: https://github.com/MetaMask/core/compare/@metamask/assets-controllers@27.1.0...@metamask/assets-controllers@27.2.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 _chunkE4SQFGKOjs = require('./chunk-E4SQFGKO.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 = _chunkE4SQFGKOjs.NftController; exports.default = _chunkE4SQFGKOjs.NftController_default; exports.getDefaultNftState = _chunkE4SQFGKOjs.getDefaultNftState;
 //# sourceMappingURL=NftController.js.map

package/dist/NftController.mjs

@@ -2,7 +2,7 @@ import {
   NftController,
   NftController_default,
   getDefaultNftState
-} from "./chunk-46UZDIXW.mjs";
+} from "./chunk-YAVESKOE.mjs";
 import "./chunk-CP3HC7AQ.mjs";
 import "./chunk-Q5JRBGWO.mjs";
 import "./chunk-XUI43LEZ.mjs";

package/dist/NftDetectionController.js

@@ -2,12 +2,12 @@
 
 
 
-var _chunkFMZML3V5js = require('./chunk-FMZML3V5.js');
+var _chunk5OC3ZKSEjs = require('./chunk-5OC3ZKSE.js');
 require('./chunk-RGHTNZQ6.js');
 require('./chunk-Z4BLTVTB.js');
 
 
 
 
-exports.BlockaidResultType = _chunkFMZML3V5js.BlockaidResultType; exports.NftDetectionController = _chunkFMZML3V5js.NftDetectionController; exports.default = _chunkFMZML3V5js.NftDetectionController_default;
+exports.BlockaidResultType = _chunk5OC3ZKSEjs.BlockaidResultType; exports.NftDetectionController = _chunk5OC3ZKSEjs.NftDetectionController; exports.default = _chunk5OC3ZKSEjs.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-WQ7TBYYE.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/TokenRatesController.js

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

package/dist/TokenRatesController.mjs

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

package/dist/TokensController.js

@@ -2,7 +2,7 @@
 
 
 
-var _chunkMBCN3MNXjs = require('./chunk-MBCN3MNX.js');
+var _chunkKCFBEGDVjs = require('./chunk-KCFBEGDV.js');
 require('./chunk-B5YY22QQ.js');
 require('./chunk-BOTVAG4A.js');
 require('./chunk-3R43XIIX.js');
@@ -12,5 +12,5 @@ require('./chunk-Z4BLTVTB.js');
 
 
 
-exports.TokensController = _chunkMBCN3MNXjs.TokensController; exports.default = _chunkMBCN3MNXjs.TokensController_default; exports.getDefaultTokensState = _chunkMBCN3MNXjs.getDefaultTokensState;
+exports.TokensController = _chunkKCFBEGDVjs.TokensController; exports.default = _chunkKCFBEGDVjs.TokensController_default; exports.getDefaultTokensState = _chunkKCFBEGDVjs.getDefaultTokensState;
 //# sourceMappingURL=TokensController.js.map

package/dist/TokensController.mjs

@@ -2,7 +2,7 @@ import {
   TokensController,
   TokensController_default,
   getDefaultTokensState
-} from "./chunk-7MMEHAKG.mjs";
+} from "./chunk-76IWVCR7.mjs";
 import "./chunk-D3K5MPMW.mjs";
 import "./chunk-LZ5ZGQEX.mjs";
 import "./chunk-Z3OQU4XW.mjs";

package/dist/chunk-5OC3ZKSE.js

@@ -0,0 +1,253 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+var _chunkZ4BLTVTBjs = require('./chunk-Z4BLTVTB.js');
+
+// src/NftDetectionController.ts
+
+
+
+
+
+
+
+var _controllerutils = require('@metamask/controller-utils');
+var _pollingcontroller = require('@metamask/polling-controller');
+var DEFAULT_INTERVAL = 18e4;
+var controllerName = "NftDetectionController";
+var BlockaidResultType = /* @__PURE__ */ ((BlockaidResultType2) => {
+  BlockaidResultType2["Benign"] = "Benign";
+  BlockaidResultType2["Spam"] = "Spam";
+  BlockaidResultType2["Warning"] = "Warning";
+  BlockaidResultType2["Malicious"] = "Malicious";
+  return BlockaidResultType2;
+})(BlockaidResultType || {});
+var _intervalId, _interval, _disabled, _addNft, _getNftState, _stopPolling, stopPolling_fn, _startPolling, startPolling_fn, _onPreferencesControllerStateChange, onPreferencesControllerStateChange_fn, _getOwnerNftApi, getOwnerNftApi_fn, _getOwnerNfts, getOwnerNfts_fn;
+var NftDetectionController = class extends _pollingcontroller.StaticIntervalPollingController {
+  /**
+   * The controller options
+   *
+   * @param options - The controller options.
+   * @param options.interval - The pooling interval.
+   * @param options.messenger - A reference to the messaging system.
+   * @param options.disabled - Represents previous value of useNftDetection. Used to detect changes of useNftDetection. Default value is true.
+   * @param options.addNft - Add an NFT.
+   * @param options.getNftState - Gets the current state of the Assets controller.
+   */
+  constructor({
+    interval = DEFAULT_INTERVAL,
+    messenger,
+    disabled = false,
+    addNft,
+    getNftState
+  }) {
+    super({
+      name: controllerName,
+      messenger,
+      metadata: {},
+      state: {}
+    });
+    _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _stopPolling);
+    /**
+     * Starts a new polling interval.
+     *
+     */
+    _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _startPolling);
+    /**
+     * Handles the state change of the preference controller.
+     * @param preferencesState - The new state of the preference controller.
+     * @param preferencesState.useNftDetection - Boolean indicating user preference on NFT detection.
+     */
+    _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _onPreferencesControllerStateChange);
+    _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _getOwnerNftApi);
+    _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _getOwnerNfts);
+    _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _intervalId, void 0);
+    _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _interval, void 0);
+    _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _disabled, void 0);
+    _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _addNft, void 0);
+    _chunkZ4BLTVTBjs.__privateAdd.call(void 0, this, _getNftState, void 0);
+    _chunkZ4BLTVTBjs.__privateSet.call(void 0, this, _interval, interval);
+    _chunkZ4BLTVTBjs.__privateSet.call(void 0, this, _disabled, disabled);
+    _chunkZ4BLTVTBjs.__privateSet.call(void 0, this, _getNftState, getNftState);
+    _chunkZ4BLTVTBjs.__privateSet.call(void 0, this, _addNft, addNft);
+    this.messagingSystem.subscribe(
+      "PreferencesController:stateChange",
+      _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _onPreferencesControllerStateChange, onPreferencesControllerStateChange_fn).bind(this)
+    );
+    this.setIntervalLength(_chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _interval));
+  }
+  async _executePoll(networkClientId, options) {
+    await this.detectNfts({ networkClientId, userAddress: options.address });
+  }
+  /**
+   * Start polling for the currency rate.
+   */
+  async start() {
+    if (!this.isMainnet() || _chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _disabled)) {
+      return;
+    }
+    await _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _startPolling, startPolling_fn).call(this);
+  }
+  /**
+   * Stop polling for the currency rate.
+   */
+  stop() {
+    _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _stopPolling, stopPolling_fn).call(this);
+  }
+  /**
+   * Checks whether network is mainnet or not.
+   *
+   * @returns Whether current network is mainnet.
+   */
+  isMainnet() {
+    const { selectedNetworkClientId } = this.messagingSystem.call(
+      "NetworkController:getState"
+    );
+    const {
+      configuration: { chainId }
+    } = this.messagingSystem.call(
+      "NetworkController:getNetworkClientById",
+      selectedNetworkClientId
+    );
+    return chainId === _controllerutils.ChainId.mainnet;
+  }
+  isMainnetByNetworkClientId(networkClient) {
+    return networkClient.configuration.chainId === _controllerutils.ChainId.mainnet;
+  }
+  /**
+   * Triggers asset ERC721 token auto detection on mainnet. Any newly detected NFTs are
+   * added.
+   *
+   * @param options - Options bag.
+   * @param options.networkClientId - The network client ID to detect NFTs on.
+   * @param options.userAddress - The address to detect NFTs for.
+   */
+  async detectNfts(options) {
+    const userAddress = options?.userAddress ?? this.messagingSystem.call("PreferencesController:getState").selectedAddress;
+    if (!this.isMainnet() || _chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _disabled)) {
+      return;
+    }
+    if (!userAddress) {
+      return;
+    }
+    const apiNfts = await _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _getOwnerNfts, getOwnerNfts_fn).call(this, userAddress);
+    const addNftPromises = apiNfts.map(async (nft) => {
+      const {
+        tokenId: token_id,
+        contract,
+        kind,
+        image: image_url,
+        imageSmall: image_thumbnail_url,
+        metadata: { imageOriginal: image_original_url } = {},
+        name,
+        description,
+        attributes,
+        topBid,
+        lastSale,
+        rarityRank,
+        rarityScore,
+        collection
+      } = nft.token;
+      let ignored;
+      const { ignoredNfts } = _chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _getNftState).call(this);
+      if (ignoredNfts.length > 0) {
+        ignored = ignoredNfts.find((c) => {
+          return c.address === _controllerutils.toChecksumHexAddress.call(void 0, contract) && c.tokenId === token_id;
+        });
+      }
+      if (!ignored) {
+        const nftMetadata = Object.assign(
+          {},
+          { name },
+          description && { description },
+          image_url && { image: image_url },
+          image_thumbnail_url && { imageThumbnail: image_thumbnail_url },
+          image_original_url && { imageOriginal: image_original_url },
+          kind && { standard: kind.toUpperCase() },
+          lastSale && { lastSale },
+          attributes && { attributes },
+          topBid && { topBid },
+          rarityRank && { rarityRank },
+          rarityScore && { rarityScore },
+          collection && { collection }
+        );
+        await _chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _addNft).call(this, contract, token_id, {
+          nftMetadata,
+          userAddress,
+          source: "detected" /* Detected */,
+          networkClientId: options?.networkClientId
+        });
+      }
+    });
+    await Promise.all(addNftPromises);
+  }
+};
+_intervalId = new WeakMap();
+_interval = new WeakMap();
+_disabled = new WeakMap();
+_addNft = new WeakMap();
+_getNftState = new WeakMap();
+_stopPolling = new WeakSet();
+stopPolling_fn = function() {
+  if (_chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _intervalId)) {
+    clearInterval(_chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _intervalId));
+  }
+};
+_startPolling = new WeakSet();
+startPolling_fn = async function() {
+  _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _stopPolling, stopPolling_fn).call(this);
+  await this.detectNfts();
+  _chunkZ4BLTVTBjs.__privateSet.call(void 0, this, _intervalId, setInterval(async () => {
+    await this.detectNfts();
+  }, _chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _interval)));
+};
+_onPreferencesControllerStateChange = new WeakSet();
+onPreferencesControllerStateChange_fn = function({ useNftDetection }) {
+  if (!useNftDetection !== _chunkZ4BLTVTBjs.__privateGet.call(void 0, this, _disabled)) {
+    _chunkZ4BLTVTBjs.__privateSet.call(void 0, this, _disabled, !useNftDetection);
+    if (useNftDetection) {
+      this.start();
+    } else {
+      this.stop();
+    }
+  }
+};
+_getOwnerNftApi = new WeakSet();
+getOwnerNftApi_fn = function({ address, next }) {
+  return `${_controllerutils.NFT_API_BASE_URL}/users/${address}/tokens?chainIds=1&limit=50&includeTopBid=true&continuation=${next ?? ""}`;
+};
+_getOwnerNfts = new WeakSet();
+getOwnerNfts_fn = async function(address) {
+  let nftApiResponse;
+  let nfts = [];
+  let next;
+  do {
+    nftApiResponse = await _controllerutils.fetchWithErrorHandling.call(void 0, {
+      url: _chunkZ4BLTVTBjs.__privateMethod.call(void 0, this, _getOwnerNftApi, getOwnerNftApi_fn).call(this, { address, next }),
+      options: {
+        headers: {
+          Version: _controllerutils.NFT_API_VERSION
+        }
+      },
+      timeout: _controllerutils.NFT_API_TIMEOUT
+    });
+    if (!nftApiResponse) {
+      return nfts;
+    }
+    const newNfts = nftApiResponse.tokens?.filter(
+      (elm) => elm.token.isSpam === false && (elm.blockaidResult?.result_type ? elm.blockaidResult?.result_type === "Benign" /* Benign */ : true)
+    ) ?? [];
+    nfts = [...nfts, ...newNfts];
+  } while (next = nftApiResponse.continuation);
+  return nfts;
+};
+var NftDetectionController_default = NftDetectionController;
+
+
+
+
+
+exports.BlockaidResultType = BlockaidResultType; exports.NftDetectionController = NftDetectionController; exports.NftDetectionController_default = NftDetectionController_default;
+//# sourceMappingURL=chunk-5OC3ZKSE.js.map

package/dist/chunk-5OC3ZKSE.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/NftDetectionController.ts"],"names":["BlockaidResultType"],"mappings":";;;;;;;;AAEA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAQP,SAAS,uCAAuC;AAchD,IAAM,mBAAmB;AAEzB,IAAM,iBAAiB;AAgIhB,IAAK,qBAAL,kBAAKA,wBAAL;AACL,EAAAA,oBAAA,YAAS;AACT,EAAAA,oBAAA,UAAO;AACP,EAAAA,oBAAA,aAAU;AACV,EAAAA,oBAAA,eAAY;AAJF,SAAAA;AAAA,GAAA;AAjKZ;AA8VO,IAAM,yBAAN,cAAqC,gCAI1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,YAAY;AAAA,IACV,WAAW;AAAA,IACX;AAAA,IACA,WAAW;AAAA,IACX;AAAA,IACA;AAAA,EACF,GAMG;AACD,UAAM;AAAA,MACJ,MAAM;AAAA,MACN;AAAA,MACA,UAAU,CAAC;AAAA,MACX,OAAO,CAAC;AAAA,IACV,CAAC;AAwCH;AAUA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAmCN;AAAA;AAAA;AAAA;AAAA;AAAA;AAWA;AAMA,uBAAM;AA5IN;AAEA;AAEA;AAEA,uBAAS,SAAT;AAEA,uBAAS,cAAT;AA+BE,uBAAK,WAAY;AACjB,uBAAK,WAAY;AAEjB,uBAAK,cAAe;AACpB,uBAAK,SAAU;AAEf,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,sBAAK,4EAAoC,KAAK,IAAI;AAAA,IACpD;AAEA,SAAK,kBAAkB,mBAAK,UAAS;AAAA,EACvC;AAAA,EAEA,MAAM,aACJ,iBACA,SACe;AACf,UAAM,KAAK,WAAW,EAAE,iBAAiB,aAAa,QAAQ,QAAQ,CAAC;AAAA,EACzE;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,QAAQ;AACZ,QAAI,CAAC,KAAK,UAAU,KAAK,mBAAK,YAAW;AACvC;AAAA,IACF;AAEA,UAAM,sBAAK,gCAAL;AAAA,EACR;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO;AACL,0BAAK,8BAAL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyBA,YAAqB;AACnB,UAAM,EAAE,wBAAwB,IAAI,KAAK,gBAAgB;AAAA,MACvD;AAAA,IACF;AACA,UAAM;AAAA,MACJ,eAAe,EAAE,QAAQ;AAAA,IAC3B,IAAI,KAAK,gBAAgB;AAAA,MACvB;AAAA,MACA;AAAA,IACF;AACA,WAAO,YAAY,QAAQ;AAAA,EAC7B;AAAA,EAEA,2BAA2B,eAAuC;AAChE,WAAO,cAAc,cAAc,YAAY,QAAQ;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmEA,MAAM,WAAW,SAGd;AACD,UAAM,cACJ,SAAS,eACT,KAAK,gBAAgB,KAAK,gCAAgC,EACvD;AAEL,QAAI,CAAC,KAAK,UAAU,KAAK,mBAAK,YAAW;AACvC;AAAA,IACF;AAEA,QAAI,CAAC,aAAa;AAChB;AAAA,IACF;AAEA,UAAM,UAAU,MAAM,sBAAK,gCAAL,WAAmB;AACzC,UAAM,iBAAiB,QAAQ,IAAI,OAAO,QAAQ;AAChD,YAAM;AAAA,QACJ,SAAS;AAAA,QACT;AAAA,QACA;AAAA,QACA,OAAO;AAAA,QACP,YAAY;AAAA,QACZ,UAAU,EAAE,eAAe,mBAAmB,IAAI,CAAC;AAAA,QACnD;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF,IAAI,IAAI;AAER,UAAI;AAEJ,YAAM,EAAE,YAAY,IAAI,mBAAK,cAAL;AACxB,UAAI,YAAY,SAAS,GAAG;AAC1B,kBAAU,YAAY,KAAK,CAAC,MAAM;AAEhC,iBACE,EAAE,YAAY,qBAAqB,QAAQ,KAC3C,EAAE,YAAY;AAAA,QAElB,CAAC;AAAA,MACH;AAGA,UAAI,CAAC,SAAS;AAEZ,cAAM,cAA2B,OAAO;AAAA,UACtC,CAAC;AAAA,UACD,EAAE,KAAK;AAAA,UACP,eAAe,EAAE,YAAY;AAAA,UAC7B,aAAa,EAAE,OAAO,UAAU;AAAA,UAChC,uBAAuB,EAAE,gBAAgB,oBAAoB;AAAA,UAC7D,sBAAsB,EAAE,eAAe,mBAAmB;AAAA,UAC1D,QAAQ,EAAE,UAAU,KAAK,YAAY,EAAE;AAAA,UACvC,YAAY,EAAE,SAAS;AAAA,UACvB,cAAc,EAAE,WAAW;AAAA,UAC3B,UAAU,EAAE,OAAO;AAAA,UACnB,cAAc,EAAE,WAAW;AAAA,UAC3B,eAAe,EAAE,YAAY;AAAA,UAC7B,cAAc,EAAE,WAAW;AAAA,QAC7B;AAEA,cAAM,mBAAK,SAAL,WAAa,UAAU,UAAU;AAAA,UACrC;AAAA,UACA;AAAA,UACA;AAAA,UACA,iBAAiB,SAAS;AAAA,QAC5B;AAAA,MACF;AAAA,IACF,CAAC;AACD,UAAM,QAAQ,IAAI,cAAc;AAAA,EAClC;AACF;AArQE;AAEA;AAEA;AAES;AAEA;AAsET;AAAA,iBAAY,WAAG;AACb,MAAI,mBAAK,cAAa;AACpB,kBAAc,mBAAK,YAAW;AAAA,EAChC;AACF;AAMM;AAAA,kBAAa,iBAAkB;AACnC,wBAAK,8BAAL;AACA,QAAM,KAAK,WAAW;AACtB,qBAAK,aAAc,YAAY,YAAY;AACzC,UAAM,KAAK,WAAW;AAAA,EACxB,GAAG,mBAAK,UAAS;AACnB;AA6BA;AAAA,wCAAmC,SAAC,EAAE,gBAAgB,GAAqB;AACzE,MAAI,CAAC,oBAAoB,mBAAK,YAAW;AACvC,uBAAK,WAAY,CAAC;AAClB,QAAI,iBAAiB;AACnB,WAAK,MAAM;AAAA,IACb,OAAO;AACL,WAAK,KAAK;AAAA,IACZ;AAAA,EACF;AACF;AAEA;AAAA,oBAAe,SAAC,EAAE,SAAS,KAAK,GAAuC;AACrE,SAAO,GAAG,gBAAgB,UAAU,OAAO,+DACzC,QAAQ,EACV;AACF;AAEM;AAAA,kBAAa,eAAC,SAAiB;AACnC,MAAI;AACJ,MAAI,OAAyB,CAAC;AAC9B,MAAI;AAEJ,KAAG;AACD,qBAAiB,MAAM,uBAAuB;AAAA,MAC5C,KAAK,sBAAK,oCAAL,WAAqB,EAAE,SAAS,KAAK;AAAA,MAC1C,SAAS;AAAA,QACP,SAAS;AAAA,UACP,SAAS;AAAA,QACX;AAAA,MACF;AAAA,MACA,SAAS;AAAA,IACX,CAAC;AAED,QAAI,CAAC,gBAAgB;AACnB,aAAO;AAAA,IACT;AAEA,UAAM,UACJ,eAAe,QAAQ;AAAA,MACrB,CAAC,QACC,IAAI,MAAM,WAAW,UACpB,IAAI,gBAAgB,cACjB,IAAI,gBAAgB,gBAAgB,wBACpC;AAAA,IACR,KAAK,CAAC;AAER,WAAO,CAAC,GAAG,MAAM,GAAG,OAAO;AAAA,EAC7B,SAAU,OAAO,eAAe;AAEhC,SAAO;AACT;AA0FF,IAAO,iCAAQ","sourcesContent":["import type { AddApprovalRequest } from '@metamask/approval-controller';\nimport type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport {\n  fetchWithErrorHandling,\n  toChecksumHexAddress,\n  ChainId,\n  NFT_API_BASE_URL,\n  NFT_API_VERSION,\n  NFT_API_TIMEOUT,\n} from '@metamask/controller-utils';\nimport type {\n  NetworkClientId,\n  NetworkClient,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerStateChangeEvent,\n  NetworkControllerGetStateAction,\n} from '@metamask/network-controller';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type {\n  PreferencesControllerGetStateAction,\n  PreferencesControllerStateChangeEvent,\n  PreferencesState,\n} from '@metamask/preferences-controller';\n\nimport { Source } from './constants';\nimport {\n  type NftController,\n  type NftState,\n  type NftMetadata,\n} from './NftController';\n\nconst DEFAULT_INTERVAL = 180000;\n\nconst controllerName = 'NftDetectionController';\n\nexport type AllowedActions =\n  | AddApprovalRequest\n  | NetworkControllerGetStateAction\n  | NetworkControllerGetNetworkClientByIdAction\n  | PreferencesControllerGetStateAction;\n\nexport type AllowedEvents =\n  | PreferencesControllerStateChangeEvent\n  | NetworkControllerStateChangeEvent;\n\nexport type NftDetectionControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  AllowedActions,\n  AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * @type ApiNft\n *\n * NFT object coming from OpenSea api\n * @property token_id - The NFT identifier\n * @property num_sales - Number of sales\n * @property background_color - The background color to be displayed with the item\n * @property image_url - URI of an image associated with this NFT\n * @property image_preview_url - URI of a smaller image associated with this NFT\n * @property image_thumbnail_url - URI of a thumbnail image associated with this NFT\n * @property image_original_url - URI of the original image associated with this NFT\n * @property animation_url - URI of a animation associated with this NFT\n * @property animation_original_url - URI of the original animation associated with this NFT\n * @property name - The NFT name\n * @property description - The NFT description\n * @property external_link - External link containing additional information\n * @property assetContract - The NFT contract information object\n * @property creator - The NFT owner information object\n * @property lastSale - When this item was last sold\n */\nexport type ApiNft = {\n  token_id: string;\n  num_sales: number | null;\n  background_color: string | null;\n  image_url: string | null;\n  image_preview_url: string | null;\n  image_thumbnail_url: string | null;\n  image_original_url: string | null;\n  animation_url: string | null;\n  animation_original_url: string | null;\n  name: string | null;\n  description: string | null;\n  external_link: string | null;\n  asset_contract: ApiNftContract;\n  creator: ApiNftCreator;\n  last_sale: ApiNftLastSale | null;\n};\n\n/**\n * @type ApiNftContract\n *\n * NFT contract object coming from OpenSea api\n * @property address - Address of the NFT contract\n * @property asset_contract_type - The NFT type, it could be `semi-fungible` or `non-fungible`\n * @property created_date - Creation date\n * @property collection - Object containing the contract name and URI of an image associated\n * @property schema_name - The schema followed by the contract, it could be `ERC721` or `ERC1155`\n * @property symbol - The NFT contract symbol\n * @property total_supply - Total supply of NFTs\n * @property description - The NFT contract description\n * @property external_link - External link containing additional information\n */\nexport type ApiNftContract = {\n  address: string;\n  asset_contract_type: string | null;\n  created_date: string | null;\n  schema_name: string | null;\n  symbol: string | null;\n  total_supply: string | null;\n  description: string | null;\n  external_link: string | null;\n  collection: {\n    name: string | null;\n    image_url?: string | null;\n    tokenCount?: string | null;\n  };\n};\n\n/**\n * @type ApiNftLastSale\n *\n * NFT sale object coming from OpenSea api\n * @property event_timestamp - Object containing a `username`\n * @property total_price - URI of NFT image associated with this owner\n * @property transaction - Object containing transaction_hash and block_hash\n */\nexport type ApiNftLastSale = {\n  event_timestamp: string;\n  total_price: string;\n  transaction: { transaction_hash: string; block_hash: string };\n};\n\n/**\n * @type ApiNftCreator\n *\n * NFT creator object coming from OpenSea api\n * @property user - Object containing a `username`\n * @property profile_img_url - URI of NFT image associated with this owner\n * @property address - The owner address\n */\nexport type ApiNftCreator = {\n  user: { username: string };\n  profile_img_url: string;\n  address: string;\n};\n\nexport type ReservoirResponse = {\n  tokens: TokensResponse[];\n  continuation?: string;\n};\n\nexport type TokensResponse = {\n  token: TokenResponse;\n  ownership: Ownership;\n  market?: Market;\n  blockaidResult?: Blockaid;\n};\n\nexport enum BlockaidResultType {\n  Benign = 'Benign',\n  Spam = 'Spam',\n  Warning = 'Warning',\n  Malicious = 'Malicious',\n}\n\nexport type Blockaid = {\n  contract: string;\n  chainId: number;\n  result_type: BlockaidResultType;\n  malicious_score: string;\n  attack_types: object;\n};\n\nexport type Market = {\n  floorAsk?: FloorAsk;\n  topBid?: TopBid;\n};\n\nexport type TokenResponse = {\n  chainId: number;\n  contract: string;\n  tokenId: string;\n  kind?: string;\n  name?: string;\n  image?: string;\n  imageSmall?: string;\n  imageLarge?: string;\n  metadata?: Metadata;\n  description?: string;\n  supply?: number;\n  remainingSupply?: number;\n  rarityScore?: number;\n  rarity?: number;\n  rarityRank?: number;\n  media?: string;\n  isFlagged?: boolean;\n  isSpam?: boolean;\n  isNsfw?: boolean;\n  metadataDisabled?: boolean;\n  lastFlagUpdate?: string;\n  lastFlagChange?: string;\n  collection?: Collection;\n  lastSale?: LastSale;\n  topBid?: TopBid;\n  lastAppraisalValue?: number;\n  attributes?: Attributes[];\n};\n\nexport type TopBid = {\n  id?: string;\n  price?: Price;\n  source?: {\n    id?: string;\n    domain?: string;\n    name?: string;\n    icon?: string;\n    url?: string;\n  };\n};\n\nexport type LastSale = {\n  saleId?: string;\n  token?: {\n    contract?: string;\n    tokenId?: string;\n    name?: string;\n    image?: string;\n    collection?: {\n      id?: string;\n      name?: string;\n    };\n  };\n  orderSource?: string;\n  orderSide?: 'ask' | 'bid';\n  orderKind?: string;\n  orderId?: string;\n  from?: string;\n  to?: string;\n  amount?: string;\n  fillSource?: string;\n  block?: number;\n  txHash?: string;\n  logIndex?: number;\n  batchIndex?: number;\n  timestamp?: number;\n  price?: Price;\n  washTradingScore?: number;\n  royaltyFeeBps?: number;\n  marketplaceFeeBps?: number;\n  paidFullRoyalty?: boolean;\n  feeBreakdown?: FeeBreakdown[];\n  isDeleted?: boolean;\n  createdAt?: string;\n  updatedAt?: string;\n};\n\nexport type FeeBreakdown = {\n  kind?: string;\n  bps?: number;\n  recipient?: string;\n  source?: string;\n  rawAmount?: string;\n};\n\nexport type Attributes = {\n  key?: string;\n  kind?: string;\n  value: string;\n  tokenCount?: number;\n  onSaleCount?: number;\n  floorAskPrice?: Price | null;\n  topBidValue?: number | null;\n  createdAt?: string;\n};\n\nexport type Collection = {\n  id?: string;\n  name?: string;\n  slug?: string;\n  symbol?: string;\n  imageUrl?: string;\n  image?: string;\n  isSpam?: boolean;\n  isNsfw?: boolean;\n  creator?: string;\n  tokenCount?: string;\n  metadataDisabled?: boolean;\n  openseaVerificationStatus?: string;\n  floorAskPrice?: Price;\n  royaltiesBps?: number;\n  royalties?: Royalties[];\n};\n\nexport type Royalties = {\n  bps?: number;\n  recipient?: string;\n};\n\nexport type Ownership = {\n  tokenCount?: string;\n  onSaleCount?: string;\n  floorAsk?: FloorAsk;\n  acquiredAt?: string;\n};\n\nexport type FloorAsk = {\n  id?: string;\n  price?: Price;\n  maker?: string;\n  kind?: string;\n  validFrom?: number;\n  validUntil?: number;\n  source?: Source;\n  rawData?: Metadata;\n  isNativeOffChainCancellable?: boolean;\n};\n\nexport type Price = {\n  currency?: {\n    contract?: string;\n    name?: string;\n    symbol?: string;\n    decimals?: number;\n    chainId?: number;\n  };\n  amount?: {\n    raw?: string;\n    decimal?: number;\n    usd?: number;\n    native?: number;\n  };\n  netAmount?: {\n    raw?: string;\n    decimal?: number;\n    usd?: number;\n    native?: number;\n  };\n};\n\nexport type Metadata = {\n  imageOriginal?: string;\n  tokenURI?: string;\n};\n\n/**\n * Controller that passively polls on a set interval for NFT auto detection\n */\nexport class NftDetectionController extends StaticIntervalPollingController<\n  typeof controllerName,\n  Record<never, never>,\n  NftDetectionControllerMessenger\n> {\n  #intervalId?: ReturnType<typeof setTimeout>;\n\n  #interval: number;\n\n  #disabled: boolean;\n\n  readonly #addNft: NftController['addNft'];\n\n  readonly #getNftState: () => NftState;\n\n  /**\n   * The controller options\n   *\n   * @param options - The controller options.\n   * @param options.interval - The pooling interval.\n   * @param options.messenger - A reference to the messaging system.\n   * @param options.disabled - Represents previous value of useNftDetection. Used to detect changes of useNftDetection. Default value is true.\n   * @param options.addNft - Add an NFT.\n   * @param options.getNftState - Gets the current state of the Assets controller.\n   */\n  constructor({\n    interval = DEFAULT_INTERVAL,\n    messenger,\n    disabled = false,\n    addNft,\n    getNftState,\n  }: {\n    interval?: number;\n    messenger: NftDetectionControllerMessenger;\n    disabled: boolean;\n    addNft: NftController['addNft'];\n    getNftState: () => NftState;\n  }) {\n    super({\n      name: controllerName,\n      messenger,\n      metadata: {},\n      state: {},\n    });\n    this.#interval = interval;\n    this.#disabled = disabled;\n\n    this.#getNftState = getNftState;\n    this.#addNft = addNft;\n\n    this.messagingSystem.subscribe(\n      'PreferencesController:stateChange',\n      this.#onPreferencesControllerStateChange.bind(this),\n    );\n\n    this.setIntervalLength(this.#interval);\n  }\n\n  async _executePoll(\n    networkClientId: string,\n    options: { address: string },\n  ): Promise<void> {\n    await this.detectNfts({ networkClientId, userAddress: options.address });\n  }\n\n  /**\n   * Start polling for the currency rate.\n   */\n  async start() {\n    if (!this.isMainnet() || this.#disabled) {\n      return;\n    }\n\n    await this.#startPolling();\n  }\n\n  /**\n   * Stop polling for the currency rate.\n   */\n  stop() {\n    this.#stopPolling();\n  }\n\n  #stopPolling() {\n    if (this.#intervalId) {\n      clearInterval(this.#intervalId);\n    }\n  }\n\n  /**\n   * Starts a new polling interval.\n   *\n   */\n  async #startPolling(): Promise<void> {\n    this.#stopPolling();\n    await this.detectNfts();\n    this.#intervalId = setInterval(async () => {\n      await this.detectNfts();\n    }, this.#interval);\n  }\n\n  /**\n   * Checks whether network is mainnet or not.\n   *\n   * @returns Whether current network is mainnet.\n   */\n  isMainnet(): boolean {\n    const { selectedNetworkClientId } = this.messagingSystem.call(\n      'NetworkController:getState',\n    );\n    const {\n      configuration: { chainId },\n    } = this.messagingSystem.call(\n      'NetworkController:getNetworkClientById',\n      selectedNetworkClientId,\n    );\n    return chainId === ChainId.mainnet;\n  }\n\n  isMainnetByNetworkClientId(networkClient: NetworkClient): boolean {\n    return networkClient.configuration.chainId === ChainId.mainnet;\n  }\n\n  /**\n   * Handles the state change of the preference controller.\n   * @param preferencesState - The new state of the preference controller.\n   * @param preferencesState.useNftDetection - Boolean indicating user preference on NFT detection.\n   */\n  #onPreferencesControllerStateChange({ useNftDetection }: PreferencesState) {\n    if (!useNftDetection !== this.#disabled) {\n      this.#disabled = !useNftDetection;\n      if (useNftDetection) {\n        this.start();\n      } else {\n        this.stop();\n      }\n    }\n  }\n\n  #getOwnerNftApi({ address, next }: { address: string; next?: string }) {\n    return `${NFT_API_BASE_URL}/users/${address}/tokens?chainIds=1&limit=50&includeTopBid=true&continuation=${\n      next ?? ''\n    }`;\n  }\n\n  async #getOwnerNfts(address: string) {\n    let nftApiResponse: ReservoirResponse;\n    let nfts: TokensResponse[] = [];\n    let next;\n\n    do {\n      nftApiResponse = await fetchWithErrorHandling({\n        url: this.#getOwnerNftApi({ address, next }),\n        options: {\n          headers: {\n            Version: NFT_API_VERSION,\n          },\n        },\n        timeout: NFT_API_TIMEOUT,\n      });\n\n      if (!nftApiResponse) {\n        return nfts;\n      }\n\n      const newNfts =\n        nftApiResponse.tokens?.filter(\n          (elm) =>\n            elm.token.isSpam === false &&\n            (elm.blockaidResult?.result_type\n              ? elm.blockaidResult?.result_type === BlockaidResultType.Benign\n              : true),\n        ) ?? [];\n\n      nfts = [...nfts, ...newNfts];\n    } while ((next = nftApiResponse.continuation));\n\n    return nfts;\n  }\n\n  /**\n   * Triggers asset ERC721 token auto detection on mainnet. Any newly detected NFTs are\n   * added.\n   *\n   * @param options - Options bag.\n   * @param options.networkClientId - The network client ID to detect NFTs on.\n   * @param options.userAddress - The address to detect NFTs for.\n   */\n  async detectNfts(options?: {\n    networkClientId?: NetworkClientId;\n    userAddress?: string;\n  }) {\n    const userAddress =\n      options?.userAddress ??\n      this.messagingSystem.call('PreferencesController:getState')\n        .selectedAddress;\n    /* istanbul ignore if */\n    if (!this.isMainnet() || this.#disabled) {\n      return;\n    }\n    /* istanbul ignore else */\n    if (!userAddress) {\n      return;\n    }\n\n    const apiNfts = await this.#getOwnerNfts(userAddress);\n    const addNftPromises = apiNfts.map(async (nft) => {\n      const {\n        tokenId: token_id,\n        contract,\n        kind,\n        image: image_url,\n        imageSmall: image_thumbnail_url,\n        metadata: { imageOriginal: image_original_url } = {},\n        name,\n        description,\n        attributes,\n        topBid,\n        lastSale,\n        rarityRank,\n        rarityScore,\n        collection,\n      } = nft.token;\n\n      let ignored;\n      /* istanbul ignore else */\n      const { ignoredNfts } = this.#getNftState();\n      if (ignoredNfts.length > 0) {\n        ignored = ignoredNfts.find((c) => {\n          /* istanbul ignore next */\n          return (\n            c.address === toChecksumHexAddress(contract) &&\n            c.tokenId === token_id\n          );\n        });\n      }\n\n      /* istanbul ignore else */\n      if (!ignored) {\n        /* istanbul ignore next */\n        const nftMetadata: NftMetadata = Object.assign(\n          {},\n          { name },\n          description && { description },\n          image_url && { image: image_url },\n          image_thumbnail_url && { imageThumbnail: image_thumbnail_url },\n          image_original_url && { imageOriginal: image_original_url },\n          kind && { standard: kind.toUpperCase() },\n          lastSale && { lastSale },\n          attributes && { attributes },\n          topBid && { topBid },\n          rarityRank && { rarityRank },\n          rarityScore && { rarityScore },\n          collection && { collection },\n        );\n\n        await this.#addNft(contract, token_id, {\n          nftMetadata,\n          userAddress,\n          source: Source.Detected,\n          networkClientId: options?.networkClientId,\n        });\n      }\n    });\n    await Promise.all(addNftPromises);\n  }\n}\n\nexport default NftDetectionController;\n"]}

package/dist/{chunk-PAJTKWEC.mjs → chunk-65PB33TE.mjs}

@@ -243,4 +243,4 @@ export {
   AccountTrackerController,
   AccountTrackerController_default
 };
-//# sourceMappingURL=chunk-PAJTKWEC.mjs.map
+//# sourceMappingURL=chunk-65PB33TE.mjs.map

package/dist/chunk-65PB33TE.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/AccountTrackerController.ts"],"sourcesContent":["import type { BaseConfig, BaseState } from '@metamask/base-controller';\nimport { query, safelyExecuteWithTimeout } from '@metamask/controller-utils';\nimport EthQuery from '@metamask/eth-query';\nimport type { Provider } from '@metamask/eth-query';\nimport type {\n  NetworkClientId,\n  NetworkController,\n  NetworkState,\n} from '@metamask/network-controller';\nimport { StaticIntervalPollingControllerV1 } from '@metamask/polling-controller';\nimport type { PreferencesState } from '@metamask/preferences-controller';\nimport { assert } from '@metamask/utils';\nimport { Mutex } from 'async-mutex';\nimport { cloneDeep } from 'lodash';\n\n/**\n * @type AccountInformation\n *\n * Account information object\n * @property balance - Hex string of an account balancec in wei\n */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface AccountInformation {\n  balance: string;\n}\n\n/**\n * @type AccountTrackerConfig\n *\n * Account tracker controller configuration\n * @property provider - Provider used to create a new underlying EthQuery instance\n */\n// This interface was created before this ESLint rule was added.\n// Remove in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface AccountTrackerConfig extends BaseConfig {\n  interval: number;\n  provider?: Provider;\n}\n\n/**\n * @type AccountTrackerState\n *\n * Account tracker controller state\n * @property accounts - Map of addresses to account information\n */\n// This interface was created before this ESLint rule was added.\n// Remove in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface AccountTrackerState extends BaseState {\n  accounts: { [address: string]: AccountInformation };\n  accountsByChainId: Record<string, { [address: string]: AccountInformation }>;\n}\n\n/**\n * Controller that tracks the network balances for all user accounts.\n */\nexport class AccountTrackerController extends StaticIntervalPollingControllerV1<\n  AccountTrackerConfig,\n  AccountTrackerState\n> {\n  private _provider?: Provider;\n\n  private readonly refreshMutex = new Mutex();\n\n  private handle?: ReturnType<typeof setTimeout>;\n\n  private syncAccounts(newChainId: string) {\n    const accounts = { ...this.state.accounts };\n    const accountsByChainId = cloneDeep(this.state.accountsByChainId);\n\n    const existing = Object.keys(accounts);\n    if (!accountsByChainId[newChainId]) {\n      accountsByChainId[newChainId] = {};\n      existing.forEach((address) => {\n        accountsByChainId[newChainId][address] = { balance: '0x0' };\n      });\n    }\n\n    const addresses = Object.keys(this.getIdentities());\n    const newAddresses = addresses.filter(\n      (address) => !existing.includes(address),\n    );\n    const oldAddresses = existing.filter(\n      (address) => !addresses.includes(address),\n    );\n    newAddresses.forEach((address) => {\n      accounts[address] = { balance: '0x0' };\n    });\n    Object.keys(accountsByChainId).forEach((chainId) => {\n      newAddresses.forEach((address) => {\n        accountsByChainId[chainId][address] = {\n          balance: '0x0',\n        };\n      });\n    });\n\n    oldAddresses.forEach((address) => {\n      delete accounts[address];\n    });\n    Object.keys(accountsByChainId).forEach((chainId) => {\n      oldAddresses.forEach((address) => {\n        delete accountsByChainId[chainId][address];\n      });\n    });\n\n    this.update({ accounts, accountsByChainId });\n  }\n\n  /**\n   * Name of this controller used during composition\n   */\n  override name = 'AccountTrackerController' as const;\n\n  private readonly getIdentities: () => PreferencesState['identities'];\n\n  private readonly getSelectedAddress: () => PreferencesState['selectedAddress'];\n\n  private readonly getMultiAccountBalancesEnabled: () => PreferencesState['isMultiAccountBalancesEnabled'];\n\n  private readonly getCurrentChainId: () => NetworkState['providerConfig']['chainId'];\n\n  private readonly getNetworkClientById: NetworkController['getNetworkClientById'];\n\n  /**\n   * Creates an AccountTracker instance.\n   *\n   * @param options - The controller options.\n   * @param options.onPreferencesStateChange - Allows subscribing to preference controller state changes.\n   * @param options.getIdentities - Gets the identities from the Preferences store.\n   * @param options.getSelectedAddress - Gets the selected address from the Preferences store.\n   * @param options.getMultiAccountBalancesEnabled - Gets the multi account balances enabled flag from the Preferences store.\n   * @param options.getCurrentChainId - Gets the chain ID for the current network from the Network store.\n   * @param options.getNetworkClientById - Gets the network client with the given id from the NetworkController.\n   * @param config - Initial options used to configure this controller.\n   * @param state - Initial state to set on this controller.\n   */\n  constructor(\n    {\n      onPreferencesStateChange,\n      getIdentities,\n      getSelectedAddress,\n      getMultiAccountBalancesEnabled,\n      getCurrentChainId,\n      getNetworkClientById,\n    }: {\n      onPreferencesStateChange: (\n        listener: (preferencesState: PreferencesState) => void,\n      ) => void;\n      getIdentities: () => PreferencesState['identities'];\n      getSelectedAddress: () => PreferencesState['selectedAddress'];\n      getMultiAccountBalancesEnabled: () => PreferencesState['isMultiAccountBalancesEnabled'];\n      getCurrentChainId: () => NetworkState['providerConfig']['chainId'];\n      getNetworkClientById: NetworkController['getNetworkClientById'];\n    },\n    config?: Partial<AccountTrackerConfig>,\n    state?: Partial<AccountTrackerState>,\n  ) {\n    super(config, state);\n    this.defaultConfig = {\n      interval: 10000,\n    };\n    this.defaultState = {\n      accounts: {},\n      accountsByChainId: {\n        [getCurrentChainId()]: {},\n      },\n    };\n    this.initialize();\n    this.setIntervalLength(this.config.interval);\n    this.getIdentities = getIdentities;\n    this.getSelectedAddress = getSelectedAddress;\n    this.getMultiAccountBalancesEnabled = getMultiAccountBalancesEnabled;\n    this.getCurrentChainId = getCurrentChainId;\n    this.getNetworkClientById = getNetworkClientById;\n    onPreferencesStateChange(() => {\n      this.refresh();\n    });\n    this.poll();\n  }\n\n  /**\n   * Sets a new provider.\n   *\n   * TODO: Replace this wth a method.\n   *\n   * @param provider - Provider used to create a new underlying EthQuery instance.\n   */\n  set provider(provider: Provider) {\n    this._provider = provider;\n  }\n\n  get provider() {\n    throw new Error('Property only used for setting');\n  }\n\n  /**\n   * Resolves a networkClientId to a network client config\n   * or globally selected network config if not provided\n   *\n   * @param networkClientId - Optional networkClientId to fetch a network client with\n   * @returns network client config\n   */\n  #getCorrectNetworkClient(networkClientId?: NetworkClientId): {\n    chainId: string;\n    ethQuery?: EthQuery;\n  } {\n    if (networkClientId) {\n      const networkClient = this.getNetworkClientById(networkClientId);\n\n      return {\n        chainId: networkClient.configuration.chainId,\n        ethQuery: new EthQuery(networkClient.provider),\n      };\n    }\n\n    return {\n      chainId: this.getCurrentChainId(),\n      ethQuery: this._provider ? new EthQuery(this._provider) : undefined,\n    };\n  }\n\n  /**\n   * Starts a new polling interval.\n   *\n   * @param interval - Polling interval trigger a 'refresh'.\n   */\n  async poll(interval?: number): Promise<void> {\n    interval && this.configure({ interval }, false, false);\n    this.handle && clearTimeout(this.handle);\n    await this.refresh();\n    this.handle = setTimeout(() => {\n      this.poll(this.config.interval);\n    }, this.config.interval);\n  }\n\n  /**\n   * Refreshes the balances of the accounts using the networkClientId\n   *\n   * @param networkClientId - The network client ID used to get balances.\n   */\n  async _executePoll(networkClientId: string): Promise<void> {\n    this.refresh(networkClientId);\n  }\n\n  /**\n   * Refreshes the balances of the accounts depending on the multi-account setting.\n   * If multi-account is disabled, only updates the selected account balance.\n   * If multi-account is enabled, updates balances for all accounts.\n   *\n   * @param networkClientId - Optional networkClientId to fetch a network client with\n   */\n  refresh = async (networkClientId?: NetworkClientId) => {\n    const releaseLock = await this.refreshMutex.acquire();\n    try {\n      const { chainId, ethQuery } =\n        this.#getCorrectNetworkClient(networkClientId);\n      this.syncAccounts(chainId);\n      const { accounts, accountsByChainId } = this.state;\n      const isMultiAccountBalancesEnabled =\n        this.getMultiAccountBalancesEnabled();\n\n      const accountsToUpdate = isMultiAccountBalancesEnabled\n        ? Object.keys(accounts)\n        : [this.getSelectedAddress()];\n\n      const accountsForChain = { ...accountsByChainId[chainId] };\n      for (const address of accountsToUpdate) {\n        const balance = await this.getBalanceFromChain(address, ethQuery);\n        if (balance) {\n          accountsForChain[address] = {\n            balance,\n          };\n        }\n      }\n\n      this.update({\n        ...(chainId === this.getCurrentChainId() && {\n          accounts: accountsForChain,\n        }),\n        accountsByChainId: {\n          ...this.state.accountsByChainId,\n          [chainId]: accountsForChain,\n        },\n      });\n    } catch (err) {\n      releaseLock();\n      throw err;\n    }\n  };\n\n  /**\n   * Fetches the balance of a given address from the blockchain.\n   *\n   * @param address - The account address to fetch the balance for.\n   * @param ethQuery - The EthQuery instance to query getBalnce with.\n   * @returns A promise that resolves to the balance in a hex string format.\n   */\n  private async getBalanceFromChain(\n    address: string,\n    ethQuery?: EthQuery,\n  ): Promise<string | undefined> {\n    return await safelyExecuteWithTimeout(async () => {\n      assert(ethQuery, 'Provider not set.');\n      return await query(ethQuery, 'getBalance', [address]);\n    });\n  }\n\n  /**\n   * Sync accounts balances with some additional addresses.\n   *\n   * @param addresses - the additional addresses, may be hardware wallet addresses.\n   * @param networkClientId - Optional networkClientId to fetch a network client with.\n   * @returns accounts - addresses with synced balance\n   */\n  async syncBalanceWithAddresses(\n    addresses: string[],\n    networkClientId?: NetworkClientId,\n  ): Promise<Record<string, { balance: string }>> {\n    const { ethQuery } = this.#getCorrectNetworkClient(networkClientId);\n\n    return await Promise.all(\n      addresses.map((address): Promise<[string, string] | undefined> => {\n        return safelyExecuteWithTimeout(async () => {\n          assert(ethQuery, 'Provider not set.');\n          const balance = await query(ethQuery, 'getBalance', [address]);\n          return [address, balance];\n        });\n      }),\n    ).then((value) => {\n      return value.reduce((obj, item) => {\n        if (!item) {\n          return obj;\n        }\n\n        const [address, balance] = item;\n        return {\n          ...obj,\n          [address]: {\n            balance,\n          },\n        };\n      }, {});\n    });\n  }\n}\n\nexport default AccountTrackerController;\n"],"mappings":";;;;;;AACA,SAAS,OAAO,gCAAgC;AAChD,OAAO,cAAc;AAOrB,SAAS,yCAAyC;AAElD,SAAS,cAAc;AACvB,SAAS,aAAa;AACtB,SAAS,iBAAiB;AAb1B;AA2DO,IAAM,2BAAN,cAAuC,kCAG5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA6EA,YACE;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAUA,QACA,OACA;AACA,UAAM,QAAQ,KAAK;AA6CrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA5IA,SAAiB,eAAe,IAAI,MAAM;AAiD1C;AAAA;AAAA;AAAA,SAAS,OAAO;AA4IhB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAU,OAAO,oBAAsC;AACrD,YAAM,cAAc,MAAM,KAAK,aAAa,QAAQ;AACpD,UAAI;AACF,cAAM,EAAE,SAAS,SAAS,IACxB,sBAAK,sDAAL,WAA8B;AAChC,aAAK,aAAa,OAAO;AACzB,cAAM,EAAE,UAAU,kBAAkB,IAAI,KAAK;AAC7C,cAAM,gCACJ,KAAK,+BAA+B;AAEtC,cAAM,mBAAmB,gCACrB,OAAO,KAAK,QAAQ,IACpB,CAAC,KAAK,mBAAmB,CAAC;AAE9B,cAAM,mBAAmB,EAAE,GAAG,kBAAkB,OAAO,EAAE;AACzD,mBAAW,WAAW,kBAAkB;AACtC,gBAAM,UAAU,MAAM,KAAK,oBAAoB,SAAS,QAAQ;AAChE,cAAI,SAAS;AACX,6BAAiB,OAAO,IAAI;AAAA,cAC1B;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAEA,aAAK,OAAO;AAAA,UACV,GAAI,YAAY,KAAK,kBAAkB,KAAK;AAAA,YAC1C,UAAU;AAAA,UACZ;AAAA,UACA,mBAAmB;AAAA,YACjB,GAAG,KAAK,MAAM;AAAA,YACd,CAAC,OAAO,GAAG;AAAA,UACb;AAAA,QACF,CAAC;AAAA,MACH,SAAS,KAAK;AACZ,oBAAY;AACZ,cAAM;AAAA,MACR;AAAA,IACF;AAlIE,SAAK,gBAAgB;AAAA,MACnB,UAAU;AAAA,IACZ;AACA,SAAK,eAAe;AAAA,MAClB,UAAU,CAAC;AAAA,MACX,mBAAmB;AAAA,QACjB,CAAC,kBAAkB,CAAC,GAAG,CAAC;AAAA,MAC1B;AAAA,IACF;AACA,SAAK,WAAW;AAChB,SAAK,kBAAkB,KAAK,OAAO,QAAQ;AAC3C,SAAK,gBAAgB;AACrB,SAAK,qBAAqB;AAC1B,SAAK,iCAAiC;AACtC,SAAK,oBAAoB;AACzB,SAAK,uBAAuB;AAC5B,6BAAyB,MAAM;AAC7B,WAAK,QAAQ;AAAA,IACf,CAAC;AACD,SAAK,KAAK;AAAA,EACZ;AAAA,EAhHQ,aAAa,YAAoB;AACvC,UAAM,WAAW,EAAE,GAAG,KAAK,MAAM,SAAS;AAC1C,UAAM,oBAAoB,UAAU,KAAK,MAAM,iBAAiB;AAEhE,UAAM,WAAW,OAAO,KAAK,QAAQ;AACrC,QAAI,CAAC,kBAAkB,UAAU,GAAG;AAClC,wBAAkB,UAAU,IAAI,CAAC;AACjC,eAAS,QAAQ,CAAC,YAAY;AAC5B,0BAAkB,UAAU,EAAE,OAAO,IAAI,EAAE,SAAS,MAAM;AAAA,MAC5D,CAAC;AAAA,IACH;AAEA,UAAM,YAAY,OAAO,KAAK,KAAK,cAAc,CAAC;AAClD,UAAM,eAAe,UAAU;AAAA,MAC7B,CAAC,YAAY,CAAC,SAAS,SAAS,OAAO;AAAA,IACzC;AACA,UAAM,eAAe,SAAS;AAAA,MAC5B,CAAC,YAAY,CAAC,UAAU,SAAS,OAAO;AAAA,IAC1C;AACA,iBAAa,QAAQ,CAAC,YAAY;AAChC,eAAS,OAAO,IAAI,EAAE,SAAS,MAAM;AAAA,IACvC,CAAC;AACD,WAAO,KAAK,iBAAiB,EAAE,QAAQ,CAAC,YAAY;AAClD,mBAAa,QAAQ,CAAC,YAAY;AAChC,0BAAkB,OAAO,EAAE,OAAO,IAAI;AAAA,UACpC,SAAS;AAAA,QACX;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAED,iBAAa,QAAQ,CAAC,YAAY;AAChC,aAAO,SAAS,OAAO;AAAA,IACzB,CAAC;AACD,WAAO,KAAK,iBAAiB,EAAE,QAAQ,CAAC,YAAY;AAClD,mBAAa,QAAQ,CAAC,YAAY;AAChC,eAAO,kBAAkB,OAAO,EAAE,OAAO;AAAA,MAC3C,CAAC;AAAA,IACH,CAAC;AAED,SAAK,OAAO,EAAE,UAAU,kBAAkB,CAAC;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiFA,IAAI,SAAS,UAAoB;AAC/B,SAAK,YAAY;AAAA,EACnB;AAAA,EAEA,IAAI,WAAW;AACb,UAAM,IAAI,MAAM,gCAAgC;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiCA,MAAM,KAAK,UAAkC;AAC3C,gBAAY,KAAK,UAAU,EAAE,SAAS,GAAG,OAAO,KAAK;AACrD,SAAK,UAAU,aAAa,KAAK,MAAM;AACvC,UAAM,KAAK,QAAQ;AACnB,SAAK,SAAS,WAAW,MAAM;AAC7B,WAAK,KAAK,KAAK,OAAO,QAAQ;AAAA,IAChC,GAAG,KAAK,OAAO,QAAQ;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAAa,iBAAwC;AACzD,SAAK,QAAQ,eAAe;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuDA,MAAc,oBACZ,SACA,UAC6B;AAC7B,WAAO,MAAM,yBAAyB,YAAY;AAChD,aAAO,UAAU,mBAAmB;AACpC,aAAO,MAAM,MAAM,UAAU,cAAc,CAAC,OAAO,CAAC;AAAA,IACtD,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,yBACJ,WACA,iBAC8C;AAC9C,UAAM,EAAE,SAAS,IAAI,sBAAK,sDAAL,WAA8B;AAEnD,WAAO,MAAM,QAAQ;AAAA,MACnB,UAAU,IAAI,CAAC,YAAmD;AAChE,eAAO,yBAAyB,YAAY;AAC1C,iBAAO,UAAU,mBAAmB;AACpC,gBAAM,UAAU,MAAM,MAAM,UAAU,cAAc,CAAC,OAAO,CAAC;AAC7D,iBAAO,CAAC,SAAS,OAAO;AAAA,QAC1B,CAAC;AAAA,MACH,CAAC;AAAA,IACH,EAAE,KAAK,CAAC,UAAU;AAChB,aAAO,MAAM,OAAO,CAAC,KAAK,SAAS;AACjC,YAAI,CAAC,MAAM;AACT,iBAAO;AAAA,QACT;AAEA,cAAM,CAAC,SAAS,OAAO,IAAI;AAC3B,eAAO;AAAA,UACL,GAAG;AAAA,UACH,CAAC,OAAO,GAAG;AAAA,YACT;AAAA,UACF;AAAA,QACF;AAAA,MACF,GAAG,CAAC,CAAC;AAAA,IACP,CAAC;AAAA,EACH;AACF;AA9IE;AAAA,6BAAwB,SAAC,iBAGvB;AACA,MAAI,iBAAiB;AACnB,UAAM,gBAAgB,KAAK,qBAAqB,eAAe;AAE/D,WAAO;AAAA,MACL,SAAS,cAAc,cAAc;AAAA,MACrC,UAAU,IAAI,SAAS,cAAc,QAAQ;AAAA,IAC/C;AAAA,EACF;AAEA,SAAO;AAAA,IACL,SAAS,KAAK,kBAAkB;AAAA,IAChC,UAAU,KAAK,YAAY,IAAI,SAAS,KAAK,SAAS,IAAI;AAAA,EAC5D;AACF;AA+HF,IAAO,mCAAQ;","names":[]}