refactor: use thiserror in the client
#623
Merged
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
tomyrd
force-pushed
the
tomyrd-next-update
branch
from
f6a4285 to
a1cdab0
Compare
tomyrd
force-pushed
the
tomyrd-thiserror
branch
from
ef97adb to
b44f79b
Compare
tomyrd
force-pushed
the
tomyrd-thiserror
branch
from
7c8fe96 to
089ef2a
Compare
igamigo
approved these changes
Dec 4, 2024
There was a problem hiding this comment.
LGTM! Left a couple of minor comments. Also, two things:
- We could use this PR to fix errors related to this PR in
miden-base, by temporarily pointing to that branch or waiting for it to be merged. - I think there are some places where we could use
#[from]to simplify conversions, though probably not for this PR. The thing to keep in mind here would be to be careful about conversions depending on the context as well (see this discussion)
crates/rust-client/src/rpc/errors.rs
Outdated
| NoteTypeError(NoteError), | ||
| #[error("invalid note type value")] | ||
| NoteTypeError(#[source] NoteError), | ||
| #[error("field `{field_name}` required to be filled in protobuf representation of {entity}")] |
There was a problem hiding this comment.
nit: Let's change this to something like:
Suggested change
| #[error("field `{field_name}` required to be filled in protobuf representation of {entity}")] | |
| #[error("field `{field_name}` expected to be present in protobuf representation of {entity}")] |
| ConversionError(String), | ||
| /// Invalid underlying note object. | ||
| NoteError(NoteError), | ||
| #[error("note error: {0}")] |
There was a problem hiding this comment.
As NoteError is the source here, it should not be added to the Display impl or otherwise it'll be duplicated on the reports.
SantiagoPittella
approved these changes
Dec 4, 2024
crates/rust-client/src/errors.rs
Outdated
Comment on lines
42
to
47
| #[error("can't import new account without seed")] | ||
| ImportNewAccountWithoutSeed, | ||
| #[error("error with merkle path: {0}")] | ||
| //TODO: use source in this error when possible | ||
| MerkleError(MerkleError), | ||
| #[error("the transaction did not produce the expected notes corresponding to note ids")] |
There was a problem hiding this comment.
We should decide if we are going to use contractions (do not -> don't, did not -> didn't) and commit to it. Maybe I'm being too picky. Feel free to left your opinion.
There was a problem hiding this comment.
I don't think it's picky. This PR is a good opportunity to look into these details and update all of the error messages.
I think I prefer contractions, just to make the error messages shorter.
| pub enum AccountProofError { | ||
| #[error("the received account hash does not match the received account header's account hash")] |
There was a problem hiding this comment.
Suggested change
| #[error("the received account hash does not match the received account header's account hash")] | |
| #[error("the received account hash does not match the received account header's hash")] |
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.
Refactor the client's errors to follow the new error design guidelines.
Some of the errors couldn't be marked with
#[source]as they are not yet refactored in their crates. Specifically, once 0xPolygonMiden/miden-vm#1588 gets merged we can modify them.