feat(transaction-controller): revert reasons#8589
Merged
Merged
Conversation
matthewwalsh0
had a problem deploying
to
default-branch
GitHub Actions
Failure
matthewwalsh0
force-pushed
the
feat/extract-revert-reason
branch
from
eff0b70 to
f5196a9
Compare
4 tasks
matthewwalsh0
force-pushed
the
feat/extract-revert-reason
branch
2 times, most recently
from
988450c to
fcfa427
Compare
matthewwalsh0
changed the title
matthewwalsh0
changed the title
…ctions When a transaction fails on-chain (status 0x0) or is predicted to fail during gas estimation, decode and surface the revert reason instead of just "Transaction failed on-chain". - Add extractRevertReason util that decodes Error(string), Panic(uint256) with named codes, custom error selectors, and empty reverts; falls back to the provider error message when no revert data is surfaced - Add revertReason?: string on TransactionMeta, populated when an on-chain receipt has a failure status (replays via eth_estimateGas) - Add gasRevertReason?: string on TransactionMeta, populated when eth_estimateGas reverts during transaction creation, allowing UI to warn the user before they confirm a tx that's predicted to fail - Append the on-chain reason to the existing 'Transaction failed on-chain' error message via a new OnChainFailureError subclass eth_estimateGas is used (instead of eth_call) for the on-chain replay path as a workaround for a bug in eth-json-rpc-middleware's RetryOnEmptyMiddleware: its isExecutionRevertedError check fails to recognise EIP-1474 / Infura-style revert errors (code 3, suffixed message), causing it to retry reverted calls 10 times and discard the original error data. eth_estimateGas returns the same revert payload but bypasses that middleware. A separate upstream PR fixes the underlying bug.
matthewwalsh0
force-pushed
the
feat/extract-revert-reason
branch
from
14e1951 to
af1eae9
Compare
…tSources schema Replaces the separate `gasRevertReason` and `revertReason` string fields on TransactionMeta with a single `revert?: RevertSources` field. Each source (`gas`, `simulation`, `receipt`) carries an optional decoded `message` and the raw `data` hex. The decoded message is derived only from the raw revert data — upstream RPC and Sentinel message strings are never parsed. The simulation source reads from the root call frame's `output` only, ignoring nested errors that may have been caught and recovered. Adds a unified `logRevert` debug logger emitting one structured line per source under the `metamask:transaction-controller:revert` namespace.
matthewwalsh0
force-pushed
the
feat/extract-revert-reason
branch
2 times, most recently
from
4e7644e to
585ed5f
Compare
…t util - Rename type `RevertSources` \u2192 `RevertData` (parent shape on TransactionMeta). - Rename file `extract-revert-reason.ts` \u2192 `revert.ts`. - New single public `decodeRevert(data)` accepting raw hex; returns `Revert` with both decoded `message` and the original `data`. - `extractRevert` swallows all errors internally and returns `undefined`. - Move simulation revert write inside the `isBalanceChangesSkipped` check so `revert.simulation` and `simulationData` stay in sync. - Single `metamask:transaction-controller:revert` debug logger; drop the earlier `extract-revert-reason` namespace. - Trim `TransactionMeta.revert` JSDoc to one line; details live on the per-source `Revert` and on `RevertData`. - Link Solidity panic spec from `PANIC_CODE_MESSAGES` JSDoc; codes verified against https://docs.soliditylang.org/en/latest/control-structures.html#panic-via-assert-and-error-via-require.
matthewwalsh0
force-pushed
the
feat/extract-revert-reason
branch
from
585ed5f to
774c7a8
Compare
- decodeRevert now takes Hex | undefined; callers extract hex themselves - Export extractRevertDataHex helper for unwrapping JSON-RPC errors - Drop panic code from message (e.g. 'Arithmetic overflow or underflow') - Add inline comment on eth_estimateGas explaining eth_call retry workaround
…efix
- decodeRevert accepts RevertInput (Hex | { data: Hex | { data: Hex } } | null | undefined) directly; no separate hex-extraction export
- Restore 'Panic: <description>' prefix on panic messages (without code)
- Move Revert/RevertData types to bottom of types.ts
- Cleaner logRevert: 'Decoded <source> revert' { message, data }
…Error to top of revert-reason.ts
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit bf8b9d3. Configure here.
| expect(emittedTxMeta).toStrictEqual(TRANSACTION_SUBMITTED_MOCK); | ||
| expect(emittedError.name).toBe('OnChainFailureError'); | ||
| expect(emittedError.message).toBe('Transaction failed on-chain'); | ||
| expect(emittedError.revertReason).toBeUndefined(); |
There was a problem hiding this comment.
Test checks nonexistent property name revertReason instead of revert
Medium Severity
The test asserts emittedError.revertReason is undefined, but OnChainFailureError defines its property as revert, not revertReason. This assertion is vacuously true because a nonexistent property is always undefined, meaning the test provides no regression protection — it would still pass even if .revert were incorrectly populated. The companion test at line 559 correctly uses .revert.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit bf8b9d3. Configure here.
OGPoyraz
approved these changes
May 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation
When a transaction fails — on-chain or during gas estimation — MetaMask records a generic message with no reason. The actual reason (
ERC20: transfer amount exceeds balance,Panic (0x11): Arithmetic overflow or underflow, etc.) is decodable from the raw revert data returned by any standard RPC.This PR adds a single
revert?: RevertSourcesfield onTransactionMetathat captures decoded revert info from up to three independent sources:revert.gas— set wheneth_estimateGasreverts during transaction creation (predicted failure)revert.simulation— set from the root call frame'soutputreturned by the simulation APIrevert.receipt— set when a receipt hasstatus: 0x0, by replaying the call viaeth_estimateGasEach entry is a
Revert { message?: string; data?: Hex }. Themessageis decoded only from the rawdata; upstream RPC and simulation message strings are never parsed. Decoder handlesError(string),Panic(uint256)(with named codes), and falls back toCustom error: 0x<selector>for custom errors.The receipt failure path also appends the decoded message to the existing error:
"Transaction failed on-chain: <reason>".References
Checklist
Note
Medium Risk
Touches gas estimation, simulation parsing, and on-chain failure handling to persist and emit decoded revert data; mistakes could change failure attribution or add extra RPC load on failed receipts.
Overview
Adds a new optional
TransactionMeta.revertfield (typed asRevertData) to persist decoded revert message and raw revert data captured from three sources:eth_estimateGasduring gas estimation (revert.gas), simulation call-trace root output (revert.simulation), and on-chain failures by replaying failed receipts viaeth_estimateGas(revert.receipt).Updates gas estimation and simulation flows to extract/decode revert payloads and thread them into transaction updates, and changes pending receipt failure handling to emit an
OnChainFailureErrorthat includes the decoded reason in the error message when available. Includes newrevert-reasonutility (+ tests), extends simulation API types to include call-traceoutput, and updates unit tests accordingly.Reviewed by Cursor Bugbot for commit bf8b9d3. Bugbot is set up for automated code reviews on this repo. Configure here.