wallet: derivehdkey RPC to get xpub at arbitrary path #32784

pull Sjors wants to merge 12 commits into bitcoin:master from Sjors:2025/06/gethdkey changing 19 files +675 −49
  1. Sjors commented at 11:04 AM on June 20, 2025: member

    Given a (blank) wallet with an unused(KEY) descriptor, derivehdkey "m/87h/0h/0h" gets the xpub or xpriv at any given path.

    This is particularly useful for multisig setup where it's not desirable to use our default derivations (e.g. 44h).

    I updated the multisig tutorial and the functional test.

    Based on:

  2. DrahtBot renamed this:
    wallet: derivehdkey RPC to get xpub at arbitrary path
    wallet: derivehdkey RPC to get xpub at arbitrary path
    on Jun 20, 2025
  3. DrahtBot added the label Wallet on Jun 20, 2025
  4. DrahtBot commented at 11:04 AM on June 20, 2025: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    <!--006a51241073e994b41acfe9ec718e94-->

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/32784.

    <!--021abf342d371248e50ceaed478a90ca-->

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    Concept ACK rkrux

    If your review is incorrectly listed, please copy-paste <code>&lt;!--meta-tag:bot-skip--&gt;</code> into the comment that the bot should ignore.

    <!--174a7506f384e20aa4161008e828411d-->

    Conflicts

    Reviewers, this pull request conflicts with the following ones:

    • #bitcoin-core/gui/872 (Menu action to export a watchonly wallet by achow101)
    • #35092 (wallet: stop materializing skipped descriptor addresses after high-index detection by takeshikurosawaa)
    • #35069 (Refactor keypath parser by pythcoiner)
    • #34861 (wallet: Add importdescriptors interface by polespinasa)
    • #33392 (wallet, rpc: add UTXO set check and incremental rescan to importdescriptors by musaHaruna)
    • #32861 (Have createwalletdescriptor auto-detect an unused(KEY) by Sjors)
    • #32489 (wallet: Add exportwatchonlywallet RPC to export a watchonly version of a wallet by achow101)
    • #31668 (Added rescan option for import descriptors by saikiran57)

    If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

    <!--5faf32d7da4f0f540f40219e4f7537a3-->

    LLM Linter (✨ experimental)

    Possible typos and grammar issues:

    • # Get the activate wpkh() receive descriptor -> # Get the active wpkh() receive descriptor [“activate” is the wrong word here; the intended meaning is “active.”]

    Possible places where named args for integral literals may be used (e.g. func(x, /*named_arg=*/0) in C++, and func(x, named_arg=0) in Python):

    • Parse(desc_str, keys, error, false) in src/wallet/rpc/wallet.cpp
    • WalletDescriptor(std::move(descs.at(0)), GetTime(), 0, 0, 0) in src/wallet/rpc/wallet.cpp

    <sup>2026-05-01 11:28:58</sup>

  5. DrahtBot added the label CI failed on Jun 20, 2025
  6. DrahtBot commented at 11:47 AM on June 20, 2025: contributor

    <!--85328a0da195eb286784d51f73fa0af9-->

    🚧 At least one of the CI tasks failed. <sub>Task lint: https://github.com/bitcoin/bitcoin/runs/44475268764</sub> <sub>LLM reason (✨ experimental): The CI failure is caused by errors from the lint check 'py_lint', specifically due to unused imports flagged by ruff.</sub>

    <details><summary>Hints</summary>

    Try to run the tests locally, according to the documentation. However, a CI failure may still happen due to a number of reasons, for example:

    • Possibly due to a silent merge conflict (the changes in this pull request being incompatible with the current code in the target branch). If so, make sure to rebase on the latest commit of the target branch.

    • A sanitizer issue, which can only be found by compiling with the sanitizer and running the affected test.

    • An intermittent issue.

    Leave a comment here, if you need help tracking down a confusing failure.

    </details>

  7. Sjors force-pushed on Jun 20, 2025
  8. Sjors force-pushed on Jun 20, 2025
  9. Sjors force-pushed on Jun 20, 2025
  10. DrahtBot removed the label CI failed on Jun 20, 2025
  11. in src/rpc/util.h:None in 30d5e5ccf7 outdated
     151 | @@ -152,6 +152,14 @@ std::pair<int64_t, int64_t> ParseDescriptorRange(const UniValue& value);
     152 |  /** Evaluate a descriptor given as a string, or as a {"desc":...,"range":...} object, with default range of 1000. */
     153 |  std::vector<CScript> EvalDescriptorStringOrObject(const UniValue& scanobject, FlatSigningProvider& provider, const bool expand_priv = false);
     154 |  
     155 | +//! Get extended key and origin info for a given path
     156 | +//! @params[in] path The BIP 32 path
    


    DrahtBot commented at 9:41 AM on June 25, 2025:
    In util.h: “@params[in] path” → “@param[in] path” [Doxygen tag typo]
  12. Sjors force-pushed on Jun 26, 2025
  13. Sjors force-pushed on Jun 27, 2025
  14. in doc/multisig-tutorial.md:None in 35eec44491 outdated
     137 |  
     138 | -./build/bin/bitcoin-cli  -signet -rpcwallet="multisig_wallet_01" getwalletinfo
     139 | +./build/bin/bitcoin rpc  -signet -rpcwallet="multisig_wallet_01" listdescriptors
     140 |  ```
     141 |  
     142 | +The `<0;1>` notation in `desc` caused the creation of two descriptors. One uses the chain 0 for external addressesd the other the chain 1 for internal ones (change).
    


    DrahtBot commented at 4:37 AM on July 2, 2025:
    addressesd -> addresses [extra “d” makes “addresses” misspelled]
  15. rkrux commented at 11:11 AM on July 18, 2025: contributor

    Very nice, Concept ACK. I will review this PR.

  16. Sjors force-pushed on Aug 1, 2025
  17. Sjors force-pushed on Aug 1, 2025
  18. DrahtBot added the label Needs rebase on Sep 25, 2025
  19. Sjors commented at 10:15 AM on September 26, 2025: member

    (will rebase this later)

  20. Sjors force-pushed on Jan 5, 2026
  21. Sjors commented at 4:05 AM on January 5, 2026: member

    Rebased after #32821 landed and #29136 was rebased. Re-tested by having an LLM follow the tutorial.

  22. DrahtBot removed the label Needs rebase on Jan 5, 2026
  23. Sjors force-pushed on Feb 2, 2026
  24. DrahtBot added the label CI failed on Apr 28, 2026
  25. DrahtBot commented at 12:39 PM on April 28, 2026: contributor

    <!--85328a0da195eb286784d51f73fa0af9-->

    🚧 At least one of the CI tasks failed. <sub>Task test ancestor commits: https://github.com/bitcoin/bitcoin/actions/runs/25052455086/job/73383604351</sub> <sub>LLM reason (✨ experimental): CI failed because the CMake build errored while compiling src/wallet (bitcoin_wallet target), stopping with make/gmake exit code 2.</sub>

    <details><summary>Hints</summary>

    Try to run the tests locally, according to the documentation. However, a CI failure may still happen due to a number of reasons, for example:

    • Possibly due to a silent merge conflict (the changes in this pull request being incompatible with the current code in the target branch). If so, make sure to rebase on the latest commit of the target branch.

    • A sanitizer issue, which can only be found by compiling with the sanitizer and running the affected test.

    • An intermittent issue.

    Leave a comment here, if you need help tracking down a confusing failure.

    </details>

  26. Sjors commented at 3:30 PM on April 28, 2026: member

    I pushed an extra commit 9814b3350df3ec8381a04189d66e5a20d9414ab0 to pre-empt IWYU warnings (at least in https://github.com/Sjors/bitcoin/pull/91, probably here too). That caused CI to pick up the latest master, which fails as expected. I'll push again after #29136 is updated.

  27. descriptor: Add unused(KEY) descriptor
    unused() descriptors do not have scriptPubKeys. Instead, the wallet uses
    them to store keys without having any scripts to watch for.
    80c29bc6f1
  28. test: Simple test for importing unused(KEY) 82bc280de4
  29. wallet: Add addhdkey RPC f3f8bcbd1d
  30. wallet, rpc: Disallow import of unused() if key already exists 35bbee6374
  31. wallet, rpc: Disallow importing unused() to wallets without privkeys 89b9a01b4e
  32. doc: Release note for addhdkey a39cc16b43
  33. Sjors force-pushed on May 1, 2026
  34. rpc: add DeriveExtKey() helper e6d19b0e0d
  35. Have ParseHDKeypath handle h derivation marker 1cc815da41
  36. rpc: ParsePathBIP32 helper a944595d4d
  37. rpc: add derivehdkey 4f60b18f0e
  38. test: use derivehdkey in M-of-N multisig demo
    Use derivehdkey instead of extracting each participant xpub (and
    derivation info) from  the listdescriptors output.
    
    Additionally use the new <0;1> descriptor syntax.
    
    Finally this commits adds a few debug log lines, and expand the
    explanation for why we use m/44h/1h/0h.
    d9698edcd8
  39. doc: use derivehdkey in multisig tutorial
    Use derivehdkey instead of extracting each participant xpub
    from  the listdescriptors output.
    
    Additionally use the new <0;1> descriptor syntax.
    
    Also use bitcoin rpc instead of bitcoin-cli.
    2e6b696372
  40. Sjors force-pushed on May 1, 2026
  41. Sjors commented at 11:28 AM on May 1, 2026: member

    Rebased after #29136 updated and squashed 9814b3350df3ec8381a04189d66e5a20d9414ab0 IWYU fixup into the first commit.

  42. DrahtBot removed the label CI failed on May 1, 2026

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-05-02 18:12 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me