feat: add leb128 variable length integer implementation to sbtc crate
#1523
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
cylewitruk
added
the
transaction library
4 tasks
matteojug
reviewed
Mar 18, 2025
matteojug
reviewed
Mar 18, 2025
matteojug
reviewed
Mar 19, 2025
matteojug
previously approved these changes
Mar 19, 2025
|
FYI, I benchmarked your impl against https://crates.io/crates/leb128 and your impl is ~6% faster in release mode, nice! |
Well that's cool, and here I was mostly going for safety and not performance 😅 |
matteojug
approved these changes
Mar 20, 2025
MCJOHN974
approved these changes
Mar 20, 2025
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 20, 2025
…in OP_RETURN) (#1525) ## 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 the `sbtc` 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 - Removed `EncodingStrategy` trait and moved the full encode/decode implementations to `encoder.rs` and `decoder.rs` respectively. - Removed a bunch of other stuff as well. - The LEB128 implementation is moved to #1523 and this PR targets that. - The encode-path is now infallible. - The packaging path remains fallible: - The only errors that can be produced (in practice) are due to input validation. - The same applies to size-estimations from `Segmenter`. - Reason being that these work on slices instead of requiring new allocs to sortable types (we expect our input to be sorted, anyway - see [this comment](#1512 (comment)) for more context). - Added a bunch of tests. - The `Segments` type now upholds the invariant that its inner segments must be sequential without overlaps. ## Checklist: - [x] I have performed a self-review of my code - [x] My changes generate no new warnings - [x] New and existing unit tests pass locally with my changes - [x] Any dependent changes have been merged and published in downstream modules
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.
Description
Break-out from withdrawal id encoding. LEB128 encoding is used to efficiently encode integer values.
Changes
Leb128and related tests to thesbtccrate which can be used to encode/decode and calculate the size of LEB-128 encoded values.Testing Information
proptestcrate for ensuring maximum coverage.Checklist: