-
Notifications
You must be signed in to change notification settings - Fork 22
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.
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
feat: add encoder/decoder for withdrawal id compression (for storage in OP_RETURN) #1525
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
djordon
reviewed
Mar 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Largely looks good, just a couple of comments.
matteojug
previously approved these changes
Mar 20, 2025
djordon
approved these changes
Mar 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good
matteojug
approved these changes
Mar 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
needed-for-withdrawals-v1
transaction library
Common library for handling transaction manipulation.
withdrawal
The withdrawal sBTC operation.
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.
Description
Part of: #1478 and supersedes #1486 (due to the size of the changes and the fact that most comments are now invalidated).
This introduces a new module
idpack
to thesbtc
crate which contains an encapsulated integer sequence compression encoding using a multi-bitmap segmentation algorithm.Compared to #1486, this PR is substantially slimmed down and drops support for the eventual handling of multiple encodings within the same encoding format, i.e. adding or changing the encodings will require a new implementation.
Changes
EncodingStrategy
trait and moved the full encode/decode implementations toencoder.rs
anddecoder.rs
respectively.sbtc
crate #1523 and this PR targets that.Segmenter
.Segments
type now upholds the invariant that its inner segments must be sequential without overlaps.Checklist: