Open
Conversation
ef9007e to
a1d15f8
Compare
tcharding
reviewed
Mar 24, 2026
Comment on lines
+186
to
+188
| #[deprecated(since = "TBD", note = "use `FullPublicKey` instead")] | ||
| #[doc(hidden)] | ||
| pub type CompressedPublicKey = FullPublicKey; |
Member
There was a problem hiding this comment.
Why did you create this alias twice instead of re-exporting the other one? (Here and also in key module)
Contributor
Author
There was a problem hiding this comment.
Two reasons:
- If you re-export the alias that is marked as deprecated, it throws a lint warning on the
pub usestatement. - I was following the precedent of
BlockInterval. It is defined in bothlib.rsandblock.rsinbitcoin, presumably to avoid the above lint error.
Member
There was a problem hiding this comment.
No worries, @apoelstra git blame says 4e4601b was you. Do you remember doing this intentionally?
Member
There was a problem hiding this comment.
No, I don't remember. I suspect I was trying to dance around the compiler's stupid broken deprecation logic somehow.
Member
|
I wonder if we should keep the re-exports of the deprecated keys everywhere so that users of the old names get the deprecation warning but their code still builds? |
Member
|
Reviewed: a1d15f8 |
a1d15f8 to
ae5d512
Compare
ae5d512 to
9566a19
Compare
Member
|
Reviewed: 9566a19 Note to self: Waiting on resolution of "should we use two separate type alias'" |
Member
|
9566a19 needs rebase |
The CompressedPublicKey represents an always compressed ECDSA public key. This key type is the standard for almost all transactions in modern Bitcoin. As such, it should be renamed to better clarify its purpose. Rename CompressedPublicKey to FullPublicKey. Deprecate CompressedPublicKey.
The senders_keys function in sign-tx-segwit uses a LegacyPublicKey to generate the WPubkeyHash. Since a FullPublicKey can generate the same hash without the fallibility, it's better for the example to use it here. Replace PublicKey with FullPublicKey in senders_keys function in sign-tx-segwit-v0 example.
The optionally-compressed PublicKey type is no longer used in Bitcoin outside of legacy transaction handling. Since the name PublicKey implies a general purpose public key type, it should be renamed to clarify the niche use compared to the typical compressed public key type, FullPublicKey. Rename PublicKey to LegacyPublicKey. Deprecate PublicKey.
9566a19 to
25941bc
Compare
tcharding
approved these changes
Mar 31, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 has been mentioned before, the public key types PublicKey and CompressedPublicKey don't correctly convey the intended usages for the types. The optionally-compressed PublicKey type is intended to be used for legacy transactions, replaced almost entirely by the CompressedPublicKey. To this end, both of the types should be renamed to better outline their usage, rather than their implementation.