@metamask/assets-controllers 1.0.0

package/dist/Standards/ERC20Standard.js

@@ -0,0 +1,121 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERC20Standard = void 0;
+const contracts_1 = require("@ethersproject/contracts");
+const metamask_eth_abis_1 = require("@metamask/metamask-eth-abis");
+const ethereumjs_util_1 = require("ethereumjs-util");
+const abi_1 = require("@ethersproject/abi");
+const controller_utils_1 = require("@metamask/controller-utils");
+const assetsUtil_1 = require("../assetsUtil");
+class ERC20Standard {
+    constructor(provider) {
+        this.provider = provider;
+    }
+    /**
+     * Get balance or count for current account on specific asset contract.
+     *
+     * @param address - Asset ERC20 contract address.
+     * @param selectedAddress - Current account public address.
+     * @returns Promise resolving to BN object containing balance for current account on specific asset contract.
+     */
+    getBalanceOf(address, selectedAddress) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC20, this.provider);
+            const balance = yield contract.balanceOf(selectedAddress);
+            return (0, assetsUtil_1.ethersBigNumberToBN)(balance);
+        });
+    }
+    /**
+     * Query for the decimals for a given ERC20 asset.
+     *
+     * @param address - ERC20 asset contract string.
+     * @returns Promise resolving to the 'decimals'.
+     */
+    getTokenDecimals(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC20, this.provider);
+            try {
+                const decimals = yield contract.decimals();
+                return decimals.toString();
+            }
+            catch (err) {
+                // Mirror previous implementation
+                if (err.message.includes('call revert exception')) {
+                    throw new Error('Failed to parse token decimals');
+                }
+                throw err;
+            }
+        });
+    }
+    /**
+     * Query for symbol for a given ERC20 asset.
+     *
+     * @param address - ERC20 asset contract address.
+     * @returns Promise resolving to the 'symbol'.
+     */
+    getTokenSymbol(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Signature for calling `symbol()`
+            const payload = { to: address, data: '0x95d89b41' };
+            const result = yield this.provider.call(payload);
+            const abiCoder = new abi_1.AbiCoder();
+            // Parse as string - treat empty string as failure
+            try {
+                const decoded = abiCoder.decode(['string'], result)[0];
+                if ((decoded === null || decoded === void 0 ? void 0 : decoded.length) > 0) {
+                    return decoded;
+                }
+            }
+            catch (_a) {
+                // Ignore error
+            }
+            // Parse as bytes - treat empty string as failure
+            try {
+                const utf8 = (0, ethereumjs_util_1.toUtf8)(result);
+                if (utf8.length > 0) {
+                    return utf8;
+                }
+            }
+            catch (_b) {
+                // Ignore error
+            }
+            throw new Error('Failed to parse token symbol');
+        });
+    }
+    /**
+     * Query if a contract implements an interface.
+     *
+     * @param address - Asset contract address.
+     * @param userAddress - The public address for the currently active user's account.
+     * @returns Promise resolving an object containing the standard, decimals, symbol and balance of the given contract/userAddress pair.
+     */
+    getDetails(address, userAddress) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [decimals, symbol] = yield Promise.all([
+                this.getTokenDecimals(address),
+                this.getTokenSymbol(address),
+            ]);
+            let balance;
+            if (userAddress) {
+                balance = yield this.getBalanceOf(address, userAddress);
+            }
+            return {
+                decimals,
+                symbol,
+                balance,
+                standard: controller_utils_1.ERC20,
+            };
+        });
+    }
+}
+exports.ERC20Standard = ERC20Standard;
+//# sourceMappingURL=ERC20Standard.js.map

