@metamask-previews/controller-utils 11.2.0-preview-9edcf0e0 → 11.2.0-preview-cf09c0a

package/dist/util.d.mts

@@ -0,0 +1,243 @@
+import type EthQuery from "@metamask/eth-query";
+import type { Hex, Json } from "@metamask/utils";
+import BN from "bn.js";
+export declare const PROTOTYPE_POLLUTION_BLOCKLIST: readonly ["__proto__", "constructor", "prototype"];
+/**
+ * Checks whether a dynamic property key could be used in
+ * a [prototype pollution attack](https://portswigger.net/web-security/prototype-pollution).
+ *
+ * @param key - The dynamic key to validate.
+ * @returns Whether the given dynamic key is safe to use.
+ */
+export declare function isSafeDynamicKey(key: string): boolean;
+/**
+ * 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.
+ */
+export declare function isSafeChainId(chainId: Hex): boolean;
+/**
+ * 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.
+ */
+export declare function BNToHex(inputBn: BN): `0x${string}`;
+/**
+ * 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.
+ */
+export declare function fractionBN(targetBN: BN, numerator: number | string, denominator: number | string): BN;
+/**
+ * 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.
+ */
+export declare function gweiDecToWEIBN(n: number | string): any;
+/**
+ * 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.
+ */
+export declare function weiHexToGweiDec(hex: string): any;
+/**
+ * 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.
+ */
+export declare function getBuyURL(networkCode?: string, address?: string, amount?: number): string | undefined;
+/**
+ * Converts a hex string to a BN object.
+ *
+ * @param inputHex - Number represented as a hex string.
+ * @returns A BN instance.
+ */
+export declare function hexToBN(inputHex: string): BN;
+/**
+ * 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.
+ */
+export declare function hexToText(hex: string): string;
+/**
+ * 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.
+ */
+export declare function fromHex(value: string | BN): BN;
+/**
+ * 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.
+ */
+export declare function toHex(value: number | bigint | string | BN): Hex;
+/**
+ * Execute and return an asynchronous operation without throwing errors.
+ *
+ * @param operation - Function returning a Promise.
+ * @param logError - Determines if the error should be logged.
+ * @template Result - Type of the result of the async operation
+ * @returns Promise resolving to the result of the async operation.
+ */
+export declare function safelyExecute<Result>(operation: () => Promise<Result>, logError?: boolean): Promise<Result | undefined>;
+/**
+ * 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.
+ * @template Result - Type of the result of the async operation
+ * @returns Promise resolving to the result of the async operation.
+ */
+export declare function safelyExecuteWithTimeout<Result>(operation: () => Promise<Result>, logError?: boolean, timeout?: number): Promise<Result | undefined>;
+/**
+ * Convert an address to a checksummed hexadecimal address.
+ *
+ * @param address - The address to convert.
+ * @returns The address in 0x-prefixed hexadecimal checksummed form if it is valid.
+ */
+export declare function toChecksumHexAddress(address: string): string;
+/**
+ * Convert an address to a checksummed hexadecimal address.
+ *
+ * Note that this particular overload does nothing.
+ *
+ * @param address - A value that is not a string (e.g. `undefined` or `null`).
+ * @returns The `address` untouched.
+ * @deprecated This overload is designed to gracefully handle an invalid input
+ * and is only present for backward compatibility. It may be removed in a future
+ * major version. Please pass a string to `toChecksumHexAddress` instead.
+ */
+export declare function toChecksumHexAddress<T>(address: T): T;
+/**
+ * Validates that the input is a hex address. This utility method is a thin
+ * wrapper around @metamask/utils.isValidHexAddress, with the exception that it
+ * by default will return true for hex strings that are otherwise valid
+ * hex addresses, 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.
+ */
+export declare function isValidHexAddress(possibleAddress: string, { allowNonPrefixed }?: {
+    allowNonPrefixed?: boolean | undefined;
+}): boolean;
+/**
+ * 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.
+ */
+export declare function isSmartContractCode(code: string): boolean;
+/**
+ * Execute fetch and verify that the response was successful.
+ *
+ * @param request - Request information.
+ * @param options - Fetch options.
+ * @returns The fetch response.
+ */
+export declare function successfulFetch(request: URL | RequestInfo, options?: RequestInit): Promise<Response>;
+/**
+ * Execute fetch and return object response.
+ *
+ * @param request - The request information.
+ * @param options - The fetch options.
+ * @returns The fetch response JSON data.
+ */
+export declare function handleFetch(request: URL | RequestInfo, options?: RequestInit): Promise<any>;
+/**
+ * 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).
+ */
+export declare function fetchWithErrorHandling({ url, options, timeout, errorCodesToCatch, }: {
+    url: string;
+    options?: RequestInit;
+    timeout?: number;
+    errorCodesToCatch?: number[];
+}): Promise<any>;
+/**
+ * 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.
+ */
+export declare function timeoutFetch(url: string, options?: RequestInit, timeout?: number): Promise<Response>;
+/**
+ * Normalizes the given ENS name.
+ *
+ * @param ensName - The ENS name.
+ * @returns The normalized ENS name string.
+ */
+export declare function normalizeEnsName(ensName: string): string | null;
+/**
+ * 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.
+ */
+export declare function query(ethQuery: EthQuery, method: string, args?: any[]): Promise<any>;
+/**
+ * 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.
+ */
+export declare const convertHexToDecimal: (value?: string | undefined) => number;
+type PlainObject = Record<number | string | symbol, unknown>;
+/**
+ * Determines whether a value is a "plain" object.
+ *
+ * @param value - A value to check
+ * @returns True if the passed value is a plain object
+ */
+export declare function isPlainObject(value: unknown): value is PlainObject;
+/**
+ * Like {@link Array}, but always non-empty.
+ *
+ * @template T - The non-empty array member type.
+ */
+export type NonEmptyArray<T> = [T, ...T[]];
+/**
+ * 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.
+ */
+export declare function isNonEmptyArray<T>(value: T[]): value is NonEmptyArray<T>;
+/**
+ * Type guard for {@link Json}.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is valid JSON.
+ */
+export declare function isValidJson(value: unknown): value is Json;
+export {};
+//# sourceMappingURL=util.d.mts.map

