Use richer errors for Bech32 encoder and decoder #271
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
jonathanknowles
changed the title
KtorZ
approved these changes
May 16, 2019
lib/bech32/bech32.cabal
Outdated
| @@ -31,7 +31,9 @@ library | |||
| build-depends: | |||
| array | |||
| , base | |||
| , bifunctors | |||
There was a problem hiding this comment.
Bifunctors are already available in base: https://hackage.haskell.org/package/base-4.11.1.0/docs/Data-Bifunctor.html
There was a problem hiding this comment.
Nicely spotted. I hadn't realized they were available in base.
| guardE (length dcp >= checksumLength) | ||
| StringToDecodeTooShort | ||
| guardE (bech32VerifyChecksum hrp dcp) | ||
| StringToDecodeContainsInvalidChars |
There was a problem hiding this comment.
This looks actually clearer than before :)
| -------------------------------------------------------------------------------} | ||
|
|
||
| guardE :: Bool -> e -> Either e () | ||
| guardE b e = if b then Right () else Left e |
There was a problem hiding this comment.
This is basically when from Control.Monad
when condition $
return MyErrorThere was a problem hiding this comment.
This is basically
whenfromControl.Monadwhen condition $ return MyError
It's very close! Tantalizingly close. :)
KtorZ
force-pushed
the
jonathanknowles/bech32-errors
branch
from
53f6a9b to
2e3085e
Compare
Closed
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.
Issue Number
Issue #238
Overview
Currently, the Bech32
encode,decode, andmkHumanReadablePartfunctions indicate failure by evaluating toNothing. Although this solution is simple, it isn't very helpful for when we want to give feedback about the exact cause of an error.This PR uses
Eitherinstead ofMaybeto indicate failure, and adds a set of error conditions.Comments
This PR doesn't include the ability to spot checksum errors. (That will be included in a later PR.)