Remove deprecated checksum routines #1253
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
There are deprecated since 0.24.0, i.e. they can be removed now.
Now that the deprecated `get_checksum{,_bytes}` routines are removed,
the checksum is always computed with ignored data after the first '#',
i.e. the boolean parameter `exclude_hash` is not needed anymore and
the functionality can be consolidated into `calc_checksum_bytes`.
danielabrozzoni
approved these changes
Jan 8, 2024
There was a problem hiding this comment.
ACK ed91a4b
Looks good to me, thanks for taking the time to clean up the code! :)
|
@theStack thank you for the contribution. However our policy is that all commits need to be signed otherwise we cannot merge! Please sign your commits! |
The commits are signed, but apparently I forgot to upload my GPG public key to GitHub. Did that now, so the commits are shown as "Verified". Is there anything more to do? |
|
It should be fine now, thanks! |
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
This PR removes the routines
get_checksumandget_checksum_bytes(in the bdk crate, descriptor/checksum.rs), which have been deprecated in 0.24.0. Consequently, the routinecalc_checksum_bytes_internalis consolidated intocalc_checksum_bytes, as the boolean parameterexclude_hashis not needed anymore. See also the two TODOs in the touched file.Notes to the reviewers
In the second commit, the signature of the function
calc_checksum_bytesslightly changes, as thedescparameter now is declared asmut, in order to change the local variable within the function. My rust experience is rather limited, so I'm not sure if this is a problem for users. IIUC, this is comparable to changing a pass-by-value parameter in C++ fromconst std::string desctostd::string desc, which is relevant only for the function implementation, but doesn't change the interface.Changelog notice
get_checksumandget_checksum_bytesroutinesChecklists
All Submissions:
cargo fmtandcargo clippybefore committing