@metamask-previews/controller-utils 4.3.1-preview.d32a7cc

package/dist/util.js

@@ -0,0 +1,495 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidJson = exports.isNonEmptyArray = exports.isPlainObject = exports.convertHexToDecimal = exports.query = exports.normalizeEnsName = exports.timeoutFetch = exports.fetchWithErrorHandling = exports.handleFetch = exports.successfulFetch = exports.isSmartContractCode = exports.isValidHexAddress = exports.toChecksumHexAddress = exports.safelyExecuteWithTimeout = exports.safelyExecute = exports.toHex = exports.fromHex = exports.hexToText = exports.hexToBN = exports.getBuyURL = exports.weiHexToGweiDec = exports.gweiDecToWEIBN = exports.fractionBN = exports.BNToHex = exports.isSafeChainId = void 0;
+const utils_1 = require("@metamask/utils");
+const eth_ens_namehash_1 = __importDefault(require("eth-ens-namehash"));
+const ethereumjs_util_1 = require("ethereumjs-util");
+const ethjs_unit_1 = require("ethjs-unit");
+const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
+const constants_1 = require("./constants");
+const TIMEOUT_ERROR = new Error('timeout');
+/**
+ * Checks whether the given number primitive chain ID is safe.
+ * Because some cryptographic libraries we use expect the chain ID to be a
+ * number primitive, it must not exceed a certain size.
+ *
+ * @param chainId - The chain ID to check for safety.
+ * @returns Whether the given chain ID is safe.
+ */
+function isSafeChainId(chainId) {
+    if (!(0, ethereumjs_util_1.isHexString)(chainId)) {
+        return false;
+    }
+    const decimalChainId = Number.parseInt(chainId);
+    return (Number.isSafeInteger(decimalChainId) &&
+        decimalChainId > 0 &&
+        decimalChainId <= constants_1.MAX_SAFE_CHAIN_ID);
+}
+exports.isSafeChainId = isSafeChainId;
+/**
+ * Converts a BN object to a hex string with a '0x' prefix.
+ *
+ * @param inputBn - BN instance to convert to a hex string.
+ * @returns A '0x'-prefixed hex string.
+ */
+function BNToHex(inputBn) {
+    return (0, ethereumjs_util_1.addHexPrefix)(inputBn.toString(16));
+}
+exports.BNToHex = BNToHex;
+/**
+ * Used to multiply a BN by a fraction.
+ *
+ * @param targetBN - Number to multiply by a fraction.
+ * @param numerator - Numerator of the fraction multiplier.
+ * @param denominator - Denominator of the fraction multiplier.
+ * @returns Product of the multiplication.
+ */
+function fractionBN(targetBN, numerator, denominator) {
+    const numBN = new ethereumjs_util_1.BN(numerator);
+    const denomBN = new ethereumjs_util_1.BN(denominator);
+    return targetBN.mul(numBN).div(denomBN);
+}
+exports.fractionBN = fractionBN;
+/**
+ * Used to convert a base-10 number from GWEI to WEI. Can handle numbers with decimal parts.
+ *
+ * @param n - The base 10 number to convert to WEI.
+ * @returns The number in WEI, as a BN.
+ */
+function gweiDecToWEIBN(n) {
+    if (Number.isNaN(n)) {
+        return new ethereumjs_util_1.BN(0);
+    }
+    const parts = n.toString().split('.');
+    const wholePart = parts[0] || '0';
+    let decimalPart = parts[1] || '';
+    if (!decimalPart) {
+        return (0, ethjs_unit_1.toWei)(wholePart, 'gwei');
+    }
+    if (decimalPart.length <= 9) {
+        return (0, ethjs_unit_1.toWei)(`${wholePart}.${decimalPart}`, 'gwei');
+    }
+    const decimalPartToRemove = decimalPart.slice(9);
+    const decimalRoundingDigit = decimalPartToRemove[0];
+    decimalPart = decimalPart.slice(0, 9);
+    let wei = (0, ethjs_unit_1.toWei)(`${wholePart}.${decimalPart}`, 'gwei');
+    if (Number(decimalRoundingDigit) >= 5) {
+        wei = wei.add(new ethereumjs_util_1.BN(1));
+    }
+    return wei;
+}
+exports.gweiDecToWEIBN = gweiDecToWEIBN;
+/**
+ * Used to convert values from wei hex format to dec gwei format.
+ *
+ * @param hex - The value in hex wei.
+ * @returns The value in dec gwei as string.
+ */
+function weiHexToGweiDec(hex) {
+    const hexWei = new ethereumjs_util_1.BN((0, ethereumjs_util_1.stripHexPrefix)(hex), 16);
+    return (0, ethjs_unit_1.fromWei)(hexWei, 'gwei').toString(10);
+}
+exports.weiHexToGweiDec = weiHexToGweiDec;
+/**
+ * Return a URL that can be used to obtain ETH for a given network.
+ *
+ * @param networkCode - Network code of desired network.
+ * @param address - Address to deposit obtained ETH.
+ * @param amount - How much ETH is desired.
+ * @returns URL to buy ETH based on network.
+ */
+function getBuyURL(networkCode = '1', address, amount = 5) {
+    switch (networkCode) {
+        case '1':
+            return `https://buy.coinbase.com/?code=9ec56d01-7e81-5017-930c-513daa27bb6a&amount=${amount}&address=${address}&crypto_currency=ETH`;
+        case '5':
+            return 'https://goerli-faucet.slock.it/';
+        case '11155111':
+            return 'https://sepoliafaucet.net/';
+        default:
+            return undefined;
+    }
+}
+exports.getBuyURL = getBuyURL;
+/**
+ * Converts a hex string to a BN object.
+ *
+ * @param inputHex - Number represented as a hex string.
+ * @returns A BN instance.
+ */
+function hexToBN(inputHex) {
+    return inputHex ? new ethereumjs_util_1.BN((0, ethereumjs_util_1.stripHexPrefix)(inputHex), 16) : new ethereumjs_util_1.BN(0);
+}
+exports.hexToBN = hexToBN;
+/**
+ * A helper function that converts hex data to human readable string.
+ *
+ * @param hex - The hex string to convert to string.
+ * @returns A human readable string conversion.
+ */
+function hexToText(hex) {
+    try {
+        const stripped = (0, ethereumjs_util_1.stripHexPrefix)(hex);
+        const buff = Buffer.from(stripped, 'hex');
+        return buff.toString('utf8');
+    }
+    catch (e) {
+        /* istanbul ignore next */
+        return hex;
+    }
+}
+exports.hexToText = hexToText;
+/**
+ * Parses a hex string and converts it into a number that can be operated on in a bignum-safe,
+ * base-10 way.
+ *
+ * @param value - A base-16 number encoded as a string.
+ * @returns The number as a BN object in base-16 mode.
+ */
+function fromHex(value) {
+    if (ethereumjs_util_1.BN.isBN(value)) {
+        return value;
+    }
+    return new ethereumjs_util_1.BN(hexToBN(value).toString(10));
+}
+exports.fromHex = fromHex;
+/**
+ * Converts an integer to a hexadecimal representation.
+ *
+ * @param value - An integer, an integer encoded as a base-10 string, or a BN.
+ * @returns The integer encoded as a hex string.
+ */
+function toHex(value) {
+    if (typeof value === 'string' && (0, utils_1.isStrictHexString)(value)) {
+        return value;
+    }
+    const hexString = ethereumjs_util_1.BN.isBN(value)
+        ? value.toString(16)
+        : new ethereumjs_util_1.BN(value.toString(), 10).toString(16);
+    return `0x${hexString}`;
+}
+exports.toHex = toHex;
+/**
+ * Execute and return an asynchronous operation without throwing errors.
+ *
+ * @param operation - Function returning a Promise.
+ * @param logError - Determines if the error should be logged.
+ * @returns Promise resolving to the result of the async operation.
+ */
+function safelyExecute(operation, logError = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            return yield operation();
+        }
+        catch (error) {
+            /* istanbul ignore next */
+            if (logError) {
+                console.error(error);
+            }
+            return undefined;
+        }
+    });
+}
+exports.safelyExecute = safelyExecute;
+/**
+ * Execute and return an asynchronous operation with a timeout.
+ *
+ * @param operation - Function returning a Promise.
+ * @param logError - Determines if the error should be logged.
+ * @param timeout - Timeout to fail the operation.
+ * @returns Promise resolving to the result of the async operation.
+ */
+function safelyExecuteWithTimeout(operation, logError = false, timeout = 500) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            return yield Promise.race([
+                operation(),
+                new Promise((_, reject) => setTimeout(() => {
+                    reject(TIMEOUT_ERROR);
+                }, timeout)),
+            ]);
+        }
+        catch (error) {
+            /* istanbul ignore next */
+            if (logError) {
+                console.error(error);
+            }
+            return undefined;
+        }
+    });
+}
+exports.safelyExecuteWithTimeout = safelyExecuteWithTimeout;
+/**
+ * Convert an address to a checksummed hexidecimal address.
+ *
+ * @param address - The address to convert.
+ * @returns A 0x-prefixed hexidecimal checksummed address.
+ */
+function toChecksumHexAddress(address) {
+    const hexPrefixed = (0, ethereumjs_util_1.addHexPrefix)(address);
+    if (!(0, ethereumjs_util_1.isHexString)(hexPrefixed)) {
+        // Version 5.1 of ethereumjs-utils would have returned '0xY' for input 'y'
+        // but we shouldn't waste effort trying to change case on a clearly invalid
+        // string. Instead just return the hex prefixed original string which most
+        // closely mimics the original behavior.
+        return hexPrefixed;
+    }
+    return (0, ethereumjs_util_1.toChecksumAddress)(hexPrefixed);
+}
+exports.toChecksumHexAddress = toChecksumHexAddress;
+/**
+ * Validates that the input is a hex address. This utility method is a thin
+ * wrapper around ethereumjs-util.isValidAddress, with the exception that it
+ * by default will return true for hex strings that meet the length requirement
+ * of a hex address, but are not prefixed with `0x`.
+ *
+ * @param possibleAddress - Input parameter to check against.
+ * @param options - The validation options.
+ * @param options.allowNonPrefixed - If true will allow addresses without `0x` prefix.`
+ * @returns Whether or not the input is a valid hex address.
+ */
+function isValidHexAddress(possibleAddress, { allowNonPrefixed = true } = {}) {
+    const addressToCheck = allowNonPrefixed
+        ? (0, ethereumjs_util_1.addHexPrefix)(possibleAddress)
+        : possibleAddress;
+    if (!(0, ethereumjs_util_1.isHexString)(addressToCheck)) {
+        return false;
+    }
+    return (0, ethereumjs_util_1.isValidAddress)(addressToCheck);
+}
+exports.isValidHexAddress = isValidHexAddress;
+/**
+ * Returns whether the given code corresponds to a smart contract.
+ *
+ * @param code - The potential smart contract code.
+ * @returns Whether the code was smart contract code or not.
+ */
+function isSmartContractCode(code) {
+    /* istanbul ignore if */
+    if (!code) {
+        return false;
+    }
+    // Geth will return '0x', and ganache-core v2.2.1 will return '0x0'
+    const smartContractCode = code !== '0x' && code !== '0x0';
+    return smartContractCode;
+}
+exports.isSmartContractCode = isSmartContractCode;
+/**
+ * Execute fetch and verify that the response was successful.
+ *
+ * @param request - Request information.
+ * @param options - Fetch options.
+ * @returns The fetch response.
+ */
+function successfulFetch(request, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield fetch(request, options);
+        if (!response.ok) {
+            throw new Error(`Fetch failed with status '${response.status}' for request '${request}'`);
+        }
+        return response;
+    });
+}
+exports.successfulFetch = successfulFetch;
+/**
+ * Execute fetch and return object response.
+ *
+ * @param request - The request information.
+ * @param options - The fetch options.
+ * @returns The fetch response JSON data.
+ */
+function handleFetch(request, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield successfulFetch(request, options);
+        const object = yield response.json();
+        return object;
+    });
+}
+exports.handleFetch = handleFetch;
+/**
+ * Execute fetch and return object response, log if known error thrown, otherwise rethrow error.
+ *
+ * @param request - the request options object
+ * @param request.url - The request url to query.
+ * @param request.options - The fetch options.
+ * @param request.timeout - Timeout to fail request
+ * @param request.errorCodesToCatch - array of error codes for errors we want to catch in a particular context
+ * @returns The fetch response JSON data or undefined (if error occurs).
+ */
+function fetchWithErrorHandling({ url, options, timeout, errorCodesToCatch, }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let result;
+        try {
+            if (timeout) {
+                result = Promise.race([
+                    yield handleFetch(url, options),
+                    new Promise((_, reject) => setTimeout(() => {
+                        reject(TIMEOUT_ERROR);
+                    }, timeout)),
+                ]);
+            }
+            else {
+                result = yield handleFetch(url, options);
+            }
+        }
+        catch (e) {
+            logOrRethrowError(e, errorCodesToCatch);
+        }
+        return result;
+    });
+}
+exports.fetchWithErrorHandling = fetchWithErrorHandling;
+/**
+ * Fetch that fails after timeout.
+ *
+ * @param url - Url to fetch.
+ * @param options - Options to send with the request.
+ * @param timeout - Timeout to fail request.
+ * @returns Promise resolving the request.
+ */
+function timeoutFetch(url, options, timeout = 500) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return Promise.race([
+            successfulFetch(url, options),
+            new Promise((_, reject) => setTimeout(() => {
+                reject(TIMEOUT_ERROR);
+            }, timeout)),
+        ]);
+    });
+}
+exports.timeoutFetch = timeoutFetch;
+/**
+ * Normalizes the given ENS name.
+ *
+ * @param ensName - The ENS name.
+ * @returns The normalized ENS name string.
+ */
+function normalizeEnsName(ensName) {
+    if (ensName && typeof ensName === 'string') {
+        try {
+            const normalized = eth_ens_namehash_1.default.normalize(ensName.trim());
+            // this regex is only sufficient with the above call to ensNamehash.normalize
+            // TODO: change 7 in regex to 3 when shorter ENS domains are live
+            if (normalized.match(/^(([\w\d-]+)\.)*[\w\d-]{7,}\.(eth|test)$/u)) {
+                return normalized;
+            }
+        }
+        catch (_) {
+            // do nothing
+        }
+    }
+    return null;
+}
+exports.normalizeEnsName = normalizeEnsName;
+/**
+ * Wrapper method to handle EthQuery requests.
+ *
+ * @param ethQuery - EthQuery object initialized with a provider.
+ * @param method - Method to request.
+ * @param args - Arguments to send.
+ * @returns Promise resolving the request.
+ */
+function query(ethQuery, method, args = []) {
+    return new Promise((resolve, reject) => {
+        const cb = (error, result) => {
+            if (error) {
+                reject(error);
+                return;
+            }
+            resolve(result);
+        };
+        // Using `in` rather than `hasProperty` so that we look up the prototype
+        // chain for the method.
+        if (method in ethQuery && typeof ethQuery[method] === 'function') {
+            ethQuery[method](...args, cb);
+        }
+        else {
+            ethQuery.sendAsync({ method, params: args }, cb);
+        }
+    });
+}
+exports.query = query;
+/**
+ * Converts valid hex strings to decimal numbers, and handles unexpected arg types.
+ *
+ * @param value - a string that is either a hexadecimal with `0x` prefix or a decimal string.
+ * @returns a decimal number.
+ */
+const convertHexToDecimal = (value = '0x0') => {
+    if ((0, ethereumjs_util_1.isHexString)(value)) {
+        return parseInt(value, 16);
+    }
+    return Number(value) ? Number(value) : 0;
+};
+exports.convertHexToDecimal = convertHexToDecimal;
+/**
+ * Determines whether a value is a "plain" object.
+ *
+ * @param value - A value to check
+ * @returns True if the passed value is a plain object
+ */
+function isPlainObject(value) {
+    return Boolean(value) && typeof value === 'object' && !Array.isArray(value);
+}
+exports.isPlainObject = isPlainObject;
+/**
+ * Type guard for {@link NonEmptyArray}.
+ *
+ * @template T - The non-empty array member type.
+ * @param value - The value to check.
+ * @returns Whether the value is a non-empty array.
+ */
+function isNonEmptyArray(value) {
+    return Array.isArray(value) && value.length > 0;
+}
+exports.isNonEmptyArray = isNonEmptyArray;
+/**
+ * Type guard for {@link Json}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is valid JSON.
+ */
+function isValidJson(value) {
+    try {
+        return (0, fast_deep_equal_1.default)(value, JSON.parse(JSON.stringify(value)));
+    }
+    catch (_) {
+        return false;
+    }
+}
+exports.isValidJson = isValidJson;
+/**
+ * Utility method to log if error is a common fetch error and otherwise rethrow it.
+ *
+ * @param error - Caught error that we should either rethrow or log to console
+ * @param codesToCatch - array of error codes for errors we want to catch and log in a particular context
+ */
+function logOrRethrowError(error, codesToCatch = []) {
+    var _a;
+    if (!error) {
+        return;
+    }
+    const includesErrorCodeToCatch = codesToCatch.some((code) => { var _a; return (_a = error.message) === null || _a === void 0 ? void 0 : _a.includes(`Fetch failed with status '${code}'`); });
+    if (error instanceof Error &&
+        (includesErrorCodeToCatch ||
+            ((_a = error.message) === null || _a === void 0 ? void 0 : _a.includes('Failed to fetch')) ||
+            error === TIMEOUT_ERROR)) {
+        console.error(error);
+    }
+    else {
+        throw error;
+    }
+}
+//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,2CAAoD;AACpD,wEAA2C;AAC3C,qDAOyB;AACzB,2CAA4C;AAC5C,sEAAwC;AAExC,2CAAgD;AAEhD,MAAM,aAAa,GAAG,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;AAE3C;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,OAAY;IACxC,IAAI,CAAC,IAAA,6BAAW,EAAC,OAAO,CAAC,EAAE;QACzB,OAAO,KAAK,CAAC;KACd;IACD,MAAM,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChD,OAAO,CACL,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC;QACpC,cAAc,GAAG,CAAC;QAClB,cAAc,IAAI,6BAAiB,CACpC,CAAC;AACJ,CAAC;AAVD,sCAUC;AACD;;;;;GAKG;AACH,SAAgB,OAAO,CAAC,OAAY;IAClC,OAAO,IAAA,8BAAY,EAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;AAC5C,CAAC;AAFD,0BAEC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CACxB,QAAa,EACb,SAA0B,EAC1B,WAA4B;IAE5B,MAAM,KAAK,GAAG,IAAI,oBAAE,CAAC,SAAS,CAAC,CAAC;IAChC,MAAM,OAAO,GAAG,IAAI,oBAAE,CAAC,WAAW,CAAC,CAAC;IACpC,OAAO,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAC1C,CAAC;AARD,gCAQC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,CAAkB;IAC/C,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QACnB,OAAO,IAAI,oBAAE,CAAC,CAAC,CAAC,CAAC;KAClB;IAED,MAAM,KAAK,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC;IAClC,IAAI,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAEjC,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,IAAA,kBAAK,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC;KACjC;IAED,IAAI,WAAW,CAAC,MAAM,IAAI,CAAC,EAAE;QAC3B,OAAO,IAAA,kBAAK,EAAC,GAAG,SAAS,IAAI,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC;KACrD;IAED,MAAM,mBAAmB,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACjD,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAEpD,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACtC,IAAI,GAAG,GAAG,IAAA,kBAAK,EAAC,GAAG,SAAS,IAAI,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC;IAEvD,IAAI,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE;QACrC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,oBAAE,CAAC,CAAC,CAAC,CAAC,CAAC;KAC1B;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AA5BD,wCA4BC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,GAAW;IACzC,MAAM,MAAM,GAAG,IAAI,oBAAE,CAAC,IAAA,gCAAc,EAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/C,OAAO,IAAA,oBAAO,EAAC,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AAC9C,CAAC;AAHD,0CAGC;AAED;;;;;;;GAOG;AACH,SAAgB,SAAS,CACvB,WAAW,GAAG,GAAG,EACjB,OAAgB,EAChB,MAAM,GAAG,CAAC;IAEV,QAAQ,WAAW,EAAE;QACnB,KAAK,GAAG;YACN,OAAO,8EAA8E,MAAM,YAAY,OAAO,sBAAsB,CAAC;QACvI,KAAK,GAAG;YACN,OAAO,iCAAiC,CAAC;QAC3C,KAAK,UAAU;YACb,OAAO,4BAA4B,CAAC;QACtC;YACE,OAAO,SAAS,CAAC;KACpB;AACH,CAAC;AAfD,8BAeC;AAED;;;;;GAKG;AACH,SAAgB,OAAO,CAAC,QAAgB;IACtC,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,oBAAE,CAAC,IAAA,gCAAc,EAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,oBAAE,CAAC,CAAC,CAAC,CAAC;AACrE,CAAC;AAFD,0BAEC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,GAAW;IACnC,IAAI;QACF,MAAM,QAAQ,GAAG,IAAA,gCAAc,EAAC,GAAG,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KAC9B;IAAC,OAAO,CAAC,EAAE;QACV,0BAA0B;QAC1B,OAAO,GAAG,CAAC;KACZ;AACH,CAAC;AATD,8BASC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAAC,KAAkB;IACxC,IAAI,oBAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;QAClB,OAAO,KAAK,CAAC;KACd;IACD,OAAO,IAAI,oBAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;AAC7C,CAAC;AALD,0BAKC;AAED;;;;;GAKG;AACH,SAAgB,KAAK,CAAC,KAA2B;IAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAA,yBAAiB,EAAC,KAAK,CAAC,EAAE;QACzD,OAAO,KAAK,CAAC;KACd;IACD,MAAM,SAAS,GAAG,oBAAE,CAAC,IAAI,CAAC,KAAK,CAAC;QAC9B,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpB,CAAC,CAAC,IAAI,oBAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC9C,OAAO,KAAK,SAAS,EAAE,CAAC;AAC1B,CAAC;AARD,sBAQC;AAED;;;;;;GAMG;AACH,SAAsB,aAAa,CACjC,SAA6B,EAC7B,QAAQ,GAAG,KAAK;;QAEhB,IAAI;YACF,OAAO,MAAM,SAAS,EAAE,CAAC;SAC1B;QAAC,OAAO,KAAU,EAAE;YACnB,0BAA0B;YAC1B,IAAI,QAAQ,EAAE;gBACZ,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACtB;YACD,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;CAAA;AAbD,sCAaC;AAED;;;;;;;GAOG;AACH,SAAsB,wBAAwB,CAC5C,SAA6B,EAC7B,QAAQ,GAAG,KAAK,EAChB,OAAO,GAAG,GAAG;;QAEb,IAAI;YACF,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC;gBACxB,SAAS,EAAE;gBACX,IAAI,OAAO,CAAO,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAC9B,UAAU,CAAC,GAAG,EAAE;oBACd,MAAM,CAAC,aAAa,CAAC,CAAC;gBACxB,CAAC,EAAE,OAAO,CAAC,CACZ;aACF,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,0BAA0B;YAC1B,IAAI,QAAQ,EAAE;gBACZ,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACtB;YACD,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;CAAA;AArBD,4DAqBC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,OAAe;IAClD,MAAM,WAAW,GAAG,IAAA,8BAAY,EAAC,OAAO,CAAC,CAAC;IAC1C,IAAI,CAAC,IAAA,6BAAW,EAAC,WAAW,CAAC,EAAE;QAC7B,0EAA0E;QAC1E,2EAA2E;QAC3E,0EAA0E;QAC1E,wCAAwC;QACxC,OAAO,WAAW,CAAC;KACpB;IACD,OAAO,IAAA,mCAAiB,EAAC,WAAW,CAAC,CAAC;AACxC,CAAC;AAVD,oDAUC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAC/B,eAAuB,EACvB,EAAE,gBAAgB,GAAG,IAAI,EAAE,GAAG,EAAE;IAEhC,MAAM,cAAc,GAAG,gBAAgB;QACrC,CAAC,CAAC,IAAA,8BAAY,EAAC,eAAe,CAAC;QAC/B,CAAC,CAAC,eAAe,CAAC;IACpB,IAAI,CAAC,IAAA,6BAAW,EAAC,cAAc,CAAC,EAAE;QAChC,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAA,gCAAc,EAAC,cAAc,CAAC,CAAC;AACxC,CAAC;AAZD,8CAYC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,IAAY;IAC9C,wBAAwB;IACxB,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,KAAK,CAAC;KACd;IACD,mEAAmE;IACnE,MAAM,iBAAiB,GAAG,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,CAAC;IAC1D,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AARD,kDAQC;AAED;;;;;;GAMG;AACH,SAAsB,eAAe,CAAC,OAAe,EAAE,OAAqB;;QAC1E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CACb,6BAA6B,QAAQ,CAAC,MAAM,kBAAkB,OAAO,GAAG,CACzE,CAAC;SACH;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;CAAA;AARD,0CAQC;AAED;;;;;;GAMG;AACH,SAAsB,WAAW,CAAC,OAAe,EAAE,OAAqB;;QACtE,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;CAAA;AAJD,kCAIC;AAED;;;;;;;;;GASG;AACH,SAAsB,sBAAsB,CAAC,EAC3C,GAAG,EACH,OAAO,EACP,OAAO,EACP,iBAAiB,GAMlB;;QACC,IAAI,MAAM,CAAC;QACX,IAAI;YACF,IAAI,OAAO,EAAE;gBACX,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;oBACpB,MAAM,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC;oBAC/B,IAAI,OAAO,CAAW,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAClC,UAAU,CAAC,GAAG,EAAE;wBACd,MAAM,CAAC,aAAa,CAAC,CAAC;oBACxB,CAAC,EAAE,OAAO,CAAC,CACZ;iBACF,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;aAC1C;SACF;QAAC,OAAO,CAAC,EAAE;YACV,iBAAiB,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;SACzC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CAAA;AA7BD,wDA6BC;AAED;;;;;;;GAOG;AACH,SAAsB,YAAY,CAChC,GAAW,EACX,OAAqB,EACrB,OAAO,GAAG,GAAG;;QAEb,OAAO,OAAO,CAAC,IAAI,CAAC;YAClB,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC;YAC7B,IAAI,OAAO,CAAW,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAClC,UAAU,CAAC,GAAG,EAAE;gBACd,MAAM,CAAC,aAAa,CAAC,CAAC;YACxB,CAAC,EAAE,OAAO,CAAC,CACZ;SACF,CAAC,CAAC;IACL,CAAC;CAAA;AAbD,oCAaC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,OAAe;IAC9C,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC1C,IAAI;YACF,MAAM,UAAU,GAAG,0BAAW,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YACzD,6EAA6E;YAC7E,iEAAiE;YACjE,IAAI,UAAU,CAAC,KAAK,CAAC,2CAA2C,CAAC,EAAE;gBACjE,OAAO,UAAU,CAAC;aACnB;SACF;QAAC,OAAO,CAAC,EAAE;YACV,aAAa;SACd;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAdD,4CAcC;AAED;;;;;;;GAOG;AACH,SAAgB,KAAK,CACnB,QAAkB,EAClB,MAAc,EACd,OAAc,EAAE;IAEhB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,EAAE,GAAG,CAAC,KAAc,EAAE,MAAe,EAAE,EAAE;YAC7C,IAAI,KAAK,EAAE;gBACT,MAAM,CAAC,KAAK,CAAC,CAAC;gBACd,OAAO;aACR;YACD,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,CAAC;QAEF,wEAAwE;QACxE,wBAAwB;QACxB,IAAI,MAAM,IAAI,QAAQ,IAAI,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,UAAU,EAAE;YAChE,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,CAAC;SAC/B;aAAM;YACL,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;SAClD;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAtBD,sBAsBC;AAED;;;;;GAKG;AACI,MAAM,mBAAmB,GAAG,CACjC,QAA4B,KAAK,EACzB,EAAE;IACV,IAAI,IAAA,6BAAW,EAAC,KAAK,CAAC,EAAE;QACtB,OAAO,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;KAC5B;IAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AARW,QAAA,mBAAmB,uBAQ9B;AAIF;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,KAAc;IAC1C,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAFD,sCAEC;AASD;;;;;;GAMG;AACH,SAAgB,eAAe,CAAI,KAAU;IAC3C,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAClD,CAAC;AAFD,0CAEC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,IAAI;QACF,OAAO,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC5D;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAND,kCAMC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,KAAU,EAAE,eAAyB,EAAE;;IAChE,IAAI,CAAC,KAAK,EAAE;QACV,OAAO;KACR;IAED,MAAM,wBAAwB,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,WAC1D,OAAA,MAAA,KAAK,CAAC,OAAO,0CAAE,QAAQ,CAAC,6BAA6B,IAAI,GAAG,CAAC,CAAA,EAAA,CAC9D,CAAC;IAEF,IACE,KAAK,YAAY,KAAK;QACtB,CAAC,wBAAwB;aACvB,MAAA,KAAK,CAAC,OAAO,0CAAE,QAAQ,CAAC,iBAAiB,CAAC,CAAA;YAC1C,KAAK,KAAK,aAAa,CAAC,EAC1B;QACA,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACtB;SAAM;QACL,MAAM,KAAK,CAAC;KACb;AACH,CAAC","sourcesContent":["import type EthQuery from '@metamask/eth-query';\nimport type { Hex, Json } from '@metamask/utils';\nimport { isStrictHexString } from '@metamask/utils';\nimport ensNamehash from 'eth-ens-namehash';\nimport {\n  addHexPrefix,\n  isValidAddress,\n  isHexString,\n  BN,\n  toChecksumAddress,\n  stripHexPrefix,\n} from 'ethereumjs-util';\nimport { fromWei, toWei } from 'ethjs-unit';\nimport deepEqual from 'fast-deep-equal';\n\nimport { MAX_SAFE_CHAIN_ID } from './constants';\n\nconst TIMEOUT_ERROR = new Error('timeout');\n\n/**\n * Checks whether the given number primitive chain ID is safe.\n * Because some cryptographic libraries we use expect the chain ID to be a\n * number primitive, it must not exceed a certain size.\n *\n * @param chainId - The chain ID to check for safety.\n * @returns Whether the given chain ID is safe.\n */\nexport function isSafeChainId(chainId: Hex): boolean {\n  if (!isHexString(chainId)) {\n    return false;\n  }\n  const decimalChainId = Number.parseInt(chainId);\n  return (\n    Number.isSafeInteger(decimalChainId) &&\n    decimalChainId > 0 &&\n    decimalChainId <= MAX_SAFE_CHAIN_ID\n  );\n}\n/**\n * Converts a BN object to a hex string with a '0x' prefix.\n *\n * @param inputBn - BN instance to convert to a hex string.\n * @returns A '0x'-prefixed hex string.\n */\nexport function BNToHex(inputBn: any) {\n  return addHexPrefix(inputBn.toString(16));\n}\n\n/**\n * Used to multiply a BN by a fraction.\n *\n * @param targetBN - Number to multiply by a fraction.\n * @param numerator - Numerator of the fraction multiplier.\n * @param denominator - Denominator of the fraction multiplier.\n * @returns Product of the multiplication.\n */\nexport function fractionBN(\n  targetBN: any,\n  numerator: number | string,\n  denominator: number | string,\n) {\n  const numBN = new BN(numerator);\n  const denomBN = new BN(denominator);\n  return targetBN.mul(numBN).div(denomBN);\n}\n\n/**\n * Used to convert a base-10 number from GWEI to WEI. Can handle numbers with decimal parts.\n *\n * @param n - The base 10 number to convert to WEI.\n * @returns The number in WEI, as a BN.\n */\nexport function gweiDecToWEIBN(n: number | string) {\n  if (Number.isNaN(n)) {\n    return new BN(0);\n  }\n\n  const parts = n.toString().split('.');\n  const wholePart = parts[0] || '0';\n  let decimalPart = parts[1] || '';\n\n  if (!decimalPart) {\n    return toWei(wholePart, 'gwei');\n  }\n\n  if (decimalPart.length <= 9) {\n    return toWei(`${wholePart}.${decimalPart}`, 'gwei');\n  }\n\n  const decimalPartToRemove = decimalPart.slice(9);\n  const decimalRoundingDigit = decimalPartToRemove[0];\n\n  decimalPart = decimalPart.slice(0, 9);\n  let wei = toWei(`${wholePart}.${decimalPart}`, 'gwei');\n\n  if (Number(decimalRoundingDigit) >= 5) {\n    wei = wei.add(new BN(1));\n  }\n\n  return wei;\n}\n\n/**\n * Used to convert values from wei hex format to dec gwei format.\n *\n * @param hex - The value in hex wei.\n * @returns The value in dec gwei as string.\n */\nexport function weiHexToGweiDec(hex: string) {\n  const hexWei = new BN(stripHexPrefix(hex), 16);\n  return fromWei(hexWei, 'gwei').toString(10);\n}\n\n/**\n * Return a URL that can be used to obtain ETH for a given network.\n *\n * @param networkCode - Network code of desired network.\n * @param address - Address to deposit obtained ETH.\n * @param amount - How much ETH is desired.\n * @returns URL to buy ETH based on network.\n */\nexport function getBuyURL(\n  networkCode = '1',\n  address?: string,\n  amount = 5,\n): string | undefined {\n  switch (networkCode) {\n    case '1':\n      return `https://buy.coinbase.com/?code=9ec56d01-7e81-5017-930c-513daa27bb6a&amount=${amount}&address=${address}&crypto_currency=ETH`;\n    case '5':\n      return 'https://goerli-faucet.slock.it/';\n    case '11155111':\n      return 'https://sepoliafaucet.net/';\n    default:\n      return undefined;\n  }\n}\n\n/**\n * Converts a hex string to a BN object.\n *\n * @param inputHex - Number represented as a hex string.\n * @returns A BN instance.\n */\nexport function hexToBN(inputHex: string) {\n  return inputHex ? new BN(stripHexPrefix(inputHex), 16) : new BN(0);\n}\n\n/**\n * A helper function that converts hex data to human readable string.\n *\n * @param hex - The hex string to convert to string.\n * @returns A human readable string conversion.\n */\nexport function hexToText(hex: string) {\n  try {\n    const stripped = stripHexPrefix(hex);\n    const buff = Buffer.from(stripped, 'hex');\n    return buff.toString('utf8');\n  } catch (e) {\n    /* istanbul ignore next */\n    return hex;\n  }\n}\n\n/**\n * Parses a hex string and converts it into a number that can be operated on in a bignum-safe,\n * base-10 way.\n *\n * @param value - A base-16 number encoded as a string.\n * @returns The number as a BN object in base-16 mode.\n */\nexport function fromHex(value: string | BN): BN {\n  if (BN.isBN(value)) {\n    return value;\n  }\n  return new BN(hexToBN(value).toString(10));\n}\n\n/**\n * Converts an integer to a hexadecimal representation.\n *\n * @param value - An integer, an integer encoded as a base-10 string, or a BN.\n * @returns The integer encoded as a hex string.\n */\nexport function toHex(value: number | string | BN): Hex {\n  if (typeof value === 'string' && isStrictHexString(value)) {\n    return value;\n  }\n  const hexString = BN.isBN(value)\n    ? value.toString(16)\n    : new BN(value.toString(), 10).toString(16);\n  return `0x${hexString}`;\n}\n\n/**\n * Execute and return an asynchronous operation without throwing errors.\n *\n * @param operation - Function returning a Promise.\n * @param logError - Determines if the error should be logged.\n * @returns Promise resolving to the result of the async operation.\n */\nexport async function safelyExecute(\n  operation: () => Promise<any>,\n  logError = false,\n) {\n  try {\n    return await operation();\n  } catch (error: any) {\n    /* istanbul ignore next */\n    if (logError) {\n      console.error(error);\n    }\n    return undefined;\n  }\n}\n\n/**\n * Execute and return an asynchronous operation with a timeout.\n *\n * @param operation - Function returning a Promise.\n * @param logError - Determines if the error should be logged.\n * @param timeout - Timeout to fail the operation.\n * @returns Promise resolving to the result of the async operation.\n */\nexport async function safelyExecuteWithTimeout(\n  operation: () => Promise<any>,\n  logError = false,\n  timeout = 500,\n) {\n  try {\n    return await Promise.race([\n      operation(),\n      new Promise<void>((_, reject) =>\n        setTimeout(() => {\n          reject(TIMEOUT_ERROR);\n        }, timeout),\n      ),\n    ]);\n  } catch (error) {\n    /* istanbul ignore next */\n    if (logError) {\n      console.error(error);\n    }\n    return undefined;\n  }\n}\n\n/**\n * Convert an address to a checksummed hexidecimal address.\n *\n * @param address - The address to convert.\n * @returns A 0x-prefixed hexidecimal checksummed address.\n */\nexport function toChecksumHexAddress(address: string) {\n  const hexPrefixed = addHexPrefix(address);\n  if (!isHexString(hexPrefixed)) {\n    // Version 5.1 of ethereumjs-utils would have returned '0xY' for input 'y'\n    // but we shouldn't waste effort trying to change case on a clearly invalid\n    // string. Instead just return the hex prefixed original string which most\n    // closely mimics the original behavior.\n    return hexPrefixed;\n  }\n  return toChecksumAddress(hexPrefixed);\n}\n\n/**\n * Validates that the input is a hex address. This utility method is a thin\n * wrapper around ethereumjs-util.isValidAddress, with the exception that it\n * by default will return true for hex strings that meet the length requirement\n * of a hex address, but are not prefixed with `0x`.\n *\n * @param possibleAddress - Input parameter to check against.\n * @param options - The validation options.\n * @param options.allowNonPrefixed - If true will allow addresses without `0x` prefix.`\n * @returns Whether or not the input is a valid hex address.\n */\nexport function isValidHexAddress(\n  possibleAddress: string,\n  { allowNonPrefixed = true } = {},\n) {\n  const addressToCheck = allowNonPrefixed\n    ? addHexPrefix(possibleAddress)\n    : possibleAddress;\n  if (!isHexString(addressToCheck)) {\n    return false;\n  }\n\n  return isValidAddress(addressToCheck);\n}\n\n/**\n * Returns whether the given code corresponds to a smart contract.\n *\n * @param code - The potential smart contract code.\n * @returns Whether the code was smart contract code or not.\n */\nexport function isSmartContractCode(code: string) {\n  /* istanbul ignore if */\n  if (!code) {\n    return false;\n  }\n  // Geth will return '0x', and ganache-core v2.2.1 will return '0x0'\n  const smartContractCode = code !== '0x' && code !== '0x0';\n  return smartContractCode;\n}\n\n/**\n * Execute fetch and verify that the response was successful.\n *\n * @param request - Request information.\n * @param options - Fetch options.\n * @returns The fetch response.\n */\nexport async function successfulFetch(request: string, options?: RequestInit) {\n  const response = await fetch(request, options);\n  if (!response.ok) {\n    throw new Error(\n      `Fetch failed with status '${response.status}' for request '${request}'`,\n    );\n  }\n  return response;\n}\n\n/**\n * Execute fetch and return object response.\n *\n * @param request - The request information.\n * @param options - The fetch options.\n * @returns The fetch response JSON data.\n */\nexport async function handleFetch(request: string, options?: RequestInit) {\n  const response = await successfulFetch(request, options);\n  const object = await response.json();\n  return object;\n}\n\n/**\n * Execute fetch and return object response, log if known error thrown, otherwise rethrow error.\n *\n * @param request - the request options object\n * @param request.url - The request url to query.\n * @param request.options - The fetch options.\n * @param request.timeout - Timeout to fail request\n * @param request.errorCodesToCatch - array of error codes for errors we want to catch in a particular context\n * @returns The fetch response JSON data or undefined (if error occurs).\n */\nexport async function fetchWithErrorHandling({\n  url,\n  options,\n  timeout,\n  errorCodesToCatch,\n}: {\n  url: string;\n  options?: RequestInit;\n  timeout?: number;\n  errorCodesToCatch?: number[];\n}) {\n  let result;\n  try {\n    if (timeout) {\n      result = Promise.race([\n        await handleFetch(url, options),\n        new Promise<Response>((_, reject) =>\n          setTimeout(() => {\n            reject(TIMEOUT_ERROR);\n          }, timeout),\n        ),\n      ]);\n    } else {\n      result = await handleFetch(url, options);\n    }\n  } catch (e) {\n    logOrRethrowError(e, errorCodesToCatch);\n  }\n  return result;\n}\n\n/**\n * Fetch that fails after timeout.\n *\n * @param url - Url to fetch.\n * @param options - Options to send with the request.\n * @param timeout - Timeout to fail request.\n * @returns Promise resolving the request.\n */\nexport async function timeoutFetch(\n  url: string,\n  options?: RequestInit,\n  timeout = 500,\n): Promise<Response> {\n  return Promise.race([\n    successfulFetch(url, options),\n    new Promise<Response>((_, reject) =>\n      setTimeout(() => {\n        reject(TIMEOUT_ERROR);\n      }, timeout),\n    ),\n  ]);\n}\n\n/**\n * Normalizes the given ENS name.\n *\n * @param ensName - The ENS name.\n * @returns The normalized ENS name string.\n */\nexport function normalizeEnsName(ensName: string): string | null {\n  if (ensName && typeof ensName === 'string') {\n    try {\n      const normalized = ensNamehash.normalize(ensName.trim());\n      // this regex is only sufficient with the above call to ensNamehash.normalize\n      // TODO: change 7 in regex to 3 when shorter ENS domains are live\n      if (normalized.match(/^(([\\w\\d-]+)\\.)*[\\w\\d-]{7,}\\.(eth|test)$/u)) {\n        return normalized;\n      }\n    } catch (_) {\n      // do nothing\n    }\n  }\n  return null;\n}\n\n/**\n * Wrapper method to handle EthQuery requests.\n *\n * @param ethQuery - EthQuery object initialized with a provider.\n * @param method - Method to request.\n * @param args - Arguments to send.\n * @returns Promise resolving the request.\n */\nexport function query(\n  ethQuery: EthQuery,\n  method: string,\n  args: any[] = [],\n): Promise<any> {\n  return new Promise((resolve, reject) => {\n    const cb = (error: unknown, result: unknown) => {\n      if (error) {\n        reject(error);\n        return;\n      }\n      resolve(result);\n    };\n\n    // Using `in` rather than `hasProperty` so that we look up the prototype\n    // chain for the method.\n    if (method in ethQuery && typeof ethQuery[method] === 'function') {\n      ethQuery[method](...args, cb);\n    } else {\n      ethQuery.sendAsync({ method, params: args }, cb);\n    }\n  });\n}\n\n/**\n * Converts valid hex strings to decimal numbers, and handles unexpected arg types.\n *\n * @param value - a string that is either a hexadecimal with `0x` prefix or a decimal string.\n * @returns a decimal number.\n */\nexport const convertHexToDecimal = (\n  value: string | undefined = '0x0',\n): number => {\n  if (isHexString(value)) {\n    return parseInt(value, 16);\n  }\n\n  return Number(value) ? Number(value) : 0;\n};\n\ntype PlainObject = Record<number | string | symbol, unknown>;\n\n/**\n * Determines whether a value is a \"plain\" object.\n *\n * @param value - A value to check\n * @returns True if the passed value is a plain object\n */\nexport function isPlainObject(value: unknown): value is PlainObject {\n  return Boolean(value) && typeof value === 'object' && !Array.isArray(value);\n}\n\n/**\n * Like {@link Array}, but always non-empty.\n *\n * @template T - The non-empty array member type.\n */\nexport type NonEmptyArray<T> = [T, ...T[]];\n\n/**\n * Type guard for {@link NonEmptyArray}.\n *\n * @template T - The non-empty array member type.\n * @param value - The value to check.\n * @returns Whether the value is a non-empty array.\n */\nexport function isNonEmptyArray<T>(value: T[]): value is NonEmptyArray<T> {\n  return Array.isArray(value) && value.length > 0;\n}\n\n/**\n * Type guard for {@link Json}.\n *\n * @param value - The value to check.\n * @returns Whether the value is valid JSON.\n */\nexport function isValidJson(value: unknown): value is Json {\n  try {\n    return deepEqual(value, JSON.parse(JSON.stringify(value)));\n  } catch (_) {\n    return false;\n  }\n}\n\n/**\n * Utility method to log if error is a common fetch error and otherwise rethrow it.\n *\n * @param error - Caught error that we should either rethrow or log to console\n * @param codesToCatch - array of error codes for errors we want to catch and log in a particular context\n */\nfunction logOrRethrowError(error: any, codesToCatch: number[] = []) {\n  if (!error) {\n    return;\n  }\n\n  const includesErrorCodeToCatch = codesToCatch.some((code) =>\n    error.message?.includes(`Fetch failed with status '${code}'`),\n  );\n\n  if (\n    error instanceof Error &&\n    (includesErrorCodeToCatch ||\n      error.message?.includes('Failed to fetch') ||\n      error === TIMEOUT_ERROR)\n  ) {\n    console.error(error);\n  } else {\n    throw error;\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@metamask-previews/controller-utils",
+  "version": "4.3.1-preview.d32a7cc",
+  "description": "Data and convenience functions shared by multiple packages",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/controller-utils#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build:docs": "typedoc",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/controller-utils",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@metamask/eth-query": "^3.0.1",
+    "@metamask/utils": "^6.2.0",
+    "@spruceid/siwe-parser": "1.1.3",
+    "eth-ens-namehash": "^2.0.8",
+    "eth-rpc-errors": "^4.0.2",
+    "ethereumjs-util": "^7.0.10",
+    "ethjs-unit": "^0.1.6",
+    "fast-deep-equal": "^3.1.3"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.1.0",
+    "@types/jest": "^27.4.1",
+    "abort-controller": "^3.0.0",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "nock": "^13.3.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.22.15",
+    "typedoc-plugin-missing-exports": "^0.22.6",
+    "typescript": "~4.6.3"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}