feat: introduces verbose actionable error messaging #592
Conversation
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
…c into db/handle-errors
dutterbutter
commented
Feb 21, 2025
Comment on lines
475
to
+491
| if let ExecutionResult::Halt { reason } = result.result { | ||
| // Halt means that something went really bad with the transaction execution (in most cases invalid signature, | ||
| // but it could also be bootloader panic etc). | ||
| // In such case, we should not persist the VM data, and we should pretend that transaction never existed. | ||
| anyhow::bail!("Transaction HALT: {reason}"); | ||
| let reason_clone = reason.clone(); | ||
|
|
||
| let halt_error = tokio::runtime::Handle::current().block_on(async { | ||
| tokio::task::spawn_blocking(move || { | ||
| // Create a new multi-threaded runtime explicitly. | ||
| let rt = tokio::runtime::Builder::new_multi_thread() | ||
| .enable_all() | ||
| .build() | ||
| .expect("Failed to create multi-threaded runtime"); | ||
| rt.block_on(reason_clone.to_halt_error()) | ||
| }) | ||
| .await | ||
| .expect("spawn_blocking failed") | ||
| }); | ||
|
|
||
| print_execution_error(&halt_error, Some(&l2_tx)); |
There was a problem hiding this comment.
Could use some guidance here, this fails the unit tests due to runtime error. It would be ideal if we can still handle halt reasons and provide users with an informative error message here rather than just bailing with halt reason.
Any insight on how I can handle the threading issue? I suppose I can make the unit tests multi-threaded (e.g. #[tokio::test(flavor = "multi_thread")]) but that seems like a workaround.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closed #571 in favour of this PR given all the changes since then.
The following
etc/errors/anvil.jsonjson file outlines the errors that could be hit based on the errors defined here. To make it easier to review and have discussion please refer to this Notion page where the json schema and display are also present for easier dialogue. Feedback would be appreciated, especially as many error cases I am unfamiliar with so assistance in properly defining cause / fixes would be helpful.cc: @sayon @itegulov @popzxc
What 💻
zksync-errorto define Halt and Revert errors to be displayed to usersCallErrorTracerLogging and Update Revert/Halt Handling #436 and [FEAT] Integrateerror-codegenfor insightful and actionable debugging #537Why ✋
Evidence 📷
Include screenshots, screen recordings, or
consoleoutput here demonstrating that your changes work as intendedPrevious errors shown
Note: We print gas estimation details implying its a gas issue even though this error is the account having insufficient funds.
Defined structured errors shown
Note: same error.