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

package/dist/siwe.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectSIWE = exports.isValidSIWEOrigin = exports.parseDomainParts = void 0;
+const siwe_parser_1 = require("@spruceid/siwe-parser");
+const ethereumjs_util_1 = require("ethereumjs-util");
+const logger_1 = require("./logger");
+const log = (0, logger_1.createModuleLogger)(logger_1.projectLogger, 'detect-siwe');
+/**
+ * This function strips the hex prefix from a string if it has one.
+ *
+ * @param str - The string to check
+ * @returns The string without the hex prefix
+ */
+function stripHexPrefix(str) {
+    if (typeof str !== 'string') {
+        return str;
+    }
+    return (0, ethereumjs_util_1.isHexPrefixed)(str) ? str.slice(2) : str;
+}
+/**
+ * This function converts a hex string to text if it's not a 32 byte hex string.
+ *
+ * @param hex - The hex string to convert to text
+ * @returns The text representation of the hex string
+ */
+function msgHexToText(hex) {
+    try {
+        const stripped = stripHexPrefix(hex);
+        const buff = Buffer.from(stripped, 'hex');
+        return buff.length === 32 ? hex : buff.toString('utf8');
+    }
+    catch (e) {
+        log(e);
+        return hex;
+    }
+}
+const DEFAULT_PORTS_BY_PROTOCOL = {
+    'http:': '80',
+    'https:': '443',
+};
+/**
+ * Parses parts from RFC 3986 authority from EIP-4361 `domain` field.
+ *
+ * @param domain - input string
+ * @param originProtocol - implied protocol from origin
+ * @returns parsed parts
+ */
+const parseDomainParts = (domain, originProtocol) => {
+    if (domain.match(/^[^/:]*:\/\//u)) {
+        return new URL(domain);
+    }
+    return new URL(`${originProtocol}//${domain}`);
+};
+exports.parseDomainParts = parseDomainParts;
+/**
+ * Validates origin of a Sign-In With Ethereum (SIWE)(EIP-4361) request.
+ * As per spec:
+ * hostname must match.
+ * port and username must match iff specified.
+ * Protocol binding and full same-origin are currently not performed.
+ *
+ * @param req - Signature request
+ * @returns true if origin matches domain; false otherwise
+ */
+const isValidSIWEOrigin = (req) => {
+    var _a;
+    try {
+        const { origin, siwe } = req;
+        // origin = scheme://[user[:password]@]domain[:port]
+        // origin is supplied by environment and must match domain claim in message
+        if (!origin || !((_a = siwe === null || siwe === void 0 ? void 0 : siwe.parsedMessage) === null || _a === void 0 ? void 0 : _a.domain)) {
+            return false;
+        }
+        const originParts = new URL(origin);
+        const domainParts = (0, exports.parseDomainParts)(siwe.parsedMessage.domain, originParts.protocol);
+        if (domainParts.hostname.localeCompare(originParts.hostname, undefined, {
+            sensitivity: 'accent',
+        }) !== 0) {
+            return false;
+        }
+        if (domainParts.port !== '' && domainParts.port !== originParts.port) {
+            // If origin port is not specified, protocol default is implied
+            return (originParts.port === '' &&
+                domainParts.port === DEFAULT_PORTS_BY_PROTOCOL[originParts.protocol]);
+        }
+        if (domainParts.username !== '' &&
+            domainParts.username !== originParts.username) {
+            return false;
+        }
+        return true;
+    }
+    catch (e) {
+        log(e);
+        return false;
+    }
+};
+exports.isValidSIWEOrigin = isValidSIWEOrigin;
+/**
+ * This function intercepts a sign message, detects if it's a
+ * Sign-In With Ethereum (SIWE)(EIP-4361) message, and returns an object with
+ * relevant SIWE data.
+ *
+ * {@see {@link https://eips.ethereum.org/EIPS/eip-4361}}
+ *
+ * @param msgParams - The params of the message to sign
+ * @param msgParams.data - The data of the message to sign
+ * @returns An object with the relevant SIWE data
+ */
+const detectSIWE = (msgParams) => {
+    try {
+        const { data } = msgParams;
+        const message = msgHexToText(data);
+        const parsedMessage = new siwe_parser_1.ParsedMessage(message);
+        return {
+            isSIWEMessage: true,
+            parsedMessage,
+        };
+    }
+    catch (error) {
+        // ignore error, it's not a valid SIWE message
+        return {
+            isSIWEMessage: false,
+            parsedMessage: null,
+        };
+    }
+};
+exports.detectSIWE = detectSIWE;
+//# sourceMappingURL=siwe.js.map

package/dist/siwe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"siwe.js","sourceRoot":"","sources":["../src/siwe.ts"],"names":[],"mappings":";;;AAAA,uDAAsD;AACtD,qDAAgD;AAEhD,qCAA6D;AAE7D,MAAM,GAAG,GAAG,IAAA,2BAAkB,EAAC,sBAAa,EAAE,aAAa,CAAC,CAAC;AAE7D;;;;;GAKG;AACH,SAAS,cAAc,CAAC,GAAW;IACjC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,GAAG,CAAC;KACZ;IACD,OAAO,IAAA,+BAAa,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AACjD,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,GAAW;IAC/B,IAAI;QACF,MAAM,QAAQ,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KACzD;IAAC,OAAO,CAAC,EAAE;QACV,GAAG,CAAC,CAAC,CAAC,CAAC;QACP,OAAO,GAAG,CAAC;KACZ;AACH,CAAC;AAsBD,MAAM,yBAAyB,GAAG;IAChC,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,KAAK;CACU,CAAC;AAE5B;;;;;;GAMG;AACI,MAAM,gBAAgB,GAAG,CAC9B,MAAc,EACd,cAAsB,EACT,EAAE;IACf,IAAI,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE;QACjC,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;KACxB;IACD,OAAO,IAAI,GAAG,CAAC,GAAG,cAAc,KAAK,MAAM,EAAE,CAAC,CAAC;AACjD,CAAC,CAAC;AARW,QAAA,gBAAgB,oBAQ3B;AAEF;;;;;;;;;GASG;AACI,MAAM,iBAAiB,GAAG,CAAC,GAAuB,EAAW,EAAE;;IACpE,IAAI;QACF,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC;QAE7B,oDAAoD;QACpD,2EAA2E;QAC3E,IAAI,CAAC,MAAM,IAAI,CAAC,CAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,0CAAE,MAAM,CAAA,EAAE;YAC3C,OAAO,KAAK,CAAC;SACd;QAED,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,WAAW,GAAG,IAAA,wBAAgB,EAClC,IAAI,CAAC,aAAa,CAAC,MAAM,EACzB,WAAW,CAAC,QAAQ,CACrB,CAAC;QAEF,IACE,WAAW,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,QAAQ,EAAE,SAAS,EAAE;YAClE,WAAW,EAAE,QAAQ;SACtB,CAAC,KAAK,CAAC,EACR;YACA,OAAO,KAAK,CAAC;SACd;QAED,IAAI,WAAW,CAAC,IAAI,KAAK,EAAE,IAAI,WAAW,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,EAAE;YACpE,+DAA+D;YAC/D,OAAO,CACL,WAAW,CAAC,IAAI,KAAK,EAAE;gBACvB,WAAW,CAAC,IAAI,KAAK,yBAAyB,CAAC,WAAW,CAAC,QAAQ,CAAC,CACrE,CAAC;SACH;QAED,IACE,WAAW,CAAC,QAAQ,KAAK,EAAE;YAC3B,WAAW,CAAC,QAAQ,KAAK,WAAW,CAAC,QAAQ,EAC7C;YACA,OAAO,KAAK,CAAC;SACd;QAED,OAAO,IAAI,CAAC;KACb;IAAC,OAAO,CAAC,EAAE;QACV,GAAG,CAAC,CAAC,CAAC,CAAC;QACP,OAAO,KAAK,CAAC;KACd;AACH,CAAC,CAAC;AA5CW,QAAA,iBAAiB,qBA4C5B;AAaF;;;;;;;;;;GAUG;AACI,MAAM,UAAU,GAAG,CAAC,SAA2B,EAAe,EAAE;IACrE,IAAI;QACF,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;QAC3B,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,aAAa,GAAG,IAAI,2BAAa,CAAC,OAAO,CAAC,CAAC;QAEjD,OAAO;YACL,aAAa,EAAE,IAAI;YACnB,aAAa;SACd,CAAC;KACH;IAAC,OAAO,KAAK,EAAE;QACd,8CAA8C;QAC9C,OAAO;YACL,aAAa,EAAE,KAAK;YACpB,aAAa,EAAE,IAAI;SACpB,CAAC;KACH;AACH,CAAC,CAAC;AAjBW,QAAA,UAAU,cAiBrB","sourcesContent":["import { ParsedMessage } from '@spruceid/siwe-parser';\nimport { isHexPrefixed } from 'ethereumjs-util';\n\nimport { projectLogger, createModuleLogger } from './logger';\n\nconst log = createModuleLogger(projectLogger, 'detect-siwe');\n\n/**\n * This function strips the hex prefix from a string if it has one.\n *\n * @param str - The string to check\n * @returns The string without the hex prefix\n */\nfunction stripHexPrefix(str: string) {\n  if (typeof str !== 'string') {\n    return str;\n  }\n  return isHexPrefixed(str) ? str.slice(2) : str;\n}\n\n/**\n * This function converts a hex string to text if it's not a 32 byte hex string.\n *\n * @param hex - The hex string to convert to text\n * @returns The text representation of the hex string\n */\nfunction msgHexToText(hex: string): string {\n  try {\n    const stripped = stripHexPrefix(hex);\n    const buff = Buffer.from(stripped, 'hex');\n    return buff.length === 32 ? hex : buff.toString('utf8');\n  } catch (e) {\n    log(e);\n    return hex;\n  }\n}\n\n/**\n * @type WrappedSIWERequest\n *\n * Sign-In With Ethereum (SIWE)(EIP-4361) message with request metadata\n * @property {string} from - Subject account address\n * @property {string} origin - The RFC 3986 originating authority of the signing request, including scheme\n * @property {ParsedMessage} siwe - The data parsed from the message\n */\nexport interface WrappedSIWERequest {\n  from: string;\n  origin: string;\n  siwe: SIWEMessage;\n}\n\ninterface DomainParts {\n  username?: string;\n  hostname: string;\n  port?: string;\n}\n\nconst DEFAULT_PORTS_BY_PROTOCOL = {\n  'http:': '80',\n  'https:': '443',\n} as Record<string, string>;\n\n/**\n * Parses parts from RFC 3986 authority from EIP-4361 `domain` field.\n *\n * @param domain - input string\n * @param originProtocol - implied protocol from origin\n * @returns parsed parts\n */\nexport const parseDomainParts = (\n  domain: string,\n  originProtocol: string,\n): DomainParts => {\n  if (domain.match(/^[^/:]*:\\/\\//u)) {\n    return new URL(domain);\n  }\n  return new URL(`${originProtocol}//${domain}`);\n};\n\n/**\n * Validates origin of a Sign-In With Ethereum (SIWE)(EIP-4361) request.\n * As per spec:\n * hostname must match.\n * port and username must match iff specified.\n * Protocol binding and full same-origin are currently not performed.\n *\n * @param req - Signature request\n * @returns true if origin matches domain; false otherwise\n */\nexport const isValidSIWEOrigin = (req: WrappedSIWERequest): boolean => {\n  try {\n    const { origin, siwe } = req;\n\n    // origin = scheme://[user[:password]@]domain[:port]\n    // origin is supplied by environment and must match domain claim in message\n    if (!origin || !siwe?.parsedMessage?.domain) {\n      return false;\n    }\n\n    const originParts = new URL(origin);\n    const domainParts = parseDomainParts(\n      siwe.parsedMessage.domain,\n      originParts.protocol,\n    );\n\n    if (\n      domainParts.hostname.localeCompare(originParts.hostname, undefined, {\n        sensitivity: 'accent',\n      }) !== 0\n    ) {\n      return false;\n    }\n\n    if (domainParts.port !== '' && domainParts.port !== originParts.port) {\n      // If origin port is not specified, protocol default is implied\n      return (\n        originParts.port === '' &&\n        domainParts.port === DEFAULT_PORTS_BY_PROTOCOL[originParts.protocol]\n      );\n    }\n\n    if (\n      domainParts.username !== '' &&\n      domainParts.username !== originParts.username\n    ) {\n      return false;\n    }\n\n    return true;\n  } catch (e) {\n    log(e);\n    return false;\n  }\n};\n\n/**\n * A locally defined object used to provide data to identify a Sign-In With Ethereum (SIWE)(EIP-4361) message and provide the parsed message\n *\n * @typedef SIWEMessage\n * @param {boolean} isSIWEMessage - Does the intercepted message conform to the SIWE specification?\n * @param {ParsedMessage} parsedMessage - The data parsed out of the message\n */\nexport type SIWEMessage =\n  | { isSIWEMessage: true; parsedMessage: ParsedMessage }\n  | { isSIWEMessage: false; parsedMessage: null };\n\n/**\n * This function intercepts a sign message, detects if it's a\n * Sign-In With Ethereum (SIWE)(EIP-4361) message, and returns an object with\n * relevant SIWE data.\n *\n * {@see {@link https://eips.ethereum.org/EIPS/eip-4361}}\n *\n * @param msgParams - The params of the message to sign\n * @param msgParams.data - The data of the message to sign\n * @returns An object with the relevant SIWE data\n */\nexport const detectSIWE = (msgParams: { data: string }): SIWEMessage => {\n  try {\n    const { data } = msgParams;\n    const message = msgHexToText(data);\n    const parsedMessage = new ParsedMessage(message);\n\n    return {\n      isSIWEMessage: true,\n      parsedMessage,\n    };\n  } catch (error) {\n    // ignore error, it's not a valid SIWE message\n    return {\n      isSIWEMessage: false,\n      parsedMessage: null,\n    };\n  }\n};\n"]}

package/dist/types.d.ts

@@ -0,0 +1,77 @@
+/**
+ * The names of built-in Infura networks
+ */
+export declare const InfuraNetworkType: {
+    readonly mainnet: "mainnet";
+    readonly goerli: "goerli";
+    readonly sepolia: "sepolia";
+    readonly 'linea-goerli': "linea-goerli";
+    readonly 'linea-mainnet': "linea-mainnet";
+};
+export declare type InfuraNetworkType = (typeof InfuraNetworkType)[keyof typeof InfuraNetworkType];
+/**
+ * The "network type"; either the name of a built-in network, or "rpc" for custom networks.
+ */
+export declare const NetworkType: {
+    readonly rpc: "rpc";
+    readonly mainnet: "mainnet";
+    readonly goerli: "goerli";
+    readonly sepolia: "sepolia";
+    readonly 'linea-goerli': "linea-goerli";
+    readonly 'linea-mainnet': "linea-mainnet";
+};
+export declare type NetworkType = (typeof NetworkType)[keyof typeof NetworkType];
+/**
+ * A helper to determine whether a given input is NetworkType.
+ *
+ * @param val - the value to check whether it is NetworkType or not.
+ * @returns boolean indicating whether or not the argument is NetworkType.
+ */
+export declare function isNetworkType(val: any): val is NetworkType;
+/**
+ * Names of networks built into the wallet.
+ *
+ * This includes both Infura and non-Infura networks.
+ */
+export declare enum BuiltInNetworkName {
+    Mainnet = "mainnet",
+    Goerli = "goerli",
+    Sepolia = "sepolia",
+    LineaGoerli = "linea-goerli",
+    LineaMainnet = "linea-mainnet",
+    Aurora = "aurora"
+}
+/**
+ * Decimal string chain IDs of built-in networks, by name.
+ *
+ * `toHex` not invoked to avoid cyclic dependency
+ */
+export declare const ChainId: {
+    readonly mainnet: "0x1";
+    readonly goerli: "0x5";
+    readonly sepolia: "0xaa36a7";
+    readonly aurora: "0x4e454152";
+    readonly "linea-goerli": "0xe704";
+    readonly "linea-mainnet": "0xe708";
+};
+export declare type ChainId = (typeof ChainId)[keyof typeof ChainId];
+/**
+ * Decimal string network IDs of built-in Infura networks, by name.
+ */
+export declare const NetworkId: {
+    readonly mainnet: "1";
+    readonly goerli: "5";
+    readonly sepolia: "11155111";
+    readonly "linea-goerli": "59140";
+    readonly "linea-mainnet": "59144";
+};
+export declare type NetworkId = (typeof NetworkId)[keyof typeof NetworkId];
+export declare enum NetworksTicker {
+    mainnet = "ETH",
+    goerli = "GoerliETH",
+    sepolia = "SepoliaETH",
+    'linea-goerli' = "LineaETH",
+    'linea-mainnet' = "ETH",
+    rpc = ""
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;CAMpB,CAAC;AAEX,oBAAY,iBAAiB,GAC3B,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;;CAGd,CAAC;AAEX,oBAAY,WAAW,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEzE;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,WAAW,CAE1D;AAED;;;;GAIG;AACH,oBAAY,kBAAkB;IAC5B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,MAAM,WAAW;CAClB;AAED;;;;GAIG;AACH,eAAO,MAAM,OAAO;;;;;;;CAOV,CAAC;AACX,oBAAY,OAAO,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,OAAO,OAAO,CAAC,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;CAMZ,CAAC;AACX,oBAAY,SAAS,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;AAEnE,oBAAY,cAAc;IACxB,OAAO,QAAQ;IACf,MAAM,cAAc;IACpB,OAAO,eAAe;IACtB,cAAc,aAAa;IAC3B,eAAe,QAAQ;IACvB,GAAG,KAAK;CACT"}

package/dist/types.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworksTicker = exports.NetworkId = exports.ChainId = exports.BuiltInNetworkName = exports.isNetworkType = exports.NetworkType = exports.InfuraNetworkType = void 0;
+/**
+ * The names of built-in Infura networks
+ */
+exports.InfuraNetworkType = {
+    mainnet: 'mainnet',
+    goerli: 'goerli',
+    sepolia: 'sepolia',
+    'linea-goerli': 'linea-goerli',
+    'linea-mainnet': 'linea-mainnet',
+};
+/**
+ * The "network type"; either the name of a built-in network, or "rpc" for custom networks.
+ */
+exports.NetworkType = Object.assign(Object.assign({}, exports.InfuraNetworkType), { rpc: 'rpc' });
+/**
+ * A helper to determine whether a given input is NetworkType.
+ *
+ * @param val - the value to check whether it is NetworkType or not.
+ * @returns boolean indicating whether or not the argument is NetworkType.
+ */
+function isNetworkType(val) {
+    return Object.values(exports.NetworkType).includes(val);
+}
+exports.isNetworkType = isNetworkType;
+/**
+ * Names of networks built into the wallet.
+ *
+ * This includes both Infura and non-Infura networks.
+ */
+var BuiltInNetworkName;
+(function (BuiltInNetworkName) {
+    BuiltInNetworkName["Mainnet"] = "mainnet";
+    BuiltInNetworkName["Goerli"] = "goerli";
+    BuiltInNetworkName["Sepolia"] = "sepolia";
+    BuiltInNetworkName["LineaGoerli"] = "linea-goerli";
+    BuiltInNetworkName["LineaMainnet"] = "linea-mainnet";
+    BuiltInNetworkName["Aurora"] = "aurora";
+})(BuiltInNetworkName = exports.BuiltInNetworkName || (exports.BuiltInNetworkName = {}));
+/**
+ * Decimal string chain IDs of built-in networks, by name.
+ *
+ * `toHex` not invoked to avoid cyclic dependency
+ */
+exports.ChainId = {
+    [BuiltInNetworkName.Mainnet]: '0x1',
+    [BuiltInNetworkName.Goerli]: '0x5',
+    [BuiltInNetworkName.Sepolia]: '0xaa36a7',
+    [BuiltInNetworkName.Aurora]: '0x4e454152',
+    [BuiltInNetworkName.LineaGoerli]: '0xe704',
+    [BuiltInNetworkName.LineaMainnet]: '0xe708', // toHex(59144)
+};
+/**
+ * Decimal string network IDs of built-in Infura networks, by name.
+ */
+exports.NetworkId = {
+    [exports.InfuraNetworkType.mainnet]: '1',
+    [exports.InfuraNetworkType.goerli]: '5',
+    [exports.InfuraNetworkType.sepolia]: '11155111',
+    [exports.InfuraNetworkType['linea-goerli']]: '59140',
+    [exports.InfuraNetworkType['linea-mainnet']]: '59144',
+};
+var NetworksTicker;
+(function (NetworksTicker) {
+    NetworksTicker["mainnet"] = "ETH";
+    NetworksTicker["goerli"] = "GoerliETH";
+    NetworksTicker["sepolia"] = "SepoliaETH";
+    NetworksTicker["linea-goerli"] = "LineaETH";
+    NetworksTicker["linea-mainnet"] = "ETH";
+    NetworksTicker["rpc"] = "";
+})(NetworksTicker = exports.NetworksTicker || (exports.NetworksTicker = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,cAAc,EAAE,cAAc;IAC9B,eAAe,EAAE,eAAe;CACxB,CAAC;AAKX;;GAEG;AACU,QAAA,WAAW,GAAG,gCACtB,yBAAiB,KACpB,GAAG,EAAE,KAAK,GACF,CAAC;AAIX;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,GAAQ;IACpC,OAAO,MAAM,CAAC,MAAM,CAAC,mBAAW,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAClD,CAAC;AAFD,sCAEC;AAED;;;;GAIG;AACH,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;IACnB,kDAA4B,CAAA;IAC5B,oDAA8B,CAAA;IAC9B,uCAAiB,CAAA;AACnB,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B;AAED;;;;GAIG;AACU,QAAA,OAAO,GAAG;IACrB,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,KAAK;IACnC,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,KAAK;IAClC,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,UAAU;IACxC,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,YAAY;IACzC,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,QAAQ;IAC1C,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,eAAe;CACpD,CAAC;AAGX;;GAEG;AACU,QAAA,SAAS,GAAG;IACvB,CAAC,yBAAiB,CAAC,OAAO,CAAC,EAAE,GAAG;IAChC,CAAC,yBAAiB,CAAC,MAAM,CAAC,EAAE,GAAG;IAC/B,CAAC,yBAAiB,CAAC,OAAO,CAAC,EAAE,UAAU;IACvC,CAAC,yBAAiB,CAAC,cAAc,CAAC,CAAC,EAAE,OAAO;IAC5C,CAAC,yBAAiB,CAAC,eAAe,CAAC,CAAC,EAAE,OAAO;CACrC,CAAC;AAGX,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,iCAAe,CAAA;IACf,sCAAoB,CAAA;IACpB,wCAAsB,CAAA;IACtB,2CAA2B,CAAA;IAC3B,uCAAuB,CAAA;IACvB,0BAAQ,CAAA;AACV,CAAC,EAPW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAOzB","sourcesContent":["/**\n * The names of built-in Infura networks\n */\nexport const InfuraNetworkType = {\n  mainnet: 'mainnet',\n  goerli: 'goerli',\n  sepolia: 'sepolia',\n  'linea-goerli': 'linea-goerli',\n  'linea-mainnet': 'linea-mainnet',\n} as const;\n\nexport type InfuraNetworkType =\n  (typeof InfuraNetworkType)[keyof typeof InfuraNetworkType];\n\n/**\n * The \"network type\"; either the name of a built-in network, or \"rpc\" for custom networks.\n */\nexport const NetworkType = {\n  ...InfuraNetworkType,\n  rpc: 'rpc',\n} as const;\n\nexport type NetworkType = (typeof NetworkType)[keyof typeof NetworkType];\n\n/**\n * A helper to determine whether a given input is NetworkType.\n *\n * @param val - the value to check whether it is NetworkType or not.\n * @returns boolean indicating whether or not the argument is NetworkType.\n */\nexport function isNetworkType(val: any): val is NetworkType {\n  return Object.values(NetworkType).includes(val);\n}\n\n/**\n * Names of networks built into the wallet.\n *\n * This includes both Infura and non-Infura networks.\n */\nexport enum BuiltInNetworkName {\n  Mainnet = 'mainnet',\n  Goerli = 'goerli',\n  Sepolia = 'sepolia',\n  LineaGoerli = 'linea-goerli',\n  LineaMainnet = 'linea-mainnet',\n  Aurora = 'aurora',\n}\n\n/**\n * Decimal string chain IDs of built-in networks, by name.\n *\n * `toHex` not invoked to avoid cyclic dependency\n */\nexport const ChainId = {\n  [BuiltInNetworkName.Mainnet]: '0x1', // toHex(1)\n  [BuiltInNetworkName.Goerli]: '0x5', // toHex(5)\n  [BuiltInNetworkName.Sepolia]: '0xaa36a7', // toHex(11155111)\n  [BuiltInNetworkName.Aurora]: '0x4e454152', // toHex(1313161554)\n  [BuiltInNetworkName.LineaGoerli]: '0xe704', // toHex(59140)\n  [BuiltInNetworkName.LineaMainnet]: '0xe708', // toHex(59144)\n} as const;\nexport type ChainId = (typeof ChainId)[keyof typeof ChainId];\n\n/**\n * Decimal string network IDs of built-in Infura networks, by name.\n */\nexport const NetworkId = {\n  [InfuraNetworkType.mainnet]: '1',\n  [InfuraNetworkType.goerli]: '5',\n  [InfuraNetworkType.sepolia]: '11155111',\n  [InfuraNetworkType['linea-goerli']]: '59140',\n  [InfuraNetworkType['linea-mainnet']]: '59144',\n} as const;\nexport type NetworkId = (typeof NetworkId)[keyof typeof NetworkId];\n\nexport enum NetworksTicker {\n  mainnet = 'ETH',\n  goerli = 'GoerliETH',\n  sepolia = 'SepoliaETH',\n  'linea-goerli' = 'LineaETH',\n  'linea-mainnet' = 'ETH',\n  rpc = '',\n}\n"]}

package/dist/util.d.ts

@@ -0,0 +1,221 @@
+/// <reference types="bn.js" />
+import type EthQuery from '@metamask/eth-query';
+import type { Hex, Json } from '@metamask/utils';
+import { BN } from 'ethereumjs-util';
+/**
+ * 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: any): 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: any, numerator: number | string, denominator: number | string): any;
+/**
+ * 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 | 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.
+ * @returns Promise resolving to the result of the async operation.
+ */
+export declare function safelyExecute(operation: () => Promise<any>, logError?: boolean): Promise<any>;
+/**
+ * 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.
+ */
+export declare function safelyExecuteWithTimeout(operation: () => Promise<any>, logError?: boolean, timeout?: number): Promise<any>;
+/**
+ * Convert an address to a checksummed hexidecimal address.
+ *
+ * @param address - The address to convert.
+ * @returns A 0x-prefixed hexidecimal checksummed address.
+ */
+export declare function toChecksumHexAddress(address: string): string;
+/**
+ * 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.
+ */
+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: string, 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: string, 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;
+declare 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 declare 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.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAGjD,OAAO,EAIL,EAAE,EAGH,MAAM,iBAAiB,CAAC;AAQzB;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO,CAUnD;AACD;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,GAAG,UAEnC;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,GAAG,EACb,SAAS,EAAE,MAAM,GAAG,MAAM,EAC1B,WAAW,EAAE,MAAM,GAAG,MAAM,OAK7B;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,CAWpB;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,EAAE,GAAG,GAAG,CAQtD;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,SAAS,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,EAC7B,QAAQ,UAAQ,gBAWjB;AAED;;;;;;;GAOG;AACH,wBAAsB,wBAAwB,CAC5C,SAAS,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,EAC7B,QAAQ,UAAQ,EAChB,OAAO,SAAM,gBAkBd;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,UAUnD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,eAAe,EAAE,MAAM,EACvB,EAAE,gBAAuB,EAAE;;CAAK,WAUjC;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,WAQ/C;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,qBAQ3E;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,gBAIvE;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,CAc/D;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,GAAE,GAAG,EAAO,GACf,OAAO,CAAC,GAAG,CAAC,CAkBd;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,WACvB,MAAM,GAAG,SAAS,KACxB,MAMF,CAAC;AAEF,aAAK,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;AACH,oBAAY,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;AAE3C;;;;;;GAMG;AACH,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"}