@metamask-previews/transaction-controller 69.6.1-preview-4f4c98e → 69.6.1-preview-eb263b0ee

package/dist/utils/transaction-type.cjs

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasTransactionType = exports.decodeTransactionData = exports.determineTransactionType = exports.ESTIMATE_GAS_ERROR = void 0;
+const abi_1 = require("@ethersproject/abi");
+const metamask_eth_abis_1 = require("@metamask/metamask-eth-abis");
+const types_js_1 = require("../types.cjs");
+const eip7702_js_1 = require("./eip7702.cjs");
+const provider_js_1 = require("./provider.cjs");
+exports.ESTIMATE_GAS_ERROR = 'eth_estimateGas rpc method error';
+const ERC20Interface = new abi_1.Interface(metamask_eth_abis_1.abiERC20);
+const ERC721Interface = new abi_1.Interface(metamask_eth_abis_1.abiERC721);
+const ERC1155Interface = new abi_1.Interface(metamask_eth_abis_1.abiERC1155);
+const USDCInterface = new abi_1.Interface(metamask_eth_abis_1.abiFiatTokenV2);
+/**
+ * Determines the type of the transaction by analyzing the txParams.
+ * It will never return TRANSACTION_TYPE_CANCEL or TRANSACTION_TYPE_RETRY as these
+ * represent specific events that we specify manually at transaction creation.
+ *
+ * @param txParams - Parameters for the transaction.
+ * @param options - Optional messenger and network client ID to query the network.
+ * @param options.messenger - The TransactionController messenger.
+ * @param options.networkClientId - The network client ID to use.
+ * @returns A object with the transaction type and the contract code response in Hex.
+ */
+async function determineTransactionType(txParams, options) {
+    const { data, to } = txParams;
+    const hasRealBytecode = Boolean(data && data !== '0x' && data.length > 2);
+    if (hasRealBytecode && !to) {
+        return { type: types_js_1.TransactionType.deployContract, getCodeResponse: undefined };
+    }
+    let getCodeResponse;
+    let isContractAddress = Boolean(data?.length);
+    if (options) {
+        const { messenger, networkClientId } = options;
+        const response = await readAddressAsContract(messenger, networkClientId, to);
+        getCodeResponse = response.contractCode;
+        isContractAddress = response.isContractAddress;
+    }
+    if (!isContractAddress) {
+        return { type: types_js_1.TransactionType.simpleSend, getCodeResponse };
+    }
+    const hasValue = Number(txParams.value ?? '0') !== 0;
+    const contractInteractionResult = {
+        type: types_js_1.TransactionType.contractInteraction,
+        getCodeResponse,
+    };
+    if (!data || hasValue) {
+        return contractInteractionResult;
+    }
+    const name = getMethodName(data);
+    if (!name) {
+        return contractInteractionResult;
+    }
+    const tokenMethodName = [
+        types_js_1.TransactionType.tokenMethodApprove,
+        types_js_1.TransactionType.tokenMethodSetApprovalForAll,
+        types_js_1.TransactionType.tokenMethodTransfer,
+        types_js_1.TransactionType.tokenMethodTransferFrom,
+        types_js_1.TransactionType.tokenMethodSafeTransferFrom,
+        types_js_1.TransactionType.tokenMethodIncreaseAllowance,
+    ].find((methodName) => methodName.toLowerCase() === name.toLowerCase());
+    if (tokenMethodName) {
+        return { type: tokenMethodName, getCodeResponse };
+    }
+    return contractInteractionResult;
+}
+exports.determineTransactionType = determineTransactionType;
+/**
+ * Parses transaction data using ABIs for three different token standards: ERC20, ERC721, ERC1155 and USDC.
+ * The data will decode correctly if the transaction is an interaction with a contract that matches one of these
+ * contract standards
+ *
+ * @param data - Encoded transaction data.
+ * @param options - Options bag.
+ * @param options.getMethodName - Whether to get the method name.
+ * @returns A representation of an ethereum contract call.
+ */
+function decodeTransactionData(data, options) {
+    if (!data || data.length < 10) {
+        return undefined;
+    }
+    const fourByte = data.substring(0, 10).toLowerCase();
+    for (const iface of [
+        ERC20Interface,
+        ERC721Interface,
+        ERC1155Interface,
+        USDCInterface,
+    ]) {
+        try {
+            if (options?.getMethodName) {
+                return iface.getFunction(fourByte)?.name;
+            }
+            return iface.parseTransaction({ data });
+        }
+        catch {
+            // Intentionally empty
+        }
+    }
+    return undefined;
+}
+exports.decodeTransactionData = decodeTransactionData;
+/**
+ * Attempts to get the method name from the given transaction data.
+ *
+ * @param data - Encoded transaction data.
+ * @returns The method name.
+ */
+function getMethodName(data) {
+    return decodeTransactionData(data, {
+        getMethodName: true,
+    });
+}
+/**
+ * Reads an Ethereum address and determines if it is a contract address.
+ *
+ * @param messenger - The TransactionController messenger.
+ * @param networkClientId - The network client ID to use.
+ * @param address - The Ethereum address.
+ * @returns An object containing the contract code and a boolean indicating if it is a contract address.
+ */
+async function readAddressAsContract(messenger, networkClientId, address) {
+    let contractCode;
+    try {
+        contractCode = (await (0, provider_js_1.rpcRequest)({
+            messenger,
+            networkClientId,
+            method: 'eth_getCode',
+            params: [address, 'latest'],
+        }));
+        // Not used
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    }
+    catch (error) {
+        contractCode = null;
+    }
+    const isContractAddress = contractCode
+        ? contractCode !== '0x' &&
+            contractCode !== '0x0' &&
+            !contractCode.startsWith(eip7702_js_1.DELEGATION_PREFIX)
+        : false;
+    return { contractCode, isContractAddress };
+}
+/**
+ * Check whether a transaction (or any of its nested transactions) has one of
+ * the given types.
+ *
+ * @param transactionMeta - Transaction metadata.
+ * @param types - Transaction types to match against.
+ * @returns `true` when the transaction or a nested transaction has one of the given types.
+ */
+function hasTransactionType(transactionMeta, types) {
+    const { nestedTransactions, type } = transactionMeta ?? {};
+    if (types.includes(type)) {
+        return true;
+    }
+    return (nestedTransactions?.some((tx) => types.includes(tx.type)) ?? false);
+}
+exports.hasTransactionType = hasTransactionType;
+//# sourceMappingURL=transaction-type.cjs.map

