@metamask/assets-controllers 37.0.0 → 38.0.1

package/dist/Standards/NftStandards/ERC721/ERC721Standard.cjs

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERC721Standard = void 0;
+const contracts_1 = require("@ethersproject/contracts");
+const controller_utils_1 = require("@metamask/controller-utils");
+const metamask_eth_abis_1 = require("@metamask/metamask-eth-abis");
+const assetsUtil_1 = require("../../../assetsUtil.cjs");
+class ERC721Standard {
+    constructor(provider) {
+        /**
+         * Query if contract implements ERC721Metadata interface.
+         *
+         * @param address - ERC721 asset contract address.
+         * @returns Promise resolving to whether the contract implements ERC721Metadata interface.
+         */
+        this.contractSupportsMetadataInterface = async (address) => {
+            return this.contractSupportsInterface(address, controller_utils_1.ERC721_METADATA_INTERFACE_ID);
+        };
+        /**
+         * Query if contract implements ERC721Enumerable interface.
+         *
+         * @param address - ERC721 asset contract address.
+         * @returns Promise resolving to whether the contract implements ERC721Enumerable interface.
+         */
+        this.contractSupportsEnumerableInterface = async (address) => {
+            return this.contractSupportsInterface(address, controller_utils_1.ERC721_ENUMERABLE_INTERFACE_ID);
+        };
+        /**
+         * Query if contract implements ERC721 interface.
+         *
+         * @param address - ERC721 asset contract address.
+         * @returns Promise resolving to whether the contract implements ERC721 interface.
+         */
+        this.contractSupportsBase721Interface = async (address) => {
+            return this.contractSupportsInterface(address, controller_utils_1.ERC721_INTERFACE_ID);
+        };
+        /**
+         * Enumerate assets assigned to an owner.
+         *
+         * @param address - ERC721 asset contract address.
+         * @param selectedAddress - Current account public address.
+         * @param index - An NFT counter less than `balanceOf(selectedAddress)`.
+         * @returns Promise resolving to token identifier for the 'index'th asset assigned to 'selectedAddress'.
+         */
+        this.getNftTokenId = async (address, selectedAddress, index) => {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC721, this.provider);
+            return contract.tokenOfOwnerByIndex(selectedAddress, index);
+        };
+        /**
+         * Query for tokenURI for a given asset.
+         *
+         * @param address - ERC721 asset contract address.
+         * @param tokenId - ERC721 asset identifier.
+         * @returns Promise resolving to the 'tokenURI'.
+         */
+        this.getTokenURI = async (address, tokenId) => {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC721, this.provider);
+            const supportsMetadata = await this.contractSupportsMetadataInterface(address);
+            if (!supportsMetadata) {
+                // Do not throw error here, supporting Metadata interface is optional even though majority of ERC721 nfts do support it.
+                // This change is made because of instances of NFTs that are ERC404( mixed ERC20 / ERC721 implementation).
+                // As of today, ERC404 is unofficial but some people use it, the contract does not support Metadata interface, but it has the tokenURI() fct.
+                console.error('Contract does not support ERC721 metadata interface.');
+            }
+            return contract.tokenURI(tokenId);
+        };
+        /**
+         * Query for name for a given asset.
+         *
+         * @param address - ERC721 asset contract address.
+         * @returns Promise resolving to the 'name'.
+         */
+        this.getAssetName = async (address) => {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC721, this.provider);
+            return contract.name();
+        };
+        /**
+         * Query for symbol for a given asset.
+         *
+         * @param address - ERC721 asset contract address.
+         * @returns Promise resolving to the 'symbol'.
+         */
+        this.getAssetSymbol = async (address) => {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC721, this.provider);
+            return contract.symbol();
+        };
+        /**
+         * Query if a contract implements an interface.
+         *
+         * @param address - Asset contract address.
+         * @param interfaceId - Interface identifier.
+         * @returns Promise resolving to whether the contract implements `interfaceID`.
+         */
+        this.contractSupportsInterface = async (address, interfaceId) => {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC721, this.provider);
+            try {
+                return await contract.supportsInterface(interfaceId);
+            }
+            catch (err) {
+                // Mirror previous implementation
+                if (err instanceof Error &&
+                    err.message.includes('call revert exception')) {
+                    return false;
+                }
+                throw err;
+            }
+        };
+        /**
+         * Query if a contract implements an interface.
+         *
+         * @param address - Asset contract address.
+         * @param ipfsGateway - The user's preferred IPFS gateway.
+         * @param tokenId - tokenId of a given token in the contract.
+         * @returns Promise resolving an object containing the standard, tokenURI, symbol and name of the given contract/tokenId pair.
+         */
+        this.getDetails = async (address, ipfsGateway, tokenId) => {
+            const isERC721 = await this.contractSupportsBase721Interface(address);
+            if (!isERC721) {
+                throw new Error("This isn't a valid ERC721 contract");
+            }
+            const [symbol, name, tokenURI] = await Promise.all([
+                (0, controller_utils_1.safelyExecute)(() => this.getAssetSymbol(address)),
+                (0, controller_utils_1.safelyExecute)(() => this.getAssetName(address)),
+                tokenId
+                    ? (0, controller_utils_1.safelyExecute)(() => this.getTokenURI(address, tokenId).then((uri) => uri.startsWith('ipfs://')
+                        ? (0, assetsUtil_1.getFormattedIpfsUrl)(ipfsGateway, uri, true)
+                        : uri))
+                    : undefined,
+            ]);
+            let image;
+            if (tokenURI) {
+                try {
+                    const response = await (0, controller_utils_1.timeoutFetch)(tokenURI);
+                    const object = await response.json();
+                    image = object?.image;
+                    if (image?.startsWith('ipfs://')) {
+                        image = (0, assetsUtil_1.getFormattedIpfsUrl)(ipfsGateway, image, true);
+                    }
+                }
+                catch {
+                    // ignore
+                }
+            }
+            return {
+                standard: controller_utils_1.ERC721,
+                tokenURI,
+                symbol,
+                name,
+                image,
+            };
+        };
+        this.provider = provider;
+    }
+    /**
+     * Query for owner for a given ERC721 asset.
+     *
+     * @param address - ERC721 asset contract address.
+     * @param tokenId - ERC721 asset identifier.
+     * @returns Promise resolving to the owner address.
+     */
+    async getOwnerOf(address, tokenId) {
+        const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC721, this.provider);
+        return contract.ownerOf(tokenId);
+    }
+}
+exports.ERC721Standard = ERC721Standard;
+//# sourceMappingURL=ERC721Standard.cjs.map

