Skip to content

Add helpers to convert to DescriptorPublicKey and Descriptor<DefinitePublicKey> data structures #818

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 13, 2025
Merged

Add helpers to convert to DescriptorPublicKey and Descriptor<DefinitePublicKey> data structures #818

merged 1 commit into from
May 13, 2025

Conversation

@philipr-za
Copy link
Contributor

@philipr-za philipr-za commented May 12, 2025 •
edited
Loading

closes #817

I added the common cases of converting from Descriptor<PublicKey> and Descriptor<XOnlyPublicKey> to Descriptor<DefinitePublicKey>. Not sure if this is considered too specific but it feels like a use case that will be very common.

@apoelstra
Copy link
Member

In 5937090:

I think this is too specific. You're the first person I've encountered who wound up with XOnlyPublicKeys (which is a low level secp256k1 type) and wanted to use it in a PSBT like this.

The From impls on the keys themselves are fine.

I agree that it would be nice if we had a .map_pk function or something that was a simpler version of .translate_pk that assumed the hash types were all the same and that the mapping function were infallible. Then you could do descriptor.map_pk(DefiniteDescriptorKey::from).

@philipr-za
Copy link
Contributor Author

In 5937090:

I think this is too specific. You're the first person I've encountered who wound up with XOnlyPublicKeys (which is a low level secp256k1 type) and wanted to use it in a PSBT like this.

The From impls on the keys themselves are fine.

I agree that it would be nice if we had a .map_pk function or something that was a simpler version of .translate_pk that assumed the hash types were all the same and that the mapping function were infallible. Then you could do descriptor.map_pk(DefiniteDescriptorKey::from).

Fair enough, I will drop those impl's and run rustfmt

@philipr-za philipr-za force-pushed the add-from-to-descriptorpublickey branch from 5937090 to 8b248f6 Compare May 13, 2025 14:14
@philipr-za
Copy link
Contributor Author

Removed the Descriptor impl's. Had to make the new constructor public on DefiniteDescriptorKey to allow for the translate_pk to work I left in the unit test to prove the application of these From impl's to the use case in the issue.

@apoelstra
Copy link
Member

Looks like the formatter is still not happy. But concept ACK.

@philipr-za philipr-za force-pushed the add-from-to-descriptorpublickey branch from 8b248f6 to a00c993 Compare May 13, 2025 14:40
apoelstra
apoelstra approved these changes May 13, 2025
View reviewed changes
Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK a00c993; successfully ran local tests

@apoelstra
Copy link
Member

BTW if you want to use this today, can you do a backport PR to the 12.x branch (along with a minor version bump)?

@apoelstra apoelstra merged commit 6d1da92 into rust-bitcoin:master May 13, 2025
31 checks passed
philipr-za added a commit to philipr-za/rust-miniscript that referenced this pull request May 14, 2025
@philipr-za
Backport unit test from rust-bitcoin#818
b6593d6
@philipr-za philipr-za mentioned this pull request May 14, 2025
Merged
apoelstra added a commit that referenced this pull request Jul 21, 2025
@apoelstra
Merge #819: Backport of #818 to 12.3
63a4047 
3cdd25f bump minor version to 12.3.5 (Philip Robinson)
5019d87 Add helpers to convert from PublicKey & XOnlyPublicKey to Descriptor Keys (Philip Robinson)

Pull request description:

  A backport of #818 to the 12.3 branch


ACKs for top commit:
  apoelstra:
    ACK 3cdd25f; successfully ran local tests


Tree-SHA512: 1812b3656067e3d75cee917fa0355abd04d39c1388db902f1daae1728fc84640b826e896a3591db8879f7fcb97d2af8e101f21a387b05d8ee5bdaa3d3d7de60f
heap-coder added a commit to heap-coder/rust-miniscript that referenced this pull request Sep 27, 2025
@heap-coder
Merge rust-bitcoin/rust-miniscript#818: Add helpers to convert to Des…
ca9477a 
…criptorPublicKey and Descriptor<DefinitePublicKey> data structures

a00c99312c216a61280b7513a3c1f1f12bffa478 Add helpers to convert from PublicKey & XOnlyPublicKey to Descriptor Keys (Philip Robinson)

Pull request description:

  closes rust-bitcoin/rust-miniscript#817

  I added the common cases of converting from `Descriptor<PublicKey>` and `Descriptor<XOnlyPublicKey>` to `Descriptor<DefinitePublicKey>`. Not sure if this is considered too specific but it feels like a use case that will be very common.

ACKs for top commit:
  apoelstra:
    ACK a00c99312c216a61280b7513a3c1f1f12bffa478; successfully ran local tests

Tree-SHA512: 151296fbeca3ccb3e7e76138cb0ba874de8250e5139f0eae5e407a16573ed312af2e25d8c5b79d7ca59c8d673bd819087381287d6551a08a64fea51d7ddd9f9e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@apoelstra apoelstra apoelstra approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Only public API for constructing DefiniteDescriptorKey or DefinitePublicKey is from_str(...)?

2 participants

@philipr-za @apoelstra