@metamask/transaction-controller 65.0.0 → 65.1.0

package/dist/utils/revert-reason.mjs

@@ -0,0 +1,186 @@
+import { defaultAbiCoder } from "@ethersproject/abi";
+import { createModuleLogger, projectLogger } from "../logger.mjs";
+import { rpcRequest } from "./provider.mjs";
+const log = createModuleLogger(projectLogger, 'revert-reason');
+const ERROR_SELECTOR = '0x08c379a0';
+const PANIC_SELECTOR = '0x4e487b71';
+/**
+ * Solidity panic code descriptions.
+ *
+ * @see https://docs.soliditylang.org/en/latest/control-structures.html#panic-via-assert-and-error-via-require
+ */
+const PANIC_CODE_MESSAGES = {
+    '0x00': 'Generic compiler panic',
+    '0x01': 'Assertion failed',
+    '0x11': 'Arithmetic overflow or underflow',
+    '0x12': 'Division or modulo by zero',
+    '0x21': 'Invalid enum value',
+    '0x22': 'Incorrectly encoded storage byte array',
+    '0x31': 'Pop on empty array',
+    '0x32': 'Array index out of bounds',
+    '0x41': 'Memory allocation overflow',
+    '0x51': 'Call to zero-initialized function',
+};
+/**
+ * Error thrown by `PendingTransactionTracker` when a transaction failed
+ * on-chain, carrying any decoded revert.
+ */
+export class OnChainFailureError extends Error {
+    constructor(revert) {
+        const suffix = revert?.message ? `: ${revert.message}` : '';
+        super(`Transaction failed on-chain${suffix}`);
+        this.name = 'OnChainFailureError';
+        this.revert = revert;
+    }
+}
+/**
+ * Decode an EVM revert into a `Revert` containing both the decoded
+ * human-readable message and the original raw `data`. Accepts either a
+ * raw revert data hex string, or a thrown JSON-RPC error of the shape
+ * `{ data: Hex | { data: Hex } }`. Handles `Error(string)`,
+ * `Panic(uint256)`, and falls back to a raw `Custom error: 0x<selector>`
+ * reference for unknown custom errors.
+ *
+ * @param input - Raw revert data hex, or a thrown JSON-RPC error.
+ * @param source - Optional label included in debug logs to identify the
+ * caller (e.g. `gas`, `simulation`).
+ * @returns A `Revert` if any data was found, otherwise `undefined`.
+ */
+export function decodeRevert(input, source) {
+    const data = toRevertDataHex(input);
+    if (!data) {
+        return undefined;
+    }
+    const message = decodeMessage(data);
+    const revert = {
+        ...(message ? { message } : {}),
+        data,
+    };
+    logRevert(source, revert);
+    return revert;
+}
+/**
+ * Replay a transaction that failed on-chain via `eth_estimateGas` to
+ * recover the revert reason. `eth_estimateGas` is used instead of
+ * `eth_call` to avoid `RetryOnEmptyMiddleware`, which retries reverted
+ * `eth_call` responses 10 times and discards the original error data.
+ *
+ * Always resolves; never throws.
+ *
+ * @param input - Extraction inputs.
+ * @param input.messenger - Transaction controller messenger.
+ * @param input.networkClientId - Network client ID to replay against.
+ * @param input.txParams - Transaction parameters for the failed tx.
+ * @returns A `Revert`, or `undefined` if none could be observed.
+ */
+export async function extractRevert({ messenger, networkClientId, txParams, }) {
+    if (!txParams?.to && !txParams?.data) {
+        return undefined;
+    }
+    const callParams = {};
+    if (txParams.from) {
+        callParams.from = txParams.from;
+    }
+    if (txParams.to) {
+        callParams.to = txParams.to;
+    }
+    if (txParams.data) {
+        callParams.data = txParams.data;
+    }
+    if (txParams.value) {
+        callParams.value = txParams.value;
+    }
+    try {
+        await rpcRequest({
+            messenger,
+            networkClientId,
+            // `eth_estimateGas` is used instead of `eth_call` to bypass
+            // `RetryOnEmptyMiddleware`, which retries reverted `eth_call`
+            // responses and discards the original revert data.
+            method: 'eth_estimateGas',
+            params: [callParams],
+        });
+        return undefined;
+    }
+    catch (error) {
+        return decodeRevert(error, 'receipt');
+    }
+}
+/**
+ * Coerce a `RevertInput` to a non-empty revert data hex string.
+ *
+ * @param input - Raw hex or thrown JSON-RPC error.
+ * @returns The revert data hex, or `undefined`.
+ */
+function toRevertDataHex(input) {
+    if (isHex(input)) {
+        return input;
+    }
+    if (typeof input !== 'object' || input === null) {
+        return undefined;
+    }
+    const { data } = input;
+    if (isHex(data)) {
+        return data;
+    }
+    if (typeof data === 'object' && data !== null && isHex(data.data)) {
+        return data.data;
+    }
+    return undefined;
+}
+/**
+ * Type guard for non-empty `0x`-prefixed hex strings.
+ *
+ * @param value - Value to test.
+ * @returns Whether the value is a non-empty hex string.
+ */
+function isHex(value) {
+    return typeof value === 'string' && value.startsWith('0x') && value !== '0x';
+}
+/**
+ * Decode raw revert data into a human-readable string.
+ *
+ * @param data - Raw revert data hex.
+ * @returns Decoded message, or `undefined` if undecodable.
+ */
+function decodeMessage(data) {
+    if (!data || data === '0x') {
+        return undefined;
+    }
+    if (data.length < 10) {
+        return `execution reverted (${data})`;
+    }
+    const selector = data.slice(0, 10).toLowerCase();
+    const payload = `0x${data.slice(10)}`;
+    if (selector === ERROR_SELECTOR) {
+        try {
+            const [reason] = defaultAbiCoder.decode(['string'], payload);
+            return typeof reason === 'string' ? reason : undefined;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    if (selector === PANIC_SELECTOR) {
+        try {
+            const [code] = defaultAbiCoder.decode(['uint256'], payload);
+            const codeHex = code.toHexString().toLowerCase();
+            const description = PANIC_CODE_MESSAGES[codeHex] ?? 'Unknown panic';
+            return `Panic: ${description}`;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    return `Custom error: ${selector}`;
+}
+/**
+ * Emit a single structured debug line for a decoded revert.
+ *
+ * @param source - Source label, when known.
+ * @param revert - Resolved Revert.
+ */
+function logRevert(source, revert) {
+    log('Decoded revert', source ?? 'unknown', revert);
+}
+//# sourceMappingURL=revert-reason.mjs.map

package/dist/utils/revert-reason.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"revert-reason.mjs","sourceRoot":"","sources":["../../src/utils/revert-reason.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,2BAA2B;AAIrD,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,sBAAkB;AAG9D,OAAO,EAAE,UAAU,EAAE,uBAAmB;AAExC,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;AAE/D,MAAM,cAAc,GAAG,YAAY,CAAC;AACpC,MAAM,cAAc,GAAG,YAAY,CAAC;AAEpC;;;;GAIG;AACH,MAAM,mBAAmB,GAA2B;IAClD,MAAM,EAAE,wBAAwB;IAChC,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,kCAAkC;IAC1C,MAAM,EAAE,4BAA4B;IACpC,MAAM,EAAE,oBAAoB;IAC5B,MAAM,EAAE,wCAAwC;IAChD,MAAM,EAAE,oBAAoB;IAC5B,MAAM,EAAE,2BAA2B;IACnC,MAAM,EAAE,4BAA4B;IACpC,MAAM,EAAE,mCAAmC;CAC5C,CAAC;AAaF;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAG5C,YAAY,MAAe;QACzB,MAAM,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5D,KAAK,CAAC,8BAA8B,MAAM,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAkB,EAClB,MAAe;IAEf,MAAM,IAAI,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACpC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACpC,MAAM,MAAM,GAAW;QACrB,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/B,IAAI;KACL,CAAC;IAEF,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,SAAS,EACT,eAAe,EACf,QAAQ,GAKT;IACC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAA2B,EAAE,CAAC;IAC9C,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClB,UAAU,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAClC,CAAC;IACD,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;QAChB,UAAU,CAAC,EAAE,GAAG,QAAQ,CAAC,EAAE,CAAC;IAC9B,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QAClB,UAAU,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAClC,CAAC;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnB,UAAU,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;IACpC,CAAC;IAED,IAAI,CAAC;QACH,MAAM,UAAU,CAAC;YACf,SAAS;YACT,eAAe;YACf,4DAA4D;YAC5D,8DAA8D;YAC9D,mDAAmD;YACnD,MAAM,EAAE,iBAAiB;YACzB,MAAM,EAAE,CAAC,UAAU,CAAC;SACrB,CAAC,CAAC;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,OAAO,YAAY,CAAC,KAAoB,EAAE,SAAS,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAC,KAAkB;IACzC,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IACvB,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAClE,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,SAAS,KAAK,CAAC,KAAc;IAC3B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,IAAI,CAAC;AAC/E,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,IAAqB;IAC1C,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACrB,OAAO,uBAAuB,IAAI,GAAG,CAAC;IACxC,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;IACjD,MAAM,OAAO,GAAG,KAAK,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;IAEtC,IAAI,QAAQ,KAAK,cAAc,EAAE,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;YAC7D,OAAO,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACzD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,KAAK,cAAc,EAAE,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,EAAE,OAAO,CAEzD,CAAC;YACF,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,WAAW,EAAS,CAAC;YACxD,MAAM,WAAW,GAAG,mBAAmB,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC;YACpE,OAAO,UAAU,WAAW,EAAE,CAAC;QACjC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED,OAAO,iBAAiB,QAAQ,EAAE,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,SAAS,SAAS,CAAC,MAA0B,EAAE,MAAc;IAC3D,GAAG,CAAC,gBAAgB,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC","sourcesContent":["import { defaultAbiCoder } from '@ethersproject/abi';\nimport type { NetworkClientId } from '@metamask/network-controller';\nimport type { Hex } from '@metamask/utils';\n\nimport { createModuleLogger, projectLogger } from '../logger';\nimport type { TransactionControllerMessenger } from '../TransactionController';\nimport type { Revert, TransactionParams } from '../types';\nimport { rpcRequest } from './provider';\n\nconst log = createModuleLogger(projectLogger, 'revert-reason');\n\nconst ERROR_SELECTOR = '0x08c379a0';\nconst PANIC_SELECTOR = '0x4e487b71';\n\n/**\n * Solidity panic code descriptions.\n *\n * @see https://docs.soliditylang.org/en/latest/control-structures.html#panic-via-assert-and-error-via-require\n */\nconst PANIC_CODE_MESSAGES: Record<string, string> = {\n  '0x00': 'Generic compiler panic',\n  '0x01': 'Assertion failed',\n  '0x11': 'Arithmetic overflow or underflow',\n  '0x12': 'Division or modulo by zero',\n  '0x21': 'Invalid enum value',\n  '0x22': 'Incorrectly encoded storage byte array',\n  '0x31': 'Pop on empty array',\n  '0x32': 'Array index out of bounds',\n  '0x41': 'Memory allocation overflow',\n  '0x51': 'Call to zero-initialized function',\n};\n\n/**\n * Input accepted by `decodeRevert`. Either raw revert data hex, or a\n * thrown JSON-RPC error carrying the data on `data` (standard) or\n * nested `data.data` (some older node forks).\n */\ntype RevertInput =\n  | Hex\n  | undefined\n  | { data?: Hex | { data?: Hex } | null }\n  | null;\n\n/**\n * Error thrown by `PendingTransactionTracker` when a transaction failed\n * on-chain, carrying any decoded revert.\n */\nexport class OnChainFailureError extends Error {\n  readonly revert?: Revert;\n\n  constructor(revert?: Revert) {\n    const suffix = revert?.message ? `: ${revert.message}` : '';\n    super(`Transaction failed on-chain${suffix}`);\n    this.name = 'OnChainFailureError';\n    this.revert = revert;\n  }\n}\n\n/**\n * Decode an EVM revert into a `Revert` containing both the decoded\n * human-readable message and the original raw `data`. Accepts either a\n * raw revert data hex string, or a thrown JSON-RPC error of the shape\n * `{ data: Hex | { data: Hex } }`. Handles `Error(string)`,\n * `Panic(uint256)`, and falls back to a raw `Custom error: 0x<selector>`\n * reference for unknown custom errors.\n *\n * @param input - Raw revert data hex, or a thrown JSON-RPC error.\n * @param source - Optional label included in debug logs to identify the\n * caller (e.g. `gas`, `simulation`).\n * @returns A `Revert` if any data was found, otherwise `undefined`.\n */\nexport function decodeRevert(\n  input: RevertInput,\n  source?: string,\n): Revert | undefined {\n  const data = toRevertDataHex(input);\n  if (!data) {\n    return undefined;\n  }\n\n  const message = decodeMessage(data);\n  const revert: Revert = {\n    ...(message ? { message } : {}),\n    data,\n  };\n\n  logRevert(source, revert);\n  return revert;\n}\n\n/**\n * Replay a transaction that failed on-chain via `eth_estimateGas` to\n * recover the revert reason. `eth_estimateGas` is used instead of\n * `eth_call` to avoid `RetryOnEmptyMiddleware`, which retries reverted\n * `eth_call` responses 10 times and discards the original error data.\n *\n * Always resolves; never throws.\n *\n * @param input - Extraction inputs.\n * @param input.messenger - Transaction controller messenger.\n * @param input.networkClientId - Network client ID to replay against.\n * @param input.txParams - Transaction parameters for the failed tx.\n * @returns A `Revert`, or `undefined` if none could be observed.\n */\nexport async function extractRevert({\n  messenger,\n  networkClientId,\n  txParams,\n}: {\n  messenger: TransactionControllerMessenger;\n  networkClientId: NetworkClientId;\n  txParams: TransactionParams;\n}): Promise<Revert | undefined> {\n  if (!txParams?.to && !txParams?.data) {\n    return undefined;\n  }\n\n  const callParams: Record<string, string> = {};\n  if (txParams.from) {\n    callParams.from = txParams.from;\n  }\n  if (txParams.to) {\n    callParams.to = txParams.to;\n  }\n  if (txParams.data) {\n    callParams.data = txParams.data;\n  }\n  if (txParams.value) {\n    callParams.value = txParams.value;\n  }\n\n  try {\n    await rpcRequest({\n      messenger,\n      networkClientId,\n      // `eth_estimateGas` is used instead of `eth_call` to bypass\n      // `RetryOnEmptyMiddleware`, which retries reverted `eth_call`\n      // responses and discards the original revert data.\n      method: 'eth_estimateGas',\n      params: [callParams],\n    });\n    return undefined;\n  } catch (error: unknown) {\n    return decodeRevert(error as RevertInput, 'receipt');\n  }\n}\n\n/**\n * Coerce a `RevertInput` to a non-empty revert data hex string.\n *\n * @param input - Raw hex or thrown JSON-RPC error.\n * @returns The revert data hex, or `undefined`.\n */\nfunction toRevertDataHex(input: RevertInput): Hex | undefined {\n  if (isHex(input)) {\n    return input;\n  }\n\n  if (typeof input !== 'object' || input === null) {\n    return undefined;\n  }\n\n  const { data } = input;\n  if (isHex(data)) {\n    return data;\n  }\n\n  if (typeof data === 'object' && data !== null && isHex(data.data)) {\n    return data.data;\n  }\n\n  return undefined;\n}\n\n/**\n * Type guard for non-empty `0x`-prefixed hex strings.\n *\n * @param value - Value to test.\n * @returns Whether the value is a non-empty hex string.\n */\nfunction isHex(value: unknown): value is Hex {\n  return typeof value === 'string' && value.startsWith('0x') && value !== '0x';\n}\n\n/**\n * Decode raw revert data into a human-readable string.\n *\n * @param data - Raw revert data hex.\n * @returns Decoded message, or `undefined` if undecodable.\n */\nfunction decodeMessage(data: Hex | undefined): string | undefined {\n  if (!data || data === '0x') {\n    return undefined;\n  }\n\n  if (data.length < 10) {\n    return `execution reverted (${data})`;\n  }\n\n  const selector = data.slice(0, 10).toLowerCase();\n  const payload = `0x${data.slice(10)}`;\n\n  if (selector === ERROR_SELECTOR) {\n    try {\n      const [reason] = defaultAbiCoder.decode(['string'], payload);\n      return typeof reason === 'string' ? reason : undefined;\n    } catch {\n      return undefined;\n    }\n  }\n\n  if (selector === PANIC_SELECTOR) {\n    try {\n      const [code] = defaultAbiCoder.decode(['uint256'], payload) as [\n        { toHexString: () => string },\n      ];\n      const codeHex = code.toHexString().toLowerCase() as Hex;\n      const description = PANIC_CODE_MESSAGES[codeHex] ?? 'Unknown panic';\n      return `Panic: ${description}`;\n    } catch {\n      return undefined;\n    }\n  }\n\n  return `Custom error: ${selector}`;\n}\n\n/**\n * Emit a single structured debug line for a decoded revert.\n *\n * @param source - Source label, when known.\n * @param revert - Resolved Revert.\n */\nfunction logRevert(source: string | undefined, revert: Revert): void {\n  log('Decoded revert', source ?? 'unknown', revert);\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/transaction-controller",
-  "version": "65.0.0",
+  "version": "65.1.0",
   "description": "Stores transactions alongside their periodically updated statuses and manages interactions such as approval and cancellation",
   "keywords": [
     "Ethereum",
@@ -60,15 +60,15 @@
     "@ethersproject/contracts": "^5.7.0",
     "@ethersproject/providers": "^5.7.0",
     "@ethersproject/wallet": "^5.7.0",
-    "@metamask/accounts-controller": "^37.2.0",
+    "@metamask/accounts-controller": "^38.0.0",
     "@metamask/approval-controller": "^9.0.1",
     "@metamask/base-controller": "^9.1.0",
     "@metamask/controller-utils": "^11.20.0",
     "@metamask/core-backend": "^6.2.1",
     "@metamask/gas-fee-controller": "^26.1.1",
-    "@metamask/messenger": "^1.1.1",
+    "@metamask/messenger": "^1.2.0",
     "@metamask/metamask-eth-abis": "^3.1.1",
-    "@metamask/network-controller": "^30.0.1",
+    "@metamask/network-controller": "^30.1.0",
     "@metamask/nonce-tracker": "^6.0.0",
     "@metamask/remote-feature-flag-controller": "^4.2.0",
     "@metamask/rpc-errors": "^7.0.2",