@metamask-previews/assets-controllers 103.1.1-preview-dff83af4c → 103.1.1-preview-aa31fa3

package/CHANGELOG.md

@@ -9,6 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING:** `NftController` no longer uses the `AssetsContractController:getERC721OwnerOf` and `AssetsContractController:getERC1155BalanceOf` messenger actions for ownership checks; these have been removed from `AllowedActions` ([#8281](https://github.com/MetaMask/core/pull/8281))
+  - Consumers that construct the `NftController` messenger and register handlers for these two actions must remove them from their allowed actions list.
+- **BREAKING:** Removed the `checkAndUpdateSingleNftOwnershipStatus` method from `NftController` ([#8281](https://github.com/MetaMask/core/pull/8281))
+  - Use `checkAndUpdateAllNftsOwnershipStatus` instead, which now batches all ownership checks via Multicall3 in a single RPC request.
+- `checkAndUpdateAllNftsOwnershipStatus` now removes NFTs confirmed as unowned from state instead of setting `isCurrentlyOwned: false` ([#8281](https://github.com/MetaMask/core/pull/8281))
+  - The `isCurrentlyOwned: false` flag was originally used to power a "Previously Owned" NFTs section in MetaMask, which is no longer supported. NFTs that are confirmed as no longer owned are now removed from state immediately rather than being retained with a stale flag.
+- `NftController` NFT ownership checks (`isNftOwner`, `checkAndUpdateAllNftsOwnershipStatus`) now use Multicall3 to batch ERC-721 `ownerOf` and ERC-1155 `balanceOf` calls into fewer RPC requests, falling back to individual calls on unsupported chains ([#8281](https://github.com/MetaMask/core/pull/8281))
 - Bump `@metamask/accounts-controller` from `^37.1.1` to `^37.2.0` ([#8363](https://github.com/MetaMask/core/pull/8363))
 - Bump `@metamask/keyring-controller` from `^25.1.1` to `^25.2.0` ([#8363](https://github.com/MetaMask/core/pull/8363))
 - Bump `@metamask/messenger` from `^1.0.0` to `^1.1.1` ([#8364](https://github.com/MetaMask/core/pull/8364), [#8373](https://github.com/MetaMask/core/pull/8373))

package/dist/NftController.cjs

@@ -17,6 +17,7 @@ var _NftController_instances, _NftController_mutex, _NftController_selectedAccou
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NftController = exports.getDefaultNftControllerState = void 0;
 const address_1 = require("@ethersproject/address");
+const providers_1 = require("@ethersproject/providers");
 const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
 const phishing_controller_1 = require("@metamask/phishing-controller");
@@ -27,6 +28,7 @@ const bn_js_1 = __importDefault(require("bn.js"));
 const uuid_1 = require("uuid");
 const assetsUtil_1 = require("./assetsUtil.cjs");
 const constants_1 = require("./constants.cjs");
+const multicall_1 = require("./multicall.cjs");
 const nftControllerMetadata = {
     allNftContracts: {
         includeInStateLogs: false,
@@ -165,26 +167,27 @@ class NftController extends base_controller_1.BaseController {
      * @param nftAddress - NFT contract address.
      * @param tokenId - NFT token ID.
      * @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
+     * @param options - Optional parameters.
+     * @param options.standard - The NFT standard ('ERC721' or 'ERC1155'). When provided, only the
+     * relevant ownership check is performed, halving the number of RPC subcalls.
      * @returns Promise resolving the NFT ownership.
      */
-    async isNftOwner(ownerAddress, nftAddress, tokenId, networkClientId) {
-        // Checks the ownership for ERC-721.
-        try {
-            const owner = await this.messenger.call('AssetsContractController:getERC721OwnerOf', nftAddress, tokenId, networkClientId);
-            return ownerAddress.toLowerCase() === owner.toLowerCase();
-        }
-        catch {
-            // Ignore ERC-721 contract error
-        }
-        // Checks the ownership for ERC-1155.
-        try {
-            const balance = await this.messenger.call('AssetsContractController:getERC1155BalanceOf', ownerAddress, nftAddress, tokenId, networkClientId);
-            return !balance.isZero();
-        }
-        catch {
-            // Ignore ERC-1155 contract error
+    async isNftOwner(ownerAddress, nftAddress, tokenId, networkClientId, { standard } = {}) {
+        const client = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
+        const provider = new providers_1.Web3Provider(client.provider);
+        const { chainId } = client.configuration;
+        const [result] = await (0, multicall_1.getNftOwnershipForMultipleNfts)([
+            {
+                nftAddress,
+                tokenId,
+                userAddress: ownerAddress,
+                standard: standard ?? null,
+            },
+        ], chainId, provider);
+        if (result.isOwned === undefined) {
+            throw new Error(`Unable to verify ownership. Possibly because the standard is not supported or the user's currently selected network does not match the chain of the asset in question.`);
         }
-        throw new Error(`Unable to verify ownership. Possibly because the standard is not supported or the user's currently selected network does not match the chain of the asset in question.`);
+        return result.isOwned;
     }
     /**
      * Verifies currently selected address owns entered NFT address/tokenId combo and
@@ -459,59 +462,10 @@ class NftController extends base_controller_1.BaseController {
             state.ignoredNfts = [];
         });
     }
-    /**
-     * Checks whether input NFT is still owned by the user
-     * And updates the isCurrentlyOwned value on the NFT object accordingly.
-     *
-     * @param nft - The NFT object to check and update.
-     * @param batch - A boolean indicating whether this method is being called as part of a batch or single update.
-     * @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
-     * @param accountParams - The userAddress and chainId to check ownership against
-     * @param accountParams.userAddress - the address passed through the confirmed transaction flow to ensure assets are stored to the correct account
-     * @returns the NFT with the updated isCurrentlyOwned value
-     */
-    async checkAndUpdateSingleNftOwnershipStatus(nft, batch, networkClientId, { userAddress } = {}) {
-        const addressToSearch = __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_getAddressOrSelectedAddress).call(this, userAddress);
-        const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
-        const { address, tokenId } = nft;
-        let isOwned = nft.isCurrentlyOwned;
-        try {
-            isOwned = await this.isNftOwner(addressToSearch, address, tokenId, networkClientId);
-        }
-        catch {
-            // ignore error
-            // this will only throw an error 'Unable to verify ownership' in which case
-            // we want to keep the current value of isCurrentlyOwned for this flow.
-        }
-        const updatedNft = {
-            ...nft,
-            isCurrentlyOwned: isOwned,
-        };
-        if (batch) {
-            return updatedNft;
-        }
-        // if this is not part of a batched update we update this one NFT in state
-        const { allNfts } = this.state;
-        const nfts = [...(allNfts[addressToSearch]?.[chainId] || [])];
-        const indexToUpdate = nfts.findIndex((item) => item.tokenId === tokenId &&
-            item.address.toLowerCase() === address.toLowerCase());
-        if (indexToUpdate !== -1) {
-            nfts[indexToUpdate] = updatedNft;
-            this.update((state) => {
-                state.allNfts[addressToSearch] = Object.assign({}, state.allNfts[addressToSearch], {
-                    [chainId]: nfts,
-                });
-            });
-            __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_updateNestedNftState).call(this, nfts, ALL_NFTS_STATE_KEY, {
-                userAddress: addressToSearch,
-                chainId,
-            });
-        }
-        return updatedNft;
-    }
     /**
      * Checks whether NFTs associated with current selectedAddress/chainId combination are still owned by the user
      * And updates the isCurrentlyOwned value on each accordingly.
+     * Uses Multicall3 to batch all ownership checks into a single RPC request when available.
      *
      * @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
      * @param options - an object of arguments
@@ -519,14 +473,30 @@ class NftController extends base_controller_1.BaseController {
      */
     async checkAndUpdateAllNftsOwnershipStatus(networkClientId, { userAddress, } = {}) {
         const addressToSearch = __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_getAddressOrSelectedAddress).call(this, userAddress);
-        const { configuration: { chainId }, } = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
+        const client = this.messenger.call('NetworkController:getNetworkClientById', networkClientId);
+        const { chainId } = client.configuration;
         const { allNfts } = this.state;
         const nfts = allNfts[addressToSearch]?.[chainId] || [];
-        const updatedNfts = await Promise.all(nfts.map(async (nft) => {
-            return ((await this.checkAndUpdateSingleNftOwnershipStatus(nft, true, networkClientId, {
-                userAddress,
-            })) ?? nft);
-        }));
+        if (nfts.length === 0) {
+            return;
+        }
+        const provider = new providers_1.Web3Provider(client.provider);
+        let ownershipResults;
+        try {
+            ownershipResults = await (0, multicall_1.getNftOwnershipForMultipleNfts)(nfts.map((nft) => ({
+                nftAddress: nft.address,
+                tokenId: nft.tokenId,
+                userAddress: addressToSearch,
+                standard: nft.standard,
+            })), chainId, provider);
+        }
+        catch {
+            return;
+        }
+        const updatedNfts = nfts.filter((_nft, index) => {
+            const { isOwned } = ownershipResults[index];
+            return isOwned !== false;
+        });
         __classPrivateFieldGet(this, _NftController_instances, "m", _NftController_updateNestedNftState).call(this, updatedNfts, ALL_NFTS_STATE_KEY, {
             userAddress: addressToSearch,
             chainId,
@@ -1161,7 +1131,7 @@ async function _NftController_addNftContracts(userAddress, contracts) {
     }
     // Check if the user owns the suggested NFT
     try {
-        const isOwner = await this.isNftOwner(userAddress, contractAddress, tokenId, networkClientId);
+        const isOwner = await this.isNftOwner(userAddress, contractAddress, tokenId, networkClientId, { standard: type });
         if (!isOwner) {
             throw rpc_errors_1.rpcErrors.invalidInput('Suggested NFT is not owned by the selected account');
         }