package/dist/utils/transaction-type.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-type.cjs","sourceRoot":"","sources":["../../src/utils/transaction-type.ts"],"names":[],"mappings":";;;AAAA,4CAA+C;AAE/C,mEAKqC;AASrC,2CAA8C;AAC9C,8CAAiD;AACjD,gDAA2C;AAE9B,QAAA,kBAAkB,GAAG,kCAAkC,CAAC;AAErE,MAAM,cAAc,GAAG,IAAI,eAAS,CAAC,4BAAQ,CAAC,CAAC;AAC/C,MAAM,eAAe,GAAG,IAAI,eAAS,CAAC,6BAAS,CAAC,CAAC;AACjD,MAAM,gBAAgB,GAAG,IAAI,eAAS,CAAC,8BAAU,CAAC,CAAC;AACnD,MAAM,aAAa,GAAG,IAAI,eAAS,CAAC,kCAAc,CAAC,CAAC;AAEpD;;;;;;;;;;GAUG;AACI,KAAK,UAAU,wBAAwB,CAC5C,QAA2B,EAC3B,OAGC;IAED,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,QAAQ,CAAC;IAE9B,MAAM,eAAe,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE1E,IAAI,eAAe,IAAI,CAAC,EAAE,EAAE,CAAC;QAC3B,OAAO,EAAE,IAAI,EAAE,0BAAe,CAAC,cAAc,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC;IAC9E,CAAC;IAED,IAAI,eAAe,CAAC;IACpB,IAAI,iBAAiB,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAE9C,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QAC/C,MAAM,QAAQ,GAAG,MAAM,qBAAqB,CAC1C,SAAS,EACT,eAAe,EACf,EAAE,CACH,CAAC;QAEF,eAAe,GAAG,QAAQ,CAAC,YAAY,CAAC;QACxC,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IACjD,CAAC;IAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,OAAO,EAAE,IAAI,EAAE,0BAAe,CAAC,UAAU,EAAE,eAAe,EAAE,CAAC;IAC/D,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IAErD,MAAM,yBAAyB,GAAG;QAChC,IAAI,EAAE,0BAAe,CAAC,mBAAmB;QACzC,eAAe;KAChB,CAAC;IAEF,IAAI,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC;QACtB,OAAO,yBAAyB,CAAC;IACnC,CAAC;IAED,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAEjC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,yBAAyB,CAAC;IACnC,CAAC;IAED,MAAM,eAAe,GAAG;QACtB,0BAAe,CAAC,kBAAkB;QAClC,0BAAe,CAAC,4BAA4B;QAC5C,0BAAe,CAAC,mBAAmB;QACnC,0BAAe,CAAC,uBAAuB;QACvC,0BAAe,CAAC,2BAA2B;QAC3C,0BAAe,CAAC,4BAA4B;KAC7C,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAExE,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,eAAe,EAAE,CAAC;IACpD,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAjED,4DAiEC;AAED;;;;;;;;;GASG;AACH,SAAgB,qBAAqB,CACnC,IAAY,EACZ,OAEC;IAED,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IAErD,KAAK,MAAM,KAAK,IAAI;QAClB,cAAc;QACd,eAAe;QACf,gBAAgB;QAChB,aAAa;KACd,EAAE,CAAC;QACF,IAAI,CAAC;YACH,IAAI,OAAO,EAAE,aAAa,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;YAC3C,CAAC;YACD,OAAO,KAAK,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1C,CAAC;QAAC,MAAM,CAAC;YACP,sBAAsB;QACxB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AA7BD,sDA6BC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,IAAa;IAClC,OAAO,qBAAqB,CAAC,IAAc,EAAE;QAC3C,aAAa,EAAE,IAAI;KACpB,CAAuB,CAAC;AAC3B,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,qBAAqB,CAClC,SAAyC,EACzC,eAAgC,EAChC,OAAgB;IAKhB,IAAI,YAAY,CAAC;IACjB,IAAI,CAAC;QACH,YAAY,GAAG,CAAC,MAAM,IAAA,wBAAU,EAAC;YAC/B,SAAS;YACT,eAAe;YACf,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,CAAC,OAAiB,EAAE,QAAQ,CAAC;SACtC,CAAC,CAAW,CAAC;QACd,WAAW;QACX,6DAA6D;IAC/D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,YAAY,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,MAAM,iBAAiB,GAAG,YAAY;QACpC,CAAC,CAAC,YAAY,KAAK,IAAI;YACrB,YAAY,KAAK,KAAK;YACtB,CAAC,YAAY,CAAC,UAAU,CAAC,8BAAiB,CAAC;QAC7C,CAAC,CAAC,KAAK,CAAC;IACV,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAChC,eAA4C,EAC5C,KAAiC;IAEjC,MAAM,EAAE,kBAAkB,EAAE,IAAI,EAAE,GAAG,eAAe,IAAI,EAAE,CAAC;IAE3D,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAuB,CAAC,EAAE,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CACL,kBAAkB,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAC9B,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAuB,CAAC,CAC3C,IAAI,KAAK,CACX,CAAC;AACJ,CAAC;AAfD,gDAeC","sourcesContent":["import { Interface } from '@ethersproject/abi';\nimport type { TransactionDescription } from '@ethersproject/abi';\nimport {\n  abiERC721,\n  abiERC20,\n  abiERC1155,\n  abiFiatTokenV2,\n} from '@metamask/metamask-eth-abis';\nimport type { NetworkClientId } from '@metamask/network-controller';\n\nimport type { TransactionControllerMessenger } from '../TransactionController.js';\nimport type {\n  InferTransactionTypeResult,\n  TransactionMeta,\n  TransactionParams,\n} from '../types.js';\nimport { TransactionType } from '../types.js';\nimport { DELEGATION_PREFIX } from './eip7702.js';\nimport { rpcRequest } from './provider.js';\n\nexport const ESTIMATE_GAS_ERROR = 'eth_estimateGas rpc method error';\n\nconst ERC20Interface = new Interface(abiERC20);\nconst ERC721Interface = new Interface(abiERC721);\nconst ERC1155Interface = new Interface(abiERC1155);\nconst USDCInterface = new Interface(abiFiatTokenV2);\n\n/**\n * Determines the type of the transaction by analyzing the txParams.\n * It will never return TRANSACTION_TYPE_CANCEL or TRANSACTION_TYPE_RETRY as these\n * represent specific events that we specify manually at transaction creation.\n *\n * @param txParams - Parameters for the transaction.\n * @param options - Optional messenger and network client ID to query the network.\n * @param options.messenger - The TransactionController messenger.\n * @param options.networkClientId - The network client ID to use.\n * @returns A object with the transaction type and the contract code response in Hex.\n */\nexport async function determineTransactionType(\n  txParams: TransactionParams,\n  options?: {\n    messenger: TransactionControllerMessenger;\n    networkClientId: NetworkClientId;\n  },\n): Promise<InferTransactionTypeResult> {\n  const { data, to } = txParams;\n\n  const hasRealBytecode = Boolean(data && data !== '0x' && data.length > 2);\n\n  if (hasRealBytecode && !to) {\n    return { type: TransactionType.deployContract, getCodeResponse: undefined };\n  }\n\n  let getCodeResponse;\n  let isContractAddress = Boolean(data?.length);\n\n  if (options) {\n    const { messenger, networkClientId } = options;\n    const response = await readAddressAsContract(\n      messenger,\n      networkClientId,\n      to,\n    );\n\n    getCodeResponse = response.contractCode;\n    isContractAddress = response.isContractAddress;\n  }\n\n  if (!isContractAddress) {\n    return { type: TransactionType.simpleSend, getCodeResponse };\n  }\n\n  const hasValue = Number(txParams.value ?? '0') !== 0;\n\n  const contractInteractionResult = {\n    type: TransactionType.contractInteraction,\n    getCodeResponse,\n  };\n\n  if (!data || hasValue) {\n    return contractInteractionResult;\n  }\n\n  const name = getMethodName(data);\n\n  if (!name) {\n    return contractInteractionResult;\n  }\n\n  const tokenMethodName = [\n    TransactionType.tokenMethodApprove,\n    TransactionType.tokenMethodSetApprovalForAll,\n    TransactionType.tokenMethodTransfer,\n    TransactionType.tokenMethodTransferFrom,\n    TransactionType.tokenMethodSafeTransferFrom,\n    TransactionType.tokenMethodIncreaseAllowance,\n  ].find((methodName) => methodName.toLowerCase() === name.toLowerCase());\n\n  if (tokenMethodName) {\n    return { type: tokenMethodName, getCodeResponse };\n  }\n\n  return contractInteractionResult;\n}\n\n/**\n * Parses transaction data using ABIs for three different token standards: ERC20, ERC721, ERC1155 and USDC.\n * The data will decode correctly if the transaction is an interaction with a contract that matches one of these\n * contract standards\n *\n * @param data - Encoded transaction data.\n * @param options - Options bag.\n * @param options.getMethodName - Whether to get the method name.\n * @returns A representation of an ethereum contract call.\n */\nexport function decodeTransactionData(\n  data: string,\n  options?: {\n    getMethodName?: boolean;\n  },\n): undefined | TransactionDescription | string {\n  if (!data || data.length < 10) {\n    return undefined;\n  }\n\n  const fourByte = data.substring(0, 10).toLowerCase();\n\n  for (const iface of [\n    ERC20Interface,\n    ERC721Interface,\n    ERC1155Interface,\n    USDCInterface,\n  ]) {\n    try {\n      if (options?.getMethodName) {\n        return iface.getFunction(fourByte)?.name;\n      }\n      return iface.parseTransaction({ data });\n    } catch {\n      // Intentionally empty\n    }\n  }\n\n  return undefined;\n}\n\n/**\n * Attempts to get the method name from the given transaction data.\n *\n * @param data - Encoded transaction data.\n * @returns The method name.\n */\nfunction getMethodName(data?: string): string | undefined {\n  return decodeTransactionData(data as string, {\n    getMethodName: true,\n  }) as string | undefined;\n}\n\n/**\n * Reads an Ethereum address and determines if it is a contract address.\n *\n * @param messenger - The TransactionController messenger.\n * @param networkClientId - The network client ID to use.\n * @param address - The Ethereum address.\n * @returns An object containing the contract code and a boolean indicating if it is a contract address.\n */\nasync function readAddressAsContract(\n  messenger: TransactionControllerMessenger,\n  networkClientId: NetworkClientId,\n  address?: string,\n): Promise<{\n  contractCode: string | null;\n  isContractAddress: boolean;\n}> {\n  let contractCode;\n  try {\n    contractCode = (await rpcRequest({\n      messenger,\n      networkClientId,\n      method: 'eth_getCode',\n      params: [address as string, 'latest'],\n    })) as string;\n    // Not used\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  } catch (error) {\n    contractCode = null;\n  }\n\n  const isContractAddress = contractCode\n    ? contractCode !== '0x' &&\n      contractCode !== '0x0' &&\n      !contractCode.startsWith(DELEGATION_PREFIX)\n    : false;\n  return { contractCode, isContractAddress };\n}\n\n/**\n * Check whether a transaction (or any of its nested transactions) has one of\n * the given types.\n *\n * @param transactionMeta - Transaction metadata.\n * @param types - Transaction types to match against.\n * @returns `true` when the transaction or a nested transaction has one of the given types.\n */\nexport function hasTransactionType(\n  transactionMeta: TransactionMeta | undefined,\n  types: readonly TransactionType[],\n): boolean {\n  const { nestedTransactions, type } = transactionMeta ?? {};\n\n  if (types.includes(type as TransactionType)) {\n    return true;\n  }\n\n  return (\n    nestedTransactions?.some((tx) =>\n      types.includes(tx.type as TransactionType),\n    ) ?? false\n  );\n}\n"]}

package/dist/utils/{transaction-type.d.ts → transaction-type.d.cts}

@@ -1,8 +1,8 @@
-import type { TransactionDescription } from '@ethersproject/abi';
-import type { NetworkClientId } from '@metamask/network-controller';
-import type { TransactionControllerMessenger } from '../TransactionController.js';
-import type { InferTransactionTypeResult, TransactionMeta, TransactionParams } from '../types.js';
-import { TransactionType } from '../types.js';
+import type { TransactionDescription } from "@ethersproject/abi";
+import type { NetworkClientId } from "@metamask/network-controller";
+import type { TransactionControllerMessenger } from "../TransactionController.cjs";
+import type { InferTransactionTypeResult, TransactionMeta, TransactionParams } from "../types.cjs";
+import { TransactionType } from "../types.cjs";
 export declare const ESTIMATE_GAS_ERROR = "eth_estimateGas rpc method error";
 /**
  * Determines the type of the transaction by analyzing the txParams.
@@ -41,4 +41,4 @@ export declare function decodeTransactionData(data: string, options?: {
  * @returns `true` when the transaction or a nested transaction has one of the given types.
  */
 export declare function hasTransactionType(transactionMeta: TransactionMeta | undefined, types: readonly TransactionType[]): boolean;
-//# sourceMappingURL=transaction-type.d.ts.map
+//# sourceMappingURL=transaction-type.d.cts.map

package/dist/utils/transaction-type.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-type.d.cts","sourceRoot":"","sources":["../../src/utils/transaction-type.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,2BAA2B;AAOjE,OAAO,KAAK,EAAE,eAAe,EAAE,qCAAqC;AAEpE,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAoC;AAClF,OAAO,KAAK,EACV,0BAA0B,EAC1B,eAAe,EACf,iBAAiB,EAClB,qBAAoB;AACrB,OAAO,EAAE,eAAe,EAAE,qBAAoB;AAI9C,eAAO,MAAM,kBAAkB,qCAAqC,CAAC;AAOrE;;;;;;;;;;GAUG;AACH,wBAAsB,wBAAwB,CAC5C,QAAQ,EAAE,iBAAiB,EAC3B,OAAO,CAAC,EAAE;IACR,SAAS,EAAE,8BAA8B,CAAC;IAC1C,eAAe,EAAE,eAAe,CAAC;CAClC,GACA,OAAO,CAAC,0BAA0B,CAAC,CA2DrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;IACR,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,GACA,SAAS,GAAG,sBAAsB,GAAG,MAAM,CAwB7C;AAoDD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,eAAe,GAAG,SAAS,EAC5C,KAAK,EAAE,SAAS,eAAe,EAAE,GAChC,OAAO,CAYT"}

package/dist/utils/transaction-type.d.mts

@@ -0,0 +1,44 @@
+import type { TransactionDescription } from "@ethersproject/abi";
+import type { NetworkClientId } from "@metamask/network-controller";
+import type { TransactionControllerMessenger } from "../TransactionController.mjs";
+import type { InferTransactionTypeResult, TransactionMeta, TransactionParams } from "../types.mjs";
+import { TransactionType } from "../types.mjs";
+export declare const ESTIMATE_GAS_ERROR = "eth_estimateGas rpc method error";
+/**
+ * Determines the type of the transaction by analyzing the txParams.
+ * It will never return TRANSACTION_TYPE_CANCEL or TRANSACTION_TYPE_RETRY as these
+ * represent specific events that we specify manually at transaction creation.
+ *
+ * @param txParams - Parameters for the transaction.
+ * @param options - Optional messenger and network client ID to query the network.
+ * @param options.messenger - The TransactionController messenger.
+ * @param options.networkClientId - The network client ID to use.
+ * @returns A object with the transaction type and the contract code response in Hex.
+ */
+export declare function determineTransactionType(txParams: TransactionParams, options?: {
+    messenger: TransactionControllerMessenger;
+    networkClientId: NetworkClientId;
+}): Promise<InferTransactionTypeResult>;
+/**
+ * Parses transaction data using ABIs for three different token standards: ERC20, ERC721, ERC1155 and USDC.
+ * The data will decode correctly if the transaction is an interaction with a contract that matches one of these
+ * contract standards
+ *
+ * @param data - Encoded transaction data.
+ * @param options - Options bag.
+ * @param options.getMethodName - Whether to get the method name.
+ * @returns A representation of an ethereum contract call.
+ */
+export declare function decodeTransactionData(data: string, options?: {
+    getMethodName?: boolean;
+}): undefined | TransactionDescription | string;
+/**
+ * Check whether a transaction (or any of its nested transactions) has one of
+ * the given types.
+ *
+ * @param transactionMeta - Transaction metadata.
+ * @param types - Transaction types to match against.
+ * @returns `true` when the transaction or a nested transaction has one of the given types.
+ */
+export declare function hasTransactionType(transactionMeta: TransactionMeta | undefined, types: readonly TransactionType[]): boolean;
+//# sourceMappingURL=transaction-type.d.mts.map

package/dist/utils/transaction-type.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-type.d.mts","sourceRoot":"","sources":["../../src/utils/transaction-type.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,2BAA2B;AAOjE,OAAO,KAAK,EAAE,eAAe,EAAE,qCAAqC;AAEpE,OAAO,KAAK,EAAE,8BAA8B,EAAE,qCAAoC;AAClF,OAAO,KAAK,EACV,0BAA0B,EAC1B,eAAe,EACf,iBAAiB,EAClB,qBAAoB;AACrB,OAAO,EAAE,eAAe,EAAE,qBAAoB;AAI9C,eAAO,MAAM,kBAAkB,qCAAqC,CAAC;AAOrE;;;;;;;;;;GAUG;AACH,wBAAsB,wBAAwB,CAC5C,QAAQ,EAAE,iBAAiB,EAC3B,OAAO,CAAC,EAAE;IACR,SAAS,EAAE,8BAA8B,CAAC;IAC1C,eAAe,EAAE,eAAe,CAAC;CAClC,GACA,OAAO,CAAC,0BAA0B,CAAC,CA2DrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;IACR,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,GACA,SAAS,GAAG,sBAAsB,GAAG,MAAM,CAwB7C;AAoDD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,eAAe,GAAG,SAAS,EAC5C,KAAK,EAAE,SAAS,eAAe,EAAE,GAChC,OAAO,CAYT"}

package/dist/utils/{transaction-type.js → transaction-type.mjs}

@@ -1,8 +1,8 @@
-import { Interface } from '@ethersproject/abi';
-import { abiERC721, abiERC20, abiERC1155, abiFiatTokenV2, } from '@metamask/metamask-eth-abis';
-import { TransactionType } from '../types.js';
-import { DELEGATION_PREFIX } from './eip7702.js';
-import { rpcRequest } from './provider.js';
+import { Interface } from "@ethersproject/abi";
+import { abiERC721, abiERC20, abiERC1155, abiFiatTokenV2 } from "@metamask/metamask-eth-abis";
+import { TransactionType } from "../types.mjs";
+import { DELEGATION_PREFIX } from "./eip7702.mjs";
+import { rpcRequest } from "./provider.mjs";
 export const ESTIMATE_GAS_ERROR = 'eth_estimateGas rpc method error';
 const ERC20Interface = new Interface(abiERC20);
 const ERC721Interface = new Interface(abiERC721);
@@ -150,4 +150,4 @@ export function hasTransactionType(transactionMeta, types) {
     }
     return (nestedTransactions?.some((tx) => types.includes(tx.type)) ?? false);
 }
-//# sourceMappingURL=transaction-type.js.map
+//# sourceMappingURL=transaction-type.mjs.map

package/dist/utils/transaction-type.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-type.mjs","sourceRoot":"","sources":["../../src/utils/transaction-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,2BAA2B;AAE/C,OAAO,EACL,SAAS,EACT,QAAQ,EACR,UAAU,EACV,cAAc,EACf,oCAAoC;AASrC,OAAO,EAAE,eAAe,EAAE,qBAAoB;AAC9C,OAAO,EAAE,iBAAiB,EAAE,sBAAqB;AACjD,OAAO,EAAE,UAAU,EAAE,uBAAsB;AAE3C,MAAM,CAAC,MAAM,kBAAkB,GAAG,kCAAkC,CAAC;AAErE,MAAM,cAAc,GAAG,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC;AAC/C,MAAM,eAAe,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC;AACjD,MAAM,gBAAgB,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;AACnD,MAAM,aAAa,GAAG,IAAI,SAAS,CAAC,cAAc,CAAC,CAAC;AAEpD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,QAA2B,EAC3B,OAGC;IAED,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,QAAQ,CAAC;IAE9B,MAAM,eAAe,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE1E,IAAI,eAAe,IAAI,CAAC,EAAE,EAAE,CAAC;QAC3B,OAAO,EAAE,IAAI,EAAE,eAAe,CAAC,cAAc,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC;IAC9E,CAAC;IAED,IAAI,eAAe,CAAC;IACpB,IAAI,iBAAiB,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAE9C,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QAC/C,MAAM,QAAQ,GAAG,MAAM,qBAAqB,CAC1C,SAAS,EACT,eAAe,EACf,EAAE,CACH,CAAC;QAEF,eAAe,GAAG,QAAQ,CAAC,YAAY,CAAC;QACxC,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IACjD,CAAC;IAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,OAAO,EAAE,IAAI,EAAE,eAAe,CAAC,UAAU,EAAE,eAAe,EAAE,CAAC;IAC/D,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;IAErD,MAAM,yBAAyB,GAAG;QAChC,IAAI,EAAE,eAAe,CAAC,mBAAmB;QACzC,eAAe;KAChB,CAAC;IAEF,IAAI,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC;QACtB,OAAO,yBAAyB,CAAC;IACnC,CAAC;IAED,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAEjC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,yBAAyB,CAAC;IACnC,CAAC;IAED,MAAM,eAAe,GAAG;QACtB,eAAe,CAAC,kBAAkB;QAClC,eAAe,CAAC,4BAA4B;QAC5C,eAAe,CAAC,mBAAmB;QACnC,eAAe,CAAC,uBAAuB;QACvC,eAAe,CAAC,2BAA2B;QAC3C,eAAe,CAAC,4BAA4B;KAC7C,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAExE,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,eAAe,EAAE,CAAC;IACpD,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,qBAAqB,CACnC,IAAY,EACZ,OAEC;IAED,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IAErD,KAAK,MAAM,KAAK,IAAI;QAClB,cAAc;QACd,eAAe;QACf,gBAAgB;QAChB,aAAa;KACd,EAAE,CAAC;QACF,IAAI,CAAC;YACH,IAAI,OAAO,EAAE,aAAa,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;YAC3C,CAAC;YACD,OAAO,KAAK,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1C,CAAC;QAAC,MAAM,CAAC;YACP,sBAAsB;QACxB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,IAAa;IAClC,OAAO,qBAAqB,CAAC,IAAc,EAAE;QAC3C,aAAa,EAAE,IAAI;KACpB,CAAuB,CAAC;AAC3B,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,qBAAqB,CAClC,SAAyC,EACzC,eAAgC,EAChC,OAAgB;IAKhB,IAAI,YAAY,CAAC;IACjB,IAAI,CAAC;QACH,YAAY,GAAG,CAAC,MAAM,UAAU,CAAC;YAC/B,SAAS;YACT,eAAe;YACf,MAAM,EAAE,aAAa;YACrB,MAAM,EAAE,CAAC,OAAiB,EAAE,QAAQ,CAAC;SACtC,CAAC,CAAW,CAAC;QACd,WAAW;QACX,6DAA6D;IAC/D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,YAAY,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,MAAM,iBAAiB,GAAG,YAAY;QACpC,CAAC,CAAC,YAAY,KAAK,IAAI;YACrB,YAAY,KAAK,KAAK;YACtB,CAAC,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC;QAC7C,CAAC,CAAC,KAAK,CAAC;IACV,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,eAA4C,EAC5C,KAAiC;IAEjC,MAAM,EAAE,kBAAkB,EAAE,IAAI,EAAE,GAAG,eAAe,IAAI,EAAE,CAAC;IAE3D,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAuB,CAAC,EAAE,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CACL,kBAAkB,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAC9B,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAuB,CAAC,CAC3C,IAAI,KAAK,CACX,CAAC;AACJ,CAAC","sourcesContent":["import { Interface } from '@ethersproject/abi';\nimport type { TransactionDescription } from '@ethersproject/abi';\nimport {\n  abiERC721,\n  abiERC20,\n  abiERC1155,\n  abiFiatTokenV2,\n} from '@metamask/metamask-eth-abis';\nimport type { NetworkClientId } from '@metamask/network-controller';\n\nimport type { TransactionControllerMessenger } from '../TransactionController.js';\nimport type {\n  InferTransactionTypeResult,\n  TransactionMeta,\n  TransactionParams,\n} from '../types.js';\nimport { TransactionType } from '../types.js';\nimport { DELEGATION_PREFIX } from './eip7702.js';\nimport { rpcRequest } from './provider.js';\n\nexport const ESTIMATE_GAS_ERROR = 'eth_estimateGas rpc method error';\n\nconst ERC20Interface = new Interface(abiERC20);\nconst ERC721Interface = new Interface(abiERC721);\nconst ERC1155Interface = new Interface(abiERC1155);\nconst USDCInterface = new Interface(abiFiatTokenV2);\n\n/**\n * Determines the type of the transaction by analyzing the txParams.\n * It will never return TRANSACTION_TYPE_CANCEL or TRANSACTION_TYPE_RETRY as these\n * represent specific events that we specify manually at transaction creation.\n *\n * @param txParams - Parameters for the transaction.\n * @param options - Optional messenger and network client ID to query the network.\n * @param options.messenger - The TransactionController messenger.\n * @param options.networkClientId - The network client ID to use.\n * @returns A object with the transaction type and the contract code response in Hex.\n */\nexport async function determineTransactionType(\n  txParams: TransactionParams,\n  options?: {\n    messenger: TransactionControllerMessenger;\n    networkClientId: NetworkClientId;\n  },\n): Promise<InferTransactionTypeResult> {\n  const { data, to } = txParams;\n\n  const hasRealBytecode = Boolean(data && data !== '0x' && data.length > 2);\n\n  if (hasRealBytecode && !to) {\n    return { type: TransactionType.deployContract, getCodeResponse: undefined };\n  }\n\n  let getCodeResponse;\n  let isContractAddress = Boolean(data?.length);\n\n  if (options) {\n    const { messenger, networkClientId } = options;\n    const response = await readAddressAsContract(\n      messenger,\n      networkClientId,\n      to,\n    );\n\n    getCodeResponse = response.contractCode;\n    isContractAddress = response.isContractAddress;\n  }\n\n  if (!isContractAddress) {\n    return { type: TransactionType.simpleSend, getCodeResponse };\n  }\n\n  const hasValue = Number(txParams.value ?? '0') !== 0;\n\n  const contractInteractionResult = {\n    type: TransactionType.contractInteraction,\n    getCodeResponse,\n  };\n\n  if (!data || hasValue) {\n    return contractInteractionResult;\n  }\n\n  const name = getMethodName(data);\n\n  if (!name) {\n    return contractInteractionResult;\n  }\n\n  const tokenMethodName = [\n    TransactionType.tokenMethodApprove,\n    TransactionType.tokenMethodSetApprovalForAll,\n    TransactionType.tokenMethodTransfer,\n    TransactionType.tokenMethodTransferFrom,\n    TransactionType.tokenMethodSafeTransferFrom,\n    TransactionType.tokenMethodIncreaseAllowance,\n  ].find((methodName) => methodName.toLowerCase() === name.toLowerCase());\n\n  if (tokenMethodName) {\n    return { type: tokenMethodName, getCodeResponse };\n  }\n\n  return contractInteractionResult;\n}\n\n/**\n * Parses transaction data using ABIs for three different token standards: ERC20, ERC721, ERC1155 and USDC.\n * The data will decode correctly if the transaction is an interaction with a contract that matches one of these\n * contract standards\n *\n * @param data - Encoded transaction data.\n * @param options - Options bag.\n * @param options.getMethodName - Whether to get the method name.\n * @returns A representation of an ethereum contract call.\n */\nexport function decodeTransactionData(\n  data: string,\n  options?: {\n    getMethodName?: boolean;\n  },\n): undefined | TransactionDescription | string {\n  if (!data || data.length < 10) {\n    return undefined;\n  }\n\n  const fourByte = data.substring(0, 10).toLowerCase();\n\n  for (const iface of [\n    ERC20Interface,\n    ERC721Interface,\n    ERC1155Interface,\n    USDCInterface,\n  ]) {\n    try {\n      if (options?.getMethodName) {\n        return iface.getFunction(fourByte)?.name;\n      }\n      return iface.parseTransaction({ data });\n    } catch {\n      // Intentionally empty\n    }\n  }\n\n  return undefined;\n}\n\n/**\n * Attempts to get the method name from the given transaction data.\n *\n * @param data - Encoded transaction data.\n * @returns The method name.\n */\nfunction getMethodName(data?: string): string | undefined {\n  return decodeTransactionData(data as string, {\n    getMethodName: true,\n  }) as string | undefined;\n}\n\n/**\n * Reads an Ethereum address and determines if it is a contract address.\n *\n * @param messenger - The TransactionController messenger.\n * @param networkClientId - The network client ID to use.\n * @param address - The Ethereum address.\n * @returns An object containing the contract code and a boolean indicating if it is a contract address.\n */\nasync function readAddressAsContract(\n  messenger: TransactionControllerMessenger,\n  networkClientId: NetworkClientId,\n  address?: string,\n): Promise<{\n  contractCode: string | null;\n  isContractAddress: boolean;\n}> {\n  let contractCode;\n  try {\n    contractCode = (await rpcRequest({\n      messenger,\n      networkClientId,\n      method: 'eth_getCode',\n      params: [address as string, 'latest'],\n    })) as string;\n    // Not used\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  } catch (error) {\n    contractCode = null;\n  }\n\n  const isContractAddress = contractCode\n    ? contractCode !== '0x' &&\n      contractCode !== '0x0' &&\n      !contractCode.startsWith(DELEGATION_PREFIX)\n    : false;\n  return { contractCode, isContractAddress };\n}\n\n/**\n * Check whether a transaction (or any of its nested transactions) has one of\n * the given types.\n *\n * @param transactionMeta - Transaction metadata.\n * @param types - Transaction types to match against.\n * @returns `true` when the transaction or a nested transaction has one of the given types.\n */\nexport function hasTransactionType(\n  transactionMeta: TransactionMeta | undefined,\n  types: readonly TransactionType[],\n): boolean {\n  const { nestedTransactions, type } = transactionMeta ?? {};\n\n  if (types.includes(type as TransactionType)) {\n    return true;\n  }\n\n  return (\n    nestedTransactions?.some((tx) =>\n      types.includes(tx.type as TransactionType),\n    ) ?? false\n  );\n}\n"]}

package/dist/utils/utils.cjs

@@ -0,0 +1,287 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.caip2ToHex = exports.setEnvelopeType = exports.getPercentageChange = exports.toBN = exports.bnFromHex = exports.padHexToEvenLength = exports.normalizeGasFeeValues = exports.normalizeTxError = exports.validateIfTransactionUnapprovedOrSubmitted = exports.validateIfTransactionUnapproved = exports.validateGasValues = exports.isEIP1559Transaction = exports.normalizeTransactionParams = exports.ESTIMATE_GAS_ERROR = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const utils_1 = require("@metamask/utils");
+const bn_js_1 = __importDefault(require("bn.js"));
+const types_js_1 = require("../types.cjs");
+exports.ESTIMATE_GAS_ERROR = 'eth_estimateGas rpc method error';
+// TODO: Replace `any` with type
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const NORMALIZERS = {
+    accessList: (accessList) => accessList,
+    authorizationList: (authorizationList) => authorizationList,
+    data: (data) => (0, utils_1.add0x)(padHexToEvenLength(data)),
+    from: (from) => (0, utils_1.add0x)(from).toLowerCase(),
+    gas: (gas) => (0, utils_1.add0x)(gas),
+    gasLimit: (gas) => (0, utils_1.add0x)(gas),
+    gasPrice: (gasPrice) => (0, utils_1.add0x)(gasPrice),
+    nonce: (nonce) => (0, utils_1.add0x)(nonce),
+    to: (to) => (0, utils_1.add0x)(to).toLowerCase(),
+    value: (value) => (0, utils_1.add0x)(value),
+    maxFeePerGas: (maxFeePerGas) => (0, utils_1.add0x)(maxFeePerGas),
+    maxPriorityFeePerGas: (maxPriorityFeePerGas) => (0, utils_1.add0x)(maxPriorityFeePerGas),
+    estimatedBaseFee: (maxPriorityFeePerGas) => (0, utils_1.add0x)(maxPriorityFeePerGas),
+    type: (type) => (0, utils_1.add0x)(type),
+};
+/**
+ * Normalizes properties on transaction params.
+ *
+ * @param txParams - The transaction params to normalize.
+ * @returns Normalized transaction params.
+ */
+function normalizeTransactionParams(txParams) {
+    const normalizedTxParams = { from: '' };
+    for (const key of (0, utils_1.getKnownPropertyNames)(NORMALIZERS)) {
+        if (txParams[key]) {
+            normalizedTxParams[key] = NORMALIZERS[key](txParams[key]);
+        }
+    }
+    normalizedTxParams.value ?? (normalizedTxParams.value = '0x0');
+    if (normalizedTxParams.gasLimit && !normalizedTxParams.gas) {
+        normalizedTxParams.gas = normalizedTxParams.gasLimit;
+    }
+    return normalizedTxParams;
+}
+exports.normalizeTransactionParams = normalizeTransactionParams;
+/**
+ * Checks if a transaction is EIP-1559 by checking for the existence of
+ * maxFeePerGas and maxPriorityFeePerGas within its parameters.
+ *
+ * @param txParams - Transaction params object to add.
+ * @returns Boolean that is true if the transaction is EIP-1559 (has maxFeePerGas and maxPriorityFeePerGas), otherwise returns false.
+ */
+function isEIP1559Transaction(txParams) {
+    const hasOwnProp = (obj, key) => Object.prototype.hasOwnProperty.call(obj, key);
+    return (hasOwnProp(txParams, 'maxFeePerGas') &&
+        hasOwnProp(txParams, 'maxPriorityFeePerGas'));
+}
+exports.isEIP1559Transaction = isEIP1559Transaction;
+const validateGasValues = (gasValues) => {
+    Object.keys(gasValues).forEach((key) => {
+        // TODO: Replace `any` with type
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const value = gasValues[key];
+        if (typeof value !== 'string' || !(0, utils_1.isStrictHexString)(value)) {
+            throw new TypeError(`expected hex string for ${key} but received: ${value}`);
+        }
+    });
+};
+exports.validateGasValues = validateGasValues;
+/**
+ * Validates that a transaction is unapproved.
+ * Throws if the transaction is not unapproved.
+ *
+ * @param transactionMeta - The transaction metadata to check.
+ * @param fnName - The name of the function calling this helper.
+ */
+function validateIfTransactionUnapproved(transactionMeta, fnName) {
+    if (transactionMeta?.status !== types_js_1.TransactionStatus.unapproved) {
+        throw new Error(`TransactionsController: Can only call ${fnName} on an unapproved transaction.\n      Current tx status: ${transactionMeta?.status}`);
+    }
+}
+exports.validateIfTransactionUnapproved = validateIfTransactionUnapproved;
+/**
+ * Validates that a transaction is unapproved or submitted.
+ * Throws if the transaction is not unapproved or submitted.
+ *
+ * @param transactionMeta - The transaction metadata to check.
+ * @param fnName - The name of the function calling this helper.
+ */
+function validateIfTransactionUnapprovedOrSubmitted(transactionMeta, fnName) {
+    const allowedStatuses = [
+        types_js_1.TransactionStatus.unapproved,
+        types_js_1.TransactionStatus.submitted,
+    ];
+    if (!transactionMeta || !allowedStatuses.includes(transactionMeta.status)) {
+        throw new Error(`TransactionsController: Can only call ${fnName} on an unapproved or submitted transaction.\n      Current tx status: ${transactionMeta?.status}`);
+    }
+}
+exports.validateIfTransactionUnapprovedOrSubmitted = validateIfTransactionUnapprovedOrSubmitted;
+/**
+ * Normalizes properties on transaction params.
+ *
+ * @param error - The error to be normalize.
+ * @returns Normalized transaction error.
+ */
+function normalizeTxError(error) {
+    return {
+        name: error.name,
+        message: error.message,
+        stack: error.stack,
+        code: error.code,
+        rpc: isJsonCompatible(error.value) ? error.value : undefined,
+    };
+}
+exports.normalizeTxError = normalizeTxError;
+/**
+ * Normalize an object containing gas fee values.
+ *
+ * @param gasFeeValues - An object containing gas fee values.
+ * @returns An object containing normalized gas fee values.
+ */
+function normalizeGasFeeValues(gasFeeValues) {
+    // TODO: Replace `any` with type
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const normalize = (value) => typeof value === 'string' ? (0, utils_1.add0x)(value) : value;
+    if ('gasPrice' in gasFeeValues) {
+        return {
+            gasPrice: normalize(gasFeeValues.gasPrice),
+        };
+    }
+    return {
+        maxFeePerGas: normalize(gasFeeValues.maxFeePerGas),
+        maxPriorityFeePerGas: normalize(gasFeeValues.maxPriorityFeePerGas),
+    };
+}
+exports.normalizeGasFeeValues = normalizeGasFeeValues;
+/**
+ * Determines whether the given value can be encoded as JSON.
+ *
+ * @param value - The value.
+ * @returns True if the value is JSON-encodable, false if not.
+ */
+function isJsonCompatible(value) {
+    try {
+        JSON.parse(JSON.stringify(value));
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Ensure a hex string is of even length by adding a leading 0 if necessary.
+ * Any existing `0x` prefix is preserved but is not added if missing.
+ *
+ * @param hexValue - The hex string to ensure is even.
+ * @returns The hex string with an even length.
+ */
+function padHexToEvenLength(hexValue) {
+    const prefix = hexValue.toLowerCase().startsWith('0x')
+        ? hexValue.slice(0, 2)
+        : '';
+    const data = prefix ? hexValue.slice(2) : hexValue;
+    const evenData = data.length % 2 === 0 ? data : `0${data}`;
+    return prefix + evenData;
+}
+exports.padHexToEvenLength = padHexToEvenLength;
+/**
+ * Create a BN from a hex string, accepting an optional 0x prefix.
+ *
+ * @param hexValue - Hex string with or without 0x prefix.
+ * @returns BN parsed as base-16.
+ */
+function bnFromHex(hexValue) {
+    const str = typeof hexValue === 'string' ? hexValue : hexValue;
+    const withoutPrefix = str.startsWith('0x') || str.startsWith('0X') ? str.slice(2) : str;
+    if (withoutPrefix.length === 0) {
+        return new bn_js_1.default(0);
+    }
+    return new bn_js_1.default(withoutPrefix, 16);
+}
+exports.bnFromHex = bnFromHex;
+/**
+ * Convert various numeric-like values to a BN instance.
+ * Accepts BN, ethers BigNumber, hex string, bigint, or number.
+ *
+ * @param value - The value to convert.
+ * @returns BN representation of the input value.
+ */
+function toBN(value) {
+    if (value instanceof bn_js_1.default) {
+        return value;
+    }
+    if (typeof bn_js_1.default.isBN ===
+        'function' &&
+        bn_js_1.default.isBN(value)) {
+        return value;
+    }
+    if (value !== null &&
+        typeof value === 'object' &&
+        typeof value.toHexString === 'function') {
+        return bnFromHex(value.toHexString());
+    }
+    if (value !== null &&
+        typeof value === 'object' &&
+        typeof value._hex === 'string') {
+        return bnFromHex(value._hex);
+    }
+    if (typeof value === 'string') {
+        return bnFromHex(value);
+    }
+    if (typeof value === 'bigint') {
+        return new bn_js_1.default(value.toString());
+    }
+    if (typeof value === 'number') {
+        return new bn_js_1.default(value);
+    }
+    throw new Error('Unexpected value returned from oracle contract');
+}
+exports.toBN = toBN;
+/**
+ * Calculate the absolute percentage change between two values.
+ *
+ * @param originalValue - The first value.
+ * @param newValue - The second value.
+ * @returns The percentage change from the first value to the second value.
+ * If the original value is zero and the new value is not, returns 100.
+ */
+function getPercentageChange(originalValue, newValue) {
+    const precisionFactor = new bn_js_1.default(10).pow(new bn_js_1.default(18));
+    const originalValuePrecision = originalValue.mul(precisionFactor);
+    const newValuePrecision = newValue.mul(precisionFactor);
+    const difference = newValuePrecision.sub(originalValuePrecision);
+    if (difference.isZero()) {
+        return 0;
+    }
+    if (originalValuePrecision.isZero() && !newValuePrecision.isZero()) {
+        return 100;
+    }
+    return difference.muln(100).div(originalValuePrecision).abs().toNumber();
+}
+exports.getPercentageChange = getPercentageChange;
+/**
+ * Sets the envelope type for the given transaction parameters based on the
+ * current network's EIP-1559 compatibility and the transaction parameters.
+ *
+ * @param txParams - The transaction parameters to set the envelope type for.
+ * @param isEIP1559Compatible - Indicates if the current network supports EIP-1559.
+ */
+function setEnvelopeType(txParams, isEIP1559Compatible) {
+    if (txParams.accessList) {
+        txParams.type = types_js_1.TransactionEnvelopeType.accessList;
+    }
+    else if (txParams.authorizationList) {
+        txParams.type = types_js_1.TransactionEnvelopeType.setCode;
+    }
+    else {
+        txParams.type = isEIP1559Compatible
+            ? types_js_1.TransactionEnvelopeType.feeMarket
+            : types_js_1.TransactionEnvelopeType.legacy;
+    }
+}
+exports.setEnvelopeType = setEnvelopeType;
+/**
+ * Convert CAIP-2 chain ID to hex format.
+ *
+ * @param caip2ChainId - Chain ID in CAIP-2 format (e.g., 'eip155:1')
+ * @returns Hex chain ID (e.g., '0x1') or undefined if invalid format
+ */
+function caip2ToHex(caip2ChainId) {
+    if (!(0, utils_1.isCaipChainId)(caip2ChainId)) {
+        return undefined;
+    }
+    try {
+        const { reference } = (0, utils_1.parseCaipChainId)(caip2ChainId);
+        return (0, controller_utils_1.toHex)(reference);
+    }
+    catch {
+        return undefined;
+    }
+}
+exports.caip2ToHex = caip2ToHex;
+//# sourceMappingURL=utils.cjs.map

package/dist/utils/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../../src/utils/utils.ts"],"names":[],"mappings":";;;;;;AACA,iEAAmD;AAEnD,2CAMyB;AACzB,kDAAuB;AASvB,2CAAyE;AAE5D,QAAA,kBAAkB,GAAG,kCAAkC,CAAC;AAErE,gCAAgC;AAChC,8DAA8D;AAC9D,MAAM,WAAW,GAAgD;IAC/D,UAAU,EAAE,CAAC,UAAuB,EAAE,EAAE,CAAC,UAAU;IACnD,iBAAiB,EAAE,CAAC,iBAAqC,EAAE,EAAE,CAC3D,iBAAiB;IACnB,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACvD,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,IAAI,CAAC,CAAC,WAAW,EAAE;IACjD,GAAG,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,GAAG,CAAC;IAChC,QAAQ,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,GAAG,CAAC;IACrC,QAAQ,EAAE,CAAC,QAAgB,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,QAAQ,CAAC;IAC/C,KAAK,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,KAAK,CAAC;IACtC,EAAE,EAAE,CAAC,EAAU,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,EAAE,CAAC,CAAC,WAAW,EAAE;IAC3C,KAAK,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,KAAK,CAAC;IACtC,YAAY,EAAE,CAAC,YAAoB,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,YAAY,CAAC;IAC3D,oBAAoB,EAAE,CAAC,oBAA4B,EAAE,EAAE,CACrD,IAAA,aAAK,EAAC,oBAAoB,CAAC;IAC7B,gBAAgB,EAAE,CAAC,oBAA4B,EAAE,EAAE,CACjD,IAAA,aAAK,EAAC,oBAAoB,CAAC;IAC7B,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,IAAI,CAAC;CACpC,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,0BAA0B,CACxC,QAA2B;IAE3B,MAAM,kBAAkB,GAAsB,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAE3D,KAAK,MAAM,GAAG,IAAI,IAAA,6BAAqB,EAAC,WAAW,CAAC,EAAE,CAAC;QACrD,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,kBAAkB,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAED,kBAAkB,CAAC,KAAK,KAAxB,kBAAkB,CAAC,KAAK,GAAK,KAAK,EAAC;IAEnC,IAAI,kBAAkB,CAAC,QAAQ,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC;QAC3D,kBAAkB,CAAC,GAAG,GAAG,kBAAkB,CAAC,QAAQ,CAAC;IACvD,CAAC;IAED,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAlBD,gEAkBC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,QAA2B;IAC9D,MAAM,UAAU,GAAG,CAAC,GAAsB,EAAE,GAAW,EAAW,EAAE,CAClE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACjD,OAAO,CACL,UAAU,CAAC,QAAQ,EAAE,cAAc,CAAC;QACpC,UAAU,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAC7C,CAAC;AACJ,CAAC;AAPD,oDAOC;AAEM,MAAM,iBAAiB,GAAG,CAC/B,SAAiD,EAC3C,EAAE;IACR,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACrC,gCAAgC;QAChC,8DAA8D;QAC9D,MAAM,KAAK,GAAI,SAAiB,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,IAAA,yBAAiB,EAAC,KAAK,CAAC,EAAE,CAAC;YAC3D,MAAM,IAAI,SAAS,CACjB,2BAA2B,GAAG,kBAAkB,KAAK,EAAE,CACxD,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAbW,QAAA,iBAAiB,qBAa5B;AAEF;;;;;;GAMG;AACH,SAAgB,+BAA+B,CAC7C,eAA4C,EAC5C,MAAc;IAEd,IAAI,eAAe,EAAE,MAAM,KAAK,4BAAiB,CAAC,UAAU,EAAE,CAAC;QAC7D,MAAM,IAAI,KAAK,CACb,yCAAyC,MAAM,4DAA4D,eAAe,EAAE,MAAM,EAAE,CACrI,CAAC;IACJ,CAAC;AACH,CAAC;AATD,0EASC;AAED;;;;;;GAMG;AACH,SAAgB,0CAA0C,CACxD,eAA4C,EAC5C,MAAc;IAEd,MAAM,eAAe,GAAG;QACtB,4BAAiB,CAAC,UAAU;QAC5B,4BAAiB,CAAC,SAAS;KAC5B,CAAC;IACF,IAAI,CAAC,eAAe,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1E,MAAM,IAAI,KAAK,CACb,yCAAyC,MAAM,yEAAyE,eAAe,EAAE,MAAM,EAAE,CAClJ,CAAC;IACJ,CAAC;AACH,CAAC;AAbD,gGAaC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAC9B,KAAiD;IAEjD,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,GAAG,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;KAC7D,CAAC;AACJ,CAAC;AAVD,4CAUC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,YAAoD;IAEpD,gCAAgC;IAChC,8DAA8D;IAC9D,MAAM,SAAS,GAAG,CAAC,KAAU,EAAU,EAAE,CACvC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAA,aAAK,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAEnD,IAAI,UAAU,IAAI,YAAY,EAAE,CAAC;QAC/B,OAAO;YACL,QAAQ,EAAE,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,OAAO;QACL,YAAY,EAAE,SAAS,CAAC,YAAY,CAAC,YAAY,CAAC;QAClD,oBAAoB,EAAE,SAAS,CAAC,YAAY,CAAC,oBAAoB,CAAC;KACnE,CAAC;AACJ,CAAC;AAlBD,sDAkBC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,KAAc;IACtC,IAAI,CAAC;QACH,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAC,QAAgB;IACjD,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;QACpD,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;QACtB,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;IAE3D,OAAO,MAAM,GAAG,QAAQ,CAAC;AAC3B,CAAC;AARD,gDAQC;AAED;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,QAAsB;IAC9C,MAAM,GAAG,GAAG,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAE,QAAmB,CAAC;IAC3E,MAAM,aAAa,GACjB,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACpE,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,IAAI,eAAE,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;IACD,OAAO,IAAI,eAAE,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;AACnC,CAAC;AARD,8BAQC;AAED;;;;;;GAMG;AACH,SAAgB,IAAI,CAAC,KAAc;IACjC,IAAI,KAAK,YAAY,eAAE,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IACE,OAAQ,eAAoD,CAAC,IAAI;QAC/D,UAAU;QACX,eAAmD,CAAC,IAAI,CAAC,KAAK,CAAC,EAChE,CAAC;QACD,OAAO,KAAW,CAAC;IACrB,CAAC;IACD,IACE,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAQ,KAAwC,CAAC,WAAW,KAAK,UAAU,EAC3E,CAAC;QACD,OAAO,SAAS,CAAE,KAAuC,CAAC,WAAW,EAAE,CAAC,CAAC;IAC3E,CAAC;IACD,IACE,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAQ,KAA2B,CAAC,IAAI,KAAK,QAAQ,EACrD,CAAC;QACD,OAAO,SAAS,CAAE,KAA0B,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,eAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,eAAE,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;AACpE,CAAC;AAnCD,oBAmCC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,aAAiB,EAAE,QAAY;IACjE,MAAM,eAAe,GAAG,IAAI,eAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,eAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACnD,MAAM,sBAAsB,GAAG,aAAa,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAClE,MAAM,iBAAiB,GAAG,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAExD,MAAM,UAAU,GAAG,iBAAiB,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAEjE,IAAI,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;QACxB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,sBAAsB,CAAC,MAAM,EAAE,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,EAAE,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;AAC3E,CAAC;AAhBD,kDAgBC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAC7B,QAA2B,EAC3B,mBAA4B;IAE5B,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;QACxB,QAAQ,CAAC,IAAI,GAAG,kCAAuB,CAAC,UAAU,CAAC;IACrD,CAAC;SAAM,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QACtC,QAAQ,CAAC,IAAI,GAAG,kCAAuB,CAAC,OAAO,CAAC;IAClD,CAAC;SAAM,CAAC;QACN,QAAQ,CAAC,IAAI,GAAG,mBAAmB;YACjC,CAAC,CAAC,kCAAuB,CAAC,SAAS;YACnC,CAAC,CAAC,kCAAuB,CAAC,MAAM,CAAC;IACrC,CAAC;AACH,CAAC;AAbD,0CAaC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,YAAoB;IAC7C,IAAI,CAAC,IAAA,qBAAa,EAAC,YAAY,CAAC,EAAE,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC;QACH,MAAM,EAAE,SAAS,EAAE,GAAG,IAAA,wBAAgB,EAAC,YAAY,CAAC,CAAC;QACrD,OAAO,IAAA,wBAAK,EAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAVD,gCAUC","sourcesContent":["import type { AccessList, AuthorizationList } from '@ethereumjs/common';\nimport { toHex } from '@metamask/controller-utils';\nimport type { Hex, Json } from '@metamask/utils';\nimport {\n  add0x,\n  getKnownPropertyNames,\n  isCaipChainId,\n  isStrictHexString,\n  parseCaipChainId,\n} from '@metamask/utils';\nimport BN from 'bn.js';\n\nimport type {\n  FeeMarketEIP1559Values,\n  GasPriceValue,\n  TransactionError,\n  TransactionMeta,\n  TransactionParams,\n} from '../types.js';\nimport { TransactionEnvelopeType, TransactionStatus } from '../types.js';\n\nexport const ESTIMATE_GAS_ERROR = 'eth_estimateGas rpc method error';\n\n// TODO: Replace `any` with type\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nconst NORMALIZERS: { [param in keyof TransactionParams]: any } = {\n  accessList: (accessList?: AccessList) => accessList,\n  authorizationList: (authorizationList?: AuthorizationList) =>\n    authorizationList,\n  data: (data: string) => add0x(padHexToEvenLength(data)),\n  from: (from: string) => add0x(from).toLowerCase(),\n  gas: (gas: string) => add0x(gas),\n  gasLimit: (gas: string) => add0x(gas),\n  gasPrice: (gasPrice: string) => add0x(gasPrice),\n  nonce: (nonce: string) => add0x(nonce),\n  to: (to: string) => add0x(to).toLowerCase(),\n  value: (value: string) => add0x(value),\n  maxFeePerGas: (maxFeePerGas: string) => add0x(maxFeePerGas),\n  maxPriorityFeePerGas: (maxPriorityFeePerGas: string) =>\n    add0x(maxPriorityFeePerGas),\n  estimatedBaseFee: (maxPriorityFeePerGas: string) =>\n    add0x(maxPriorityFeePerGas),\n  type: (type: string) => add0x(type),\n};\n\n/**\n * Normalizes properties on transaction params.\n *\n * @param txParams - The transaction params to normalize.\n * @returns Normalized transaction params.\n */\nexport function normalizeTransactionParams(\n  txParams: TransactionParams,\n): TransactionParams {\n  const normalizedTxParams: TransactionParams = { from: '' };\n\n  for (const key of getKnownPropertyNames(NORMALIZERS)) {\n    if (txParams[key]) {\n      normalizedTxParams[key] = NORMALIZERS[key](txParams[key]);\n    }\n  }\n\n  normalizedTxParams.value ??= '0x0';\n\n  if (normalizedTxParams.gasLimit && !normalizedTxParams.gas) {\n    normalizedTxParams.gas = normalizedTxParams.gasLimit;\n  }\n\n  return normalizedTxParams;\n}\n\n/**\n * Checks if a transaction is EIP-1559 by checking for the existence of\n * maxFeePerGas and maxPriorityFeePerGas within its parameters.\n *\n * @param txParams - Transaction params object to add.\n * @returns Boolean that is true if the transaction is EIP-1559 (has maxFeePerGas and maxPriorityFeePerGas), otherwise returns false.\n */\nexport function isEIP1559Transaction(txParams: TransactionParams): boolean {\n  const hasOwnProp = (obj: TransactionParams, key: string): boolean =>\n    Object.prototype.hasOwnProperty.call(obj, key);\n  return (\n    hasOwnProp(txParams, 'maxFeePerGas') &&\n    hasOwnProp(txParams, 'maxPriorityFeePerGas')\n  );\n}\n\nexport const validateGasValues = (\n  gasValues: GasPriceValue | FeeMarketEIP1559Values,\n): void => {\n  Object.keys(gasValues).forEach((key) => {\n    // TODO: Replace `any` with type\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const value = (gasValues as any)[key];\n    if (typeof value !== 'string' || !isStrictHexString(value)) {\n      throw new TypeError(\n        `expected hex string for ${key} but received: ${value}`,\n      );\n    }\n  });\n};\n\n/**\n * Validates that a transaction is unapproved.\n * Throws if the transaction is not unapproved.\n *\n * @param transactionMeta - The transaction metadata to check.\n * @param fnName - The name of the function calling this helper.\n */\nexport function validateIfTransactionUnapproved(\n  transactionMeta: TransactionMeta | undefined,\n  fnName: string,\n): void {\n  if (transactionMeta?.status !== TransactionStatus.unapproved) {\n    throw new Error(\n      `TransactionsController: Can only call ${fnName} on an unapproved transaction.\\n      Current tx status: ${transactionMeta?.status}`,\n    );\n  }\n}\n\n/**\n * Validates that a transaction is unapproved or submitted.\n * Throws if the transaction is not unapproved or submitted.\n *\n * @param transactionMeta - The transaction metadata to check.\n * @param fnName - The name of the function calling this helper.\n */\nexport function validateIfTransactionUnapprovedOrSubmitted(\n  transactionMeta: TransactionMeta | undefined,\n  fnName: string,\n): void {\n  const allowedStatuses = [\n    TransactionStatus.unapproved,\n    TransactionStatus.submitted,\n  ];\n  if (!transactionMeta || !allowedStatuses.includes(transactionMeta.status)) {\n    throw new Error(\n      `TransactionsController: Can only call ${fnName} on an unapproved or submitted transaction.\\n      Current tx status: ${transactionMeta?.status}`,\n    );\n  }\n}\n\n/**\n * Normalizes properties on transaction params.\n *\n * @param error - The error to be normalize.\n * @returns Normalized transaction error.\n */\nexport function normalizeTxError(\n  error: Error & { code?: string; value?: unknown },\n): TransactionError {\n  return {\n    name: error.name,\n    message: error.message,\n    stack: error.stack,\n    code: error.code,\n    rpc: isJsonCompatible(error.value) ? error.value : undefined,\n  };\n}\n\n/**\n * Normalize an object containing gas fee values.\n *\n * @param gasFeeValues - An object containing gas fee values.\n * @returns An object containing normalized gas fee values.\n */\nexport function normalizeGasFeeValues(\n  gasFeeValues: GasPriceValue | FeeMarketEIP1559Values,\n): GasPriceValue | FeeMarketEIP1559Values {\n  // TODO: Replace `any` with type\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  const normalize = (value: any): string =>\n    typeof value === 'string' ? add0x(value) : value;\n\n  if ('gasPrice' in gasFeeValues) {\n    return {\n      gasPrice: normalize(gasFeeValues.gasPrice),\n    };\n  }\n\n  return {\n    maxFeePerGas: normalize(gasFeeValues.maxFeePerGas),\n    maxPriorityFeePerGas: normalize(gasFeeValues.maxPriorityFeePerGas),\n  };\n}\n\n/**\n * Determines whether the given value can be encoded as JSON.\n *\n * @param value - The value.\n * @returns True if the value is JSON-encodable, false if not.\n */\nfunction isJsonCompatible(value: unknown): value is Json {\n  try {\n    JSON.parse(JSON.stringify(value));\n    return true;\n  } catch {\n    return false;\n  }\n}\n\n/**\n * Ensure a hex string is of even length by adding a leading 0 if necessary.\n * Any existing `0x` prefix is preserved but is not added if missing.\n *\n * @param hexValue - The hex string to ensure is even.\n * @returns The hex string with an even length.\n */\nexport function padHexToEvenLength(hexValue: string): string {\n  const prefix = hexValue.toLowerCase().startsWith('0x')\n    ? hexValue.slice(0, 2)\n    : '';\n  const data = prefix ? hexValue.slice(2) : hexValue;\n  const evenData = data.length % 2 === 0 ? data : `0${data}`;\n\n  return prefix + evenData;\n}\n\n/**\n * Create a BN from a hex string, accepting an optional 0x prefix.\n *\n * @param hexValue - Hex string with or without 0x prefix.\n * @returns BN parsed as base-16.\n */\nexport function bnFromHex(hexValue: string | Hex): BN {\n  const str = typeof hexValue === 'string' ? hexValue : (hexValue as string);\n  const withoutPrefix =\n    str.startsWith('0x') || str.startsWith('0X') ? str.slice(2) : str;\n  if (withoutPrefix.length === 0) {\n    return new BN(0);\n  }\n  return new BN(withoutPrefix, 16);\n}\n\n/**\n * Convert various numeric-like values to a BN instance.\n * Accepts BN, ethers BigNumber, hex string, bigint, or number.\n *\n * @param value - The value to convert.\n * @returns BN representation of the input value.\n */\nexport function toBN(value: unknown): BN {\n  if (value instanceof BN) {\n    return value;\n  }\n  if (\n    typeof (BN as unknown as { isBN?: (v: unknown) => boolean }).isBN ===\n      'function' &&\n    (BN as unknown as { isBN: (v: unknown) => boolean }).isBN(value)\n  ) {\n    return value as BN;\n  }\n  if (\n    value !== null &&\n    typeof value === 'object' &&\n    typeof (value as { toHexString?: () => string }).toHexString === 'function'\n  ) {\n    return bnFromHex((value as { toHexString: () => string }).toHexString());\n  }\n  if (\n    value !== null &&\n    typeof value === 'object' &&\n    typeof (value as { _hex?: string })._hex === 'string'\n  ) {\n    return bnFromHex((value as { _hex: string })._hex);\n  }\n  if (typeof value === 'string') {\n    return bnFromHex(value);\n  }\n  if (typeof value === 'bigint') {\n    return new BN(value.toString());\n  }\n  if (typeof value === 'number') {\n    return new BN(value);\n  }\n  throw new Error('Unexpected value returned from oracle contract');\n}\n\n/**\n * Calculate the absolute percentage change between two values.\n *\n * @param originalValue - The first value.\n * @param newValue - The second value.\n * @returns The percentage change from the first value to the second value.\n * If the original value is zero and the new value is not, returns 100.\n */\nexport function getPercentageChange(originalValue: BN, newValue: BN): number {\n  const precisionFactor = new BN(10).pow(new BN(18));\n  const originalValuePrecision = originalValue.mul(precisionFactor);\n  const newValuePrecision = newValue.mul(precisionFactor);\n\n  const difference = newValuePrecision.sub(originalValuePrecision);\n\n  if (difference.isZero()) {\n    return 0;\n  }\n\n  if (originalValuePrecision.isZero() && !newValuePrecision.isZero()) {\n    return 100;\n  }\n\n  return difference.muln(100).div(originalValuePrecision).abs().toNumber();\n}\n\n/**\n * Sets the envelope type for the given transaction parameters based on the\n * current network's EIP-1559 compatibility and the transaction parameters.\n *\n * @param txParams - The transaction parameters to set the envelope type for.\n * @param isEIP1559Compatible - Indicates if the current network supports EIP-1559.\n */\nexport function setEnvelopeType(\n  txParams: TransactionParams,\n  isEIP1559Compatible: boolean,\n): void {\n  if (txParams.accessList) {\n    txParams.type = TransactionEnvelopeType.accessList;\n  } else if (txParams.authorizationList) {\n    txParams.type = TransactionEnvelopeType.setCode;\n  } else {\n    txParams.type = isEIP1559Compatible\n      ? TransactionEnvelopeType.feeMarket\n      : TransactionEnvelopeType.legacy;\n  }\n}\n\n/**\n * Convert CAIP-2 chain ID to hex format.\n *\n * @param caip2ChainId - Chain ID in CAIP-2 format (e.g., 'eip155:1')\n * @returns Hex chain ID (e.g., '0x1') or undefined if invalid format\n */\nexport function caip2ToHex(caip2ChainId: string): Hex | undefined {\n  if (!isCaipChainId(caip2ChainId)) {\n    return undefined;\n  }\n  try {\n    const { reference } = parseCaipChainId(caip2ChainId);\n    return toHex(reference);\n  } catch {\n    return undefined;\n  }\n}\n"]}

package/dist/utils/{utils.d.ts → utils.d.cts}

@@ -1,6 +1,6 @@
-import type { Hex } from '@metamask/utils';
-import BN from 'bn.js';
-import type { FeeMarketEIP1559Values, GasPriceValue, TransactionError, TransactionMeta, TransactionParams } from '../types.js';
+import type { Hex } from "@metamask/utils";
+import BN from "bn.js";
+import type { FeeMarketEIP1559Values, GasPriceValue, TransactionError, TransactionMeta, TransactionParams } from "../types.cjs";
 export declare const ESTIMATE_GAS_ERROR = "eth_estimateGas rpc method error";
 /**
  * Normalizes properties on transaction params.
@@ -98,4 +98,4 @@ export declare function setEnvelopeType(txParams: TransactionParams, isEIP1559Co
  * @returns Hex chain ID (e.g., '0x1') or undefined if invalid format
  */
 export declare function caip2ToHex(caip2ChainId: string): Hex | undefined;
-//# sourceMappingURL=utils.d.ts.map
+//# sourceMappingURL=utils.d.cts.map