Replace panic with Result #113
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
dpaiton
force-pushed
the
dpaiton/stop-panicking
branch
2 times, most recently
from
0a4fb0e to
1fd4d13
Compare
This was
linked to
issues
May 24, 2024
dpaiton
force-pushed
the
dpaiton/stop-panicking
branch
2 times, most recently
from
4fa1f87 to
251a844
Compare
dpaiton
requested review from
jalextowle,
jrhea,
mcclurejt,
sentilesdal,
ryangoree,
slundqui and
wakamex
as code owners
sentilesdal
approved these changes
May 24, 2024
There was a problem hiding this comment.
Yeah this all seems fine to me. Add some more in the description if you can. Looks like you're:
- getting rid of all explicit
panic!calls in hyperdrive-math - fixedpoint pow returns result
- fixedpoint exp returns result
- error messaging improvements in bindings
- catch overflow panics for max short/long
dpaiton
force-pushed
the
dpaiton/stop-panicking
branch
from
8cb5007 to
3227ba8
Compare
dpaiton
force-pushed
the
dpaiton/stop-panicking
branch
2 times, most recently
from
f4814d0 to
e8081cd
Compare
dpaiton
force-pushed
the
dpaiton/stop-panicking
branch
from
e8081cd to
a2f9714
Compare
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.
Resolved Issues
#99 #64 #65 #66
Description
Our use of both panic and result results in a worse developer experience, and should be changed to using Result everywhere possible. This PR removes almost all
panicuses in the core libs; where functions once would panic but return a typeTthey now return an error with the typeResult<T>. I also removedunwrap()statements, which convertResulttopanic, in most places around the repo.Exceptions were made for core (anything with sugar like
+,-,*) FixedPoint arithmetic (thus keeping any U256 panics), certain test-related cases, and macros.I also improved some error messaging (in bindings mostly, but also elsewhere), added comments, & added a lint ignore.
I ran the fuzz testing with 10k
FUZZ_RUNSand 50kFAST_FUZZ_RUNStwice without error locally.