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

package/dist/index.mjs

@@ -1,138 +1,5 @@
-import {
-  detectSIWE,
-  isValidSIWEOrigin,
-  parseDomainParts
-} from "./chunk-VDEIYYE4.mjs";
-import "./chunk-RZFCNKW4.mjs";
-import {
-  BNToHex,
-  convertHexToDecimal,
-  fetchWithErrorHandling,
-  fractionBN,
-  fromHex,
-  getBuyURL,
-  gweiDecToWEIBN,
-  handleFetch,
-  hexToBN,
-  hexToText,
-  isNonEmptyArray,
-  isPlainObject,
-  isSafeChainId,
-  isSafeDynamicKey,
-  isSmartContractCode,
-  isValidHexAddress,
-  isValidJson,
-  normalizeEnsName,
-  query,
-  safelyExecute,
-  safelyExecuteWithTimeout,
-  successfulFetch,
-  timeoutFetch,
-  toChecksumHexAddress,
-  toHex,
-  weiHexToGweiDec
-} from "./chunk-2DKE2P5J.mjs";
-import {
-  ASSET_TYPES,
-  ApprovalType,
-  BUILT_IN_NETWORKS,
-  CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP,
-  ERC1155,
-  ERC1155_INTERFACE_ID,
-  ERC1155_METADATA_URI_INTERFACE_ID,
-  ERC1155_TOKEN_RECEIVER_INTERFACE_ID,
-  ERC20,
-  ERC721,
-  ERC721_ENUMERABLE_INTERFACE_ID,
-  ERC721_INTERFACE_ID,
-  ERC721_METADATA_INTERFACE_ID,
-  FALL_BACK_VS_CURRENCY,
-  GANACHE_CHAIN_ID,
-  GWEI,
-  IPFS_DEFAULT_GATEWAY_URL,
-  MAX_SAFE_CHAIN_ID,
-  NFT_API_BASE_URL,
-  NFT_API_TIMEOUT,
-  NFT_API_VERSION,
-  OPENSEA_PROXY_URL,
-  ORIGIN_METAMASK,
-  RPC,
-  TESTNET_TICKER_SYMBOLS
-} from "./chunk-6LGAYF2M.mjs";
-import {
-  BlockExplorerUrl,
-  BuiltInNetworkName,
-  ChainId,
-  InfuraNetworkType,
-  NetworkNickname,
-  NetworkType,
-  NetworksTicker,
-  isInfuraNetworkType,
-  isNetworkType
-} from "./chunk-CQMU5S2P.mjs";
-export {
-  ASSET_TYPES,
-  ApprovalType,
-  BNToHex,
-  BUILT_IN_NETWORKS,
-  BlockExplorerUrl,
-  BuiltInNetworkName,
-  CHAIN_ID_TO_ETHERS_NETWORK_NAME_MAP,
-  ChainId,
-  ERC1155,
-  ERC1155_INTERFACE_ID,
-  ERC1155_METADATA_URI_INTERFACE_ID,
-  ERC1155_TOKEN_RECEIVER_INTERFACE_ID,
-  ERC20,
-  ERC721,
-  ERC721_ENUMERABLE_INTERFACE_ID,
-  ERC721_INTERFACE_ID,
-  ERC721_METADATA_INTERFACE_ID,
-  FALL_BACK_VS_CURRENCY,
-  GANACHE_CHAIN_ID,
-  GWEI,
-  IPFS_DEFAULT_GATEWAY_URL,
-  InfuraNetworkType,
-  MAX_SAFE_CHAIN_ID,
-  NFT_API_BASE_URL,
-  NFT_API_TIMEOUT,
-  NFT_API_VERSION,
-  NetworkNickname,
-  NetworkType,
-  NetworksTicker,
-  OPENSEA_PROXY_URL,
-  ORIGIN_METAMASK,
-  RPC,
-  TESTNET_TICKER_SYMBOLS,
-  convertHexToDecimal,
-  detectSIWE,
-  fetchWithErrorHandling,
-  fractionBN,
-  fromHex,
-  getBuyURL,
-  gweiDecToWEIBN,
-  handleFetch,
-  hexToBN,
-  hexToText,
-  isInfuraNetworkType,
-  isNetworkType,
-  isNonEmptyArray,
-  isPlainObject,
-  isSafeChainId,
-  isSafeDynamicKey,
-  isSmartContractCode,
-  isValidHexAddress,
-  isValidJson,
-  isValidSIWEOrigin,
-  normalizeEnsName,
-  parseDomainParts,
-  query,
-  safelyExecute,
-  safelyExecuteWithTimeout,
-  successfulFetch,
-  timeoutFetch,
-  toChecksumHexAddress,
-  toHex,
-  weiHexToGweiDec
-};
+export * from "./constants.mjs";
+export { BNToHex, convertHexToDecimal, fetchWithErrorHandling, fractionBN, fromHex, getBuyURL, gweiDecToWEIBN, handleFetch, hexToBN, hexToText, isNonEmptyArray, isPlainObject, isSafeChainId, isSafeDynamicKey, isSmartContractCode, isValidJson, isValidHexAddress, normalizeEnsName, query, safelyExecute, safelyExecuteWithTimeout, successfulFetch, timeoutFetch, toChecksumHexAddress, toHex, weiHexToGweiDec } from "./util.mjs";
+export * from "./types.mjs";
+export * from "./siwe.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAA4B;AAE5B,OAAO,EACL,OAAO,EACP,mBAAmB,EACnB,sBAAsB,EACtB,UAAU,EACV,OAAO,EACP,SAAS,EACT,cAAc,EACd,WAAW,EACX,OAAO,EACP,SAAS,EACT,eAAe,EACf,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,mBAAmB,EACnB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,wBAAwB,EACxB,eAAe,EACf,YAAY,EACZ,oBAAoB,EACpB,KAAK,EACL,eAAe,EAChB,mBAAe;AAChB,4BAAwB;AACxB,2BAAuB","sourcesContent":["export * from './constants';\nexport type { NonEmptyArray } from './util';\nexport {\n  BNToHex,\n  convertHexToDecimal,\n  fetchWithErrorHandling,\n  fractionBN,\n  fromHex,\n  getBuyURL,\n  gweiDecToWEIBN,\n  handleFetch,\n  hexToBN,\n  hexToText,\n  isNonEmptyArray,\n  isPlainObject,\n  isSafeChainId,\n  isSafeDynamicKey,\n  isSmartContractCode,\n  isValidJson,\n  isValidHexAddress,\n  normalizeEnsName,\n  query,\n  safelyExecute,\n  safelyExecuteWithTimeout,\n  successfulFetch,\n  timeoutFetch,\n  toChecksumHexAddress,\n  toHex,\n  weiHexToGweiDec,\n} from './util';\nexport * from './types';\nexport * from './siwe';\n"]}

package/dist/logger.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createModuleLogger = exports.projectLogger = void 0;
+const utils_1 = require("@metamask/utils");
+Object.defineProperty(exports, "createModuleLogger", { enumerable: true, get: function () { return utils_1.createModuleLogger; } });
+exports.projectLogger = (0, utils_1.createProjectLogger)('controller-utils');
+//# sourceMappingURL=logger.cjs.map

package/dist/logger.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.cjs","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;AAAA,2CAA0E;AAIjE,mGAJqB,0BAAkB,OAIrB;AAFd,QAAA,aAAa,GAAG,IAAA,2BAAmB,EAAC,kBAAkB,CAAC,CAAC","sourcesContent":["import { createProjectLogger, createModuleLogger } from '@metamask/utils';\n\nexport const projectLogger = createProjectLogger('controller-utils');\n\nexport { createModuleLogger };\n"]}

package/dist/{types/logger.d.ts → logger.d.cts}

@@ -1,5 +1,5 @@
 /// <reference types="debug" />
-import { createModuleLogger } from '@metamask/utils';
+import { createModuleLogger } from "@metamask/utils";
 export declare const projectLogger: import("debug").Debugger;
 export { createModuleLogger };
-//# sourceMappingURL=logger.d.ts.map
+//# sourceMappingURL=logger.d.cts.map

package/dist/logger.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.cts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";AAAA,OAAO,EAAuB,kBAAkB,EAAE,wBAAwB;AAE1E,eAAO,MAAM,aAAa,0BAA0C,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/logger.d.mts

@@ -0,0 +1,5 @@
+/// <reference types="debug" />
+import { createModuleLogger } from "@metamask/utils";
+export declare const projectLogger: import("debug").Debugger;
+export { createModuleLogger };
+//# sourceMappingURL=logger.d.mts.map

package/dist/logger.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.mts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";AAAA,OAAO,EAAuB,kBAAkB,EAAE,wBAAwB;AAE1E,eAAO,MAAM,aAAa,0BAA0C,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/logger.mjs

@@ -1,9 +1,4 @@
-import {
-  createModuleLogger,
-  projectLogger
-} from "./chunk-RZFCNKW4.mjs";
-export {
-  createModuleLogger,
-  projectLogger
-};
+import { createProjectLogger, createModuleLogger } from "@metamask/utils";
+export const projectLogger = createProjectLogger('controller-utils');
+export { createModuleLogger };
 //# sourceMappingURL=logger.mjs.map

package/dist/logger.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"logger.mjs","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,wBAAwB;AAE1E,MAAM,CAAC,MAAM,aAAa,GAAG,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,CAAC","sourcesContent":["import { createProjectLogger, createModuleLogger } from '@metamask/utils';\n\nexport const projectLogger = createProjectLogger('controller-utils');\n\nexport { createModuleLogger };\n"]}

package/dist/siwe.cjs

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectSIWE = exports.isValidSIWEOrigin = exports.parseDomainParts = void 0;
+const utils_1 = require("@metamask/utils");
+const siwe_parser_1 = require("@spruceid/siwe-parser");
+const logger_1 = require("./logger.cjs");
+const log = (0, logger_1.createModuleLogger)(logger_1.projectLogger, 'detect-siwe');
+/**
+ * This function strips the hex prefix from a string if it has one.
+ * If the input is not a string, return it unmodified.
+ *
+ * @param str - The string to check
+ * @returns The string without the hex prefix
+ */
+function safeStripHexPrefix(str) {
+    if (typeof str !== 'string') {
+        return str;
+    }
+    return (0, utils_1.remove0x)(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 = safeStripHexPrefix(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) => {
+    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 || !siwe?.parsedMessage?.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.cjs.map

package/dist/siwe.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"siwe.cjs","sourceRoot":"","sources":["../src/siwe.ts"],"names":[],"mappings":";;;AAAA,2CAA2C;AAC3C,uDAAsD;AAEtD,yCAA6D;AAE7D,MAAM,GAAG,GAAG,IAAA,2BAAkB,EAAC,sBAAa,EAAE,aAAa,CAAC,CAAC;AAE7D;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,GAAW;IACrC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,GAAG,CAAC;KACZ;IACD,OAAO,IAAA,gBAAQ,EAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,GAAW;IAC/B,IAAI;QACF,MAAM,QAAQ,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACzC,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;AA4BD,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,IAAI,EAAE,aAAa,EAAE,MAAM,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 { remove0x } from '@metamask/utils';\nimport { ParsedMessage } from '@spruceid/siwe-parser';\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 * If the input is not a string, return it unmodified.\n *\n * @param str - The string to check\n * @returns The string without the hex prefix\n */\nfunction safeStripHexPrefix(str: string) {\n  if (typeof str !== 'string') {\n    return str;\n  }\n  return remove0x(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 = safeStripHexPrefix(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 */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface WrappedSIWERequest {\n  from: string;\n  origin: string;\n  siwe: SIWEMessage;\n}\n\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\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/siwe.d.ts → siwe.d.cts}

@@ -1,4 +1,4 @@
-import { ParsedMessage } from '@spruceid/siwe-parser';
+import { ParsedMessage } from "@spruceid/siwe-parser";
 /**
  * @type WrappedSIWERequest
  *
@@ -65,4 +65,4 @@ export declare const detectSIWE: (msgParams: {
     data: string;
 }) => SIWEMessage;
 export {};
-//# sourceMappingURL=siwe.d.ts.map
+//# sourceMappingURL=siwe.d.cts.map

package/dist/siwe.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"siwe.d.cts","sourceRoot":"","sources":["../src/siwe.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,8BAA8B;AAqCtD;;;;;;;GAOG;AAIH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,WAAW,CAAC;CACnB;AAKD,UAAU,WAAW;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAOD;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,WACnB,MAAM,kBACE,MAAM,KACrB,WAKF,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,QAAS,kBAAkB,KAAG,OA4C3D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,aAAa,EAAE,IAAI,CAAC;IAAC,aAAa,EAAE,aAAa,CAAA;CAAE,GACrD;IAAE,aAAa,EAAE,KAAK,CAAC;IAAC,aAAa,EAAE,IAAI,CAAA;CAAE,CAAC;AAElD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,cAAe;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,KAAG,WAiBxD,CAAC"}

package/dist/siwe.d.mts

@@ -0,0 +1,68 @@
+import { ParsedMessage } from "@spruceid/siwe-parser";
+/**
+ * @type WrappedSIWERequest
+ *
+ * Sign-In With Ethereum (SIWE)(EIP-4361) message with request metadata
+ * @property {string} from - Subject account address
+ * @property {string} origin - The RFC 3986 originating authority of the signing request, including scheme
+ * @property {ParsedMessage} siwe - The data parsed from the message
+ */
+export interface WrappedSIWERequest {
+    from: string;
+    origin: string;
+    siwe: SIWEMessage;
+}
+interface DomainParts {
+    username?: string;
+    hostname: string;
+    port?: string;
+}
+/**
+ * Parses parts from RFC 3986 authority from EIP-4361 `domain` field.
+ *
+ * @param domain - input string
+ * @param originProtocol - implied protocol from origin
+ * @returns parsed parts
+ */
+export declare const parseDomainParts: (domain: string, originProtocol: string) => DomainParts;
+/**
+ * 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
+ */
+export declare const isValidSIWEOrigin: (req: WrappedSIWERequest) => boolean;
+/**
+ * A locally defined object used to provide data to identify a Sign-In With Ethereum (SIWE)(EIP-4361) message and provide the parsed message
+ *
+ * @typedef SIWEMessage
+ * @param {boolean} isSIWEMessage - Does the intercepted message conform to the SIWE specification?
+ * @param {ParsedMessage} parsedMessage - The data parsed out of the message
+ */
+export type SIWEMessage = {
+    isSIWEMessage: true;
+    parsedMessage: ParsedMessage;
+} | {
+    isSIWEMessage: false;
+    parsedMessage: null;
+};
+/**
+ * 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
+ */
+export declare const detectSIWE: (msgParams: {
+    data: string;
+}) => SIWEMessage;
+export {};
+//# sourceMappingURL=siwe.d.mts.map

package/dist/siwe.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"siwe.d.mts","sourceRoot":"","sources":["../src/siwe.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,8BAA8B;AAqCtD;;;;;;;GAOG;AAIH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,WAAW,CAAC;CACnB;AAKD,UAAU,WAAW;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAOD;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,WACnB,MAAM,kBACE,MAAM,KACrB,WAKF,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,QAAS,kBAAkB,KAAG,OA4C3D,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,aAAa,EAAE,IAAI,CAAC;IAAC,aAAa,EAAE,aAAa,CAAA;CAAE,GACrD;IAAE,aAAa,EAAE,KAAK,CAAC;IAAC,aAAa,EAAE,IAAI,CAAA;CAAE,CAAC;AAElD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,cAAe;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,KAAG,WAiBxD,CAAC"}

package/dist/siwe.mjs

@@ -1,12 +1,122 @@
-import {
-  detectSIWE,
-  isValidSIWEOrigin,
-  parseDomainParts
-} from "./chunk-VDEIYYE4.mjs";
-import "./chunk-RZFCNKW4.mjs";
-export {
-  detectSIWE,
-  isValidSIWEOrigin,
-  parseDomainParts
+import { remove0x } from "@metamask/utils";
+import { ParsedMessage } from "@spruceid/siwe-parser";
+import { projectLogger, createModuleLogger } from "./logger.mjs";
+const log = createModuleLogger(projectLogger, 'detect-siwe');
+/**
+ * This function strips the hex prefix from a string if it has one.
+ * If the input is not a string, return it unmodified.
+ *
+ * @param str - The string to check
+ * @returns The string without the hex prefix
+ */
+function safeStripHexPrefix(str) {
+    if (typeof str !== 'string') {
+        return str;
+    }
+    return remove0x(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 = safeStripHexPrefix(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
+ */
+export const parseDomainParts = (domain, originProtocol) => {
+    if (domain.match(/^[^/:]*:\/\//u)) {
+        return new URL(domain);
+    }
+    return new URL(`${originProtocol}//${domain}`);
+};
+/**
+ * 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
+ */
+export const isValidSIWEOrigin = (req) => {
+    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 || !siwe?.parsedMessage?.domain) {
+            return false;
+        }
+        const originParts = new URL(origin);
+        const domainParts = 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;
+    }
+};
+/**
+ * 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
+ */
+export const detectSIWE = (msgParams) => {
+    try {
+        const { data } = msgParams;
+        const message = msgHexToText(data);
+        const parsedMessage = new ParsedMessage(message);
+        return {
+            isSIWEMessage: true,
+            parsedMessage,
+        };
+    }
+    catch (error) {
+        // ignore error, it's not a valid SIWE message
+        return {
+            isSIWEMessage: false,
+            parsedMessage: null,
+        };
+    }
 };
 //# sourceMappingURL=siwe.mjs.map

package/dist/siwe.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"siwe.mjs","sourceRoot":"","sources":["../src/siwe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,wBAAwB;AAC3C,OAAO,EAAE,aAAa,EAAE,8BAA8B;AAEtD,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,qBAAiB;AAE7D,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AAE7D;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,GAAW;IACrC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,GAAG,CAAC;KACZ;IACD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,GAAW;IAC/B,IAAI;QACF,MAAM,QAAQ,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACzC,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;AA4BD,MAAM,yBAAyB,GAAG;IAChC,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,KAAK;CACU,CAAC;AAE5B;;;;;;GAMG;AACH,MAAM,CAAC,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;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,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,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE;YAC3C,OAAO,KAAK,CAAC;SACd;QAED,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,WAAW,GAAG,gBAAgB,CAClC,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;AAaF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,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,aAAa,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","sourcesContent":["import { remove0x } from '@metamask/utils';\nimport { ParsedMessage } from '@spruceid/siwe-parser';\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 * If the input is not a string, return it unmodified.\n *\n * @param str - The string to check\n * @returns The string without the hex prefix\n */\nfunction safeStripHexPrefix(str: string) {\n  if (typeof str !== 'string') {\n    return str;\n  }\n  return remove0x(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 = safeStripHexPrefix(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 */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface WrappedSIWERequest {\n  from: string;\n  origin: string;\n  siwe: SIWEMessage;\n}\n\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\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"]}