package/dist/util.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.mts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,QAAQ,4BAA4B;AAEhD,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,wBAAwB;AAOjD,OAAO,EAAE,cAAc;AAQvB,eAAO,MAAM,6BAA6B,oDAIhC,CAAC;AAEX;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAKrD;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAanD;AACD;;;;;GAKG;AAGH,wBAAgB,OAAO,CAAC,OAAO,EAAE,EAAE,iBAElC;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,EAAE,EACZ,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,WAAW,EAAE,MAAM,GAAG,MAAM,MAK7B;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,OA4BhD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,OAG1C;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,WAAW,SAAM,EACjB,OAAO,CAAC,EAAE,MAAM,EAChB,MAAM,SAAI,GACT,MAAM,GAAG,SAAS,CAapB;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,MAEvC;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,UASpC;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,EAAE,GAAG,EAAE,CAK9C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,EAAE,GAAG,GAAG,CAS/D;AAED;;;;;;;GAOG;AACH,wBAAsB,aAAa,CAAC,MAAM,EACxC,SAAS,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EAChC,QAAQ,UAAQ,GACf,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAU7B;AAED;;;;;;;;GAQG;AACH,wBAAsB,wBAAwB,CAAC,MAAM,EACnD,SAAS,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EAChC,QAAQ,UAAQ,EAChB,OAAO,SAAM,GACZ,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAiB7B;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;AAE9D;;;;;;;;;;GAUG;AAGH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;AAwBvD;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,eAAe,EAAE,MAAM,EACvB,EAAE,gBAAuB,EAAE;;CAAK,GAC/B,OAAO,CAST;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,WAQ/C;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CACnC,OAAO,EAAE,GAAG,GAAG,WAAW,EAC1B,OAAO,CAAC,EAAE,WAAW,qBAWtB;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAC/B,OAAO,EAAE,GAAG,GAAG,WAAW,EAC1B,OAAO,CAAC,EAAE,WAAW,gBAKtB;AAED;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAAC,EAC3C,GAAG,EACH,OAAO,EACP,OAAO,EACP,iBAAiB,GAClB,EAAE;IACD,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B,gBAmBA;AAED;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAChC,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,WAAW,EACrB,OAAO,SAAM,GACZ,OAAO,CAAC,QAAQ,CAAC,CASnB;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAkB/D;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,EAGd,IAAI,GAAE,GAAG,EAAO,GAGf,OAAO,CAAC,GAAG,CAAC,CAkBd;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,WACvB,MAAM,GAAG,SAAS,KACxB,MAMF,CAAC;AAEF,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;AAE7D;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAElE;AAED;;;;GAIG;AAGH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;AAE3C;;;;;;GAMG;AAGH,wBAAgB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,KAAK,IAAI,aAAa,CAAC,CAAC,CAAC,CAExE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAMzD"}