@metamask/assets-controllers 13.0.0 → 15.0.0

package/dist/NftController.js

@@ -43,13 +43,14 @@ class NftController extends base_controller_1.BaseController {
      * @param options.getERC721OwnerOf - Get the owner of a ERC-721 NFT.
      * @param options.getERC1155BalanceOf - Gets balance of a ERC-1155 NFT.
      * @param options.getERC1155TokenURI - Gets the URI of the ERC1155 token at the given address, with the given ID.
+     * @param options.getNetworkClientById - Gets the network client for the given networkClientId.
      * @param options.onNftAdded - Callback that is called when an NFT is added. Currently used pass data
      * for tracking the NFT added event.
      * @param options.messenger - The controller messenger.
      * @param config - Initial options used to configure this controller.
      * @param state - Initial state to set on this controller.
      */
-    constructor({ chainId: initialChainId, onPreferencesStateChange, onNetworkStateChange, getERC721AssetName, getERC721AssetSymbol, getERC721TokenURI, getERC721OwnerOf, getERC1155BalanceOf, getERC1155TokenURI, onNftAdded, messenger, }, config, state) {
+    constructor({ chainId: initialChainId, onPreferencesStateChange, onNetworkStateChange, getERC721AssetName, getERC721AssetSymbol, getERC721TokenURI, getERC721OwnerOf, getERC1155BalanceOf, getERC1155TokenURI, getNetworkClientById, onNftAdded, messenger, }, config, state) {
         super(config, state);
         this.mutex = new async_mutex_1.Mutex();
         /**
@@ -80,6 +81,7 @@ class NftController extends base_controller_1.BaseController {
         this.getERC721OwnerOf = getERC721OwnerOf;
         this.getERC1155BalanceOf = getERC1155BalanceOf;
         this.getERC1155TokenURI = getERC1155TokenURI;
+        this.getNetworkClientById = getNetworkClientById;
         this.onNftAdded = onNftAdded;
         this.messagingSystem = messenger;
         onPreferencesStateChange(({ selectedAddress, ipfsGateway, openSeaEnabled, isIpfsGatewayEnabled, }) => {
@@ -131,6 +133,7 @@ class NftController extends base_controller_1.BaseController {
      */
     getNftInformationFromApi(contractAddress, tokenId) {
         return __awaiter(this, void 0, void 0, function* () {
+            // TODO Parameterize this by chainId for non-mainnet token detection
             // Attempt to fetch the data with the proxy
             const nftInformation = yield (0, controller_utils_1.fetchWithErrorHandling)({
                 url: this.getNftApi({
@@ -162,12 +165,13 @@ class NftController extends base_controller_1.BaseController {
      *
      * @param contractAddress - Hex address of the NFT contract.
      * @param tokenId - The NFT identifier.
+     * @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
      * @returns Promise resolving to the current NFT name and image.
      */
-    getNftInformationFromTokenURI(contractAddress, tokenId) {
+    getNftInformationFromTokenURI(contractAddress, tokenId, networkClientId) {
         return __awaiter(this, void 0, void 0, function* () {
             const { ipfsGateway, useIPFSSubdomains, isIpfsGatewayEnabled } = this.config;
-            const result = yield this.getNftURIAndStandard(contractAddress, tokenId);
+            const result = yield this.getNftURIAndStandard(contractAddress, tokenId, networkClientId);
             let tokenURI = result[0];
             const standard = result[1];
             const hasIpfsTokenURI = tokenURI.startsWith('ipfs://');
@@ -216,13 +220,14 @@ class NftController extends base_controller_1.BaseController {
      *
      * @param contractAddress - 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.
      * @returns Promise resolving NFT uri and token standard.
      */
-    getNftURIAndStandard(contractAddress, tokenId) {
+    getNftURIAndStandard(contractAddress, tokenId, networkClientId) {
         return __awaiter(this, void 0, void 0, function* () {
             // try ERC721 uri
             try {
-                const uri = yield this.getERC721TokenURI(contractAddress, tokenId);
+                const uri = yield this.getERC721TokenURI(contractAddress, tokenId, networkClientId);
                 return [uri, controller_utils_1.ERC721];
             }
             catch (_a) {
@@ -230,7 +235,7 @@ class NftController extends base_controller_1.BaseController {
             }
             // try ERC1155 uri
             try {
-                const tokenURI = yield this.getERC1155TokenURI(contractAddress, tokenId);
+                const tokenURI = yield this.getERC1155TokenURI(contractAddress, tokenId, networkClientId);
                 /**
                  * According to EIP1155 the URI value allows for ID substitution
                  * in case the string `{id}` exists.
@@ -255,16 +260,23 @@ class NftController extends base_controller_1.BaseController {
      *
      * @param contractAddress - Hex address of the NFT contract.
      * @param tokenId - The NFT identifier.
+     * @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
      * @returns Promise resolving to the current NFT name and image.
      */
-    getNftInformation(contractAddress, tokenId) {
+    getNftInformation(contractAddress, tokenId, networkClientId) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         return __awaiter(this, void 0, void 0, function* () {
+            let { chainId } = this.config;
+            if (networkClientId) {
+                chainId =
+                    this.getNetworkClientById(networkClientId).configuration.chainId;
+            }
             const blockchainMetadata = yield (0, controller_utils_1.safelyExecute)(() => __awaiter(this, void 0, void 0, function* () {
-                return yield this.getNftInformationFromTokenURI(contractAddress, tokenId);
+                return yield this.getNftInformationFromTokenURI(contractAddress, tokenId, networkClientId);
             }));
             let openSeaMetadata;
-            if (this.config.openSeaEnabled) {
+            // currently we only need to enter this block if we are on mainnet
+            if (this.config.openSeaEnabled && chainId === '0x1') {
                 openSeaMetadata = yield (0, controller_utils_1.safelyExecute)(() => __awaiter(this, void 0, void 0, function* () {
                     return yield this.getNftInformationFromApi(contractAddress, tokenId);
                 }));
@@ -312,12 +324,13 @@ class NftController extends base_controller_1.BaseController {
      * Request NFT contract information from the contract itself.
      *
      * @param contractAddress - Hex address of the NFT contract.
+     * @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
      * @returns Promise resolving to the current NFT name and image.
      */
-    getNftContractInformationFromContract(contractAddress) {
+    getNftContractInformationFromContract(contractAddress, networkClientId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const name = yield this.getERC721AssetName(contractAddress);
-            const symbol = yield this.getERC721AssetSymbol(contractAddress);
+            const name = yield this.getERC721AssetName(contractAddress, networkClientId);
+            const symbol = yield this.getERC721AssetSymbol(contractAddress, networkClientId);
             return {
                 collection: { name },
                 symbol,
@@ -329,15 +342,21 @@ class NftController extends base_controller_1.BaseController {
      * Request NFT contract information from OpenSea API.
      *
      * @param contractAddress - Hex address of the NFT contract.
+     * @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
      * @returns Promise resolving to the NFT contract name, image and description.
      */
-    getNftContractInformation(contractAddress) {
+    getNftContractInformation(contractAddress, networkClientId) {
         return __awaiter(this, void 0, void 0, function* () {
             const blockchainContractData = yield (0, controller_utils_1.safelyExecute)(() => __awaiter(this, void 0, void 0, function* () {
-                return yield this.getNftContractInformationFromContract(contractAddress);
+                return yield this.getNftContractInformationFromContract(contractAddress, networkClientId);
             }));
+            const { chainId } = this.config;
+            const getCurrentChainId = this.getCorrectChainId({
+                chainId,
+                networkClientId,
+            });
             let openSeaContractData;
-            if (this.config.openSeaEnabled) {
+            if (this.config.openSeaEnabled && getCurrentChainId === '0x1') {
                 openSeaContractData = yield (0, controller_utils_1.safelyExecute)(() => __awaiter(this, void 0, void 0, function* () {
                     return yield this.getNftContractInformationFromApi(contractAddress);
                 }));
@@ -362,39 +381,31 @@ class NftController extends base_controller_1.BaseController {
     /**
      * Adds an individual NFT to the stored NFT list.
      *
-     * @param address - Hex address of the NFT contract.
+     * @param tokenAddress - Hex address of the NFT contract.
      * @param tokenId - The NFT identifier.
      * @param nftMetadata - NFT optional information (name, image and description).
      * @param nftContract - An object containing contract data of the NFT being added.
-     * @param accountParams - The chain ID and address of network and account to which the nftContract should be added.
+     * @param chainId - The chainId of the network where the NFT is being added.
+     * @param userAddress - The address of the account where the NFT is being added.
      * @param source - Whether the NFT was detected, added manually or suggested by a dapp.
      * @returns Promise resolving to the current NFT list.
      */
-    addIndividualNft(address, tokenId, nftMetadata, nftContract, accountParams, source = constants_1.Source.Custom) {
+    addIndividualNft(tokenAddress, tokenId, nftMetadata, nftContract, chainId, userAddress, source) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             // TODO: Remove unused return
             const releaseLock = yield this.mutex.acquire();
             try {
-                address = (0, controller_utils_1.toChecksumHexAddress)(address);
+                tokenAddress = (0, controller_utils_1.toChecksumHexAddress)(tokenAddress);
                 const { allNfts } = this.state;
-                let chainId, selectedAddress;
-                if (accountParams) {
-                    chainId = accountParams.chainId;
-                    selectedAddress = accountParams.userAddress;
-                }
-                else {
-                    chainId = this.config.chainId;
-                    selectedAddress = this.config.selectedAddress;
-                }
-                const nfts = ((_a = allNfts[selectedAddress]) === null || _a === void 0 ? void 0 : _a[chainId]) || [];
-                const existingEntry = nfts.find((nft) => nft.address.toLowerCase() === address.toLowerCase() &&
+                const nfts = ((_a = allNfts[userAddress]) === null || _a === void 0 ? void 0 : _a[chainId]) || [];
+                const existingEntry = nfts.find((nft) => nft.address.toLowerCase() === tokenAddress.toLowerCase() &&
                     nft.tokenId === tokenId);
                 if (existingEntry) {
                     const differentMetadata = (0, assetsUtil_1.compareNftMetadata)(nftMetadata, existingEntry);
                     if (differentMetadata || !existingEntry.isCurrentlyOwned) {
                         // TODO: Switch to indexToUpdate
-                        const indexToRemove = nfts.findIndex((nft) => nft.address.toLowerCase() === address.toLowerCase() &&
+                        const indexToRemove = nfts.findIndex((nft) => nft.address.toLowerCase() === tokenAddress.toLowerCase() &&
                             nft.tokenId === tokenId);
                         /* istanbul ignore next */
                         if (indexToRemove !== -1) {
@@ -405,16 +416,15 @@ class NftController extends base_controller_1.BaseController {
                         return nfts;
                     }
                 }
-                const newEntry = Object.assign({ address,
-                    tokenId, favorite: (existingEntry === null || existingEntry === void 0 ? void 0 : existingEntry.favorite) || false, isCurrentlyOwned: true }, nftMetadata);
+                const newEntry = Object.assign({ address: tokenAddress, tokenId, favorite: (existingEntry === null || existingEntry === void 0 ? void 0 : existingEntry.favorite) || false, isCurrentlyOwned: true }, nftMetadata);
                 const newNfts = [...nfts, newEntry];
                 this.updateNestedNftState(newNfts, ALL_NFTS_STATE_KEY, {
                     chainId,
-                    userAddress: selectedAddress,
+                    userAddress,
                 });
                 if (this.onNftAdded) {
                     this.onNftAdded({
-                        address,
+                        address: tokenAddress,
                         symbol: nftContract.symbol,
                         tokenId: tokenId.toString(),
                         standard: nftMetadata.standard,
@@ -431,33 +441,34 @@ class NftController extends base_controller_1.BaseController {
     /**
      * Adds an NFT contract to the stored NFT contracts list.
      *
-     * @param address - Hex address of the NFT contract.
-     * @param accountParams - The chain ID and address of network and account to which the nftContract should be added.
-     * @param source - Whether the NFT was detected, added manually or suggested by a dapp.
+     * @param options - options.
+     * @param options.tokenAddress - Hex address of the NFT contract.
+     * @param options.chainId - The chainId of the network where the NFT is being added.
+     * @param options.userAddress - The address of the account where the NFT is being added.
+     * @param options.networkClientId - The networkClientId that can be used to identify the network client to use for this request.
+     * @param options.source - Whether the NFT was detected, added manually or suggested by a dapp.
      * @returns Promise resolving to the current NFT contracts list.
      */
-    addNftContract(address, accountParams, source) {
+    addNftContract({ tokenAddress, chainId, userAddress, networkClientId, source, }) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const releaseLock = yield this.mutex.acquire();
             try {
-                address = (0, controller_utils_1.toChecksumHexAddress)(address);
+                tokenAddress = (0, controller_utils_1.toChecksumHexAddress)(tokenAddress);
                 const { allNftContracts } = this.state;
-                let chainId, selectedAddress;
-                if (accountParams) {
-                    chainId = accountParams.chainId;
-                    selectedAddress = accountParams.userAddress;
-                }
-                else {
-                    chainId = this.config.chainId;
-                    selectedAddress = this.config.selectedAddress;
-                }
-                const nftContracts = ((_a = allNftContracts[selectedAddress]) === null || _a === void 0 ? void 0 : _a[chainId]) || [];
-                const existingEntry = nftContracts.find((nftContract) => nftContract.address.toLowerCase() === address.toLowerCase());
+                const currentChainId = this.getCorrectChainId({
+                    chainId,
+                    networkClientId,
+                });
+                const selectedAddress = userAddress !== null && userAddress !== void 0 ? userAddress : this.config.selectedAddress;
+                const nftContracts = ((_a = allNftContracts[selectedAddress]) === null || _a === void 0 ? void 0 : _a[currentChainId]) || [];
+                const existingEntry = nftContracts.find((nftContract) => nftContract.address.toLowerCase() === tokenAddress.toLowerCase());
                 if (existingEntry) {
                     return nftContracts;
                 }
-                const contractInformation = yield this.getNftContractInformation(address);
+                // this doesn't work currently for detection if the user switches networks while the detection is processing
+                // will be fixed once detection uses networkClientIds
+                const contractInformation = yield this.getNftContractInformation(tokenAddress, networkClientId);
                 const { asset_contract_type, created_date, schema_name, symbol, total_supply, description, external_link, collection: { name, image_url }, } = contractInformation;
                 // If the nft is auto-detected we want some valid metadata to be present
                 if (source === constants_1.Source.Detected &&
@@ -474,11 +485,11 @@ class NftController extends base_controller_1.BaseController {
                     return nftContracts;
                 }
                 /* istanbul ignore next */
-                const newEntry = Object.assign({}, { address }, description && { description }, name && { name }, image_url && { logo: image_url }, symbol && { symbol }, total_supply !== null &&
+                const newEntry = Object.assign({}, { address: tokenAddress }, description && { description }, name && { name }, image_url && { logo: image_url }, symbol && { symbol }, total_supply !== null &&
                     typeof total_supply !== 'undefined' && { totalSupply: total_supply }, asset_contract_type && { assetContractType: asset_contract_type }, created_date && { createdDate: created_date }, schema_name && { schemaName: schema_name }, external_link && { externalLink: external_link });
                 const newNftContracts = [...nftContracts, newEntry];
                 this.updateNestedNftState(newNftContracts, ALL_NFTS_CONTRACTS_STATE_KEY, {
-                    chainId,
+                    chainId: currentChainId,
                     userAddress: selectedAddress,
                 });
                 return newNftContracts;
@@ -547,7 +558,7 @@ class NftController extends base_controller_1.BaseController {
         this.updateNestedNftState(newNftContracts, ALL_NFTS_CONTRACTS_STATE_KEY);
         return newNftContracts;
     }
-    validateWatchNft(asset, type, accountAddress) {
+    validateWatchNft(asset, type, userAddress) {
         return __awaiter(this, void 0, void 0, function* () {
             const { address: contractAddress, tokenId } = asset;
             // Validate parameters
@@ -568,7 +579,7 @@ class NftController extends base_controller_1.BaseController {
             }
             // Check if the user owns the suggested NFT
             try {
-                const isOwner = yield this.isNftOwner(accountAddress, contractAddress, tokenId);
+                const isOwner = yield this.isNftOwner(userAddress, contractAddress, tokenId);
                 if (!isOwner) {
                     throw rpc_errors_1.rpcErrors.invalidInput('Suggested NFT is not owned by the selected account');
                 }
@@ -579,6 +590,17 @@ class NftController extends base_controller_1.BaseController {
             }
         });
     }
+    // temporary method to get the correct chainId until we remove chainId from the config & the chainId arg from the detection logic
+    // Just a helper method to prefer the networkClient chainId first then the chainId argument and then finally the config chainId
+    getCorrectChainId({ chainId, networkClientId, }) {
+        if (networkClientId) {
+            return this.getNetworkClientById(networkClientId).configuration.chainId;
+        }
+        else if (chainId) {
+            return chainId;
+        }
+        return this.config.chainId;
+    }
     /**
      * Adds a new suggestedAsset to state. Parameters will be validated according to
      * asset type being watched. A `<suggestedNftMeta.id>:pending` hub event will be emitted once added.
@@ -588,13 +610,14 @@ class NftController extends base_controller_1.BaseController {
      * @param asset.tokenId - The ID of the asset.
      * @param type - The asset type.
      * @param origin - Domain origin to register the asset from.
+     * @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
      * @returns Object containing a Promise resolving to the suggestedAsset address if accepted.
      */
-    watchNft(asset, type, origin) {
+    watchNft(asset, type, origin, networkClientId) {
         return __awaiter(this, void 0, void 0, function* () {
             const { selectedAddress, chainId } = this.config;
             yield this.validateWatchNft(asset, type, selectedAddress);
-            const nftMetadata = yield this.getNftInformation(asset.address, asset.tokenId);
+            const nftMetadata = yield this.getNftInformation(asset.address, asset.tokenId, networkClientId);
             if (nftMetadata.standard && nftMetadata.standard !== type) {
                 throw rpc_errors_1.rpcErrors.invalidInput(`Suggested NFT of type ${nftMetadata.standard} does not match received type ${type}`);
             }
@@ -610,14 +633,17 @@ class NftController extends base_controller_1.BaseController {
             const { address, tokenId } = asset;
             const { name, standard, description, image } = nftMetadata;
             yield this.addNft(address, tokenId, {
-                name: name !== null && name !== void 0 ? name : null,
-                description: description !== null && description !== void 0 ? description : null,
-                image: image !== null && image !== void 0 ? image : null,
-                standard: standard !== null && standard !== void 0 ? standard : null,
-            }, {
+                nftMetadata: {
+                    name: name !== null && name !== void 0 ? name : null,
+                    description: description !== null && description !== void 0 ? description : null,
+                    image: image !== null && image !== void 0 ? image : null,
+                    standard: standard !== null && standard !== void 0 ? standard : null,
+                },
                 chainId,
                 userAddress: selectedAddress,
-            }, constants_1.Source.Dapp);
+                source: constants_1.Source.Dapp,
+                networkClientId,
+            });
         });
     }
     /**
@@ -633,14 +659,15 @@ class NftController extends base_controller_1.BaseController {
      *
      * @param ownerAddress - User public address.
      * @param nftAddress - NFT contract address.
-     * @param nftId - NFT token ID.
+     * @param tokenId - NFT token ID.
+     * @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
      * @returns Promise resolving the NFT ownership.
      */
-    isNftOwner(ownerAddress, nftAddress, nftId) {
+    isNftOwner(ownerAddress, nftAddress, tokenId, networkClientId) {
         return __awaiter(this, void 0, void 0, function* () {
             // Checks the ownership for ERC-721.
             try {
-                const owner = yield this.getERC721OwnerOf(nftAddress, nftId);
+                const owner = yield this.getERC721OwnerOf(nftAddress, tokenId, networkClientId);
                 return ownerAddress.toLowerCase() === owner.toLowerCase();
                 // eslint-disable-next-line no-empty
             }
@@ -649,7 +676,7 @@ class NftController extends base_controller_1.BaseController {
             }
             // Checks the ownership for ERC-1155.
             try {
-                const balance = yield this.getERC1155BalanceOf(ownerAddress, nftAddress, nftId);
+                const balance = yield this.getERC1155BalanceOf(ownerAddress, nftAddress, tokenId, networkClientId);
                 return !balance.isZero();
                 // eslint-disable-next-line no-empty
             }
@@ -665,37 +692,52 @@ class NftController extends base_controller_1.BaseController {
      *
      * @param address - Hex address of the NFT contract.
      * @param tokenId - The NFT identifier.
+     * @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
+     * @param source - Whether the NFT was detected, added manually or suggested by a dapp.
      */
-    addNftVerifyOwnership(address, tokenId) {
+    addNftVerifyOwnership(address, tokenId, networkClientId, source) {
         return __awaiter(this, void 0, void 0, function* () {
             const { selectedAddress } = this.config;
-            if (!(yield this.isNftOwner(selectedAddress, address, tokenId))) {
+            if (!(yield this.isNftOwner(selectedAddress, address, tokenId, networkClientId))) {
                 throw new Error('This NFT is not owned by the user');
             }
-            yield this.addNft(address, tokenId);
+            yield this.addNft(address, tokenId, { networkClientId, source });
         });
     }
     /**
      * Adds an NFT and respective NFT contract to the stored NFT and NFT contracts lists.
      *
-     * @param address - Hex address of the NFT contract.
+     * @param tokenAddress - Hex address of the NFT contract.
      * @param tokenId - The NFT identifier.
-     * @param nftMetadata - NFT optional metadata.
-     * @param accountParams - The chain ID and address of network and account to which the nftContract should be added.
-     * @param source - Whether the NFT was detected, added manually or suggested by a dapp.
+     * @param options - an object of arguments
+     * @param options.nftMetadata - NFT optional metadata.
+     * @param options.chainId - The chain ID of the current network.
+     * @param options.userAddress - The address of the current user.
+     * @param options.source - Whether the NFT was detected, added manually or suggested by a dapp.
+     * @param options.networkClientId - The networkClientId that can be used to identify the network client to use for this request.
      * @returns Promise resolving to the current NFT list.
      */
-    addNft(address, tokenId, nftMetadata, accountParams, source = constants_1.Source.Custom) {
+    addNft(tokenAddress, tokenId, { nftMetadata, chainId, // TODO remove and replace chainId arg with fetch chainId using getNetworkClientById(networkClientId).configuration.chainId once polling refactor is complete
+    userAddress, source = constants_1.Source.Custom, networkClientId, } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            address = (0, controller_utils_1.toChecksumHexAddress)(address);
-            const newNftContracts = yield this.addNftContract(address, accountParams, source);
+            tokenAddress = (0, controller_utils_1.toChecksumHexAddress)(tokenAddress);
+            const currentChainId = this.getCorrectChainId({ chainId, networkClientId });
+            const selectedAddress = userAddress !== null && userAddress !== void 0 ? userAddress : this.config.selectedAddress;
+            const newNftContracts = yield this.addNftContract({
+                tokenAddress,
+                chainId: currentChainId,
+                userAddress: selectedAddress,
+                networkClientId,
+                source,
+            });
             nftMetadata =
-                nftMetadata || (yield this.getNftInformation(address, tokenId));
+                nftMetadata ||
+                    (yield this.getNftInformation(tokenAddress, tokenId, networkClientId));
             // If NFT contract was not added, do not add individual NFT
-            const nftContract = newNftContracts.find((contract) => contract.address.toLowerCase() === address.toLowerCase());
+            const nftContract = newNftContracts.find((contract) => contract.address.toLowerCase() === tokenAddress.toLowerCase());
             // If NFT contract information, add individual NFT
             if (nftContract) {
-                yield this.addIndividualNft(address, tokenId, nftMetadata, nftContract, accountParams, source);
+                yield this.addIndividualNft(tokenAddress, tokenId, nftMetadata, nftContract, currentChainId, selectedAddress, source);
             }
         });
     }