Fix API docs for LoadParams::two_path_descriptor method#506
Open
thunderbiscuit wants to merge 1 commit into
Open
Fix API docs for LoadParams::two_path_descriptor method#506thunderbiscuit wants to merge 1 commit into
LoadParams::two_path_descriptor method#506thunderbiscuit wants to merge 1 commit into
Conversation
thunderbiscuit
requested review from
ValuedMammal and
oleonardolima
as code owners
thunderbiscuit
changed the title
LoadParams::two_path_descriptor method
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #506 +/- ##
=======================================
Coverage 80.96% 80.96%
=======================================
Files 24 24
Lines 5489 5489
Branches 247 247
=======================================
Hits 4444 4444
Misses 968 968
Partials 77 77
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This was referenced Jun 24, 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
1 participant
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.
This is a follow up PR to #418 and the sister PR to #306.
Read #306 for more information on this, but the gist is that miniscript cannot parse multipath descriptors that use extended private keys. Our constructors to create/load from two_path_descriptors() fail if users provide private keys there.
This PR adds a test for this failure case, and adjusts the API docs to warn users of this constraint.
cc @yukibtc
Changelog notice
None.
Before submitting