@metamask-previews/assets-controllers 93.1.0-preview-f557eade → 93.1.0-preview-aabe1c65

package/CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- **BREAKING:** `NftDetectionController` now calls a new function `NftController:addNfts` that reduces API calls to bulk-scan to batch multiple NFTs URLs ([#7411](https://github.com/MetaMask/core/pull/7411))
 - Added decimal precision (default 9dp) for `CurrencyRateController` `conversionRate` and `conversionRate` properties. ([#7324](https://github.com/MetaMask/core/pull/7324))
   - This fixes any BigNumber conversion errors due to exceeding the 15 significant digit limit
 

package/dist/NftController.cjs

@@ -253,6 +253,42 @@ class NftController extends base_controller_1.BaseController {
             await __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_addIndividualNft).call(this, checksumHexAddress, tokenId, nftMetadata, nftContract, chainId, addressToSearch, source);
         }
     }
+    /**
+     * Adds multiple NFTs and respective NFT contracts to the stored NFT and NFT contracts lists.
+     *
+     * @param nfts - An array of NFT objects to add.
+     * @param nfts[].tokenAddress - Hex address of the NFT contract.
+     * @param nfts[].tokenId - The NFT identifier.
+     * @param nfts[].nftMetadata - NFT metadata including chainId.
+     * @param userAddress - The address of the current user.
+     * @param source - Whether the NFT was detected, added manually or suggested by a dapp. Defaults to Source.Custom.
+     * @returns Promise resolving to the current NFT list.
+     */
+    async addNfts(nfts, userAddress, source = constants_1.Source.Custom) {
+        const addressToSearch = __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_getAddressOrSelectedAddress).call(this, userAddress);
+        if (!addressToSearch) {
+            return;
+        }
+        // Remember max number of urls this allows is 250
+        const sanitizedNftMetadata = await __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_bulkSanitizeNftMetadata).call(this, nfts.map((nft) => nft.nftMetadata));
+        for (const [index, nft] of nfts.entries()) {
+            const checksumHexAddress = (0, controller_utils_1.toChecksumHexAddress)(nft.tokenAddress);
+            const hexChainId = (0, controller_utils_1.toHex)(nft.nftMetadata.chainId);
+            const networkClientId = this.messenger.call('NetworkController:findNetworkClientIdByChainId', hexChainId);
+            const newNftContracts = await __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_addNftContract).call(this, networkClientId, {
+                tokenAddress: checksumHexAddress,
+                userAddress: addressToSearch,
+                source,
+                nftMetadata: sanitizedNftMetadata[index],
+            });
+            // If NFT contract was not added, do not add individual NFT
+            const nftContract = newNftContracts.find((contract) => contract.address.toLowerCase() === checksumHexAddress.toLowerCase());
+            // If NFT contract information, add individual NFT
+            if (nftContract) {
+                await __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_addIndividualNft).call(this, checksumHexAddress, nft.tokenId, sanitizedNftMetadata[index], nftContract, hexChainId, addressToSearch, source);
+            }
+        }
+    }
     /**
      * Refetches NFT metadata and updates the state
      *
@@ -1216,27 +1252,40 @@ async function _NftController_bulkSanitizeNftMetadata(metadataList) {
         return sanitizedMetadataList;
     }
     try {
-        // Use bulkScanUrls to check all URLs at once
-        const bulkScanResponse = await this.messenger.call('PhishingController:bulkScanUrls', urlsToCheck);
-        // Apply scan results to all metadata objects
-        Object.entries(bulkScanResponse.results).forEach(([url, result]) => {
-            if (result.recommendedAction === phishing_controller_1.RecommendedAction.Block) {
-                // Remove this URL from all metadata objects where it appears
-                urlMap[url].forEach(({ metadataIndex, fieldName }) => {
-                    if (fieldName === 'collection.externalLink' &&
-                        sanitizedMetadataList[metadataIndex].collection // Check if collection exists
-                    ) {
-                        const { collection } = sanitizedMetadataList[metadataIndex];
-                        // Ensure collection is not undefined again just to be safe before using 'in'
-                        if (collection && 'externalLink' in collection) {
-                            delete collection.externalLink;
-                        }
-                    }
-                    else {
-                        delete sanitizedMetadataList[metadataIndex][fieldName];
+        // PhishingController has a 250 URL limit, so batch if needed
+        const MAX_URLS_PER_BATCH = 250;
+        // Process URLs in batches serially
+        const blockedUrls = await (0, assetsUtil_1.reduceInBatchesSerially)({
+            values: urlsToCheck,
+            batchSize: MAX_URLS_PER_BATCH,
+            eachBatch: async (workingBlockedUrls, batch) => {
+                // Use bulkScanUrls to check this batch
+                const bulkScanResponse = await this.messenger.call('PhishingController:bulkScanUrls', batch);
+                // Collect blocked URLs from this batch
+                Object.entries(bulkScanResponse.results).forEach(([url, result]) => {
+                    if (result.recommendedAction === phishing_controller_1.RecommendedAction.Block) {
+                        // Type assertion is safe here as we always initialize with a Set and return a Set
+                        workingBlockedUrls.add(url);
                     }
                 });
-            }
+                return workingBlockedUrls;
+            },
+            initialResult: new Set(),
+        });
+        // Apply scan results to all metadata objects
+        blockedUrls.forEach((url) => {
+            urlMap[url].forEach(({ metadataIndex, fieldName }) => {
+                if (fieldName === 'collection.externalLink' &&
+                    sanitizedMetadataList[metadataIndex].collection) {
+                    const { collection } = sanitizedMetadataList[metadataIndex];
+                    if (collection && 'externalLink' in collection) {
+                        delete collection.externalLink;
+                    }
+                }
+                else {
+                    delete sanitizedMetadataList[metadataIndex][fieldName];
+                }
+            });
         });
     }
     catch (error) {