Add witness_version functions to CheckedHrpstring
#175
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
The `witness_version` function does not remove the witness version; improve the documentation on `UncheckedHrpstring::witness_version` to mention this and point devs towards `UncheckedHrpstring::remove_witness_version`.
As we did for `UncheckedHrpstring` add functions to the `CheckedHrpstring` struct to allow checking the initial byte of the data part and removing it if required.
tcharding
force-pushed
the
01-29-witness-version
branch
from
d905b7c to
2d7832a
Compare
|
Do we need standalone tests for this, or is that captured in the docs examples? |
|
Let me confirm that breaking the doc examples breaks CI on my end -- but I'm pretty sure they are run in CI, yes. |
|
Ok, yes, they're run in the real CI but not in my local one :). Glad I checked this. I'll fix the local thing, then remove my failing commit. |
apoelstra
force-pushed
the
01-29-witness-version
branch
from
017f60b to
2d7832a
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.
As we did for
UncheckedHrpstringadd functions to theCheckedHrpstringstruct to allow checking the initial byte of the data part and removing it if required.Add an initial patch that improves the docs on the
UncheckedHrpstring::remove_witness_versionfunction (this is then copied in patch 2).