Make RPC reason settable, pass execution failure reason in RPC error message #6343

matthew1001 · 2024-01-03T14:44:15Z

PR description

This PR adds a setter for the reason field in JsonRpcError.

If a caller sets the reason, it is appended to the message for the error that is taken from the RpcErrorType enums.

It also adds a new RpcErrorType of EXECUTION_HALTED to be used during transaction simulations (e.g. during eth_estimateGas() calls) so a failed gas estimation doesn't just return INTERNAL_ERROR when there's a problem with the execution.

The specific example I hit this in was using a Shanghai smart contract with the JUMP0 opcode against a QBFT Besu node (QBFT doesn't currently support Shanghai).

Fixed Issue(s)

Fixes #4914
(See also #5706 which improves the error messages sent back to the user for reverted transactions)

TODO before taking out of draft

Unit test fixes

github-actions · 2024-01-03T14:44:31Z

I thought about documentation and added the doc-change-required label to this PR if updates are required.
I thought about the changelog and included a changelog update if required.
If my PR includes database changes (e.g. KeyValueSegmentIdentifier) I have thought about compatibility and performed forwards and backwards compatibility tests

jflo

So far so good is this a fix for #4914 ?

matthew1001 · 2024-01-03T16:32:24Z

So far so good is this a fix for #4914 ?

I think it helps to resolve part of what #4914 is asking for, along with #5706 from August 2023 which ABI-decodes revert reasons before returning them to the user.

It can always be re-opened, but probably needs to specify which calls, which error messages etc. aren't getting back to the user.

…message Signed-off-by: Matthew Whitehead <[email protected]>

Signed-off-by: Matthew Whitehead <[email protected]>

macfarla

LGTM

* mark deleted slot during clear storage step (hyperledger#6305) Signed-off-by: Karim Taam <[email protected]> Co-authored-by: garyschulte <[email protected]> * made directory structure of tests match source; fixed one typo (hyperledger#6337) Signed-off-by: Sally MacFarlane <[email protected]> * migrate controller tests to junit 5 (hyperledger#6338) Signed-off-by: Sally MacFarlane <[email protected]> * add new forkids for testnets, update forkid test to Junit5, no longer need named network specific trusted setups (hyperledger#6322) Signed-off-by: jflo <[email protected]> * Fix trielog shipping issue during self destruct (hyperledger#6340) * fix trielog shipping issue Signed-off-by: Karim Taam <[email protected]> * bump gradle properties version and adjust changelog to match release (hyperledger#6347) Signed-off-by: garyschulte <[email protected]> * finalized cancun spec (hyperledger#6351) * finalized cancun spec Signed-off-by: jflo <[email protected]> * finalized cancun spec Signed-off-by: jflo <[email protected]> --------- Signed-off-by: jflo <[email protected]> * Optimize RocksDB WAL file (hyperledger#6328) Signed-off-by: Fabio Di Fabio <[email protected]> * Make RPC reason settable, pass execution failure reason in RPC error message (hyperledger#6343) * Make RPC reason settable, pass execution failure reason in RPC error message Signed-off-by: Matthew Whitehead <[email protected]> * Update unit tests Signed-off-by: Matthew Whitehead <[email protected]> * Update tests Signed-off-by: Matthew Whitehead <[email protected]> * Update change log Signed-off-by: Matthew Whitehead <[email protected]> * Update integration tests Signed-off-by: Matthew Whitehead <[email protected]> --------- Signed-off-by: Matthew Whitehead <[email protected]> * TestWatcher junit5 (hyperledger#6339) * TestWatcher junit5 * add test class and method name to context * moved the testwatcher junit5 function to a new junit5 superclass * one qbft test to junit5 superclass Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: Sally MacFarlane <[email protected]> Co-authored-by: Stefan Pingel <[email protected]> * Migrate BFT tests to junit 5 (hyperledger#6350) * bft tests to junit 5 * base class for pki extend AcceptanceTestBaseJunit5 * try/catch in case of empty optionals * fixed parameterization method Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: Sally MacFarlane <[email protected]> * fixing on selfdestruct (hyperledger#6359) Signed-off-by: Karim Taam <[email protected]> * migrate clique tests fully to junit5 (hyperledger#6362) * migrate clique tests fully to junit5 Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: Sally MacFarlane <[email protected]> * fixed link to logging docs (hyperledger#6366) Signed-off-by: Sally MacFarlane <[email protected]> * Move logging to RunnerBuilder (hyperledger#6367) Signed-off-by: Gabriel-Trintinalia <[email protected]> * Use synchronized call to access the chain head block in `eth_estimateGas` (hyperledger#6345) * Use synchronized call to access the chain head block in estimateGas() Signed-off-by: Matthew Whitehead <[email protected]> * Add error log entries when throwing internal error from estimateGas() Signed-off-by: Matthew Whitehead <[email protected]> * Update unit tests Signed-off-by: Matthew Whitehead <[email protected]> * Update changelog Signed-off-by: Matthew Whitehead <[email protected]> --------- Signed-off-by: Matthew Whitehead <[email protected]> --------- Signed-off-by: Karim Taam <[email protected]> Signed-off-by: Sally MacFarlane <[email protected]> Signed-off-by: jflo <[email protected]> Signed-off-by: garyschulte <[email protected]> Signed-off-by: Fabio Di Fabio <[email protected]> Signed-off-by: Matthew Whitehead <[email protected]> Signed-off-by: Gabriel-Trintinalia <[email protected]> Co-authored-by: Karim TAAM <[email protected]> Co-authored-by: garyschulte <[email protected]> Co-authored-by: Sally MacFarlane <[email protected]> Co-authored-by: Justin Florentine <[email protected]> Co-authored-by: Matt Whitehead <[email protected]> Co-authored-by: Stefan Pingel <[email protected]> Co-authored-by: Gabriel-Trintinalia <[email protected]>

* mark deleted slot during clear storage step (hyperledger#6305) Signed-off-by: Karim Taam <[email protected]> Co-authored-by: garyschulte <[email protected]> * made directory structure of tests match source; fixed one typo (hyperledger#6337) Signed-off-by: Sally MacFarlane <[email protected]> * migrate controller tests to junit 5 (hyperledger#6338) Signed-off-by: Sally MacFarlane <[email protected]> * add new forkids for testnets, update forkid test to Junit5, no longer need named network specific trusted setups (hyperledger#6322) Signed-off-by: jflo <[email protected]> * Fix trielog shipping issue during self destruct (hyperledger#6340) * fix trielog shipping issue Signed-off-by: Karim Taam <[email protected]> * bump gradle properties version and adjust changelog to match release (hyperledger#6347) Signed-off-by: garyschulte <[email protected]> * finalized cancun spec (hyperledger#6351) * finalized cancun spec Signed-off-by: jflo <[email protected]> * finalized cancun spec Signed-off-by: jflo <[email protected]> --------- Signed-off-by: jflo <[email protected]> * Optimize RocksDB WAL file (hyperledger#6328) Signed-off-by: Fabio Di Fabio <[email protected]> * Make RPC reason settable, pass execution failure reason in RPC error message (hyperledger#6343) * Make RPC reason settable, pass execution failure reason in RPC error message Signed-off-by: Matthew Whitehead <[email protected]> * Update unit tests Signed-off-by: Matthew Whitehead <[email protected]> * Update tests Signed-off-by: Matthew Whitehead <[email protected]> * Update change log Signed-off-by: Matthew Whitehead <[email protected]> * Update integration tests Signed-off-by: Matthew Whitehead <[email protected]> --------- Signed-off-by: Matthew Whitehead <[email protected]> * TestWatcher junit5 (hyperledger#6339) * TestWatcher junit5 * add test class and method name to context * moved the testwatcher junit5 function to a new junit5 superclass * one qbft test to junit5 superclass Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: Sally MacFarlane <[email protected]> Co-authored-by: Stefan Pingel <[email protected]> * Migrate BFT tests to junit 5 (hyperledger#6350) * bft tests to junit 5 * base class for pki extend AcceptanceTestBaseJunit5 * try/catch in case of empty optionals * fixed parameterization method Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: Sally MacFarlane <[email protected]> * fixing on selfdestruct (hyperledger#6359) Signed-off-by: Karim Taam <[email protected]> * migrate clique tests fully to junit5 (hyperledger#6362) * migrate clique tests fully to junit5 Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: Sally MacFarlane <[email protected]> * fixed link to logging docs (hyperledger#6366) Signed-off-by: Sally MacFarlane <[email protected]> * Move logging to RunnerBuilder (hyperledger#6367) Signed-off-by: Gabriel-Trintinalia <[email protected]> * Use synchronized call to access the chain head block in `eth_estimateGas` (hyperledger#6345) * Use synchronized call to access the chain head block in estimateGas() Signed-off-by: Matthew Whitehead <[email protected]> * Add error log entries when throwing internal error from estimateGas() Signed-off-by: Matthew Whitehead <[email protected]> * Update unit tests Signed-off-by: Matthew Whitehead <[email protected]> * Update changelog Signed-off-by: Matthew Whitehead <[email protected]> --------- Signed-off-by: Matthew Whitehead <[email protected]> * Add --X-trie-log subcommand (hyperledger#6303) * Add x-trie-log subcommand for one-off trie log backlog prune Signed-off-by: Simon Dudley <[email protected]> Signed-off-by: Gabriel Fukushima <[email protected]> --------- Signed-off-by: Simon Dudley <[email protected]> Signed-off-by: Gabriel Fukushima <[email protected]> Co-authored-by: Simon Dudley <[email protected]> * fix typos (hyperledger#6368) Signed-off-by: vuittont60 <[email protected]> * Added alias --sync-min-peers for --fast-sync-min-peers (hyperledger#6372) * sync-min-peers as an alias * added unit tests Signed-off-by: Sally MacFarlane <[email protected]> --------- Signed-off-by: Sally MacFarlane <[email protected]> * Fix: Fallback to getName when canonicalName is null in BlockHeaderValidator DEBUG log (hyperledger#6332) * fallback to simple name when canonical name is null * use getName instead of getSimpleName to include the package name Signed-off-by: Manoj P R <[email protected]> --------- Signed-off-by: Manoj P R <[email protected]> Co-authored-by: Sally MacFarlane <[email protected]> * fix: use UID 1000 for besu user (hyperledger#6358) (hyperledger#6360) The openjdk-latest Docker image is using UID 1001 for besu, because its base image ubuntu:23.10 now contains a default "ubuntu" user with UID 1000. (This UID change causes the besu user with UID 1001 to not have access to files created for past versions with UID 1000.) We now remove the default ubuntu user and explicitly use UID 1000 when creating the besu user. Signed-off-by: Hal Blackburn <[email protected]> * Ignore generated files when running the spdx license check (hyperledger#6379) Signed-off-by: Meredith Baxter <[email protected]> * full sync - don't fail startup if sync-min-peers specified (hyperledger#6373) Signed-off-by: Sally MacFarlane <[email protected]> * Copy also computed fields, when doing a Transaction detached copy (hyperledger#6329) Signed-off-by: Fabio Di Fabio <[email protected]> * Disable txpool when not in sync (hyperledger#6302) Signed-off-by: Fabio Di Fabio <[email protected]> * Bump to nex release snapshot 24.1.1 (hyperledger#6383) * release next snapshot 24.1.1 Signed-off-by: garyschulte <[email protected]> * move recent changelog items to 24.1.1-SNAPSHOT Signed-off-by: garyschulte <[email protected]> --------- Signed-off-by: garyschulte <[email protected]> * Correct Tangerine Whistle definition in Fluent EVM APIs. (hyperledger#6382) The fluent API incorrectly added the code size limit in Tangerine Whistle instead of first adding it in Spurious Dragon. Signed-off-by: Danno Ferrin <[email protected]> * [MINOR] Fix pki tests condition check on mac (hyperledger#6387) Signed-off-by: Gabriel-Trintinalia <[email protected]> * Upgrade dependencies (hyperledger#6377) * Bump com.github.oshi:oshi-core to 6.4.10 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump com.github.tomakehurst to org.wiremock 3.3.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump com.google.auto.service:auto-service to 1.1.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump com.google.dagger group to 2.50 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump com.graphql-java:graphql-java to 21.3 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump com.splunk.logging:splunk-library-javalogging to 1.11.8 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump com.squareup.okhttp3:okhttp to 4.12.0 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump commons-io:commons-io to 2.15.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump dnsjava:dnsjava to 3.5.3 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump info.picocli group to 4.7.5 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump io.grpc group to 1.60.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump io.kubernetes:client-java to 18.0.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump io.netty group to 4.1.104.Final Signed-off-by: Fabio Di Fabio <[email protected]> * Bump net.java.dev.jna:jna to 5.14.0 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.apache.commons:commons-compress to 1.25.0 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.apache.commons:commons-lang3 to 3.14.0 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.apache.commons:commons-text to 1.11.0 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.apache.logging.log4j group to 2.22.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Redorder io.tmio group Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.assertj:assertj-core to 3.25.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.bouncycastle group to 1.77 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.fusesource.jansi:jansi to 2.4.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.immutables group 2.10.0 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.java-websocket:Java-WebSocket to 1.5.5 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.jetbrains.kotlin:kotlin-stdlib to 1.9.22 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.junit.jupiter group to 5.10.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.jupnp group to 2.7.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.rocksdb:rocksdbjni to 8.9.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.slf4j group to 2.0.10 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.springframework.security:spring-security-crypto to 6.2.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.testcontainers:testcontainers to 1.19.3 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.web3j group to 4.10.3 Signed-off-by: Fabio Di Fabio <[email protected]> * Bump org.xerial.snappy:snappy-java to 1.1.10.5 Signed-off-by: Fabio Di Fabio <[email protected]> * Regenerate gradle verification metadata Signed-off-by: Fabio Di Fabio <[email protected]> * Update commons-codec:commons-codec to 1.16.0 Signed-off-by: Fabio Di Fabio <[email protected]> * Update org.junit.vintage:junit-vintage-engine to 5.10.1 Signed-off-by: Fabio Di Fabio <[email protected]> * Update CHANGELOG Signed-off-by: Fabio Di Fabio <[email protected]> --------- Signed-off-by: Fabio Di Fabio <[email protected]> * add a fallback for docker detection on Mac (hyperledger#6356) Signed-off-by: garyschulte <[email protected]> * Fix test flackyness of acceptanceTestsPermissioning (hyperledger#6384) Signed-off-by: Fabio Di Fabio <[email protected]> Signed-off-by: Sally MacFarlane <[email protected]> Co-authored-by: Sally MacFarlane <[email protected]> * Upgrade `com.fasterxml.jackson` dependencies (hyperledger#6378) Signed-off-by: Fabio Di Fabio <[email protected]> * Use mining beneficiary from protocol spec in TraceServiceImpl (hyperledger#6390) * use mining beneficiary from protocol spec Signed-off-by: Daniel Lehrner <[email protected]> --------- Signed-off-by: Daniel Lehrner <[email protected]> Co-authored-by: Sally MacFarlane <[email protected]> * Update verification metadata and allowed licenses for Linea-Besu --------- Signed-off-by: Karim Taam <[email protected]> Signed-off-by: Sally MacFarlane <[email protected]> Signed-off-by: jflo <[email protected]> Signed-off-by: garyschulte <[email protected]> Signed-off-by: Fabio Di Fabio <[email protected]> Signed-off-by: Matthew Whitehead <[email protected]> Signed-off-by: Gabriel-Trintinalia <[email protected]> Signed-off-by: Simon Dudley <[email protected]> Signed-off-by: Gabriel Fukushima <[email protected]> Signed-off-by: vuittont60 <[email protected]> Signed-off-by: Manoj P R <[email protected]> Signed-off-by: Hal Blackburn <[email protected]> Signed-off-by: Meredith Baxter <[email protected]> Signed-off-by: Danno Ferrin <[email protected]> Signed-off-by: Daniel Lehrner <[email protected]> Co-authored-by: Karim TAAM <[email protected]> Co-authored-by: garyschulte <[email protected]> Co-authored-by: Sally MacFarlane <[email protected]> Co-authored-by: Justin Florentine <[email protected]> Co-authored-by: Fabio Di Fabio <[email protected]> Co-authored-by: Matt Whitehead <[email protected]> Co-authored-by: Stefan Pingel <[email protected]> Co-authored-by: Gabriel-Trintinalia <[email protected]> Co-authored-by: Gabriel Fukushima <[email protected]> Co-authored-by: Simon Dudley <[email protected]> Co-authored-by: vuittont60 <[email protected]> Co-authored-by: Manoj P R <[email protected]> Co-authored-by: Hal Blackburn <[email protected]> Co-authored-by: mbaxter <[email protected]> Co-authored-by: Danno Ferrin <[email protected]> Co-authored-by: daniellehrner <[email protected]>

…message (hyperledger#6343) * Make RPC reason settable, pass execution failure reason in RPC error message Signed-off-by: Matthew Whitehead <[email protected]> * Update unit tests Signed-off-by: Matthew Whitehead <[email protected]> * Update tests Signed-off-by: Matthew Whitehead <[email protected]> * Update change log Signed-off-by: Matthew Whitehead <[email protected]> * Update integration tests Signed-off-by: Matthew Whitehead <[email protected]> --------- Signed-off-by: Matthew Whitehead <[email protected]>

jflo reviewed Jan 3, 2024

View reviewed changes

matthew1001 changed the title ~~Make RPC reason settable, pass execution failure reason in RPC error …~~ Make RPC reason settable, pass execution failure reason in RPC error message Jan 3, 2024

Make RPC reason settable, pass execution failure reason in RPC error …

e04eed4

…message Signed-off-by: Matthew Whitehead <[email protected]>

matthew1001 force-pushed the tx-fail-reason branch from b372aa8 to e04eed4 Compare January 4, 2024 09:25

Update unit tests

b4dbc9e

Signed-off-by: Matthew Whitehead <[email protected]>

matthew1001 force-pushed the tx-fail-reason branch from 60b1a2a to b4dbc9e Compare January 4, 2024 10:36

matthew1001 added 3 commits January 4, 2024 11:26

Merge branch 'main' into tx-fail-reason

10d3e0c

Update tests

ac145c4

Signed-off-by: Matthew Whitehead <[email protected]>

Merge branch 'main' into tx-fail-reason

4ed0a69

matthew1001 marked this pull request as ready for review January 4, 2024 17:14

matthew1001 added 2 commits January 4, 2024 17:20

Update change log

8826dc9

Signed-off-by: Matthew Whitehead <[email protected]>

Update integration tests

ee6ee97

Signed-off-by: Matthew Whitehead <[email protected]>

jflo approved these changes Jan 4, 2024

View reviewed changes

macfarla approved these changes Jan 4, 2024

View reviewed changes

Merge branch 'main' into tx-fail-reason

5de5ebb

matthew1001 enabled auto-merge (squash) January 5, 2024 08:38

matthew1001 merged commit aea171c into hyperledger:main Jan 5, 2024
18 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make RPC reason settable, pass execution failure reason in RPC error message #6343

Make RPC reason settable, pass execution failure reason in RPC error message #6343

matthew1001 commented Jan 3, 2024 •

edited

Loading

github-actions bot commented Jan 3, 2024 •

edited by matthew1001

Loading

jflo left a comment •

edited

Loading

matthew1001 commented Jan 3, 2024

macfarla left a comment

Make RPC reason settable, pass execution failure reason in RPC error message #6343

Make RPC reason settable, pass execution failure reason in RPC error message #6343

Conversation

matthew1001 commented Jan 3, 2024 • edited Loading

PR description

Fixed Issue(s)

TODO before taking out of draft

github-actions bot commented Jan 3, 2024 • edited by matthew1001 Loading

jflo left a comment • edited Loading

Choose a reason for hiding this comment

matthew1001 commented Jan 3, 2024

macfarla left a comment

Choose a reason for hiding this comment

matthew1001 commented Jan 3, 2024 •

edited

Loading

github-actions bot commented Jan 3, 2024 •

edited by matthew1001

Loading

jflo left a comment •

edited

Loading