@metamask/assets-controllers 38.0.0 → 38.0.1

package/dist/AssetsContractController.mjs

@@ -1,18 +1,389 @@
-import {
-  AssetsContractController,
-  AssetsContractController_default,
-  MISSING_PROVIDER_ERROR,
-  SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID
-} from "./chunk-AZSIKIMK.mjs";
-import "./chunk-3QDXAE2D.mjs";
-import "./chunk-S5CFNNOM.mjs";
-import "./chunk-KPBNX6GP.mjs";
-import "./chunk-BZEAPSD5.mjs";
-import "./chunk-XUI43LEZ.mjs";
-export {
-  AssetsContractController,
-  MISSING_PROVIDER_ERROR,
-  SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID,
-  AssetsContractController_default as default
+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 _AssetsContractController_instances, _AssetsContractController_provider, _AssetsContractController_ipfsGateway, _AssetsContractController_chainId, _AssetsContractController_registerActionHandlers, _AssetsContractController_registerEventSubscriptions, _AssetsContractController_getCorrectProvider, _AssetsContractController_getCorrectChainId;
+function $importDefault(module) {
+    if (module?.__esModule) {
+        return module.default;
+    }
+    return module;
+}
+import { Contract } from "@ethersproject/contracts";
+import { Web3Provider } from "@ethersproject/providers";
+import { IPFS_DEFAULT_GATEWAY_URL } from "@metamask/controller-utils";
+import { getKnownPropertyNames } from "@metamask/utils";
+import $abiSingleCallBalancesContract from "single-call-balance-checker-abi";
+const abiSingleCallBalancesContract = $importDefault($abiSingleCallBalancesContract);
+import { SupportedTokenDetectionNetworks } from "./assetsUtil.mjs";
+import { ERC20Standard } from "./Standards/ERC20Standard.mjs";
+import { ERC1155Standard } from "./Standards/NftStandards/ERC1155/ERC1155Standard.mjs";
+import { ERC721Standard } from "./Standards/NftStandards/ERC721/ERC721Standard.mjs";
+/**
+ * Check if token detection is enabled for certain networks
+ *
+ * @param chainId - ChainID of network
+ * @returns Whether the current network supports token detection
+ */
+export const SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID = {
+    [SupportedTokenDetectionNetworks.mainnet]: '0xb1f8e55c7f64d203c1400b9d8555d050f94adf39',
+    [SupportedTokenDetectionNetworks.bsc]: '0x2352c63A83f9Fd126af8676146721Fa00924d7e4',
+    [SupportedTokenDetectionNetworks.polygon]: '0x2352c63A83f9Fd126af8676146721Fa00924d7e4',
+    [SupportedTokenDetectionNetworks.avax]: '0xD023D153a0DFa485130ECFdE2FAA7e612EF94818',
+    [SupportedTokenDetectionNetworks.aurora]: '0x1286415D333855237f89Df27D388127181448538',
+    [SupportedTokenDetectionNetworks.linea_goerli]: '0x10dAd7Ca3921471f616db788D9300DC97Db01783',
+    [SupportedTokenDetectionNetworks.linea_mainnet]: '0xF62e6a41561b3650a69Bb03199C735e3E3328c0D',
+    [SupportedTokenDetectionNetworks.arbitrum]: '0x151E24A486D7258dd7C33Fb67E4bB01919B7B32c',
+    [SupportedTokenDetectionNetworks.optimism]: '0xB1c568e9C3E6bdaf755A60c7418C269eb11524FC',
+    [SupportedTokenDetectionNetworks.base]: '0x6AA75276052D96696134252587894ef5FFA520af',
+    [SupportedTokenDetectionNetworks.zksync]: '0x458fEd3144680a5b8bcfaa0F9594aa19B4Ea2D34',
+    [SupportedTokenDetectionNetworks.cronos]: '0x768ca200f0fc702ac9ea502498c18f5eff176378',
+    [SupportedTokenDetectionNetworks.celo]: '0x6aa75276052d96696134252587894ef5ffa520af',
+    [SupportedTokenDetectionNetworks.gnosis]: '0x6aa75276052d96696134252587894ef5ffa520af',
+    [SupportedTokenDetectionNetworks.fantom]: '0x6aa75276052d96696134252587894ef5ffa520af',
+    [SupportedTokenDetectionNetworks.polygon_zkevm]: '0x6aa75276052d96696134252587894ef5ffa520af',
+    [SupportedTokenDetectionNetworks.moonbeam]: '0x6aa75276052d96696134252587894ef5ffa520af',
+    [SupportedTokenDetectionNetworks.moonriver]: '0x6aa75276052d96696134252587894ef5ffa520af',
+};
+export const MISSING_PROVIDER_ERROR = 'AssetsContractController failed to set the provider correctly. A provider must be set for this method to be available';
+/**
+ * The name of the {@link AssetsContractController}
+ */
+const name = 'AssetsContractController';
+/**
+ * Controller that interacts with contracts on mainnet through web3
+ */
+export class AssetsContractController {
+    /**
+     * Creates a AssetsContractController instance.
+     *
+     * @param options - The controller options.
+     * @param options.messenger - The controller messenger.
+     * @param options.chainId - The chain ID of the current network.
+     */
+    constructor({ messenger, chainId: initialChainId, }) {
+        _AssetsContractController_instances.add(this);
+        this.name = name;
+        _AssetsContractController_provider.set(this, void 0);
+        _AssetsContractController_ipfsGateway.set(this, void 0);
+        _AssetsContractController_chainId.set(this, void 0);
+        this.messagingSystem = messenger;
+        __classPrivateFieldSet(this, _AssetsContractController_provider, undefined, "f");
+        __classPrivateFieldSet(this, _AssetsContractController_ipfsGateway, IPFS_DEFAULT_GATEWAY_URL, "f");
+        __classPrivateFieldSet(this, _AssetsContractController_chainId, initialChainId, "f");
+        __classPrivateFieldGet(this, _AssetsContractController_instances, "m", _AssetsContractController_registerActionHandlers).call(this);
+        __classPrivateFieldGet(this, _AssetsContractController_instances, "m", _AssetsContractController_registerEventSubscriptions).call(this);
+    }
+    /**
+     * Sets a new provider.
+     *
+     * @param provider - Provider used to create a new underlying Web3 instance
+     */
+    setProvider(provider) {
+        __classPrivateFieldSet(this, _AssetsContractController_provider, provider, "f");
+    }
+    get ipfsGateway() {
+        return __classPrivateFieldGet(this, _AssetsContractController_ipfsGateway, "f");
+    }
+    get chainId() {
+        return __classPrivateFieldGet(this, _AssetsContractController_chainId, "f");
+    }
+    /**
+     * Get a ERC20Standard instance using the relevant provider instance.
+     *
+     * @param networkClientId - Network Client ID used to get the provider.
+     * @returns ERC20Standard instance.
+     */
+    getERC20Standard(networkClientId) {
+        const provider = __classPrivateFieldGet(this, _AssetsContractController_instances, "m", _AssetsContractController_getCorrectProvider).call(this, networkClientId);
+        return new ERC20Standard(provider);
+    }
+    /**
+     * Get a ERC721Standard instance using the relevant provider instance.
+     *
+     * @param networkClientId - Network Client ID used to get the provider.
+     * @returns ERC721Standard instance.
+     */
+    getERC721Standard(networkClientId) {
+        const provider = __classPrivateFieldGet(this, _AssetsContractController_instances, "m", _AssetsContractController_getCorrectProvider).call(this, networkClientId);
+        return new ERC721Standard(provider);
+    }
+    /**
+     * Get a ERC1155Standard instance using the relevant provider instance.
+     *
+     * @param networkClientId - Network Client ID used to get the provider.
+     * @returns ERC1155Standard instance.
+     */
+    getERC1155Standard(networkClientId) {
+        const provider = __classPrivateFieldGet(this, _AssetsContractController_instances, "m", _AssetsContractController_getCorrectProvider).call(this, networkClientId);
+        return new ERC1155Standard(provider);
+    }
+    /**
+     * Get balance or count for current account on specific asset contract.
+     *
+     * @param address - Asset ERC20 contract address.
+     * @param selectedAddress - Current account public address.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to BN object containing balance for current account on specific asset contract.
+     */
+    async getERC20BalanceOf(address, selectedAddress, networkClientId) {
+        const erc20Standard = this.getERC20Standard(networkClientId);
+        return erc20Standard.getBalanceOf(address, selectedAddress);
+    }
+    /**
+     * Query for the decimals for a given ERC20 asset.
+     *
+     * @param address - ERC20 asset contract address.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to the 'decimals'.
+     */
+    async getERC20TokenDecimals(address, networkClientId) {
+        const erc20Standard = this.getERC20Standard(networkClientId);
+        return erc20Standard.getTokenDecimals(address);
+    }
+    /**
+     * Query for the name for a given ERC20 asset.
+     *
+     * @param address - ERC20 asset contract address.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to the 'decimals'.
+     */
+    async getERC20TokenName(address, networkClientId) {
+        const erc20Standard = this.getERC20Standard(networkClientId);
+        return erc20Standard.getTokenName(address);
+    }
+    /**
+     * 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)`.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to token identifier for the 'index'th asset assigned to 'selectedAddress'.
+     */
+    async getERC721NftTokenId(address, selectedAddress, index, networkClientId) {
+        const erc721Standard = this.getERC721Standard(networkClientId);
+        return erc721Standard.getNftTokenId(address, selectedAddress, index);
+    }
+    /**
+     * Enumerate assets assigned to an owner.
+     *
+     * @param tokenAddress - ERC721 asset contract address.
+     * @param userAddress - Current account public address.
+     * @param tokenId - ERC721 asset identifier.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to an object containing the token standard and a set of details which depend on which standard the token supports.
+     */
+    async getTokenStandardAndDetails(tokenAddress, userAddress, tokenId, networkClientId) {
+        // Asserts provider is available
+        __classPrivateFieldGet(this, _AssetsContractController_instances, "m", _AssetsContractController_getCorrectProvider).call(this, networkClientId);
+        // ERC721
+        try {
+            const erc721Standard = this.getERC721Standard(networkClientId);
+            return {
+                ...(await erc721Standard.getDetails(tokenAddress, __classPrivateFieldGet(this, _AssetsContractController_ipfsGateway, "f"), tokenId)),
+            };
+        }
+        catch {
+            // Ignore
+        }
+        // ERC1155
+        try {
+            const erc1155Standard = this.getERC1155Standard(networkClientId);
+            return {
+                ...(await erc1155Standard.getDetails(tokenAddress, __classPrivateFieldGet(this, _AssetsContractController_ipfsGateway, "f"), tokenId)),
+            };
+        }
+        catch {
+            // Ignore
+        }
+        // ERC20
+        try {
+            const erc20Standard = this.getERC20Standard(networkClientId);
+            return {
+                ...(await erc20Standard.getDetails(tokenAddress, userAddress)),
+            };
+        }
+        catch {
+            // Ignore
+        }
+        throw new Error('Unable to determine contract standard');
+    }
+    /**
+     * Query for tokenURI for a given ERC721 asset.
+     *
+     * @param address - ERC721 asset contract address.
+     * @param tokenId - ERC721 asset identifier.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to the 'tokenURI'.
+     */
+    async getERC721TokenURI(address, tokenId, networkClientId) {
+        const erc721Standard = this.getERC721Standard(networkClientId);
+        return erc721Standard.getTokenURI(address, tokenId);
+    }
+    /**
+     * Query for name for a given asset.
+     *
+     * @param address - ERC721 or ERC20 asset contract address.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to the 'name'.
+     */
+    async getERC721AssetName(address, networkClientId) {
+        const erc721Standard = this.getERC721Standard(networkClientId);
+        return erc721Standard.getAssetName(address);
+    }
+    /**
+     * Query for symbol for a given asset.
+     *
+     * @param address - ERC721 or ERC20 asset contract address.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to the 'symbol'.
+     */
+    async getERC721AssetSymbol(address, networkClientId) {
+        const erc721Standard = this.getERC721Standard(networkClientId);
+        return erc721Standard.getAssetSymbol(address);
+    }
+    /**
+     * Query for owner for a given ERC721 asset.
+     *
+     * @param address - ERC721 asset contract address.
+     * @param tokenId - ERC721 asset identifier.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to the owner address.
+     */
+    async getERC721OwnerOf(address, tokenId, networkClientId) {
+        const erc721Standard = this.getERC721Standard(networkClientId);
+        return erc721Standard.getOwnerOf(address, tokenId);
+    }
+    /**
+     * Query for tokenURI for a given asset.
+     *
+     * @param address - ERC1155 asset contract address.
+     * @param tokenId - ERC1155 asset identifier.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to the 'tokenURI'.
+     */
+    async getERC1155TokenURI(address, tokenId, networkClientId) {
+        const erc1155Standard = this.getERC1155Standard(networkClientId);
+        return erc1155Standard.getTokenURI(address, tokenId);
+    }
+    /**
+     * Query for balance of a given ERC 1155 token.
+     *
+     * @param userAddress - Wallet public address.
+     * @param nftAddress - ERC1155 asset contract address.
+     * @param nftId - ERC1155 asset identifier.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to the 'balanceOf'.
+     */
+    async getERC1155BalanceOf(userAddress, nftAddress, nftId, networkClientId) {
+        const erc1155Standard = this.getERC1155Standard(networkClientId);
+        return erc1155Standard.getBalanceOf(nftAddress, userAddress, nftId);
+    }
+    /**
+     * Transfer single ERC1155 token.
+     *
+     * @param nftAddress - ERC1155 token address.
+     * @param senderAddress - ERC1155 token sender.
+     * @param recipientAddress - ERC1155 token recipient.
+     * @param nftId - ERC1155 token id.
+     * @param qty - Quantity of tokens to be sent.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns Promise resolving to the 'transferSingle' ERC1155 token.
+     */
+    async transferSingleERC1155(nftAddress, senderAddress, recipientAddress, nftId, qty, networkClientId) {
+        const erc1155Standard = this.getERC1155Standard(networkClientId);
+        return erc1155Standard.transferSingle(nftAddress, senderAddress, recipientAddress, nftId, qty);
+    }
+    /**
+     * Get the token balance for a list of token addresses in a single call. Only non-zero balances
+     * are returned.
+     *
+     * @param selectedAddress - The address to check token balances for.
+     * @param tokensToDetect - The token addresses to detect balances for.
+     * @param networkClientId - Network Client ID to fetch the provider with.
+     * @returns The list of non-zero token balances.
+     */
+    async getBalancesInSingleCall(selectedAddress, tokensToDetect, networkClientId) {
+        const chainId = __classPrivateFieldGet(this, _AssetsContractController_instances, "m", _AssetsContractController_getCorrectChainId).call(this, networkClientId);
+        const provider = __classPrivateFieldGet(this, _AssetsContractController_instances, "m", _AssetsContractController_getCorrectProvider).call(this, networkClientId);
+        if (!((id) => id in SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID)(chainId)) {
+            // Only fetch balance if contract address exists
+            return {};
+        }
+        const contractAddress = SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID[chainId];
+        const contract = new Contract(contractAddress, abiSingleCallBalancesContract, provider);
+        const result = await contract.balances([selectedAddress], tokensToDetect);
+        const nonZeroBalances = {};
+        /* istanbul ignore else */
+        if (result.length > 0) {
+            tokensToDetect.forEach((tokenAddress, index) => {
+                const balance = result[index];
+                /* istanbul ignore else */
+                if (String(balance) !== '0') {
+                    nonZeroBalances[tokenAddress] = balance;
+                }
+            });
+        }
+        return nonZeroBalances;
+    }
+}
+_AssetsContractController_provider = new WeakMap(), _AssetsContractController_ipfsGateway = new WeakMap(), _AssetsContractController_chainId = new WeakMap(), _AssetsContractController_instances = new WeakSet(), _AssetsContractController_registerActionHandlers = function _AssetsContractController_registerActionHandlers() {
+    const methodsExcludedFromMessenger = [
+        'constructor',
+        'messagingSystem',
+        'setProvider',
+        'provider',
+        'ipfsGateway',
+        'chainId',
+    ];
+    getKnownPropertyNames(Object.getPrototypeOf(this)).forEach((method) => {
+        if (((key) => !methodsExcludedFromMessenger.find((e) => e === key) &&
+            typeof this[key] === 'function')(method)) {
+            this.messagingSystem.registerActionHandler(`${name}:${method}`, 
+            // TODO: Write a generic for-loop implementation that iterates over an input union type in tandem with the input array.
+            // @ts-expect-error Both assigned argument and assignee parameter are using the entire union type for `method` instead of the type for the current element
+            this[method].bind(this));
+        }
+    });
+}, _AssetsContractController_registerEventSubscriptions = function _AssetsContractController_registerEventSubscriptions() {
+    this.messagingSystem.subscribe(`PreferencesController:stateChange`, ({ ipfsGateway }) => {
+        __classPrivateFieldSet(this, _AssetsContractController_ipfsGateway, ipfsGateway, "f");
+    });
+    this.messagingSystem.subscribe(`NetworkController:networkDidChange`, ({ selectedNetworkClientId }) => {
+        const chainId = __classPrivateFieldGet(this, _AssetsContractController_instances, "m", _AssetsContractController_getCorrectChainId).call(this, selectedNetworkClientId);
+        if (__classPrivateFieldGet(this, _AssetsContractController_chainId, "f") !== chainId) {
+            __classPrivateFieldSet(this, _AssetsContractController_chainId, chainId, "f");
+            // @ts-expect-error TODO: remove this annotation once the `Eip1193Provider` class is released
+            __classPrivateFieldSet(this, _AssetsContractController_provider, __classPrivateFieldGet(this, _AssetsContractController_instances, "m", _AssetsContractController_getCorrectProvider).call(this), "f");
+        }
+    });
+}, _AssetsContractController_getCorrectProvider = function _AssetsContractController_getCorrectProvider(networkClientId) {
+    const provider = networkClientId
+        ? this.messagingSystem.call(`NetworkController:getNetworkClientById`, networkClientId).provider
+        : this.messagingSystem.call('NetworkController:getSelectedNetworkClient')
+            ?.provider ?? __classPrivateFieldGet(this, _AssetsContractController_provider, "f");
+    if (provider === undefined) {
+        throw new Error(MISSING_PROVIDER_ERROR);
+    }
+    return new Web3Provider(provider);
+}, _AssetsContractController_getCorrectChainId = function _AssetsContractController_getCorrectChainId(networkClientId) {
+    if (networkClientId) {
+        const networkClientConfiguration = this.messagingSystem.call('NetworkController:getNetworkConfigurationByNetworkClientId', networkClientId);
+        if (networkClientConfiguration) {
+            return networkClientConfiguration.chainId;
+        }
+    }
+    const { selectedNetworkClientId } = this.messagingSystem.call('NetworkController:getState');
+    const networkClient = this.messagingSystem.call('NetworkController:getNetworkClientById', selectedNetworkClientId);
+    return networkClient.configuration?.chainId ?? __classPrivateFieldGet(this, _AssetsContractController_chainId, "f");
+};
+export default AssetsContractController;
 //# sourceMappingURL=AssetsContractController.mjs.map

package/dist/AssetsContractController.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"AssetsContractController.mjs","sourceRoot":"","sources":["../src/AssetsContractController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,iCAAiC;AACpD,OAAO,EAAE,YAAY,EAAE,iCAAiC;AAKxD,OAAO,EAAE,wBAAwB,EAAE,mCAAmC;AAWtE,OAAO,EAAE,qBAAqB,EAAY,wBAAwB;AAElE,OAAO,8BAA6B,wCAAwC;;AAE5E,OAAO,EAAE,+BAA+B,EAAE,yBAAqB;AAC/D,OAAO,EAAE,aAAa,EAAE,sCAAkC;AAC1D,OAAO,EAAE,eAAe,EAAE,6DAAyD;AACnF,OAAO,EAAE,cAAc,EAAE,2DAAuD;AAEhF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG;IACrD,CAAC,+BAA+B,CAAC,OAAO,CAAC,EACvC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,GAAG,CAAC,EACnC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,OAAO,CAAC,EACvC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,IAAI,CAAC,EACpC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,YAAY,CAAC,EAC5C,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,aAAa,CAAC,EAC7C,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,QAAQ,CAAC,EACxC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,QAAQ,CAAC,EACxC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,IAAI,CAAC,EACpC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,IAAI,CAAC,EACpC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,MAAM,CAAC,EACtC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,aAAa,CAAC,EAC7C,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,QAAQ,CAAC,EACxC,4CAA4C;IAC9C,CAAC,+BAA+B,CAAC,SAAS,CAAC,EACzC,4CAA4C;CACR,CAAC;AAEzC,MAAM,CAAC,MAAM,sBAAsB,GACjC,uHAAuH,CAAC;AAY1H;;GAEG;AACH,MAAM,IAAI,GAAG,0BAA0B,CAAC;AAgHxC;;GAEG;AACH,MAAM,OAAO,wBAAwB;IAWnC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,OAAO,EAAE,cAAc,GAIxB;;QAvBQ,SAAI,GAAgB,IAAI,CAAC;QAIlC,qDAAgC;QAEhC,wDAAqB;QAErB,oDAAc;QAgBZ,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,uBAAA,IAAI,sCAAa,SAAS,MAAA,CAAC;QAC3B,uBAAA,IAAI,yCAAgB,wBAAwB,MAAA,CAAC;QAC7C,uBAAA,IAAI,qCAAY,cAAc,MAAA,CAAC;QAE/B,uBAAA,IAAI,6FAAwB,MAA5B,IAAI,CAA0B,CAAC;QAC/B,uBAAA,IAAI,iGAA4B,MAAhC,IAAI,CAA8B,CAAC;IACrC,CAAC;IAqDD;;;;OAIG;IACH,WAAW,CAAC,QAA8B;QACxC,uBAAA,IAAI,sCAAa,QAAQ,MAAA,CAAC;IAC5B,CAAC;IAED,IAAI,WAAW;QACb,OAAO,uBAAA,IAAI,6CAAa,CAAC;IAC3B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,uBAAA,IAAI,yCAAS,CAAC;IACvB,CAAC;IAkDD;;;;;OAKG;IACH,gBAAgB,CAAC,eAAiC;QAChD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,OAAO,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,eAAiC;QACjD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,OAAO,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,eAAiC;QAClD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,OAAO,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,eAAuB,EACvB,eAAiC;QAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC,YAAY,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAe,EACf,eAAiC;QAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,eAAiC;QAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;QAC7D,OAAO,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAe,EACf,eAAuB,EACvB,KAAa,EACb,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,0BAA0B,CAC9B,YAAoB,EACpB,WAAoB,EACpB,OAAgB,EAChB,eAAiC;QASjC,gCAAgC;QAChC,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAE1C,SAAS;QACT,IAAI;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;YAC/D,OAAO;gBACL,GAAG,CAAC,MAAM,cAAc,CAAC,UAAU,CACjC,YAAY,EACZ,uBAAA,IAAI,6CAAa,EACjB,OAAO,CACR,CAAC;aACH,CAAC;SACH;QAAC,MAAM;YACN,SAAS;SACV;QAED,UAAU;QACV,IAAI;YACF,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;YACjE,OAAO;gBACL,GAAG,CAAC,MAAM,eAAe,CAAC,UAAU,CAClC,YAAY,EACZ,uBAAA,IAAI,6CAAa,EACjB,OAAO,CACR,CAAC;aACH,CAAC;SACH;QAAC,MAAM;YACN,SAAS;SACV;QAED,QAAQ;QACR,IAAI;YACF,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;YAC7D,OAAO;gBACL,GAAG,CAAC,MAAM,aAAa,CAAC,UAAU,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;aAC/D,CAAC;SACH;QAAC,MAAM;YACN,SAAS;SACV;QAED,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,OAAe,EACf,eAAiC;QAEjC,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;QAC/D,OAAO,cAAc,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,OAAe,EACf,eAAiC;QAEjC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACjE,OAAO,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,mBAAmB,CACvB,WAAmB,EACnB,UAAkB,EAClB,KAAa,EACb,eAAiC;QAEjC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACjE,OAAO,eAAe,CAAC,YAAY,CAAC,UAAU,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,qBAAqB,CACzB,UAAkB,EAClB,aAAqB,EACrB,gBAAwB,EACxB,KAAa,EACb,GAAW,EACX,eAAiC;QAEjC,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACjE,OAAO,eAAe,CAAC,cAAc,CACnC,UAAU,EACV,aAAa,EACb,gBAAgB,EAChB,KAAK,EACL,GAAG,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uBAAuB,CAC3B,eAAuB,EACvB,cAAwB,EACxB,eAAiC;QAEjC,MAAM,OAAO,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,eAAe,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,EAAqB,eAAe,CAAC,CAAC;QAC3D,IACE,CAAC,CAAC,CAAC,EAAE,EAA8D,EAAE,CACnE,EAAE,IAAI,uCAAuC,CAAC,CAAC,OAAO,CAAC,EACzD;YACA,gDAAgD;YAChD,OAAO,EAAE,CAAC;SACX;QACD,MAAM,eAAe,GAAG,uCAAuC,CAAC,OAAO,CAAC,CAAC;QAEzE,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAC3B,eAAe,EACf,6BAA6B,EAC7B,QAAQ,CACT,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC,CAAC;QAC1E,MAAM,eAAe,GAAe,EAAE,CAAC;QACvC,0BAA0B;QAC1B,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,cAAc,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE;gBAC7C,MAAM,OAAO,GAAO,MAAM,CAAC,KAAK,CAAC,CAAC;gBAClC,0BAA0B;gBAC1B,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,GAAG,EAAE;oBAC3B,eAAe,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;iBACzC;YACH,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;;IApcG,MAAM,4BAA4B,GAAG;QACnC,aAAa;QACb,iBAAiB;QACjB,aAAa;QACb,UAAU;QACV,aAAa;QACb,SAAS;KACV,CAAC;IAEF,qBAAqB,CAAa,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CACpE,CAAC,MAAM,EAAE,EAAE;QACT,IACE,CAAC,CAAC,GAAe,EAA6C,EAAE,CAC9D,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC;YACpD,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,CAAC,MAAM,CAAC,EAC1C;YACA,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,IAAI,IAAI,MAAM,EAAE;YACnB,uHAAuH;YACvH,0JAA0J;YAC1J,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACxB,CAAC;SACH;IACH,CAAC,CACF,CAAC;AACJ,CAAC;IAGC,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,mCAAmC,EACnC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE;QAClB,uBAAA,IAAI,yCAAgB,WAAW,MAAA,CAAC;IAClC,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,oCAAoC,EACpC,CAAC,EAAE,uBAAuB,EAAE,EAAE,EAAE;QAC9B,MAAM,OAAO,GAAG,uBAAA,IAAI,wFAAmB,MAAvB,IAAI,EAAoB,uBAAuB,CAAC,CAAC;QAEjE,IAAI,uBAAA,IAAI,yCAAS,KAAK,OAAO,EAAE;YAC7B,uBAAA,IAAI,qCAAY,OAAO,MAAA,CAAC;YACxB,6FAA6F;YAC7F,uBAAA,IAAI,sCAAa,uBAAA,IAAI,yFAAoB,MAAxB,IAAI,CAAsB,MAAA,CAAC;SAC7C;IACH,CAAC,CACF,CAAC;AACJ,CAAC,uGAyBmB,eAAiC;IACnD,MAAM,QAAQ,GAAG,eAAe;QAC9B,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CACvB,wCAAwC,EACxC,eAAe,CAChB,CAAC,QAAQ;QACZ,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,4CAA4C,CAAC;YACrE,EAAE,QAAQ,IAAI,uBAAA,IAAI,0CAAU,CAAC;IAEnC,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;KACzC;IAED,OAAO,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAC;AACpC,CAAC,qGAQkB,eAAiC;IAClD,IAAI,eAAe,EAAE;QACnB,MAAM,0BAA0B,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC1D,4DAA4D,EAC5D,eAAe,CAChB,CAAC;QACF,IAAI,0BAA0B,EAAE;YAC9B,OAAO,0BAA0B,CAAC,OAAO,CAAC;SAC3C;KACF;IACD,MAAM,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC3D,4BAA4B,CAC7B,CAAC;IACF,MAAM,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAC7C,wCAAwC,EACxC,uBAAuB,CACxB,CAAC;IACF,OAAO,aAAa,CAAC,aAAa,EAAE,OAAO,IAAI,uBAAA,IAAI,yCAAS,CAAC;AAC/D,CAAC;AAsVH,eAAe,wBAAwB,CAAC","sourcesContent":["import { Contract } from '@ethersproject/contracts';\nimport { Web3Provider } from '@ethersproject/providers';\nimport type {\n  ActionConstraint,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport { IPFS_DEFAULT_GATEWAY_URL } from '@metamask/controller-utils';\nimport type {\n  NetworkClientId,\n  NetworkControllerGetNetworkClientByIdAction,\n  NetworkControllerGetNetworkConfigurationByNetworkClientId,\n  NetworkControllerGetSelectedNetworkClientAction,\n  NetworkControllerGetStateAction,\n  NetworkControllerNetworkDidChangeEvent,\n  Provider,\n} from '@metamask/network-controller';\nimport type { PreferencesControllerStateChangeEvent } from '@metamask/preferences-controller';\nimport { getKnownPropertyNames, type Hex } from '@metamask/utils';\nimport type BN from 'bn.js';\nimport abiSingleCallBalancesContract from 'single-call-balance-checker-abi';\n\nimport { SupportedTokenDetectionNetworks } from './assetsUtil';\nimport { ERC20Standard } from './Standards/ERC20Standard';\nimport { ERC1155Standard } from './Standards/NftStandards/ERC1155/ERC1155Standard';\nimport { ERC721Standard } from './Standards/NftStandards/ERC721/ERC721Standard';\n\n/**\n * Check if token detection is enabled for certain networks\n *\n * @param chainId - ChainID of network\n * @returns Whether the current network supports token detection\n */\nexport const SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID = {\n  [SupportedTokenDetectionNetworks.mainnet]:\n    '0xb1f8e55c7f64d203c1400b9d8555d050f94adf39',\n  [SupportedTokenDetectionNetworks.bsc]:\n    '0x2352c63A83f9Fd126af8676146721Fa00924d7e4',\n  [SupportedTokenDetectionNetworks.polygon]:\n    '0x2352c63A83f9Fd126af8676146721Fa00924d7e4',\n  [SupportedTokenDetectionNetworks.avax]:\n    '0xD023D153a0DFa485130ECFdE2FAA7e612EF94818',\n  [SupportedTokenDetectionNetworks.aurora]:\n    '0x1286415D333855237f89Df27D388127181448538',\n  [SupportedTokenDetectionNetworks.linea_goerli]:\n    '0x10dAd7Ca3921471f616db788D9300DC97Db01783',\n  [SupportedTokenDetectionNetworks.linea_mainnet]:\n    '0xF62e6a41561b3650a69Bb03199C735e3E3328c0D',\n  [SupportedTokenDetectionNetworks.arbitrum]:\n    '0x151E24A486D7258dd7C33Fb67E4bB01919B7B32c',\n  [SupportedTokenDetectionNetworks.optimism]:\n    '0xB1c568e9C3E6bdaf755A60c7418C269eb11524FC',\n  [SupportedTokenDetectionNetworks.base]:\n    '0x6AA75276052D96696134252587894ef5FFA520af',\n  [SupportedTokenDetectionNetworks.zksync]:\n    '0x458fEd3144680a5b8bcfaa0F9594aa19B4Ea2D34',\n  [SupportedTokenDetectionNetworks.cronos]:\n    '0x768ca200f0fc702ac9ea502498c18f5eff176378',\n  [SupportedTokenDetectionNetworks.celo]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.gnosis]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.fantom]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.polygon_zkevm]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.moonbeam]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n  [SupportedTokenDetectionNetworks.moonriver]:\n    '0x6aa75276052d96696134252587894ef5ffa520af',\n} as const satisfies Record<Hex, string>;\n\nexport const MISSING_PROVIDER_ERROR =\n  'AssetsContractController failed to set the provider correctly. A provider must be set for this method to be available';\n\n/**\n * @type BalanceMap\n *\n * Key value object containing the balance for each tokenAddress\n * @property [tokenAddress] - Address of the token\n */\nexport type BalanceMap = {\n  [tokenAddress: string]: BN;\n};\n\n/**\n * The name of the {@link AssetsContractController}\n */\nconst name = 'AssetsContractController';\n\n/**\n * A utility type that derives the public method names of a given messenger consumer class,\n * and uses it to generate the class's internal messenger action types.\n * @template Controller - A messenger consumer class.\n */\n// TODO: Figure out generic constraint and move to base-controller\ntype ControllerActionsMap<Controller> = {\n  [ClassMethod in keyof Controller as Controller[ClassMethod] extends ActionConstraint['handler']\n    ? ClassMethod\n    : never]: {\n    type: `${typeof name}:${ClassMethod & string}`;\n    handler: Controller[ClassMethod];\n  };\n};\n\ntype AssetsContractControllerActionsMap =\n  ControllerActionsMap<AssetsContractController>;\n\n/**\n * The union of all public class method names of {@link AssetsContractController}.\n */\ntype AssetsContractControllerMethodName =\n  keyof AssetsContractControllerActionsMap;\n\n/**\n * The union of all internal messenger actions available to the {@link AssetsContractControllerMessenger}.\n */\nexport type AssetsContractControllerActions =\n  AssetsContractControllerActionsMap[AssetsContractControllerMethodName];\n\nexport type AssetsContractControllerGetERC20StandardAction =\n  AssetsContractControllerActionsMap['getERC20Standard'];\n\nexport type AssetsContractControllerGetERC721StandardAction =\n  AssetsContractControllerActionsMap['getERC721Standard'];\n\nexport type AssetsContractControllerGetERC1155StandardAction =\n  AssetsContractControllerActionsMap['getERC1155Standard'];\n\nexport type AssetsContractControllerGetERC20BalanceOfAction =\n  AssetsContractControllerActionsMap['getERC20BalanceOf'];\n\nexport type AssetsContractControllerGetERC20TokenDecimalsAction =\n  AssetsContractControllerActionsMap['getERC20TokenDecimals'];\n\nexport type AssetsContractControllerGetERC20TokenNameAction =\n  AssetsContractControllerActionsMap['getERC20TokenName'];\n\nexport type AssetsContractControllerGetERC721NftTokenIdAction =\n  AssetsContractControllerActionsMap['getERC721NftTokenId'];\n\nexport type AssetsContractControllerGetERC721TokenURIAction =\n  AssetsContractControllerActionsMap['getERC721TokenURI'];\n\nexport type AssetsContractControllerGetERC721AssetNameAction =\n  AssetsContractControllerActionsMap['getERC721AssetName'];\n\nexport type AssetsContractControllerGetERC721AssetSymbolAction =\n  AssetsContractControllerActionsMap['getERC721AssetSymbol'];\n\nexport type AssetsContractControllerGetERC721OwnerOfAction =\n  AssetsContractControllerActionsMap['getERC721OwnerOf'];\n\nexport type AssetsContractControllerGetERC1155TokenURIAction =\n  AssetsContractControllerActionsMap['getERC1155TokenURI'];\n\nexport type AssetsContractControllerGetERC1155BalanceOfAction =\n  AssetsContractControllerActionsMap['getERC1155BalanceOf'];\n\nexport type AssetsContractControllerTransferSingleERC1155Action =\n  AssetsContractControllerActionsMap['transferSingleERC1155'];\n\nexport type AssetsContractControllerGetTokenStandardAndDetailsAction =\n  AssetsContractControllerActionsMap['getTokenStandardAndDetails'];\n\nexport type AssetsContractControllerGetBalancesInSingleCallAction =\n  AssetsContractControllerActionsMap['getBalancesInSingleCall'];\n\n/**\n * The union of all internal messenger events available to the {@link AssetsContractControllerMessenger}.\n */\nexport type AssetsContractControllerEvents = never;\n\n/**\n * The union of all external messenger actions that must be allowed by the {@link AssetsContractControllerMessenger}.\n */\nexport type AllowedActions =\n  | NetworkControllerGetNetworkClientByIdAction\n  | NetworkControllerGetNetworkConfigurationByNetworkClientId\n  | NetworkControllerGetSelectedNetworkClientAction\n  | NetworkControllerGetStateAction;\n\n/**\n * The union of all external messenger event that must be allowed by the {@link AssetsContractControllerMessenger}.\n */\nexport type AllowedEvents =\n  | PreferencesControllerStateChangeEvent\n  | NetworkControllerNetworkDidChangeEvent;\n\n/**\n * The messenger of the {@link AssetsContractController}.\n */\nexport type AssetsContractControllerMessenger = RestrictedControllerMessenger<\n  typeof name,\n  AssetsContractControllerActions | AllowedActions,\n  AssetsContractControllerEvents | AllowedEvents,\n  AllowedActions['type'],\n  AllowedEvents['type']\n>;\n\n/**\n * Controller that interacts with contracts on mainnet through web3\n */\nexport class AssetsContractController {\n  readonly name: typeof name = name;\n\n  protected messagingSystem: AssetsContractControllerMessenger;\n\n  #provider: Provider | undefined;\n\n  #ipfsGateway: string;\n\n  #chainId: Hex;\n\n  /**\n   * Creates a AssetsContractController instance.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The controller messenger.\n   * @param options.chainId - The chain ID of the current network.\n   */\n  constructor({\n    messenger,\n    chainId: initialChainId,\n  }: {\n    messenger: AssetsContractControllerMessenger;\n    chainId: Hex;\n  }) {\n    this.messagingSystem = messenger;\n    this.#provider = undefined;\n    this.#ipfsGateway = IPFS_DEFAULT_GATEWAY_URL;\n    this.#chainId = initialChainId;\n\n    this.#registerActionHandlers();\n    this.#registerEventSubscriptions();\n  }\n\n  // TODO: Expand into base-controller utility function that batch registers action handlers.\n  #registerActionHandlers() {\n    const methodsExcludedFromMessenger = [\n      'constructor',\n      'messagingSystem',\n      'setProvider',\n      'provider',\n      'ipfsGateway',\n      'chainId',\n    ];\n\n    getKnownPropertyNames<keyof this>(Object.getPrototypeOf(this)).forEach(\n      (method) => {\n        if (\n          ((key: keyof this): key is AssetsContractControllerMethodName =>\n            !methodsExcludedFromMessenger.find((e) => e === key) &&\n            typeof this[key] === 'function')(method)\n        ) {\n          this.messagingSystem.registerActionHandler(\n            `${name}:${method}`,\n            // TODO: Write a generic for-loop implementation that iterates over an input union type in tandem with the input array.\n            // @ts-expect-error Both assigned argument and assignee parameter are using the entire union type for `method` instead of the type for the current element\n            this[method].bind(this),\n          );\n        }\n      },\n    );\n  }\n\n  #registerEventSubscriptions() {\n    this.messagingSystem.subscribe(\n      `PreferencesController:stateChange`,\n      ({ ipfsGateway }) => {\n        this.#ipfsGateway = ipfsGateway;\n      },\n    );\n\n    this.messagingSystem.subscribe(\n      `NetworkController:networkDidChange`,\n      ({ selectedNetworkClientId }) => {\n        const chainId = this.#getCorrectChainId(selectedNetworkClientId);\n\n        if (this.#chainId !== chainId) {\n          this.#chainId = chainId;\n          // @ts-expect-error TODO: remove this annotation once the `Eip1193Provider` class is released\n          this.#provider = this.#getCorrectProvider();\n        }\n      },\n    );\n  }\n\n  /**\n   * Sets a new provider.\n   *\n   * @param provider - Provider used to create a new underlying Web3 instance\n   */\n  setProvider(provider: Provider | undefined) {\n    this.#provider = provider;\n  }\n\n  get ipfsGateway() {\n    return this.#ipfsGateway;\n  }\n\n  get chainId() {\n    return this.#chainId;\n  }\n\n  /**\n   * Get the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID.\n   * @returns Web3Provider instance.\n   */\n  #getCorrectProvider(networkClientId?: NetworkClientId): Web3Provider {\n    const provider = networkClientId\n      ? this.messagingSystem.call(\n          `NetworkController:getNetworkClientById`,\n          networkClientId,\n        ).provider\n      : this.messagingSystem.call('NetworkController:getSelectedNetworkClient')\n          ?.provider ?? this.#provider;\n\n    if (provider === undefined) {\n      throw new Error(MISSING_PROVIDER_ERROR);\n    }\n\n    return new Web3Provider(provider);\n  }\n\n  /**\n   * Get the relevant chain ID.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns Hex chain ID.\n   */\n  #getCorrectChainId(networkClientId?: NetworkClientId): Hex {\n    if (networkClientId) {\n      const networkClientConfiguration = this.messagingSystem.call(\n        'NetworkController:getNetworkConfigurationByNetworkClientId',\n        networkClientId,\n      );\n      if (networkClientConfiguration) {\n        return networkClientConfiguration.chainId;\n      }\n    }\n    const { selectedNetworkClientId } = this.messagingSystem.call(\n      'NetworkController:getState',\n    );\n    const networkClient = this.messagingSystem.call(\n      'NetworkController:getNetworkClientById',\n      selectedNetworkClientId,\n    );\n    return networkClient.configuration?.chainId ?? this.#chainId;\n  }\n\n  /**\n   * Get a ERC20Standard instance using the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns ERC20Standard instance.\n   */\n  getERC20Standard(networkClientId?: NetworkClientId): ERC20Standard {\n    const provider = this.#getCorrectProvider(networkClientId);\n    return new ERC20Standard(provider);\n  }\n\n  /**\n   * Get a ERC721Standard instance using the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns ERC721Standard instance.\n   */\n  getERC721Standard(networkClientId?: NetworkClientId): ERC721Standard {\n    const provider = this.#getCorrectProvider(networkClientId);\n    return new ERC721Standard(provider);\n  }\n\n  /**\n   * Get a ERC1155Standard instance using the relevant provider instance.\n   *\n   * @param networkClientId - Network Client ID used to get the provider.\n   * @returns ERC1155Standard instance.\n   */\n  getERC1155Standard(networkClientId?: NetworkClientId): ERC1155Standard {\n    const provider = this.#getCorrectProvider(networkClientId);\n    return new ERC1155Standard(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   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to BN object containing balance for current account on specific asset contract.\n   */\n  async getERC20BalanceOf(\n    address: string,\n    selectedAddress: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<BN> {\n    const erc20Standard = this.getERC20Standard(networkClientId);\n    return erc20Standard.getBalanceOf(address, selectedAddress);\n  }\n\n  /**\n   * Query for the decimals for a given ERC20 asset.\n   *\n   * @param address - ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'decimals'.\n   */\n  async getERC20TokenDecimals(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc20Standard = this.getERC20Standard(networkClientId);\n    return erc20Standard.getTokenDecimals(address);\n  }\n\n  /**\n   * Query for the name for a given ERC20 asset.\n   *\n   * @param address - ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'decimals'.\n   */\n  async getERC20TokenName(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc20Standard = this.getERC20Standard(networkClientId);\n    return erc20Standard.getTokenName(address);\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   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to token identifier for the 'index'th asset assigned to 'selectedAddress'.\n   */\n  async getERC721NftTokenId(\n    address: string,\n    selectedAddress: string,\n    index: number,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getNftTokenId(address, selectedAddress, index);\n  }\n\n  /**\n   * Enumerate assets assigned to an owner.\n   *\n   * @param tokenAddress - ERC721 asset contract address.\n   * @param userAddress - Current account public address.\n   * @param tokenId - ERC721 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to an object containing the token standard and a set of details which depend on which standard the token supports.\n   */\n  async getTokenStandardAndDetails(\n    tokenAddress: string,\n    userAddress?: string,\n    tokenId?: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<{\n    standard: string;\n    tokenURI?: string | undefined;\n    symbol?: string | undefined;\n    name?: string | undefined;\n    decimals?: string | undefined;\n    balance?: BN | undefined;\n  }> {\n    // Asserts provider is available\n    this.#getCorrectProvider(networkClientId);\n\n    // ERC721\n    try {\n      const erc721Standard = this.getERC721Standard(networkClientId);\n      return {\n        ...(await erc721Standard.getDetails(\n          tokenAddress,\n          this.#ipfsGateway,\n          tokenId,\n        )),\n      };\n    } catch {\n      // Ignore\n    }\n\n    // ERC1155\n    try {\n      const erc1155Standard = this.getERC1155Standard(networkClientId);\n      return {\n        ...(await erc1155Standard.getDetails(\n          tokenAddress,\n          this.#ipfsGateway,\n          tokenId,\n        )),\n      };\n    } catch {\n      // Ignore\n    }\n\n    // ERC20\n    try {\n      const erc20Standard = this.getERC20Standard(networkClientId);\n      return {\n        ...(await erc20Standard.getDetails(tokenAddress, userAddress)),\n      };\n    } catch {\n      // Ignore\n    }\n\n    throw new Error('Unable to determine contract standard');\n  }\n\n  /**\n   * Query for tokenURI for a given ERC721 asset.\n   *\n   * @param address - ERC721 asset contract address.\n   * @param tokenId - ERC721 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'tokenURI'.\n   */\n  async getERC721TokenURI(\n    address: string,\n    tokenId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getTokenURI(address, tokenId);\n  }\n\n  /**\n   * Query for name for a given asset.\n   *\n   * @param address - ERC721 or ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'name'.\n   */\n  async getERC721AssetName(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getAssetName(address);\n  }\n\n  /**\n   * Query for symbol for a given asset.\n   *\n   * @param address - ERC721 or ERC20 asset contract address.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'symbol'.\n   */\n  async getERC721AssetSymbol(\n    address: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getAssetSymbol(address);\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   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the owner address.\n   */\n  async getERC721OwnerOf(\n    address: string,\n    tokenId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc721Standard = this.getERC721Standard(networkClientId);\n    return erc721Standard.getOwnerOf(address, tokenId);\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   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'tokenURI'.\n   */\n  async getERC1155TokenURI(\n    address: string,\n    tokenId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<string> {\n    const erc1155Standard = this.getERC1155Standard(networkClientId);\n    return erc1155Standard.getTokenURI(address, tokenId);\n  }\n\n  /**\n   * Query for balance of a given ERC 1155 token.\n   *\n   * @param userAddress - Wallet public address.\n   * @param nftAddress - ERC1155 asset contract address.\n   * @param nftId - ERC1155 asset identifier.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'balanceOf'.\n   */\n  async getERC1155BalanceOf(\n    userAddress: string,\n    nftAddress: string,\n    nftId: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<BN> {\n    const erc1155Standard = this.getERC1155Standard(networkClientId);\n    return erc1155Standard.getBalanceOf(nftAddress, userAddress, nftId);\n  }\n\n  /**\n   * Transfer single ERC1155 token.\n   *\n   * @param nftAddress - ERC1155 token address.\n   * @param senderAddress - ERC1155 token sender.\n   * @param recipientAddress - ERC1155 token recipient.\n   * @param nftId - ERC1155 token id.\n   * @param qty - Quantity of tokens to be sent.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns Promise resolving to the 'transferSingle' ERC1155 token.\n   */\n  async transferSingleERC1155(\n    nftAddress: string,\n    senderAddress: string,\n    recipientAddress: string,\n    nftId: string,\n    qty: string,\n    networkClientId?: NetworkClientId,\n  ): Promise<void> {\n    const erc1155Standard = this.getERC1155Standard(networkClientId);\n    return erc1155Standard.transferSingle(\n      nftAddress,\n      senderAddress,\n      recipientAddress,\n      nftId,\n      qty,\n    );\n  }\n\n  /**\n   * Get the token balance for a list of token addresses in a single call. Only non-zero balances\n   * are returned.\n   *\n   * @param selectedAddress - The address to check token balances for.\n   * @param tokensToDetect - The token addresses to detect balances for.\n   * @param networkClientId - Network Client ID to fetch the provider with.\n   * @returns The list of non-zero token balances.\n   */\n  async getBalancesInSingleCall(\n    selectedAddress: string,\n    tokensToDetect: string[],\n    networkClientId?: NetworkClientId,\n  ) {\n    const chainId = this.#getCorrectChainId(networkClientId);\n    const provider = this.#getCorrectProvider(networkClientId);\n    if (\n      !((id): id is keyof typeof SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID =>\n        id in SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID)(chainId)\n    ) {\n      // Only fetch balance if contract address exists\n      return {};\n    }\n    const contractAddress = SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID[chainId];\n\n    const contract = new Contract(\n      contractAddress,\n      abiSingleCallBalancesContract,\n      provider,\n    );\n    const result = await contract.balances([selectedAddress], tokensToDetect);\n    const nonZeroBalances: BalanceMap = {};\n    /* istanbul ignore else */\n    if (result.length > 0) {\n      tokensToDetect.forEach((tokenAddress, index) => {\n        const balance: BN = result[index];\n        /* istanbul ignore else */\n        if (String(balance) !== '0') {\n          nonZeroBalances[tokenAddress] = balance;\n        }\n      });\n    }\n    return nonZeroBalances;\n  }\n}\n\nexport default AssetsContractController;\n"]}

package/dist/CurrencyRateController.cjs

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrencyRateController = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const polling_controller_1 = require("@metamask/polling-controller");
+const async_mutex_1 = require("async-mutex");
+const crypto_compare_service_1 = require("./crypto-compare-service/index.cjs");
+const name = 'CurrencyRateController';
+const metadata = {
+    currentCurrency: { persist: true, anonymous: true },
+    currencyRates: { persist: true, anonymous: true },
+};
+const defaultState = {
+    currentCurrency: 'usd',
+    currencyRates: {
+        ETH: {
+            conversionDate: 0,
+            conversionRate: 0,
+            usdConversionRate: null,
+        },
+    },
+};
+/**
+ * Controller that passively polls on a set interval for an exchange rate from the current network
+ * asset to the user's preferred currency.
+ */
+class CurrencyRateController extends polling_controller_1.StaticIntervalPollingController {
+    /**
+     * Creates a CurrencyRateController instance.
+     *
+     * @param options - Constructor options.
+     * @param options.includeUsdRate - Keep track of the USD rate in addition to the current currency rate.
+     * @param options.interval - The polling interval, in milliseconds.
+     * @param options.messenger - A reference to the messaging system.
+     * @param options.state - Initial state to set on this controller.
+     * @param options.fetchExchangeRate - Fetches the exchange rate from an external API. This option is primarily meant for use in unit tests.
+     */
+    constructor({ includeUsdRate = false, interval = 180000, messenger, state, fetchExchangeRate = crypto_compare_service_1.fetchExchangeRate, }) {
+        super({
+            name,
+            metadata,
+            messenger,
+            state: { ...defaultState, ...state },
+        });
+        this.mutex = new async_mutex_1.Mutex();
+        this.includeUsdRate = includeUsdRate;
+        this.setIntervalLength(interval);
+        this.fetchExchangeRate = fetchExchangeRate;
+    }
+    /**
+     * Sets a currency to track.
+     *
+     * @param currentCurrency - ISO 4217 currency code.
+     */
+    async setCurrentCurrency(currentCurrency) {
+        const releaseLock = await this.mutex.acquire();
+        const nativeCurrencies = Object.keys(this.state.currencyRates);
+        try {
+            this.update(() => {
+                return {
+                    ...defaultState,
+                    currentCurrency,
+                };
+            });
+        }
+        finally {
+            releaseLock();
+        }
+        // TODO: Either fix this lint violation or explain why it's necessary to ignore.
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        nativeCurrencies.forEach(this.updateExchangeRate.bind(this));
+    }
+    /**
+     * Updates the exchange rate for the current currency and native currency pair.
+     *
+     * @param nativeCurrency - The ticker symbol for the chain.
+     */
+    async updateExchangeRate(nativeCurrency) {
+        const releaseLock = await this.mutex.acquire();
+        const { currentCurrency, currencyRates } = this.state;
+        let conversionDate = null;
+        let conversionRate = null;
+        let usdConversionRate = null;
+        // For preloaded testnets (Goerli, Sepolia) we want to fetch exchange rate for real ETH.
+        const nativeCurrencyForExchangeRate = Object.values(controller_utils_1.TESTNET_TICKER_SYMBOLS).includes(nativeCurrency)
+            ? controller_utils_1.FALL_BACK_VS_CURRENCY // ETH
+            : nativeCurrency;
+        let shouldUpdateState = true;
+        try {
+            if (currentCurrency &&
+                nativeCurrency &&
+                // if either currency is an empty string we can skip the comparison
+                // because it will result in an error from the api and ultimately
+                // a null conversionRate either way.
+                currentCurrency !== '' &&
+                nativeCurrency !== '') {
+                const fetchExchangeRateResponse = await this.fetchExchangeRate(currentCurrency, nativeCurrencyForExchangeRate, this.includeUsdRate);
+                conversionRate = fetchExchangeRateResponse.conversionRate;
+                usdConversionRate = fetchExchangeRateResponse.usdConversionRate;
+                conversionDate = Date.now() / 1000;
+            }
+        }
+        catch (error) {
+            if (!(error instanceof Error &&
+                error.message.includes('market does not exist for this coin pair'))) {
+                // Don't update state on transient / unexpected errors
+                shouldUpdateState = false;
+                throw error;
+            }
+        }
+        finally {
+            try {
+                if (shouldUpdateState) {
+                    this.update(() => {
+                        return {
+                            currencyRates: {
+                                ...currencyRates,
+                                [nativeCurrency]: {
+                                    conversionDate,
+                                    conversionRate,
+                                    usdConversionRate,
+                                },
+                            },
+                            currentCurrency,
+                        };
+                    });
+                }
+            }
+            finally {
+                releaseLock();
+            }
+        }
+    }
+    /**
+     * Prepare to discard this controller.
+     *
+     * This stops any active polling.
+     */
+    destroy() {
+        super.destroy();
+        this.stopAllPolling();
+    }
+    /**
+     * Updates exchange rate for the current currency.
+     *
+     * @param networkClientId - The network client ID used to get a ticker value.
+     * @returns The controller state.
+     */
+    async _executePoll(networkClientId) {
+        const networkClient = this.messagingSystem.call('NetworkController:getNetworkClientById', networkClientId);
+        await this.updateExchangeRate(networkClient.configuration.ticker);
+    }
+}
+exports.CurrencyRateController = CurrencyRateController;
+exports.default = CurrencyRateController;
+//# sourceMappingURL=CurrencyRateController.cjs.map