[rpc][structured-error-handling][2/n] State trait for AuthorityState, group AuthorityState-originating SuiErrors #12933
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
6 Ignored Deployments
|
wlmyng
changed the title
7 tasks
wlmyng
changed the title
wlmyng
requested review from
patrickkuo,
bmwill,
666lcz,
healthydeve and
lavindir
wlmyng
force-pushed
the
dyn-state-trait-for-rpc
branch
from
01ae3d3
to
ecb799c
Compare
wlmyng
changed the title
wlmyng
force-pushed
the
dyn-state-trait-for-rpc
branch
from
ecb799c
to
0a978ad
Compare
lavindir
reviewed
Jul 21, 2023
| | SuiError::UnsupportedFeatureError { .. } | ||
| | SuiError::UserInputError { .. } | ||
| | SuiError::WrongMessageVersion { .. } => StateReadError::Client(e.into()), | ||
| _ => StateReadError::Internal(e.into()), |
There was a problem hiding this comment.
It may be useful to clarify somehow when the error is transient, indicating to the user that they can retry, vs an error that is non-transient
lavindir
approved these changes
Jul 24, 2023
|
Approved with the above suggestions applied |
wlmyng
force-pushed
the
dyn-state-trait-for-rpc
branch
from
0a978ad
to
c53bc90
Compare
wlmyng
force-pushed
the
dyn-state-trait-for-rpc
branch
from
c53bc90
to
6ad4f80
Compare
wlmyng
force-pushed
the
dyn-state-trait-for-rpc
branch
from
b2ee45b
to
bb93ab7
Compare
…tyState as StateReadError. This will help us later when handling QuorumDriverErrror and SuiErrors that may arise from other situations
wlmyng
force-pushed
the
dyn-state-trait-for-rpc
branch
from
bb93ab7
to
a872525
Compare
ebmifa
pushed a commit
that referenced
this pull request
Aug 10, 2023
… group AuthorityState-originating SuiErrors (#12933) ## Description Part of the first set of PRs is to group the errors that are possible on the RPC today into a few categories transparently, setting us up to eventually standardize error strings and resolution. This PR specifically introduces a `State` trait which `AuthorityState` implements to centralize `AuthorityState`-originating `SuiError`s so that we can disambiguate these errors from other sources of `SuiError`. This has the added benefit of helping w/ unit test writing, as demonstrated by `coin_api` and `move_utils`. No change has been made to error strings, but StateReadError::Internal will now code to `-32603` instead of `-32000`. But this can be negotiable too. ## Test Plan Existing tests --- If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process. ### Type of Change (Check all that apply) - [ ] protocol change - [x] user-visible impact - [x] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes Internal errors that arise while reading from authority will now return -32603 error code. Client-fault errors that arise while reading from authority will now return -32602 error code. Error strings have not been modified.
ebmifa
added a commit
that referenced
this pull request
Aug 29, 2023
## Description Adding protocol change highlight to release notes script ## Test Plan ``` eugene@mac-studio ~/code/sui (eugene/add_protocol_highlight_to_release_notes) $ ./scripts/generate-release-notes.sh releases/sui-v1.7.0-release releases/sui-v1.8.0-release Sui Protocol Version in this release: XX #13124: Add protocol config feature flags for zkLogin to enable testing in Devnet, use updated proof verification logics for zkLogin signature verification. #13417: When building Move code, there are now additional linter warnings related to comparing collections from Sui framework code (`Bag`, `Table`, and `TableVec`). Note that this comparison is not a structural one based on the collection content, which is what one might expect, so Sui now indicates this via a linter warning. #12989: All transaction execution errors from `execute_transaction_block` of `client-fault` now return a -32002 error code. If you encounter this error code, there is most likely an issue in your transaction inputs. Previously, when executing a transaction failed on the RPC, you would receive a, "Transaction has non recoverable errors from at least 1/3 of validators" after the transaction failed to execute. You now receive an improved error message, "Transaction execution failed due to issues with transaction inputs, please review the errors and try again: {errors}", where `{errors}` is a string list of actionable errors. After you resolve the errors indicated, your transaction should succeed. #13194: When building Move code, there are now additional linter warnings related to freezing an object containing (directly or indirectly) other (wrapped) object. Freezing such an object prevents unwrapping of inner objects. #12575: The details included in error messages returned during dependency graph construction might differ from the previous error messages, but they still include similar details and information. #12933: Error code designation is updated to support a more cohesive error reporting structure. Internal errors that arise while reading from authority return a `-32603` error code. Client-fault errors that arise while reading from authority return a `-32602` error code. Error strings are not modified. #13312: Removes the `--legacy-digest` flag from the `sui client upgrade` and `sui move build` CLI commands, as Sui networks no longer require package digests to be calculated using the legacy algorithm. ```
randall-Mysten
pushed a commit
that referenced
this pull request
Sep 6, 2023
## Description Adding protocol change highlight to release notes script ## Test Plan ``` eugene@mac-studio ~/code/sui (eugene/add_protocol_highlight_to_release_notes) $ ./scripts/generate-release-notes.sh releases/sui-v1.7.0-release releases/sui-v1.8.0-release Sui Protocol Version in this release: XX #13124: Add protocol config feature flags for zkLogin to enable testing in Devnet, use updated proof verification logics for zkLogin signature verification. #13417: When building Move code, there are now additional linter warnings related to comparing collections from Sui framework code (`Bag`, `Table`, and `TableVec`). Note that this comparison is not a structural one based on the collection content, which is what one might expect, so Sui now indicates this via a linter warning. #12989: All transaction execution errors from `execute_transaction_block` of `client-fault` now return a -32002 error code. If you encounter this error code, there is most likely an issue in your transaction inputs. Previously, when executing a transaction failed on the RPC, you would receive a, "Transaction has non recoverable errors from at least 1/3 of validators" after the transaction failed to execute. You now receive an improved error message, "Transaction execution failed due to issues with transaction inputs, please review the errors and try again: {errors}", where `{errors}` is a string list of actionable errors. After you resolve the errors indicated, your transaction should succeed. #13194: When building Move code, there are now additional linter warnings related to freezing an object containing (directly or indirectly) other (wrapped) object. Freezing such an object prevents unwrapping of inner objects. #12575: The details included in error messages returned during dependency graph construction might differ from the previous error messages, but they still include similar details and information. #12933: Error code designation is updated to support a more cohesive error reporting structure. Internal errors that arise while reading from authority return a `-32603` error code. Client-fault errors that arise while reading from authority return a `-32602` error code. Error strings are not modified. #13312: Removes the `--legacy-digest` flag from the `sui client upgrade` and `sui move build` CLI commands, as Sui networks no longer require package digests to be calculated using the legacy algorithm. ```
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.
Description
Part of the first set of PRs is to group the errors that are possible on the RPC today into a few categories transparently, setting us up to eventually standardize error strings and resolution. This PR specifically introduces a
Statetrait whichAuthorityStateimplements to centralizeAuthorityState-originatingSuiErrors so that we can disambiguate these errors from other sources ofSuiError. This has the added benefit of helping w/ unit test writing, as demonstrated bycoin_apiandmove_utils.No change has been made to error strings, but StateReadError::Internal will now code to
-32603instead of-32000. But this can be negotiable too.Test Plan
Existing tests
If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process.
Type of Change (Check all that apply)
Release notes
Error code designation is updated to support a more cohesive error reporting structure. Internal errors that arise while reading from authority return a
-32603error code. Client-fault errors that arise while reading from authority return a-32602error code. Error strings are not modified.