fix(key_map): derivation_path for `Xprv` with key origin info by oleonardolima · Pull Request #872 · rust-bitcoin/rust-miniscript

oleonardolima · 2025-10-31T15:09:54Z

Description

The GetKey for DescriptorSecretKey (and thus KeyMap) returned the wrong key when an extended private key with key origin info was queried via KeyRequest::Bip32.

The key request path is master-relative, but the xkey is anchored at its origin (e.g. [d34db33f/84h/1h/0h]). The old code stripped the path returned by matches(); the fix strips the origin prefix instead (and uses the full path when there is no origin) before deriving from the xkey.

--

Also, this PR introduces the test get_key_xpriv_with_key_origin covering the scenarios: bare wildcard; single fixed step; fixed step then wildcard, and the matching/non-matching cases build requests from explicit (fingerprint, path) key sources.

Notes

If you'd like an overview on the issue, see: #863 (comment)

Changelog notice

### Fixed
- keymap: fix `GetKey` derivation path for `Xprv` with key origin info [#872](https://github.com/rust-bitcoin/rust-miniscript/pull/872)

Checklists

Bugfixes:

This pull request breaks the existing API
I've added tests to reproduce the issue which are now passing
I'm linking the issue being fixed by this PR

We cannot link to a file by directory path in rustdocs. Just remove the link. This is breaking the docs build in rust-bitcoin#805 and is also mentioned in rust-bitcoin#872.

f853906 Remove link to doc file (Tobin C. Harding) Pull request description: We cannot link to a file by directory path in rustdocs. Just remove the link. This is breaking the docs build in #805 and is also mentioned in #872. ACKs for top commit: apoelstra: ACK f853906; successfully ran local tests Tree-SHA512: d2e2eb182cb823297de53635ac23d55ff920b750d28efa7e18de08ddeda3a7f2bdffe8ff32dcf4c54ec32a33a176cea349291260388fd5e5cdad14c6c2e9802e

We cannot link to a file by directory path in rustdocs. Just remove the link. This is breaking the docs build in rust-bitcoin#805 and is also mentioned in rust-bitcoin#872.

- fixes the implementation of `GetKey` for `Xprv` with `KeyRequest::Bip32`, when the the key_origin information is available. - introduces a new test for a scenario with no wildcard used, a specific derivation index is used instead.

- introduce table-driven cases for `get_key_xpriv_with_key_origin` with named fields - drop redundant key parsing, and build requests from explicit key sources Assisted-by: Claude Opus 4.8

oleonardolima · 2026-06-16T20:11:17Z

@notmandatory I updated this PR and added new test scenarios, it should be ready to review.

cc'in @noahjoeris as you had interest in this and a review would be appreciated.

- backports rust-bitcoin#872 fixes for the implementation of `GetKey` for `Xprv` with `KeyRequest::Bip32`, when the the key_origin information is available. - introduces a new test for a scenario with no wildcard used, a specific derivation index is used instead.

- backports introduced rust-bitcoin#872 table-driven test cases for `get_key_xpriv_with_key_origin` with named fields - drop redundant key parsing, and build requests from explicit key sources Assisted-by: Claude Opus 4.8

notmandatory

ACK a2f4497

Changes look good, tests easy to follow.

noahjoeris

tACK a2f4497

Looking good, thanks.

oleonardolima · 2026-06-24T13:52:37Z

ping @tcharding @apoelstra for awareness.

apoelstra · 2026-06-24T14:27:08Z

Oops, missed this somehow. Will review it and the backport today.

apoelstra

ACK a2f4497; successfully ran local tests

evanlinjin · 2026-06-27T00:11:28Z

@oleonardolima I noticed that KeyMapWrapper of the release-12.x branch also has the same bug. Would you be able to port the fix there since bdk_tx depends on that version of miniscript? Let me know if you would like me to do it instead. Thanks in advance.

noahjoeris · 2026-06-27T11:24:42Z

@evanlinjin it's here #867

oleonardolima · 2026-06-27T13:31:15Z

@oleonardolima I noticed that KeyMapWrapper of the release-12.x branch also has the same bug. Would you be able to port the fix there since bdk_tx depends on that version of miniscript? Let me know if you would like me to do it instead. Thanks in advance.

@evanlinjin It's already covered in #867 as Noah commented above.

- backports rust-bitcoin#872 fixes for the implementation of `GetKey` for `Xprv` with `KeyRequest::Bip32`, when the the key_origin information is available.

- backports introduced rust-bitcoin#872 table-driven test cases for `get_key_xpriv_with_key_origin` with named fields - drop redundant key parsing, and build requests from explicit key sources Assisted-by: Claude Opus 4.8

…r keys with origin d01ee72 test(key_map): improve `Xprv` key origin tests (Leonardo Lima) 1053799 fix(key_map): derivation_path for `Xprv` with key origin info (Leonardo Lima) Pull request description: backports #872 ### Description It backports the fix for deriving the private key correctly in scenarios where the key origin is available, see #872. The GetKey for DescriptorSecretKey (and thus KeyMap) returned the wrong key when an extended private key with key origin info was queried via KeyRequest::Bip32. The key request path is master-relative, but the xkey is anchored at its origin (e.g. [d34db33f/84h/1h/0h]). The old code stripped the path returned by matches(); the fix strips the origin prefix instead (and uses the full path when there is no origin) before deriving from the xkey. cherry-picks 20ae466 and a2f4497. ### Changelog notice ``` ### Fixed - keymap: fix `GetKey` derivation path for `Xprv` with key origin info [#872](#872) ``` ### Checklists #### Bugfixes: * [ ] This pull request breaks the existing API * [x] I've added tests to reproduce the issue which are now passing * [x] I'm linking the issue being fixed by this PR ACKs for top commit: apoelstra: ACK d01ee72; successfully ran local tests Tree-SHA512: dbba09188978b7d295ebe6a58a3d32e65b22f0208f60f6c0f800e1ee15f1b54e8be2992da6fe6deb7c6b3ae848b100b4c6d44cd04d63eefaec8d563e9ba56c5f

…vailable Ports changes from rust-bitcoin/rust-miniscript#872

Port test for GetKey impl for miniscript::descriptor::KeyMap as of the state of latest state of rust-bitcoin/rust-miniscript#872.

…tions for `DescriptorSecretKey` and `KeyMap` fba23e6 test: port `miniscript::descriptor::key_map` tests (Leonardo Lima) d2fcfca fix: strip origin prefix before deriving xkey or use full path if unavailable (Leonardo Lima) 36bcf54 feat: insource miniscript GetKey impl for DescriptorSecretKey and KeyMap (nymius) Pull request description: This was suggested by https://git.rust-bitcoin.org/rust-bitcoin/rust-psbt/pulls/180#issuecomment-11659. It includes the changes from rust-bitcoin/rust-miniscript#872. A working example using `GetKey` from `KeyMap` and `update_psbt_input` from `PlanExt` is in https://git.rust-bitcoin.org/nymius/rust-psbt/compare/push-xstopvrvruzp...push-rmuzzkyxvrru. ACKs for top commit: tobin: ACK fba23e6 Tree-SHA512: aaa49ab45788cfcfc21e89ab78ea1b22f1e82e7b0e5a637e3dbb324a3f31e4d69cb66d490c2ede7035e547f38d43f36302b2c287897f09ae0f4bf0484b44f605

oleonardolima mentioned this pull request Oct 31, 2025

fix(keymap): use correct derivation_path for keys with origin #863

Merged

oleonardolima force-pushed the fix/getkey-xprv-bip32-with-orign branch 3 times, most recently from 9869841 to 64483f3 Compare October 31, 2025 15:51

oleonardolima commented Oct 31, 2025

View reviewed changes

Comment thread src/policy/concrete.rs Outdated

tcharding mentioned this pull request Nov 3, 2025

Remove link to doc file #873

Merged

notmandatory mentioned this pull request Dec 15, 2025

Add an example/Make more obvious how to sign a transaction bitcoindevkit/bdk_wallet#340

Open

11 tasks

ItoroD mentioned this pull request Jan 12, 2026

Add Psbt::sign API to Psbt type bitcoindevkit/bdk-ffi#866

Open

oleonardolima force-pushed the fix/getkey-xprv-bip32-with-orign branch 5 times, most recently from 43d92da to 32867b3 Compare June 16, 2026 17:11

oleonardolima added 2 commits June 16, 2026 17:09

test(key_map): improve Xprv key origin tests

a2f4497

- introduce table-driven cases for `get_key_xpriv_with_key_origin` with named fields - drop redundant key parsing, and build requests from explicit key sources Assisted-by: Claude Opus 4.8

oleonardolima force-pushed the fix/getkey-xprv-bip32-with-orign branch from 9cd3d75 to a2f4497 Compare June 16, 2026 20:09

oleonardolima mentioned this pull request Jun 16, 2026

fix(keymap): backport use of correct derivation_path for keys with origin #867

Merged

3 tasks

oleonardolima changed the title ~~fix(get_key): for Xprv with key origin info~~ fix(key_map): derivation_path for Xprv with key origin info Jun 16, 2026

oleonardolima marked this pull request as ready for review June 16, 2026 20:51

notmandatory approved these changes Jun 16, 2026

View reviewed changes

noahjoeris approved these changes Jun 17, 2026

View reviewed changes

This was referenced Jun 18, 2026

feat(wallet): add Wallet::sign_psbt<K> wrapping bitcoin::Psbt::sign bitcoindevkit/bdk_wallet#438

Closed

Deprecate wallet-owned signing APIs bitcoindevkit/bdk_wallet#505

Draft

apoelstra approved these changes Jun 24, 2026

View reviewed changes

notmandatory mentioned this pull request Jun 24, 2026

Update starter example to use new signing workflow bitcoindevkit/book-of-bdk#155

Merged

evanlinjin mentioned this pull request Jun 27, 2026

fix(signer): match BIP32 origin via matches, not string prefix bitcoindevkit/bdk-tx#81

Open

2 tasks

apoelstra merged commit 6cc4369 into rust-bitcoin:master Jun 27, 2026
14 checks passed

oleonardolima deleted the fix/getkey-xprv-bip32-with-orign branch June 27, 2026 13:30

nyonson pushed a commit to rust-bitcoin/rust-psbt that referenced this pull request Jul 13, 2026

fix: strip origin prefix before deriving xkey or use full path if una…

d2fcfca

…vailable Ports changes from rust-bitcoin/rust-miniscript#872

nyonson pushed a commit to rust-bitcoin/rust-psbt that referenced this pull request Jul 13, 2026

test: port miniscript::descriptor::key_map tests

fba23e6

Port test for GetKey impl for miniscript::descriptor::KeyMap as of the state of latest state of rust-bitcoin/rust-miniscript#872.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(key_map): derivation_path for `Xprv` with key origin info#872

fix(key_map): derivation_path for `Xprv` with key origin info#872
apoelstra merged 2 commits into
rust-bitcoin:masterfrom
oleonardolima:fix/getkey-xprv-bip32-with-orign

oleonardolima commented Oct 31, 2025 •

edited

Loading

Uh oh!

Uh oh!

oleonardolima commented Jun 16, 2026

Uh oh!

notmandatory left a comment

Uh oh!

noahjoeris left a comment

Uh oh!

oleonardolima commented Jun 24, 2026

Uh oh!

apoelstra commented Jun 24, 2026

Uh oh!

apoelstra left a comment

Uh oh!

evanlinjin commented Jun 27, 2026

Uh oh!

noahjoeris commented Jun 27, 2026

Uh oh!

Uh oh!

oleonardolima commented Jun 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

oleonardolima commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes

Changelog notice

Checklists

Bugfixes:

Uh oh!

Uh oh!

oleonardolima commented Jun 16, 2026

Uh oh!

notmandatory left a comment

Choose a reason for hiding this comment

Uh oh!

noahjoeris left a comment

Choose a reason for hiding this comment

Uh oh!

oleonardolima commented Jun 24, 2026

Uh oh!

apoelstra commented Jun 24, 2026

Uh oh!

apoelstra left a comment

Choose a reason for hiding this comment

Uh oh!

evanlinjin commented Jun 27, 2026

Uh oh!

noahjoeris commented Jun 27, 2026

Uh oh!

Uh oh!

oleonardolima commented Jun 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

oleonardolima commented Oct 31, 2025 •

edited

Loading