create taproot descriptor template by vladimirfomene · Pull Request #840 · bitcoindevkit/bdk

vladimirfomene · 2023-01-23T14:16:08Z

Description

This PR solves bitcoindevkit/bdk_wallet#169. This PR adds a P2TR
descriptor template and a BIP86 taproot
descriptor template. With this, users
can now create a taproot descriptor with templates.

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

New Features:

I've added tests for the new feature
I've added docs for the new feature

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

w0xlt

Concept ACK

rajarshimaitra

Review ACK 242f5bd

Everything looks good to me. Just one observation.

rajarshimaitra · 2023-01-30T18:27:50Z

            Bip49(prvkey, KeychainKind::External).build(Network::Bitcoin),
            true,
            false,
+            false,
+            Network::Regtest,


I was a bit confused with this at first. Why a Mainnet descriptor matches with a Regtest address? That's because the first network is used for setting the 2nd derivation index of Bipxx, and the second network is used for the address prefix.

As a result, if someone actually tries with the same Xpriv but builds with build(Network::Regtest) and derives the addresses, they will not match up with the test vector.

So does it make sense to change the first network into regtest in the build call, or change the second network to mainnet? The first option is a much smaller changeset and can be done in a separate PR.

@rajarshimaitra , you are right this is a bit confusing. I will opt for your first option. I will option a small PR for it before end of the week. I will open an issue that helps me keep track of it.

notmandatory · 2023-01-30T19:23:11Z

@vladimirfomene please rebase to pickup the new MSRV change from #842.

notmandatory · 2023-02-14T13:20:59Z

Would be good to get this one in before merging bdk_core work.

vladimirfomene · 2023-02-14T17:59:43Z

I will work on this tonight, I will be ready tomorrow

notmandatory · 2023-03-03T16:37:52Z

Thanks for all your work on this but we've gotten to the point where I'd like to hold off on merging any new features and only merge critical bug fixes to the release/0.27 branch.

Can you rebase this after the new bdk_core_staging stuff in #793 is merged to master branch? then we can merge it in for one of the upcoming 1.0.0-alpha releases.

danielabrozzoni · 2023-03-16T17:28:23Z

Hey, can you please rebase this one on master?

notmandatory · 2023-05-24T00:07:05Z

I see we didn't get merged in before the big bdk 1.0 switch. It It looks like it's ready to go, can you rebase this or update it for the new master branch?

I was looking for this because @reez and I want to use a TR template for the iOS example app we're doing.

notmandatory · 2023-05-24T00:10:02Z

After this is merged to master I'll get it back-ported to a maintenance release.

This PR solves #836. This PR adds a P2TR descriptor template and a BIP86 taproot descriptor template. With this, users can now create a taproot descriptor with templates.

vladimirfomene · 2023-05-25T10:45:01Z

@notmandatory , this is good to go. I have created an issue bitcoindevkit/bdk_wallet#149 for fixing the issue raised by @rajarshimaitra

notmandatory

ACK e30919b

7587f16 feat(descriptor): backport from master branch new taproot descriptor template (BIP86) (Steve Myers) 177c96d Create taproot descriptor template (Vladimir Fomene) Pull request description: ### Description This PR solves #836 for the release/0.28 branch. This PR adds a P2TR descriptor template and a BIP86 taproot descriptor template. With this, users can now create a taproot descriptor with templates. ### Notes to the reviewers The commit from #840 is cherry-picked from the `master` branch to the `release/0.28` branch without any changes. ### Changelog notice Add taproot descriptor template (BIP-86). ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) * [x] I ran `cargo fmt` and `cargo clippy` before committing #### New Features: * [x] I've added tests for the new feature * [x] I've added docs for the new feature ACKs for top commit: danielabrozzoni: utACK 7587f16 Tree-SHA512: e5b07473e27bba8ca5ec58854fa318c5a82cb67ce751d352ef17e9926dd08f8e6b7a720a77170b6f6f018c58ed9f8741cee396dc8e8721f4022c33ef2904815f

Summary This patch release backports (from the BDK 1.0 dev branch) a fix for a bug in the policy condition calculation and adds a new taproot single key descriptor template (BIP-86). The policy condition calculation bug can cause issues when a policy subtree fails due to missing info even if it's not selected when creating a new transaction, errors on unused policy paths are now ignored. Fixed - Backported bitcoindevkit#932 fix for policy condition calculation bitcoindevkit#1008 Added - Backported bitcoindevkit#840 taproot descriptor template (BIP-86) bitcoindevkit#1033

w0xlt reviewed Jan 24, 2023

View reviewed changes

notmandatory mentioned this pull request Jan 28, 2023

W5 BDK Lib Team Call bitcoindevkit/.github#42

Closed

23 tasks

rajarshimaitra approved these changes Jan 30, 2023

View reviewed changes

notmandatory added the new feature New feature or request label Jan 30, 2023

notmandatory assigned vladimirfomene Jan 30, 2023

notmandatory added this to the Release 0.28.0 Feature Freeze milestone Jan 30, 2023

notmandatory reviewed Jan 30, 2023

View reviewed changes

Comment thread src/descriptor/template.rs Outdated

notmandatory mentioned this pull request Feb 14, 2023

W7 BDK Lib Team Call bitcoindevkit/.github#43

Closed

24 tasks

vladimirfomene force-pushed the add-bip-86-template branch 2 times, most recently from fb8d20d to 6470776 Compare February 15, 2023 08:02

notmandatory removed this from the Release 0.27.2 Feature Freeze milestone Mar 3, 2023

vladimirfomene force-pushed the add-bip-86-template branch from 6470776 to 50ac75e Compare May 25, 2023 08:14

vladimirfomene mentioned this pull request Apr 7, 2025

Asymmetry between network used by descriptor template build method and tests check method bitcoindevkit/bdk_wallet#149

Open

Create taproot descriptor template

e30919b

This PR solves #836. This PR adds a P2TR descriptor template and a BIP86 taproot descriptor template. With this, users can now create a taproot descriptor with templates.

vladimirfomene force-pushed the add-bip-86-template branch from 50ac75e to e30919b Compare May 25, 2023 10:43

notmandatory approved these changes May 26, 2023

View reviewed changes

notmandatory added this to the 1.0.0-alpha.1 milestone May 26, 2023

notmandatory merged commit b184e35 into bitcoindevkit:master Jun 19, 2023

thunderbiscuit mentioned this pull request Jun 22, 2023

Wrappers, helpers, and syntactic sugar on BDK bitcoindevkit/bdk-ffi#266

Closed

This was referenced Jul 4, 2023

Release 1.0.0-alpha.1 #1025

Closed

Socratic Seminar #9 Topics NashBitDevs/nashbitdevs.org#10

Closed

notmandatory mentioned this pull request Jul 19, 2023

Backport new taproot descriptor template (BIP86) #1033

Merged

5 tasks

notmandatory mentioned this pull request Aug 3, 2023

Release 0.28.1 #1056

Closed

12 tasks

notmandatory mentioned this pull request Aug 3, 2023

release: bump version to 0.28.1 #1057

Merged

notmandatory mentioned this pull request Mar 27, 2025

Add descriptor::template for "Key Derivation for Single Key P2TR Outputs" #463

Closed

Conversation

vladimirfomene commented Jan 23, 2023

Description

Checklists

All Submissions:

New Features:

Bugfixes:

Uh oh!

w0xlt left a comment

Choose a reason for hiding this comment

Uh oh!

rajarshimaitra left a comment

Choose a reason for hiding this comment

Uh oh!

rajarshimaitra Jan 30, 2023

Choose a reason for hiding this comment

Uh oh!

vladimirfomene Feb 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

notmandatory commented Jan 30, 2023

Uh oh!

Uh oh!

notmandatory commented Feb 14, 2023

Uh oh!

vladimirfomene commented Feb 14, 2023

Uh oh!

notmandatory commented Mar 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danielabrozzoni commented Mar 16, 2023

Uh oh!

notmandatory commented May 24, 2023

Uh oh!

notmandatory commented May 24, 2023

Uh oh!

vladimirfomene commented May 25, 2023

Uh oh!

notmandatory left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vladimirfomene Feb 14, 2023 •

edited

Loading

notmandatory commented Mar 3, 2023 •

edited

Loading