package/dist/Standards/NftStandards/ERC721/ERC721Standard.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ERC721Standard.cjs","sourceRoot":"","sources":["../../../../src/Standards/NftStandards/ERC721/ERC721Standard.ts"],"names":[],"mappings":";;;AAAA,wDAAoD;AAEpD,iEAOoC;AACpC,mEAAwD;AAExD,wDAA0D;AAE1D,MAAa,cAAc;IAGzB,YAAY,QAAsB;QAIlC;;;;;WAKG;QACH,sCAAiC,GAAG,KAAK,EACvC,OAAe,EACG,EAAE;YACpB,OAAO,IAAI,CAAC,yBAAyB,CACnC,OAAO,EACP,+CAA4B,CAC7B,CAAC;QACJ,CAAC,CAAC;QAEF;;;;;WAKG;QACH,wCAAmC,GAAG,KAAK,EACzC,OAAe,EACG,EAAE;YACpB,OAAO,IAAI,CAAC,yBAAyB,CACnC,OAAO,EACP,iDAA8B,CAC/B,CAAC;QACJ,CAAC,CAAC;QAEF;;;;;WAKG;QACH,qCAAgC,GAAG,KAAK,EACtC,OAAe,EACG,EAAE;YACpB,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,sCAAmB,CAAC,CAAC;QACtE,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,kBAAa,GAAG,KAAK,EACnB,OAAe,EACf,eAAuB,EACvB,KAAa,EACI,EAAE;YACnB,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,6BAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,OAAO,QAAQ,CAAC,mBAAmB,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC,CAAC;QAEF;;;;;;WAMG;QACH,gBAAW,GAAG,KAAK,EAAE,OAAe,EAAE,OAAe,EAAmB,EAAE;YACxE,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,6BAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,iCAAiC,CACnE,OAAO,CACR,CAAC;YACF,IAAI,CAAC,gBAAgB,EAAE;gBACrB,wHAAwH;gBACxH,0GAA0G;gBAC1G,6IAA6I;gBAC7I,OAAO,CAAC,KAAK,CAAC,sDAAsD,CAAC,CAAC;aACvE;YACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QAEF;;;;;WAKG;QACH,iBAAY,GAAG,KAAK,EAAE,OAAe,EAAmB,EAAE;YACxD,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,6BAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;QACzB,CAAC,CAAC;QAEF;;;;;WAKG;QACH,mBAAc,GAAG,KAAK,EAAE,OAAe,EAAmB,EAAE;YAC1D,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,6BAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC3B,CAAC,CAAC;QAcF;;;;;;WAMG;QACc,8BAAyB,GAAG,KAAK,EAChD,OAAe,EACf,WAAmB,EACD,EAAE;YACpB,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,6BAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,IAAI;gBACF,OAAO,MAAM,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;aACtD;YAAC,OAAO,GAAG,EAAE;gBACZ,iCAAiC;gBACjC,IACE,GAAG,YAAY,KAAK;oBACpB,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAC7C;oBACA,OAAO,KAAK,CAAC;iBACd;gBACD,MAAM,GAAG,CAAC;aACX;QACH,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,eAAU,GAAG,KAAK,EAChB,OAAe,EACf,WAAmB,EACnB,OAAgB,EAOf,EAAE;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC;YACtE,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACvD;YAED,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACjD,IAAA,gCAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBACjD,IAAA,gCAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAC/C,OAAO;oBACL,CAAC,CAAC,IAAA,gCAAa,EAAC,GAAG,EAAE,CACjB,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAC9C,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC;wBACvB,CAAC,CAAC,IAAA,gCAAmB,EAAC,WAAW,EAAE,GAAG,EAAE,IAAI,CAAC;wBAC7C,CAAC,CAAC,GAAG,CACR,CACF;oBACH,CAAC,CAAC,SAAS;aACd,CAAC,CAAC;YAEH,IAAI,KAAK,CAAC;YACV,IAAI,QAAQ,EAAE;gBACZ,IAAI;oBACF,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAY,EAAC,QAAQ,CAAC,CAAC;oBAC9C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;oBACrC,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC;oBACtB,IAAI,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE;wBAChC,KAAK,GAAG,IAAA,gCAAmB,EAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;qBACvD;iBACF;gBAAC,MAAM;oBACN,SAAS;iBACV;aACF;YAED,OAAO;gBACL,QAAQ,EAAE,yBAAM;gBAChB,QAAQ;gBACR,MAAM;gBACN,IAAI;gBACJ,KAAK;aACN,CAAC;QACJ,CAAC,CAAC;QA1MA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAwGD;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,OAAe;QAC/C,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,6BAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;CAwFF;AA/MD,wCA+MC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport type { Web3Provider } from '@ethersproject/providers';\nimport {\n  timeoutFetch,\n  ERC721_INTERFACE_ID,\n  ERC721_METADATA_INTERFACE_ID,\n  ERC721_ENUMERABLE_INTERFACE_ID,\n  ERC721,\n  safelyExecute,\n} from '@metamask/controller-utils';\nimport { abiERC721 } from '@metamask/metamask-eth-abis';\n\nimport { getFormattedIpfsUrl } from '../../../assetsUtil';\n\nexport class ERC721Standard {\n  private readonly provider: Web3Provider;\n\n  constructor(provider: Web3Provider) {\n    this.provider = provider;\n  }\n\n  /**\n   * Query if contract implements ERC721Metadata interface.\n   *\n   * @param address - ERC721 asset contract address.\n   * @returns Promise resolving to whether the contract implements ERC721Metadata interface.\n   */\n  contractSupportsMetadataInterface = async (\n    address: string,\n  ): Promise<boolean> => {\n    return this.contractSupportsInterface(\n      address,\n      ERC721_METADATA_INTERFACE_ID,\n    );\n  };\n\n  /**\n   * Query if contract implements ERC721Enumerable interface.\n   *\n   * @param address - ERC721 asset contract address.\n   * @returns Promise resolving to whether the contract implements ERC721Enumerable interface.\n   */\n  contractSupportsEnumerableInterface = async (\n    address: string,\n  ): Promise<boolean> => {\n    return this.contractSupportsInterface(\n      address,\n      ERC721_ENUMERABLE_INTERFACE_ID,\n    );\n  };\n\n  /**\n   * Query if contract implements ERC721 interface.\n   *\n   * @param address - ERC721 asset contract address.\n   * @returns Promise resolving to whether the contract implements ERC721 interface.\n   */\n  contractSupportsBase721Interface = async (\n    address: string,\n  ): Promise<boolean> => {\n    return this.contractSupportsInterface(address, ERC721_INTERFACE_ID);\n  };\n\n  /**\n   * Enumerate assets assigned to an owner.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param selectedAddress - Current account public address.\n   * @param index - An NFT counter less than `balanceOf(selectedAddress)`.\n   * @returns Promise resolving to token identifier for the 'index'th asset assigned to 'selectedAddress'.\n   */\n  getNftTokenId = async (\n    address: string,\n    selectedAddress: string,\n    index: number,\n  ): Promise<string> => {\n    const contract = new Contract(address, abiERC721, this.provider);\n    return contract.tokenOfOwnerByIndex(selectedAddress, index);\n  };\n\n  /**\n   * Query for tokenURI for a given asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param tokenId - ERC721 asset identifier.\n   * @returns Promise resolving to the 'tokenURI'.\n   */\n  getTokenURI = async (address: string, tokenId: string): Promise<string> => {\n    const contract = new Contract(address, abiERC721, this.provider);\n    const supportsMetadata = await this.contractSupportsMetadataInterface(\n      address,\n    );\n    if (!supportsMetadata) {\n      // Do not throw error here, supporting Metadata interface is optional even though majority of ERC721 nfts do support it.\n      // This change is made because of instances of NFTs that are ERC404( mixed ERC20 / ERC721 implementation).\n      // As of today, ERC404 is unofficial but some people use it, the contract does not support Metadata interface, but it has the tokenURI() fct.\n      console.error('Contract does not support ERC721 metadata interface.');\n    }\n    return contract.tokenURI(tokenId);\n  };\n\n  /**\n   * Query for name for a given asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @returns Promise resolving to the 'name'.\n   */\n  getAssetName = async (address: string): Promise<string> => {\n    const contract = new Contract(address, abiERC721, this.provider);\n    return contract.name();\n  };\n\n  /**\n   * Query for symbol for a given asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @returns Promise resolving to the 'symbol'.\n   */\n  getAssetSymbol = async (address: string): Promise<string> => {\n    const contract = new Contract(address, abiERC721, this.provider);\n    return contract.symbol();\n  };\n\n  /**\n   * Query for owner for a given ERC721 asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param tokenId - ERC721 asset identifier.\n   * @returns Promise resolving to the owner address.\n   */\n  async getOwnerOf(address: string, tokenId: string): Promise<string> {\n    const contract = new Contract(address, abiERC721, this.provider);\n    return contract.ownerOf(tokenId);\n  }\n\n  /**\n   * Query if a contract implements an interface.\n   *\n   * @param address - Asset contract address.\n   * @param interfaceId - Interface identifier.\n   * @returns Promise resolving to whether the contract implements `interfaceID`.\n   */\n  private readonly contractSupportsInterface = async (\n    address: string,\n    interfaceId: string,\n  ): Promise<boolean> => {\n    const contract = new Contract(address, abiERC721, this.provider);\n    try {\n      return await contract.supportsInterface(interfaceId);\n    } catch (err) {\n      // Mirror previous implementation\n      if (\n        err instanceof Error &&\n        err.message.includes('call revert exception')\n      ) {\n        return false;\n      }\n      throw err;\n    }\n  };\n\n  /**\n   * Query if a contract implements an interface.\n   *\n   * @param address - Asset contract address.\n   * @param ipfsGateway - The user's preferred IPFS gateway.\n   * @param tokenId - tokenId of a given token in the contract.\n   * @returns Promise resolving an object containing the standard, tokenURI, symbol and name of the given contract/tokenId pair.\n   */\n  getDetails = async (\n    address: string,\n    ipfsGateway: string,\n    tokenId?: string,\n  ): Promise<{\n    standard: string;\n    tokenURI: string | undefined;\n    symbol: string | undefined;\n    name: string | undefined;\n    image: string | undefined;\n  }> => {\n    const isERC721 = await this.contractSupportsBase721Interface(address);\n    if (!isERC721) {\n      throw new Error(\"This isn't a valid ERC721 contract\");\n    }\n\n    const [symbol, name, tokenURI] = await Promise.all([\n      safelyExecute(() => this.getAssetSymbol(address)),\n      safelyExecute(() => this.getAssetName(address)),\n      tokenId\n        ? safelyExecute(() =>\n            this.getTokenURI(address, tokenId).then((uri) =>\n              uri.startsWith('ipfs://')\n                ? getFormattedIpfsUrl(ipfsGateway, uri, true)\n                : uri,\n            ),\n          )\n        : undefined,\n    ]);\n\n    let image;\n    if (tokenURI) {\n      try {\n        const response = await timeoutFetch(tokenURI);\n        const object = await response.json();\n        image = object?.image;\n        if (image?.startsWith('ipfs://')) {\n          image = getFormattedIpfsUrl(ipfsGateway, image, true);\n        }\n      } catch {\n        // ignore\n      }\n    }\n\n    return {\n      standard: ERC721,\n      tokenURI,\n      symbol,\n      name,\n      image,\n    };\n  };\n}\n"]}

package/dist/{types/Standards/NftStandards/ERC721/ERC721Standard.d.ts → Standards/NftStandards/ERC721/ERC721Standard.d.cts}

@@ -1,4 +1,4 @@
-import type { Web3Provider } from '@ethersproject/providers';
+import type { Web3Provider } from "@ethersproject/providers";
 export declare class ERC721Standard {
     private readonly provider;
     constructor(provider: Web3Provider);
@@ -86,4 +86,4 @@ export declare class ERC721Standard {
         image: string | undefined;
     }>;
 }
-//# sourceMappingURL=ERC721Standard.d.ts.map
+//# sourceMappingURL=ERC721Standard.d.cts.map

package/dist/Standards/NftStandards/ERC721/ERC721Standard.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ERC721Standard.d.cts","sourceRoot":"","sources":["../../../../src/Standards/NftStandards/ERC721/ERC721Standard.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,iCAAiC;AAa7D,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAe;gBAE5B,QAAQ,EAAE,YAAY;IAIlC;;;;;OAKG;IACH,iCAAiC,YACtB,MAAM,KACd,QAAQ,OAAO,CAAC,CAKjB;IAEF;;;;;OAKG;IACH,mCAAmC,YACxB,MAAM,KACd,QAAQ,OAAO,CAAC,CAKjB;IAEF;;;;;OAKG;IACH,gCAAgC,YACrB,MAAM,KACd,QAAQ,OAAO,CAAC,CAEjB;IAEF;;;;;;;OAOG;IACH,aAAa,YACF,MAAM,mBACE,MAAM,SAChB,MAAM,KACZ,QAAQ,MAAM,CAAC,CAGhB;IAEF;;;;;;OAMG;IACH,WAAW,YAAmB,MAAM,WAAW,MAAM,KAAG,QAAQ,MAAM,CAAC,CAYrE;IAEF;;;;;OAKG;IACH,YAAY,YAAmB,MAAM,KAAG,QAAQ,MAAM,CAAC,CAGrD;IAEF;;;;;OAKG;IACH,cAAc,YAAmB,MAAM,KAAG,QAAQ,MAAM,CAAC,CAGvD;IAEF;;;;;;OAMG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKnE;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAiBxC;IAEF;;;;;;;OAOG;IACH,UAAU,YACC,MAAM,eACF,MAAM,YACT,MAAM;kBAEN,MAAM;kBACN,MAAM,GAAG,SAAS;gBACpB,MAAM,GAAG,SAAS;cACpB,MAAM,GAAG,SAAS;eACjB,MAAM,GAAG,SAAS;OA0CzB;CACH"}

package/dist/Standards/NftStandards/ERC721/ERC721Standard.d.mts

@@ -0,0 +1,89 @@
+import type { Web3Provider } from "@ethersproject/providers";
+export declare class ERC721Standard {
+    private readonly provider;
+    constructor(provider: Web3Provider);
+    /**
+     * Query if contract implements ERC721Metadata interface.
+     *
+     * @param address - ERC721 asset contract address.
+     * @returns Promise resolving to whether the contract implements ERC721Metadata interface.
+     */
+    contractSupportsMetadataInterface: (address: string) => Promise<boolean>;
+    /**
+     * Query if contract implements ERC721Enumerable interface.
+     *
+     * @param address - ERC721 asset contract address.
+     * @returns Promise resolving to whether the contract implements ERC721Enumerable interface.
+     */
+    contractSupportsEnumerableInterface: (address: string) => Promise<boolean>;
+    /**
+     * Query if contract implements ERC721 interface.
+     *
+     * @param address - ERC721 asset contract address.
+     * @returns Promise resolving to whether the contract implements ERC721 interface.
+     */
+    contractSupportsBase721Interface: (address: string) => Promise<boolean>;
+    /**
+     * Enumerate assets assigned to an owner.
+     *
+     * @param address - ERC721 asset contract address.
+     * @param selectedAddress - Current account public address.
+     * @param index - An NFT counter less than `balanceOf(selectedAddress)`.
+     * @returns Promise resolving to token identifier for the 'index'th asset assigned to 'selectedAddress'.
+     */
+    getNftTokenId: (address: string, selectedAddress: string, index: number) => Promise<string>;
+    /**
+     * Query for tokenURI for a given asset.
+     *
+     * @param address - ERC721 asset contract address.
+     * @param tokenId - ERC721 asset identifier.
+     * @returns Promise resolving to the 'tokenURI'.
+     */
+    getTokenURI: (address: string, tokenId: string) => Promise<string>;
+    /**
+     * Query for name for a given asset.
+     *
+     * @param address - ERC721 asset contract address.
+     * @returns Promise resolving to the 'name'.
+     */
+    getAssetName: (address: string) => Promise<string>;
+    /**
+     * Query for symbol for a given asset.
+     *
+     * @param address - ERC721 asset contract address.
+     * @returns Promise resolving to the 'symbol'.
+     */
+    getAssetSymbol: (address: string) => Promise<string>;
+    /**
+     * Query for owner for a given ERC721 asset.
+     *
+     * @param address - ERC721 asset contract address.
+     * @param tokenId - ERC721 asset identifier.
+     * @returns Promise resolving to the owner address.
+     */
+    getOwnerOf(address: string, tokenId: string): Promise<string>;
+    /**
+     * Query if a contract implements an interface.
+     *
+     * @param address - Asset contract address.
+     * @param interfaceId - Interface identifier.
+     * @returns Promise resolving to whether the contract implements `interfaceID`.
+     */
+    private readonly contractSupportsInterface;
+    /**
+     * Query if a contract implements an interface.
+     *
+     * @param address - Asset contract address.
+     * @param ipfsGateway - The user's preferred IPFS gateway.
+     * @param tokenId - tokenId of a given token in the contract.
+     * @returns Promise resolving an object containing the standard, tokenURI, symbol and name of the given contract/tokenId pair.
+     */
+    getDetails: (address: string, ipfsGateway: string, tokenId?: string) => Promise<{
+        standard: string;
+        tokenURI: string | undefined;
+        symbol: string | undefined;
+        name: string | undefined;
+        image: string | undefined;
+    }>;
+}
+//# sourceMappingURL=ERC721Standard.d.mts.map

package/dist/Standards/NftStandards/ERC721/ERC721Standard.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ERC721Standard.d.mts","sourceRoot":"","sources":["../../../../src/Standards/NftStandards/ERC721/ERC721Standard.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,iCAAiC;AAa7D,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAe;gBAE5B,QAAQ,EAAE,YAAY;IAIlC;;;;;OAKG;IACH,iCAAiC,YACtB,MAAM,KACd,QAAQ,OAAO,CAAC,CAKjB;IAEF;;;;;OAKG;IACH,mCAAmC,YACxB,MAAM,KACd,QAAQ,OAAO,CAAC,CAKjB;IAEF;;;;;OAKG;IACH,gCAAgC,YACrB,MAAM,KACd,QAAQ,OAAO,CAAC,CAEjB;IAEF;;;;;;;OAOG;IACH,aAAa,YACF,MAAM,mBACE,MAAM,SAChB,MAAM,KACZ,QAAQ,MAAM,CAAC,CAGhB;IAEF;;;;;;OAMG;IACH,WAAW,YAAmB,MAAM,WAAW,MAAM,KAAG,QAAQ,MAAM,CAAC,CAYrE;IAEF;;;;;OAKG;IACH,YAAY,YAAmB,MAAM,KAAG,QAAQ,MAAM,CAAC,CAGrD;IAEF;;;;;OAKG;IACH,cAAc,YAAmB,MAAM,KAAG,QAAQ,MAAM,CAAC,CAGvD;IAEF;;;;;;OAMG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKnE;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAiBxC;IAEF;;;;;;;OAOG;IACH,UAAU,YACC,MAAM,eACF,MAAM,YACT,MAAM;kBAEN,MAAM;kBACN,MAAM,GAAG,SAAS;gBACpB,MAAM,GAAG,SAAS;cACpB,MAAM,GAAG,SAAS;eACjB,MAAM,GAAG,SAAS;OA0CzB;CACH"}

package/dist/Standards/NftStandards/ERC721/ERC721Standard.mjs

@@ -1,9 +1,163 @@
-import {
-  ERC721Standard
-} from "../../../chunk-3QDXAE2D.mjs";
-import "../../../chunk-BZEAPSD5.mjs";
-import "../../../chunk-XUI43LEZ.mjs";
-export {
-  ERC721Standard
-};
+import { Contract } from "@ethersproject/contracts";
+import { timeoutFetch, ERC721_INTERFACE_ID, ERC721_METADATA_INTERFACE_ID, ERC721_ENUMERABLE_INTERFACE_ID, ERC721, safelyExecute } from "@metamask/controller-utils";
+import { abiERC721 } from "@metamask/metamask-eth-abis";
+import { getFormattedIpfsUrl } from "../../../assetsUtil.mjs";
+export class ERC721Standard {
+    constructor(provider) {
+        /**
+         * Query if contract implements ERC721Metadata interface.
+         *
+         * @param address - ERC721 asset contract address.
+         * @returns Promise resolving to whether the contract implements ERC721Metadata interface.
+         */
+        this.contractSupportsMetadataInterface = async (address) => {
+            return this.contractSupportsInterface(address, ERC721_METADATA_INTERFACE_ID);
+        };
+        /**
+         * Query if contract implements ERC721Enumerable interface.
+         *
+         * @param address - ERC721 asset contract address.
+         * @returns Promise resolving to whether the contract implements ERC721Enumerable interface.
+         */
+        this.contractSupportsEnumerableInterface = async (address) => {
+            return this.contractSupportsInterface(address, ERC721_ENUMERABLE_INTERFACE_ID);
+        };
+        /**
+         * Query if contract implements ERC721 interface.
+         *
+         * @param address - ERC721 asset contract address.
+         * @returns Promise resolving to whether the contract implements ERC721 interface.
+         */
+        this.contractSupportsBase721Interface = async (address) => {
+            return this.contractSupportsInterface(address, ERC721_INTERFACE_ID);
+        };
+        /**
+         * Enumerate assets assigned to an owner.
+         *
+         * @param address - ERC721 asset contract address.
+         * @param selectedAddress - Current account public address.
+         * @param index - An NFT counter less than `balanceOf(selectedAddress)`.
+         * @returns Promise resolving to token identifier for the 'index'th asset assigned to 'selectedAddress'.
+         */
+        this.getNftTokenId = async (address, selectedAddress, index) => {
+            const contract = new Contract(address, abiERC721, this.provider);
+            return contract.tokenOfOwnerByIndex(selectedAddress, index);
+        };
+        /**
+         * Query for tokenURI for a given asset.
+         *
+         * @param address - ERC721 asset contract address.
+         * @param tokenId - ERC721 asset identifier.
+         * @returns Promise resolving to the 'tokenURI'.
+         */
+        this.getTokenURI = async (address, tokenId) => {
+            const contract = new Contract(address, abiERC721, this.provider);
+            const supportsMetadata = await this.contractSupportsMetadataInterface(address);
+            if (!supportsMetadata) {
+                // Do not throw error here, supporting Metadata interface is optional even though majority of ERC721 nfts do support it.
+                // This change is made because of instances of NFTs that are ERC404( mixed ERC20 / ERC721 implementation).
+                // As of today, ERC404 is unofficial but some people use it, the contract does not support Metadata interface, but it has the tokenURI() fct.
+                console.error('Contract does not support ERC721 metadata interface.');
+            }
+            return contract.tokenURI(tokenId);
+        };
+        /**
+         * Query for name for a given asset.
+         *
+         * @param address - ERC721 asset contract address.
+         * @returns Promise resolving to the 'name'.
+         */
+        this.getAssetName = async (address) => {
+            const contract = new Contract(address, abiERC721, this.provider);
+            return contract.name();
+        };
+        /**
+         * Query for symbol for a given asset.
+         *
+         * @param address - ERC721 asset contract address.
+         * @returns Promise resolving to the 'symbol'.
+         */
+        this.getAssetSymbol = async (address) => {
+            const contract = new Contract(address, abiERC721, this.provider);
+            return contract.symbol();
+        };
+        /**
+         * Query if a contract implements an interface.
+         *
+         * @param address - Asset contract address.
+         * @param interfaceId - Interface identifier.
+         * @returns Promise resolving to whether the contract implements `interfaceID`.
+         */
+        this.contractSupportsInterface = async (address, interfaceId) => {
+            const contract = new Contract(address, abiERC721, this.provider);
+            try {
+                return await contract.supportsInterface(interfaceId);
+            }
+            catch (err) {
+                // Mirror previous implementation
+                if (err instanceof Error &&
+                    err.message.includes('call revert exception')) {
+                    return false;
+                }
+                throw err;
+            }
+        };
+        /**
+         * Query if a contract implements an interface.
+         *
+         * @param address - Asset contract address.
+         * @param ipfsGateway - The user's preferred IPFS gateway.
+         * @param tokenId - tokenId of a given token in the contract.
+         * @returns Promise resolving an object containing the standard, tokenURI, symbol and name of the given contract/tokenId pair.
+         */
+        this.getDetails = async (address, ipfsGateway, tokenId) => {
+            const isERC721 = await this.contractSupportsBase721Interface(address);
+            if (!isERC721) {
+                throw new Error("This isn't a valid ERC721 contract");
+            }
+            const [symbol, name, tokenURI] = await Promise.all([
+                safelyExecute(() => this.getAssetSymbol(address)),
+                safelyExecute(() => this.getAssetName(address)),
+                tokenId
+                    ? safelyExecute(() => this.getTokenURI(address, tokenId).then((uri) => uri.startsWith('ipfs://')
+                        ? getFormattedIpfsUrl(ipfsGateway, uri, true)
+                        : uri))
+                    : undefined,
+            ]);
+            let image;
+            if (tokenURI) {
+                try {
+                    const response = await timeoutFetch(tokenURI);
+                    const object = await response.json();
+                    image = object?.image;
+                    if (image?.startsWith('ipfs://')) {
+                        image = getFormattedIpfsUrl(ipfsGateway, image, true);
+                    }
+                }
+                catch {
+                    // ignore
+                }
+            }
+            return {
+                standard: ERC721,
+                tokenURI,
+                symbol,
+                name,
+                image,
+            };
+        };
+        this.provider = provider;
+    }
+    /**
+     * Query for owner for a given ERC721 asset.
+     *
+     * @param address - ERC721 asset contract address.
+     * @param tokenId - ERC721 asset identifier.
+     * @returns Promise resolving to the owner address.
+     */
+    async getOwnerOf(address, tokenId) {
+        const contract = new Contract(address, abiERC721, this.provider);
+        return contract.ownerOf(tokenId);
+    }
+}
 //# sourceMappingURL=ERC721Standard.mjs.map

package/dist/Standards/NftStandards/ERC721/ERC721Standard.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"ERC721Standard.mjs","sourceRoot":"","sources":["../../../../src/Standards/NftStandards/ERC721/ERC721Standard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AAEpD,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,4BAA4B,EAC5B,8BAA8B,EAC9B,MAAM,EACN,aAAa,EACd,mCAAmC;AACpC,OAAO,EAAE,SAAS,EAAE,oCAAoC;AAExD,OAAO,EAAE,mBAAmB,EAAE,gCAA4B;AAE1D,MAAM,OAAO,cAAc;IAGzB,YAAY,QAAsB;QAIlC;;;;;WAKG;QACH,sCAAiC,GAAG,KAAK,EACvC,OAAe,EACG,EAAE;YACpB,OAAO,IAAI,CAAC,yBAAyB,CACnC,OAAO,EACP,4BAA4B,CAC7B,CAAC;QACJ,CAAC,CAAC;QAEF;;;;;WAKG;QACH,wCAAmC,GAAG,KAAK,EACzC,OAAe,EACG,EAAE;YACpB,OAAO,IAAI,CAAC,yBAAyB,CACnC,OAAO,EACP,8BAA8B,CAC/B,CAAC;QACJ,CAAC,CAAC;QAEF;;;;;WAKG;QACH,qCAAgC,GAAG,KAAK,EACtC,OAAe,EACG,EAAE;YACpB,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;QACtE,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,kBAAa,GAAG,KAAK,EACnB,OAAe,EACf,eAAuB,EACvB,KAAa,EACI,EAAE;YACnB,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,OAAO,QAAQ,CAAC,mBAAmB,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC,CAAC;QAEF;;;;;;WAMG;QACH,gBAAW,GAAG,KAAK,EAAE,OAAe,EAAE,OAAe,EAAmB,EAAE;YACxE,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,iCAAiC,CACnE,OAAO,CACR,CAAC;YACF,IAAI,CAAC,gBAAgB,EAAE;gBACrB,wHAAwH;gBACxH,0GAA0G;gBAC1G,6IAA6I;gBAC7I,OAAO,CAAC,KAAK,CAAC,sDAAsD,CAAC,CAAC;aACvE;YACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QAEF;;;;;WAKG;QACH,iBAAY,GAAG,KAAK,EAAE,OAAe,EAAmB,EAAE;YACxD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;QACzB,CAAC,CAAC;QAEF;;;;;WAKG;QACH,mBAAc,GAAG,KAAK,EAAE,OAAe,EAAmB,EAAE;YAC1D,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC3B,CAAC,CAAC;QAcF;;;;;;WAMG;QACc,8BAAyB,GAAG,KAAK,EAChD,OAAe,EACf,WAAmB,EACD,EAAE;YACpB,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,IAAI;gBACF,OAAO,MAAM,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;aACtD;YAAC,OAAO,GAAG,EAAE;gBACZ,iCAAiC;gBACjC,IACE,GAAG,YAAY,KAAK;oBACpB,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAC7C;oBACA,OAAO,KAAK,CAAC;iBACd;gBACD,MAAM,GAAG,CAAC;aACX;QACH,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,eAAU,GAAG,KAAK,EAChB,OAAe,EACf,WAAmB,EACnB,OAAgB,EAOf,EAAE;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC;YACtE,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;aACvD;YAED,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACjD,aAAa,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBACjD,aAAa,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAC/C,OAAO;oBACL,CAAC,CAAC,aAAa,CAAC,GAAG,EAAE,CACjB,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAC9C,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC;wBACvB,CAAC,CAAC,mBAAmB,CAAC,WAAW,EAAE,GAAG,EAAE,IAAI,CAAC;wBAC7C,CAAC,CAAC,GAAG,CACR,CACF;oBACH,CAAC,CAAC,SAAS;aACd,CAAC,CAAC;YAEH,IAAI,KAAK,CAAC;YACV,IAAI,QAAQ,EAAE;gBACZ,IAAI;oBACF,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;oBAC9C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;oBACrC,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC;oBACtB,IAAI,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE;wBAChC,KAAK,GAAG,mBAAmB,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;qBACvD;iBACF;gBAAC,MAAM;oBACN,SAAS;iBACV;aACF;YAED,OAAO;gBACL,QAAQ,EAAE,MAAM;gBAChB,QAAQ;gBACR,MAAM;gBACN,IAAI;gBACJ,KAAK;aACN,CAAC;QACJ,CAAC,CAAC;QA1MA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAwGD;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,OAAe;QAC/C,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;CAwFF","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport type { Web3Provider } from '@ethersproject/providers';\nimport {\n  timeoutFetch,\n  ERC721_INTERFACE_ID,\n  ERC721_METADATA_INTERFACE_ID,\n  ERC721_ENUMERABLE_INTERFACE_ID,\n  ERC721,\n  safelyExecute,\n} from '@metamask/controller-utils';\nimport { abiERC721 } from '@metamask/metamask-eth-abis';\n\nimport { getFormattedIpfsUrl } from '../../../assetsUtil';\n\nexport class ERC721Standard {\n  private readonly provider: Web3Provider;\n\n  constructor(provider: Web3Provider) {\n    this.provider = provider;\n  }\n\n  /**\n   * Query if contract implements ERC721Metadata interface.\n   *\n   * @param address - ERC721 asset contract address.\n   * @returns Promise resolving to whether the contract implements ERC721Metadata interface.\n   */\n  contractSupportsMetadataInterface = async (\n    address: string,\n  ): Promise<boolean> => {\n    return this.contractSupportsInterface(\n      address,\n      ERC721_METADATA_INTERFACE_ID,\n    );\n  };\n\n  /**\n   * Query if contract implements ERC721Enumerable interface.\n   *\n   * @param address - ERC721 asset contract address.\n   * @returns Promise resolving to whether the contract implements ERC721Enumerable interface.\n   */\n  contractSupportsEnumerableInterface = async (\n    address: string,\n  ): Promise<boolean> => {\n    return this.contractSupportsInterface(\n      address,\n      ERC721_ENUMERABLE_INTERFACE_ID,\n    );\n  };\n\n  /**\n   * Query if contract implements ERC721 interface.\n   *\n   * @param address - ERC721 asset contract address.\n   * @returns Promise resolving to whether the contract implements ERC721 interface.\n   */\n  contractSupportsBase721Interface = async (\n    address: string,\n  ): Promise<boolean> => {\n    return this.contractSupportsInterface(address, ERC721_INTERFACE_ID);\n  };\n\n  /**\n   * Enumerate assets assigned to an owner.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param selectedAddress - Current account public address.\n   * @param index - An NFT counter less than `balanceOf(selectedAddress)`.\n   * @returns Promise resolving to token identifier for the 'index'th asset assigned to 'selectedAddress'.\n   */\n  getNftTokenId = async (\n    address: string,\n    selectedAddress: string,\n    index: number,\n  ): Promise<string> => {\n    const contract = new Contract(address, abiERC721, this.provider);\n    return contract.tokenOfOwnerByIndex(selectedAddress, index);\n  };\n\n  /**\n   * Query for tokenURI for a given asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param tokenId - ERC721 asset identifier.\n   * @returns Promise resolving to the 'tokenURI'.\n   */\n  getTokenURI = async (address: string, tokenId: string): Promise<string> => {\n    const contract = new Contract(address, abiERC721, this.provider);\n    const supportsMetadata = await this.contractSupportsMetadataInterface(\n      address,\n    );\n    if (!supportsMetadata) {\n      // Do not throw error here, supporting Metadata interface is optional even though majority of ERC721 nfts do support it.\n      // This change is made because of instances of NFTs that are ERC404( mixed ERC20 / ERC721 implementation).\n      // As of today, ERC404 is unofficial but some people use it, the contract does not support Metadata interface, but it has the tokenURI() fct.\n      console.error('Contract does not support ERC721 metadata interface.');\n    }\n    return contract.tokenURI(tokenId);\n  };\n\n  /**\n   * Query for name for a given asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @returns Promise resolving to the 'name'.\n   */\n  getAssetName = async (address: string): Promise<string> => {\n    const contract = new Contract(address, abiERC721, this.provider);\n    return contract.name();\n  };\n\n  /**\n   * Query for symbol for a given asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @returns Promise resolving to the 'symbol'.\n   */\n  getAssetSymbol = async (address: string): Promise<string> => {\n    const contract = new Contract(address, abiERC721, this.provider);\n    return contract.symbol();\n  };\n\n  /**\n   * Query for owner for a given ERC721 asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param tokenId - ERC721 asset identifier.\n   * @returns Promise resolving to the owner address.\n   */\n  async getOwnerOf(address: string, tokenId: string): Promise<string> {\n    const contract = new Contract(address, abiERC721, this.provider);\n    return contract.ownerOf(tokenId);\n  }\n\n  /**\n   * Query if a contract implements an interface.\n   *\n   * @param address - Asset contract address.\n   * @param interfaceId - Interface identifier.\n   * @returns Promise resolving to whether the contract implements `interfaceID`.\n   */\n  private readonly contractSupportsInterface = async (\n    address: string,\n    interfaceId: string,\n  ): Promise<boolean> => {\n    const contract = new Contract(address, abiERC721, this.provider);\n    try {\n      return await contract.supportsInterface(interfaceId);\n    } catch (err) {\n      // Mirror previous implementation\n      if (\n        err instanceof Error &&\n        err.message.includes('call revert exception')\n      ) {\n        return false;\n      }\n      throw err;\n    }\n  };\n\n  /**\n   * Query if a contract implements an interface.\n   *\n   * @param address - Asset contract address.\n   * @param ipfsGateway - The user's preferred IPFS gateway.\n   * @param tokenId - tokenId of a given token in the contract.\n   * @returns Promise resolving an object containing the standard, tokenURI, symbol and name of the given contract/tokenId pair.\n   */\n  getDetails = async (\n    address: string,\n    ipfsGateway: string,\n    tokenId?: string,\n  ): Promise<{\n    standard: string;\n    tokenURI: string | undefined;\n    symbol: string | undefined;\n    name: string | undefined;\n    image: string | undefined;\n  }> => {\n    const isERC721 = await this.contractSupportsBase721Interface(address);\n    if (!isERC721) {\n      throw new Error(\"This isn't a valid ERC721 contract\");\n    }\n\n    const [symbol, name, tokenURI] = await Promise.all([\n      safelyExecute(() => this.getAssetSymbol(address)),\n      safelyExecute(() => this.getAssetName(address)),\n      tokenId\n        ? safelyExecute(() =>\n            this.getTokenURI(address, tokenId).then((uri) =>\n              uri.startsWith('ipfs://')\n                ? getFormattedIpfsUrl(ipfsGateway, uri, true)\n                : uri,\n            ),\n          )\n        : undefined,\n    ]);\n\n    let image;\n    if (tokenURI) {\n      try {\n        const response = await timeoutFetch(tokenURI);\n        const object = await response.json();\n        image = object?.image;\n        if (image?.startsWith('ipfs://')) {\n          image = getFormattedIpfsUrl(ipfsGateway, image, true);\n        }\n      } catch {\n        // ignore\n      }\n    }\n\n    return {\n      standard: ERC721,\n      tokenURI,\n      symbol,\n      name,\n      image,\n    };\n  };\n}\n"]}

package/dist/TokenBalancesController.cjs

@@ -0,0 +1,136 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _TokenBalancesController_handle, _TokenBalancesController_interval, _TokenBalancesController_tokens, _TokenBalancesController_disabled;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenBalancesController = exports.getDefaultTokenBalancesState = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const DEFAULT_INTERVAL = 180000;
+const controllerName = 'TokenBalancesController';
+const metadata = {
+    contractBalances: { persist: true, anonymous: false },
+};
+/**
+ * Get the default TokenBalancesController state.
+ *
+ * @returns The default TokenBalancesController state.
+ */
+function getDefaultTokenBalancesState() {
+    return {
+        contractBalances: {},
+    };
+}
+exports.getDefaultTokenBalancesState = getDefaultTokenBalancesState;
+/**
+ * Controller that passively polls on a set interval token balances
+ * for tokens stored in the TokensController
+ */
+class TokenBalancesController extends base_controller_1.BaseController {
+    /**
+     * Construct a Token Balances Controller.
+     *
+     * @param options - The controller options.
+     * @param options.interval - Polling interval used to fetch new token balances.
+     * @param options.tokens - List of tokens to track balances for.
+     * @param options.disabled - If set to true, all tracked tokens contract balances updates are blocked.
+     * @param options.state - Initial state to set on this controller.
+     * @param options.messenger - The controller restricted messenger.
+     */
+    constructor({ interval = DEFAULT_INTERVAL, tokens = [], disabled = false, messenger, state = {}, }) {
+        super({
+            name: controllerName,
+            metadata,
+            messenger,
+            state: {
+                ...getDefaultTokenBalancesState(),
+                ...state,
+            },
+        });
+        _TokenBalancesController_handle.set(this, void 0);
+        _TokenBalancesController_interval.set(this, void 0);
+        _TokenBalancesController_tokens.set(this, void 0);
+        _TokenBalancesController_disabled.set(this, void 0);
+        __classPrivateFieldSet(this, _TokenBalancesController_disabled, disabled, "f");
+        __classPrivateFieldSet(this, _TokenBalancesController_interval, interval, "f");
+        __classPrivateFieldSet(this, _TokenBalancesController_tokens, tokens, "f");
+        this.messagingSystem.subscribe('TokensController:stateChange', ({ tokens: newTokens, detectedTokens }) => {
+            __classPrivateFieldSet(this, _TokenBalancesController_tokens, [...newTokens, ...detectedTokens], "f");
+            // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            this.updateBalances();
+        });
+        // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        this.poll();
+    }
+    /**
+     * Allows controller to update tracked tokens contract balances.
+     */
+    enable() {
+        __classPrivateFieldSet(this, _TokenBalancesController_disabled, false, "f");
+    }
+    /**
+     * Blocks controller from updating tracked tokens contract balances.
+     */
+    disable() {
+        __classPrivateFieldSet(this, _TokenBalancesController_disabled, true, "f");
+    }
+    /**
+     * Starts a new polling interval.
+     *
+     * @param interval - Polling interval used to fetch new token balances.
+     */
+    async poll(interval) {
+        if (interval) {
+            __classPrivateFieldSet(this, _TokenBalancesController_interval, interval, "f");
+        }
+        if (__classPrivateFieldGet(this, _TokenBalancesController_handle, "f")) {
+            clearTimeout(__classPrivateFieldGet(this, _TokenBalancesController_handle, "f"));
+        }
+        await (0, controller_utils_1.safelyExecute)(() => this.updateBalances());
+        __classPrivateFieldSet(this, _TokenBalancesController_handle, setTimeout(() => {
+            // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            this.poll(__classPrivateFieldGet(this, _TokenBalancesController_interval, "f"));
+        }, __classPrivateFieldGet(this, _TokenBalancesController_interval, "f")), "f");
+    }
+    /**
+     * Updates balances for all tokens.
+     */
+    async updateBalances() {
+        if (__classPrivateFieldGet(this, _TokenBalancesController_disabled, "f")) {
+            return;
+        }
+        const selectedInternalAccount = this.messagingSystem.call('AccountsController:getSelectedAccount');
+        const newContractBalances = {};
+        for (const token of __classPrivateFieldGet(this, _TokenBalancesController_tokens, "f")) {
+            const { address } = token;
+            try {
+                const balance = await this.messagingSystem.call('AssetsContractController:getERC20BalanceOf', address, selectedInternalAccount.address);
+                newContractBalances[address] = (0, controller_utils_1.toHex)(balance);
+                token.hasBalanceError = false;
+            }
+            catch (error) {
+                newContractBalances[address] = (0, controller_utils_1.toHex)(0);
+                token.hasBalanceError = true;
+            }
+        }
+        this.update((state) => {
+            state.contractBalances = newContractBalances;
+        });
+    }
+}
+exports.TokenBalancesController = TokenBalancesController;
+_TokenBalancesController_handle = new WeakMap(), _TokenBalancesController_interval = new WeakMap(), _TokenBalancesController_tokens = new WeakMap(), _TokenBalancesController_disabled = new WeakMap();
+exports.default = TokenBalancesController;
+//# sourceMappingURL=TokenBalancesController.cjs.map