Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bech32 Library #248

Merged
merged 23 commits into from
May 15, 2019
Merged

Bech32 Library #248

merged 23 commits into from
May 15, 2019

Conversation

jonathanknowles
Copy link
Contributor

@jonathanknowles jonathanknowles commented May 9, 2019 •
edited
Loading

Issue Number

Issue #238

@jonathanknowles jonathanknowles self-assigned this May 9, 2019
@KtorZ KtorZ mentioned this pull request May 9, 2019
Closed
@KtorZ KtorZ force-pushed the jonathanknowles/bech32-lib branch from 584dbd0 to dab6d08 Compare May 14, 2019 15:26
@KtorZ KtorZ marked this pull request as ready for review May 14, 2019 15:26
KtorZ
KtorZ approved these changes May 14, 2019
View reviewed changes
Copy link
Member

@KtorZ KtorZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jonathanknowles

This leaves us with a basic encode / decode API for the bech32 format. I've slightly review the high-level module API to be easier to use (using ByteString as an input type instead of [Word8] and, removing type alias HRP in a favor of a newtype HumanReadablePart with a smart-constructor).

This isn't perfect, but since I know you'll be working on some extra stuff for the error location, I'll leave it to you to iterate on top of this. Please don't spend too much time with this error detection though 🙏

@jonathanknowles jonathanknowles force-pushed the jonathanknowles/bech32-lib branch 2 times, most recently from 7e66795 to 467c69f Compare May 15, 2019 06:39
@jonathanknowles jonathanknowles changed the title WIP Bech32 Library Bech32 Library May 15, 2019
jonathanknowles and others added 22 commits May 15, 2019 09:22
@jonathanknowles
Add original implementation.
2ef9b8a
@jonathanknowles
Format imports and exports according to our coding standards.
9cc1527
@jonathanknowles
Format code according to our coding standards.
5e1ef5c
@jonathanknowles
Use <$> instead of fmap .. $.
8101b63
@jonathanknowles
Import Data.ByteString.Char8 as B8 rather than BSC.
8addb76
@jonathanknowles
Add original unit test source code.
f984bb0
@jonathanknowles
Format test code to meet our coding standards.
dd2f49b
@jonathanknowles
Format imports and exports according to our coding standards.
a7b78b7
@jonathanknowles
Change constraint from Num to Integral.
4b6311f
@jonathanknowles
Shorten length of Word5 constructor from UnsafeWord5 to Word5.
a5807d1 
This makes code more concise, but doesn't affect safety, as this constructor is
not exported outside of the `Codec.Binary.Bech32` module.
@jonathanknowles
Move brackets to avoid unnecessary $.
0b2ad65
@jonathanknowles
Import Data.ByteString.Char8 as B8 rather than BSC.
7c1b9e8
@KtorZ @jonathanknowles
add module description and author credits on top of the file
cd03189
@KtorZ @jonathanknowles
replace usage of 'tasty' by 'hspec' in lib/bech32
1642cc7
@KtorZ @jonathanknowles
remove bitcoin-specific details and provide a slightly more general API
6ac2d5a
@KtorZ @jonathanknowles
add QuickCheck roundtrip for encode . decode
37af224
@jonathanknowles
Add roundtrip tests for toBase256 and toBase32 functions.
e5a4574
@jonathanknowles
Add roundtrip tests for character set conversion functions.
5e40f85
@jonathanknowles
Add QuickCheck tests for convertBits function.
9c8c5b0
@jonathanknowles
Introduce humanReadableCharset{Min,Max}Bound constants.
97d2358 
Use these constants instead of repeating the same hard-coded values in
different places.
@jonathanknowles
Introduce constants checksumLength and maxEncodedStringLength.
0fdc8bb 
Use these constants to avoid repeatedly hardcoding the same values
within functions.
@jonathanknowles
Improve documentation comment for function convertBits.
e31048b
@jonathanknowles jonathanknowles force-pushed the jonathanknowles/bech32-lib branch from 91d4d12 to 9374258 Compare May 15, 2019 09:22
@jonathanknowles
Copy link
Contributor Author

jonathanknowles commented May 15, 2019 •
edited
Loading

@KtorZ I've added more tests, and separated out the modules into public (Bech32) and internal (Bech32.Internal). This PR is ready for final review and merging.

I've moved the WIP error location detection code to a separate branch for the moment. (jonathanknowles/bech32-lib-error-location-detection)

@jonathanknowles jonathanknowles requested a review from KtorZ May 15, 2019 10:30
KtorZ
KtorZ approved these changes May 15, 2019
View reviewed changes
Copy link
Member

@KtorZ KtorZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@KtorZ KtorZ merged commit 8b027bb into master May 15, 2019
@iohk-bors iohk-bors bot deleted the jonathanknowles/bech32-lib branch May 15, 2019 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KtorZ KtorZ KtorZ approved these changes

Assignees

@jonathanknowles jonathanknowles

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jonathanknowles @KtorZ