Ready for Review: Improve consistency for bip32::ChildNumber #126
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
There seemed to be some confusion as to whether the internal represenation of a ChildNumber is supposed to be the index (0..2^31-1 for _both_ Normal and Hardened) or the actual number (0..2^31-1 for Normal and 2^31..2^32-1 for Hardened). This commits fixes this confusion. - Make clear that the internal representation is the index rather than the actual number - Make the internal representation non-public - Provide methods for creating valid ChildNumbers - Change relevant callers and tests to conform to this new ChildNumber My rationale for using index rather than the actual number as internal representation is that the difference between the two enum variants already encode wether a ChildNumber is a normal one or a hardened one, so the only bit of extra information left to be encoded is its index.
dongcarl
force-pushed
the
bip32-consistency
branch
from
f20158c
to
4a5bf52
Compare
dongcarl
changed the title
|
Can you add helper methods |
- Fix documentation links
|
@apoelstra Done. |
apoelstra
approved these changes
Aug 11, 2018
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.
There seemed to be some confusion as to whether the internal
represenation of a ChildNumber is supposed to be the index (0..2^31-1
for both Normal and Hardened) or the actual number (0..2^31-1 for
Normal and 2^31..2^32-1 for Hardened). This commits fixes this
confusion.
than the actual number
My rationale for using index rather than the actual number as internal
representation is that the difference between the two enum variants
already encode wether a ChildNumber is a normal one or a hardened one,
so the only bit of extra information left to be encoded is its index.