package/dist/Standards/ERC20Standard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ERC20Standard.js","sourceRoot":"","sources":["../../src/Standards/ERC20Standard.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAAoD;AACpD,mEAAuD;AACvD,qDAA6C;AAC7C,4CAA8C;AAE9C,iEAAmD;AACnD,8CAAoD;AAEpD,MAAa,aAAa;IAGxB,YAAY,QAAsB;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACG,YAAY,CAAC,OAAe,EAAE,eAAuB;;YACzD,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,4BAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChE,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;YAC1D,OAAO,IAAA,gCAAmB,EAAC,OAAO,CAAC,CAAC;QACtC,CAAC;KAAA;IAED;;;;;OAKG;IACG,gBAAgB,CAAC,OAAe;;YACpC,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,4BAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChE,IAAI;gBACF,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBAC3C,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;aAC5B;YAAC,OAAO,GAAQ,EAAE;gBACjB,iCAAiC;gBACjC,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE;oBACjD,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;iBACnD;gBACD,MAAM,GAAG,CAAC;aACX;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACG,cAAc,CAAC,OAAe;;YAClC,mCAAmC;YACnC,MAAM,OAAO,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;YACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAEjD,MAAM,QAAQ,GAAG,IAAI,cAAQ,EAAE,CAAC;YAEhC,kDAAkD;YAClD,IAAI;gBACF,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,IAAG,CAAC,EAAE;oBACvB,OAAO,OAAO,CAAC;iBAChB;aACF;YAAC,WAAM;gBACN,eAAe;aAChB;YAED,iDAAiD;YACjD,IAAI;gBACF,MAAM,IAAI,GAAG,IAAA,wBAAM,EAAC,MAAM,CAAC,CAAC;gBAC5B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;oBACnB,OAAO,IAAI,CAAC;iBACb;aACF;YAAC,WAAM;gBACN,eAAe;aAChB;YAED,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;KAAA;IAED;;;;;;OAMG;IACG,UAAU,CACd,OAAe,EACf,WAAoB;;YAOpB,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAC3C,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC;gBAC9B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;aAC7B,CAAC,CAAC;YACH,IAAI,OAAO,CAAC;YACZ,IAAI,WAAW,EAAE;gBACf,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;aACzD;YACD,OAAO;gBACL,QAAQ;gBACR,MAAM;gBACN,OAAO;gBACP,QAAQ,EAAE,wBAAK;aAChB,CAAC;QACJ,CAAC;KAAA;CACF;AA3GD,sCA2GC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { abiERC20 } from '@metamask/metamask-eth-abis';\nimport { BN, toUtf8 } from 'ethereumjs-util';\nimport { AbiCoder } from '@ethersproject/abi';\nimport { Web3Provider } from '@ethersproject/providers';\nimport { ERC20 } from '@metamask/controller-utils';\nimport { ethersBigNumberToBN } from '../assetsUtil';\n\nexport class ERC20Standard {\n  private provider: Web3Provider;\n\n  constructor(provider: Web3Provider) {\n    this.provider = provider;\n  }\n\n  /**\n   * Get balance or count for current account on specific asset contract.\n   *\n   * @param address - Asset ERC20 contract address.\n   * @param selectedAddress - Current account public address.\n   * @returns Promise resolving to BN object containing balance for current account on specific asset contract.\n   */\n  async getBalanceOf(address: string, selectedAddress: string): Promise<BN> {\n    const contract = new Contract(address, abiERC20, this.provider);\n    const balance = await contract.balanceOf(selectedAddress);\n    return ethersBigNumberToBN(balance);\n  }\n\n  /**\n   * Query for the decimals for a given ERC20 asset.\n   *\n   * @param address - ERC20 asset contract string.\n   * @returns Promise resolving to the 'decimals'.\n   */\n  async getTokenDecimals(address: string): Promise<string> {\n    const contract = new Contract(address, abiERC20, this.provider);\n    try {\n      const decimals = await contract.decimals();\n      return decimals.toString();\n    } catch (err: any) {\n      // Mirror previous implementation\n      if (err.message.includes('call revert exception')) {\n        throw new Error('Failed to parse token decimals');\n      }\n      throw err;\n    }\n  }\n\n  /**\n   * Query for symbol for a given ERC20 asset.\n   *\n   * @param address - ERC20 asset contract address.\n   * @returns Promise resolving to the 'symbol'.\n   */\n  async getTokenSymbol(address: string): Promise<string> {\n    // Signature for calling `symbol()`\n    const payload = { to: address, data: '0x95d89b41' };\n    const result = await this.provider.call(payload);\n\n    const abiCoder = new AbiCoder();\n\n    // Parse as string - treat empty string as failure\n    try {\n      const decoded = abiCoder.decode(['string'], result)[0];\n      if (decoded?.length > 0) {\n        return decoded;\n      }\n    } catch {\n      // Ignore error\n    }\n\n    // Parse as bytes - treat empty string as failure\n    try {\n      const utf8 = toUtf8(result);\n      if (utf8.length > 0) {\n        return utf8;\n      }\n    } catch {\n      // Ignore error\n    }\n\n    throw new Error('Failed to parse token symbol');\n  }\n\n  /**\n   * Query if a contract implements an interface.\n   *\n   * @param address - Asset contract address.\n   * @param userAddress - The public address for the currently active user's account.\n   * @returns Promise resolving an object containing the standard, decimals, symbol and balance of the given contract/userAddress pair.\n   */\n  async getDetails(\n    address: string,\n    userAddress?: string,\n  ): Promise<{\n    standard: string;\n    symbol: string | undefined;\n    decimals: string | undefined;\n    balance: BN | undefined;\n  }> {\n    const [decimals, symbol] = await Promise.all([\n      this.getTokenDecimals(address),\n      this.getTokenSymbol(address),\n    ]);\n    let balance;\n    if (userAddress) {\n      balance = await this.getBalanceOf(address, userAddress);\n    }\n    return {\n      decimals,\n      symbol,\n      balance,\n      standard: ERC20,\n    };\n  }\n}\n"]}

package/dist/Standards/NftStandards/ERC1155/ERC1155Standard.d.ts

@@ -0,0 +1,78 @@
+import { BN } from 'ethereumjs-util';
+import { Web3Provider } from '@ethersproject/providers';
+export declare class ERC1155Standard {
+    private provider;
+    constructor(provider: Web3Provider);
+    /**
+     * Query if contract implements ERC1155 URI Metadata interface.
+     *
+     * @param address - ERC1155 asset contract address.
+     * @returns Promise resolving to whether the contract implements ERC1155 URI Metadata interface.
+     */
+    contractSupportsURIMetadataInterface: (address: string) => Promise<boolean>;
+    /**
+     * Query if contract implements ERC1155 Token Receiver interface.
+     *
+     * @param address - ERC1155 asset contract address.
+     * @returns Promise resolving to whether the contract implements ERC1155 Token Receiver interface.
+     */
+    contractSupportsTokenReceiverInterface: (address: string) => Promise<boolean>;
+    /**
+     * Query if contract implements ERC1155 interface.
+     *
+     * @param address - ERC1155 asset contract address.
+     * @returns Promise resolving to whether the contract implements the base ERC1155 interface.
+     */
+    contractSupportsBase1155Interface: (address: string) => Promise<boolean>;
+    /**
+     * Query for tokenURI for a given asset.
+     *
+     * @param address - ERC1155 asset contract address.
+     * @param tokenId - ERC1155 asset identifier.
+     * @returns Promise resolving to the 'tokenURI'.
+     */
+    getTokenURI: (address: string, tokenId: string) => Promise<string>;
+    /**
+     * Query for balance of a given ERC1155 token.
+     *
+     * @param contractAddress - ERC1155 asset contract address.
+     * @param address - Wallet public address.
+     * @param tokenId - ERC1155 asset identifier.
+     * @returns Promise resolving to the 'balanceOf'.
+     */
+    getBalanceOf: (contractAddress: string, address: string, tokenId: string) => Promise<BN>;
+    /**
+     * Transfer single ERC1155 token.
+     * When minting/creating tokens, the from arg MUST be set to 0x0 (i.e. zero address).
+     * When burning/destroying tokens, the to arg MUST be set to 0x0 (i.e. zero address).
+     *
+     * @param operator - ERC1155 token address.
+     * @param from - ERC1155 token holder.
+     * @param to - ERC1155 token recipient.
+     * @param id - ERC1155 token id.
+     * @param value - Number of tokens to be sent.
+     * @returns Promise resolving to the 'transferSingle'.
+     */
+    transferSingle: (operator: string, from: string, to: string, id: string, value: string) => Promise<void>;
+    /**
+     * Query if a contract implements an interface.
+     *
+     * @param address - ERC1155 asset contract address.
+     * @param interfaceId - Interface identifier.
+     * @returns Promise resolving to whether the contract implements `interfaceID`.
+     */
+    private 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 | undefined) => Promise<{
+        standard: string;
+        tokenURI: string | undefined;
+        image: string | undefined;
+    }>;
+}

package/dist/Standards/NftStandards/ERC1155/ERC1155Standard.js

@@ -0,0 +1,148 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERC1155Standard = void 0;
+const metamask_eth_abis_1 = require("@metamask/metamask-eth-abis");
+const contracts_1 = require("@ethersproject/contracts");
+const controller_utils_1 = require("@metamask/controller-utils");
+const assetsUtil_1 = require("../../../assetsUtil");
+class ERC1155Standard {
+    constructor(provider) {
+        /**
+         * Query if contract implements ERC1155 URI Metadata interface.
+         *
+         * @param address - ERC1155 asset contract address.
+         * @returns Promise resolving to whether the contract implements ERC1155 URI Metadata interface.
+         */
+        this.contractSupportsURIMetadataInterface = (address) => __awaiter(this, void 0, void 0, function* () {
+            return this.contractSupportsInterface(address, controller_utils_1.ERC1155_METADATA_URI_INTERFACE_ID);
+        });
+        /**
+         * Query if contract implements ERC1155 Token Receiver interface.
+         *
+         * @param address - ERC1155 asset contract address.
+         * @returns Promise resolving to whether the contract implements ERC1155 Token Receiver interface.
+         */
+        this.contractSupportsTokenReceiverInterface = (address) => __awaiter(this, void 0, void 0, function* () {
+            return this.contractSupportsInterface(address, controller_utils_1.ERC1155_TOKEN_RECEIVER_INTERFACE_ID);
+        });
+        /**
+         * Query if contract implements ERC1155 interface.
+         *
+         * @param address - ERC1155 asset contract address.
+         * @returns Promise resolving to whether the contract implements the base ERC1155 interface.
+         */
+        this.contractSupportsBase1155Interface = (address) => __awaiter(this, void 0, void 0, function* () {
+            return this.contractSupportsInterface(address, controller_utils_1.ERC1155_INTERFACE_ID);
+        });
+        /**
+         * Query for tokenURI for a given asset.
+         *
+         * @param address - ERC1155 asset contract address.
+         * @param tokenId - ERC1155 asset identifier.
+         * @returns Promise resolving to the 'tokenURI'.
+         */
+        this.getTokenURI = (address, tokenId) => __awaiter(this, void 0, void 0, function* () {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC1155, this.provider);
+            return contract.uri(tokenId);
+        });
+        /**
+         * Query for balance of a given ERC1155 token.
+         *
+         * @param contractAddress - ERC1155 asset contract address.
+         * @param address - Wallet public address.
+         * @param tokenId - ERC1155 asset identifier.
+         * @returns Promise resolving to the 'balanceOf'.
+         */
+        this.getBalanceOf = (contractAddress, address, tokenId) => __awaiter(this, void 0, void 0, function* () {
+            const contract = new contracts_1.Contract(contractAddress, metamask_eth_abis_1.abiERC1155, this.provider);
+            const balance = yield contract.balanceOf(address, tokenId);
+            return (0, assetsUtil_1.ethersBigNumberToBN)(balance);
+        });
+        /**
+         * Transfer single ERC1155 token.
+         * When minting/creating tokens, the from arg MUST be set to 0x0 (i.e. zero address).
+         * When burning/destroying tokens, the to arg MUST be set to 0x0 (i.e. zero address).
+         *
+         * @param operator - ERC1155 token address.
+         * @param from - ERC1155 token holder.
+         * @param to - ERC1155 token recipient.
+         * @param id - ERC1155 token id.
+         * @param value - Number of tokens to be sent.
+         * @returns Promise resolving to the 'transferSingle'.
+         */
+        this.transferSingle = (operator, from, to, id, value) => __awaiter(this, void 0, void 0, function* () {
+            const contract = new contracts_1.Contract(operator, metamask_eth_abis_1.abiERC1155, this.provider);
+            return new Promise((resolve, reject) => {
+                contract.transferSingle(operator, from, to, id, value, (error, result) => {
+                    /* istanbul ignore if */
+                    if (error) {
+                        reject(error);
+                        return;
+                    }
+                    resolve(result);
+                });
+            });
+        });
+        /**
+         * Query if a contract implements an interface.
+         *
+         * @param address - ERC1155 asset contract address.
+         * @param interfaceId - Interface identifier.
+         * @returns Promise resolving to whether the contract implements `interfaceID`.
+         */
+        this.contractSupportsInterface = (address, interfaceId) => __awaiter(this, void 0, void 0, function* () {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC1155, this.provider);
+            return contract.supportsInterface(interfaceId);
+        });
+        /**
+         * 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 = (address, ipfsGateway, tokenId) => __awaiter(this, void 0, void 0, function* () {
+            const isERC1155 = yield this.contractSupportsBase1155Interface(address);
+            if (!isERC1155) {
+                throw new Error("This isn't a valid ERC1155 contract");
+            }
+            let tokenURI, image;
+            if (tokenId) {
+                tokenURI = yield this.getTokenURI(address, tokenId);
+                if (tokenURI.startsWith('ipfs://')) {
+                    tokenURI = (0, assetsUtil_1.getFormattedIpfsUrl)(ipfsGateway, tokenURI, true);
+                }
+                try {
+                    const response = yield (0, controller_utils_1.timeoutFetch)(tokenURI);
+                    const object = yield response.json();
+                    image = object === null || object === void 0 ? void 0 : object.image;
+                    if (image === null || image === void 0 ? void 0 : image.startsWith('ipfs://')) {
+                        image = (0, assetsUtil_1.getFormattedIpfsUrl)(ipfsGateway, image, true);
+                    }
+                }
+                catch (_a) {
+                    // ignore
+                }
+            }
+            // TODO consider querying to the metadata to get name.
+            return {
+                standard: controller_utils_1.ERC1155,
+                tokenURI,
+                image,
+            };
+        });
+        this.provider = provider;
+    }
+}
+exports.ERC1155Standard = ERC1155Standard;
+//# sourceMappingURL=ERC1155Standard.js.map

package/dist/Standards/NftStandards/ERC1155/ERC1155Standard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ERC1155Standard.js","sourceRoot":"","sources":["../../../../src/Standards/NftStandards/ERC1155/ERC1155Standard.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mEAAyD;AACzD,wDAAoD;AAGpD,iEAMoC;AACpC,oDAA+E;AAE/E,MAAa,eAAe;IAG1B,YAAY,QAAsB;QAIlC;;;;;WAKG;QACH,yCAAoC,GAAG,CACrC,OAAe,EACG,EAAE;YACpB,OAAO,IAAI,CAAC,yBAAyB,CACnC,OAAO,EACP,oDAAiC,CAClC,CAAC;QACJ,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,2CAAsC,GAAG,CACvC,OAAe,EACG,EAAE;YACpB,OAAO,IAAI,CAAC,yBAAyB,CACnC,OAAO,EACP,sDAAmC,CACpC,CAAC;QACJ,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,sCAAiC,GAAG,CAClC,OAAe,EACG,EAAE;YACpB,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,uCAAoB,CAAC,CAAC;QACvE,CAAC,CAAA,CAAC;QAEF;;;;;;WAMG;QACH,gBAAW,GAAG,CAAO,OAAe,EAAE,OAAe,EAAmB,EAAE;YACxE,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,8BAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClE,OAAO,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAA,CAAC;QAEF;;;;;;;WAOG;QACH,iBAAY,GAAG,CACb,eAAuB,EACvB,OAAe,EACf,OAAe,EACF,EAAE;YACf,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,eAAe,EAAE,8BAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1E,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC3D,OAAO,IAAA,gCAAmB,EAAC,OAAO,CAAC,CAAC;QACtC,CAAC,CAAA,CAAC;QAEF;;;;;;;;;;;WAWG;QACH,mBAAc,GAAG,CACf,QAAgB,EAChB,IAAY,EACZ,EAAU,EACV,EAAU,EACV,KAAa,EACE,EAAE;YACjB,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,QAAQ,EAAE,8BAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnE,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC3C,QAAQ,CAAC,cAAc,CACrB,QAAQ,EACR,IAAI,EACJ,EAAE,EACF,EAAE,EACF,KAAK,EACL,CAAC,KAAY,EAAE,MAAY,EAAE,EAAE;oBAC7B,wBAAwB;oBACxB,IAAI,KAAK,EAAE;wBACT,MAAM,CAAC,KAAK,CAAC,CAAC;wBACd,OAAO;qBACR;oBACD,OAAO,CAAC,MAAM,CAAC,CAAC;gBAClB,CAAC,CACF,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAA,CAAC;QAEF;;;;;;WAMG;QACK,8BAAyB,GAAG,CAClC,OAAe,EACf,WAAmB,EACD,EAAE;YACpB,MAAM,QAAQ,GAAG,IAAI,oBAAQ,CAAC,OAAO,EAAE,8BAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClE,OAAO,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QACjD,CAAC,CAAA,CAAC;QAEF;;;;;;;WAOG;QACH,eAAU,GAAG,CACX,OAAe,EACf,WAAmB,EACnB,OAAgB,EAKf,EAAE;YACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,iCAAiC,CAAC,OAAO,CAAC,CAAC;YAExE,IAAI,CAAC,SAAS,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aACxD;YACD,IAAI,QAAQ,EAAE,KAAK,CAAC;YAEpB,IAAI,OAAO,EAAE;gBACX,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBACpD,IAAI,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;oBAClC,QAAQ,GAAG,IAAA,gCAAmB,EAAC,WAAW,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;iBAC7D;gBAED,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,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC;oBACtB,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,CAAC,SAAS,CAAC,EAAE;wBAChC,KAAK,GAAG,IAAA,gCAAmB,EAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;qBACvD;iBACF;gBAAC,WAAM;oBACN,SAAS;iBACV;aACF;YAED,sDAAsD;YACtD,OAAO;gBACL,QAAQ,EAAE,0BAAO;gBACjB,QAAQ;gBACR,KAAK;aACN,CAAC;QACJ,CAAC,CAAA,CAAC;QAjLA,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CAiLF;AAtLD,0CAsLC","sourcesContent":["import { abiERC1155 } from '@metamask/metamask-eth-abis';\nimport { Contract } from '@ethersproject/contracts';\nimport { BN } from 'ethereumjs-util';\nimport { Web3Provider } from '@ethersproject/providers';\nimport {\n  ERC1155,\n  ERC1155_INTERFACE_ID,\n  ERC1155_METADATA_URI_INTERFACE_ID,\n  ERC1155_TOKEN_RECEIVER_INTERFACE_ID,\n  timeoutFetch,\n} from '@metamask/controller-utils';\nimport { getFormattedIpfsUrl, ethersBigNumberToBN } from '../../../assetsUtil';\n\nexport class ERC1155Standard {\n  private provider: Web3Provider;\n\n  constructor(provider: Web3Provider) {\n    this.provider = provider;\n  }\n\n  /**\n   * Query if contract implements ERC1155 URI Metadata interface.\n   *\n   * @param address - ERC1155 asset contract address.\n   * @returns Promise resolving to whether the contract implements ERC1155 URI Metadata interface.\n   */\n  contractSupportsURIMetadataInterface = async (\n    address: string,\n  ): Promise<boolean> => {\n    return this.contractSupportsInterface(\n      address,\n      ERC1155_METADATA_URI_INTERFACE_ID,\n    );\n  };\n\n  /**\n   * Query if contract implements ERC1155 Token Receiver interface.\n   *\n   * @param address - ERC1155 asset contract address.\n   * @returns Promise resolving to whether the contract implements ERC1155 Token Receiver interface.\n   */\n  contractSupportsTokenReceiverInterface = async (\n    address: string,\n  ): Promise<boolean> => {\n    return this.contractSupportsInterface(\n      address,\n      ERC1155_TOKEN_RECEIVER_INTERFACE_ID,\n    );\n  };\n\n  /**\n   * Query if contract implements ERC1155 interface.\n   *\n   * @param address - ERC1155 asset contract address.\n   * @returns Promise resolving to whether the contract implements the base ERC1155 interface.\n   */\n  contractSupportsBase1155Interface = async (\n    address: string,\n  ): Promise<boolean> => {\n    return this.contractSupportsInterface(address, ERC1155_INTERFACE_ID);\n  };\n\n  /**\n   * Query for tokenURI for a given asset.\n   *\n   * @param address - ERC1155 asset contract address.\n   * @param tokenId - ERC1155 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, abiERC1155, this.provider);\n    return contract.uri(tokenId);\n  };\n\n  /**\n   * Query for balance of a given ERC1155 token.\n   *\n   * @param contractAddress - ERC1155 asset contract address.\n   * @param address - Wallet public address.\n   * @param tokenId - ERC1155 asset identifier.\n   * @returns Promise resolving to the 'balanceOf'.\n   */\n  getBalanceOf = async (\n    contractAddress: string,\n    address: string,\n    tokenId: string,\n  ): Promise<BN> => {\n    const contract = new Contract(contractAddress, abiERC1155, this.provider);\n    const balance = await contract.balanceOf(address, tokenId);\n    return ethersBigNumberToBN(balance);\n  };\n\n  /**\n   * Transfer single ERC1155 token.\n   * When minting/creating tokens, the from arg MUST be set to 0x0 (i.e. zero address).\n   * When burning/destroying tokens, the to arg MUST be set to 0x0 (i.e. zero address).\n   *\n   * @param operator - ERC1155 token address.\n   * @param from - ERC1155 token holder.\n   * @param to - ERC1155 token recipient.\n   * @param id - ERC1155 token id.\n   * @param value - Number of tokens to be sent.\n   * @returns Promise resolving to the 'transferSingle'.\n   */\n  transferSingle = async (\n    operator: string,\n    from: string,\n    to: string,\n    id: string,\n    value: string,\n  ): Promise<void> => {\n    const contract = new Contract(operator, abiERC1155, this.provider);\n    return new Promise<void>((resolve, reject) => {\n      contract.transferSingle(\n        operator,\n        from,\n        to,\n        id,\n        value,\n        (error: Error, result: void) => {\n          /* istanbul ignore if */\n          if (error) {\n            reject(error);\n            return;\n          }\n          resolve(result);\n        },\n      );\n    });\n  };\n\n  /**\n   * Query if a contract implements an interface.\n   *\n   * @param address - ERC1155 asset contract address.\n   * @param interfaceId - Interface identifier.\n   * @returns Promise resolving to whether the contract implements `interfaceID`.\n   */\n  private contractSupportsInterface = async (\n    address: string,\n    interfaceId: string,\n  ): Promise<boolean> => {\n    const contract = new Contract(address, abiERC1155, this.provider);\n    return contract.supportsInterface(interfaceId);\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    image: string | undefined;\n  }> => {\n    const isERC1155 = await this.contractSupportsBase1155Interface(address);\n\n    if (!isERC1155) {\n      throw new Error(\"This isn't a valid ERC1155 contract\");\n    }\n    let tokenURI, image;\n\n    if (tokenId) {\n      tokenURI = await this.getTokenURI(address, tokenId);\n      if (tokenURI.startsWith('ipfs://')) {\n        tokenURI = getFormattedIpfsUrl(ipfsGateway, tokenURI, true);\n      }\n\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    // TODO consider querying to the metadata to get name.\n    return {\n      standard: ERC1155,\n      tokenURI,\n      image,\n    };\n  };\n}\n"]}

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

@@ -0,0 +1,88 @@
+import { Web3Provider } from '@ethersproject/providers';
+export declare class ERC721Standard {
+    private 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 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 | undefined) => Promise<{
+        standard: string;
+        tokenURI: string | undefined;
+        symbol: string | undefined;
+        name: string | undefined;
+        image: string | undefined;
+    }>;
+}

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

@@ -0,0 +1,182 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERC721Standard = void 0;
+const metamask_eth_abis_1 = require("@metamask/metamask-eth-abis");
+const contracts_1 = require("@ethersproject/contracts");
+const controller_utils_1 = require("@metamask/controller-utils");
+const assetsUtil_1 = require("../../../assetsUtil");
+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 = (address) => __awaiter(this, void 0, void 0, function* () {
+            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 = (address) => __awaiter(this, void 0, void 0, function* () {
+            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 = (address) => __awaiter(this, void 0, void 0, function* () {
+            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 = (address, selectedAddress, index) => __awaiter(this, void 0, void 0, function* () {
+            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 = (address, tokenId) => __awaiter(this, void 0, void 0, function* () {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC721, this.provider);
+            const supportsMetadata = yield this.contractSupportsMetadataInterface(address);
+            if (!supportsMetadata) {
+                throw new 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 = (address) => __awaiter(this, void 0, void 0, function* () {
+            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 = (address) => __awaiter(this, void 0, void 0, function* () {
+            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 = (address, interfaceId) => __awaiter(this, void 0, void 0, function* () {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC721, this.provider);
+            try {
+                return yield contract.supportsInterface(interfaceId);
+            }
+            catch (err) {
+                // Mirror previous implementation
+                if (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 = (address, ipfsGateway, tokenId) => __awaiter(this, void 0, void 0, function* () {
+            const isERC721 = yield this.contractSupportsBase721Interface(address);
+            if (!isERC721) {
+                throw new Error("This isn't a valid ERC721 contract");
+            }
+            let tokenURI, image, symbol, name;
+            // TODO upgrade to use Promise.allSettled for name/symbol when we can refactor to use es2020 in tsconfig
+            try {
+                symbol = yield this.getAssetSymbol(address);
+            }
+            catch (_a) {
+                // ignore
+            }
+            try {
+                name = yield this.getAssetName(address);
+            }
+            catch (_b) {
+                // ignore
+            }
+            if (tokenId) {
+                try {
+                    tokenURI = yield this.getTokenURI(address, tokenId);
+                    if (tokenURI.startsWith('ipfs://')) {
+                        tokenURI = (0, assetsUtil_1.getFormattedIpfsUrl)(ipfsGateway, tokenURI, true);
+                    }
+                    const response = yield (0, controller_utils_1.timeoutFetch)(tokenURI);
+                    const object = yield response.json();
+                    image = object === null || object === void 0 ? void 0 : object.image;
+                    if (image === null || image === void 0 ? void 0 : image.startsWith('ipfs://')) {
+                        image = (0, assetsUtil_1.getFormattedIpfsUrl)(ipfsGateway, image, true);
+                    }
+                }
+                catch (_c) {
+                    // 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.
+     */
+    getOwnerOf(address, tokenId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contract = new contracts_1.Contract(address, metamask_eth_abis_1.abiERC721, this.provider);
+            return contract.ownerOf(tokenId);
+        });
+    }
+}
+exports.ERC721Standard = ERC721Standard;
+//# sourceMappingURL=ERC721Standard.js.map