Adding descriptor generator #180
Open
Conversation
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
tvpeter
reviewed
May 6, 2025
AmosOO7
force-pushed
the
adding_descriptor_generator
branch
from
09b4f4a to
ebf6be3
Compare
tvpeter
requested changes
May 12, 2025
tvpeter
requested changes
May 21, 2025
tvpeter
requested changes
Jun 4, 2025
There was a problem hiding this comment.
Thank you for your work on this, @AmosOO7.
If possible, please revert the imports you removed, as this will help in tracking your imports. Also, kindly remove any unnecessary comments and squash your commits into logical groupings. I have also left comments on other specific areas for your review.
Thank you!
AmosOO7
force-pushed
the
adding_descriptor_generator
branch
7 times, most recently
from
6bff257 to
31f256a
Compare
tvpeter
requested changes
Jun 12, 2025
This enhancement introduces a new `descriptor` subcommand to `bdk-cli`, allowing users to generate wallet descriptors from either extended private keys (xprv), or fresh BIP39 mnemonics. It supports standard script types (BIP44, BIP49, BIP84, BIP86) and outputs both public and private descriptors for external and internal branches. The design improves developer and user experience by enabling easier wallet creation and script descriptor introspection. Closes bitcoindevkit#175
AmosOO7
force-pushed
the
adding_descriptor_generator
branch
from
15495c4 to
6c8e714
Compare
- Ensure you can generate different type of descriptor with mnemonic - Changed the Json output format - Added path subcommand for generating descriptors from keys - Set multipath to accept different types for descriptors - Set multipath default value to false and gave it a short of m - Set type default to 84 and gave it a short to t
Pull Request Test Coverage Report for Build 15804707728Details
💛 - Coveralls |
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 introduces a new
descriptorsubcommand to the BDK CLI that enables users to generate Bitcoin wallet descriptors for internal and external paths, supporting common BIP standards (44, 49, 84, 86). It includes support for both single-path and multipath descriptors from extended keys (xprv/xpubortprv/tpub).This resolves issue #175
Features Implemented
descriptorsubcommand to the CLI--multipathfor wildcard derivation paths--path(e.g.,m/84h/1h/0h) for non-multipath descriptors--typedefaults to84and a shortt--networkdefaulttestnet--multipathdefaults tofalseand a shortmUsage Examples
1. Generate a New Key (Mnemonic)
2. Generate Descriptors from an Extended Private Key
3. Generate Descriptors from a Mnemonic (no key provided)
4. Generate Multipath Descriptors from an Extended Public Key or Private Key
5. Generate Descriptors from XPRV with a Custom Derivation Path
cargo fmtandcargo clippybefore committingNew Features:
CHANGELOG.md