Extract revert messages #6226
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,6 +20,7 @@ public class TransactionSubstate | |
| private const int RevertPrefix = 4; | ||
|
|
||
| private const string RevertedErrorMessagePrefix = "Reverted "; | ||
| private readonly byte[] ErrorFunctionSelector = { 0x08, 0xc3, 0x79, 0xa0 }; | ||
|
|
||
| public bool IsError => Error is not null && !ShouldRevert; | ||
| public string? Error { get; } | ||
|
|
@@ -68,6 +69,7 @@ public TransactionSubstate(EvmExceptionType exceptionType, bool isTracerConnecte | |
|
|
||
| ReadOnlySpan<byte> span = Output.Span; | ||
| Error = TryGetErrorMessage(span) | ||
| ?? TryUnpackRevertMessage(span) | ||
| ?? DefaultErrorMessage(span); | ||
| } | ||
|
|
||
|
|
@@ -104,4 +106,36 @@ private string DefaultErrorMessage(ReadOnlySpan<byte> span) | |
| return null; | ||
| } | ||
| } | ||
|
|
||
| private unsafe string? TryUnpackRevertMessage(ReadOnlySpan<byte> span) | ||
|
There was a problem hiding this comment. Shouldn't this be unified with There was a problem hiding this comment. They are similar but not the same:
Still, maybe there's something to be done to reduce the amount of code. What do you think @benaadams? |
||
| { | ||
| if (span.Length < RevertPrefix + sizeof(UInt256) * 2) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| if (!span[..RevertPrefix].SequenceEqual(ErrorFunctionSelector)) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| try | ||
| { | ||
| int start = (int)new UInt256(span.Slice(RevertPrefix, sizeof(UInt256)), isBigEndian: true); | ||
| if (start != sizeof(UInt256)) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| int length = (int)new UInt256(span.Slice(RevertPrefix + sizeof(UInt256), sizeof(UInt256)), isBigEndian: true); | ||
| ReadOnlySpan<byte> binaryMessage = span.Slice(RevertPrefix + sizeof(UInt256) + sizeof(UInt256), length); | ||
| string message = string.Concat(RevertedErrorMessagePrefix, System.Text.Encoding.UTF8.GetString(binaryMessage)); | ||
|
|
||
| return message; | ||
| } | ||
| catch (Exception e) when (e is OverflowException or ArgumentOutOfRangeException) | ||
| { | ||
| return null; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there was an extra colon in the prefix, i.e.
Reverted: {message}this would become compatible with Geth. I want to point it out since you're already making a breaking change.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's an ongoing discussion on standarization of error messages: ethereum/execution-apis#463.