Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ keywords = ["bitcoin", "wallet", "descriptor", "psbt"]
readme = "README.md"
license = "MIT OR Apache-2.0"
authors = ["Bitcoin Dev Kit Developers"]
edition = "2021"
edition = "2024"
rust-version = "1.85.0"

[package.metadata.docs.rs]
Expand Down
6 changes: 3 additions & 3 deletions examples/bitcoind_rpc.rs
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
use bdk_bitcoind_rpc::{
bitcoincore_rpc::{Auth, Client, RpcApi},
Emitter, MempoolEvent,
bitcoincore_rpc::{Auth, Client, RpcApi},
};
use bdk_wallet::rusqlite::Connection;
use bdk_wallet::{
bitcoin::{Block, Network},
KeychainKind, Wallet,
bitcoin::{Block, Network},
};
use clap::{self, Parser};
use std::{
path::PathBuf,
sync::{mpsc::sync_channel, Arc},
sync::{Arc, mpsc::sync_channel},
thread::spawn,
time::Instant,
};
Expand Down
2 changes: 1 addition & 1 deletion examples/compiler.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ use core::error::Error;
use std::str::FromStr;

use bitcoin::Network;
use miniscript::policy::Concrete;
use miniscript::Descriptor;
use miniscript::policy::Concrete;

use bdk_wallet::{KeychainKind, Wallet};

Expand Down
4 changes: 2 additions & 2 deletions examples/electrum.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
use bdk_electrum::electrum_client;
use bdk_electrum::BdkElectrumClient;
use bdk_electrum::electrum_client;
use bdk_wallet::Wallet;
use bdk_wallet::bitcoin::Amount;
use bdk_wallet::bitcoin::FeeRate;
use bdk_wallet::bitcoin::Network;
use bdk_wallet::chain::collections::HashSet;
use bdk_wallet::psbt::PsbtUtils;
use bdk_wallet::rusqlite::Connection;
use bdk_wallet::Wallet;
use bdk_wallet::{KeychainKind, SignOptions};
use std::io::Write;
use std::thread::sleep;
Expand Down
6 changes: 3 additions & 3 deletions examples/esplora_async.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
use bdk_esplora::{esplora_client, EsploraAsyncExt};
use bdk_esplora::{EsploraAsyncExt, esplora_client};
use bdk_wallet::{
KeychainKind, SignOptions, Wallet,
bitcoin::{Amount, FeeRate, Network},
psbt::PsbtUtils,
rusqlite::Connection,
KeychainKind, SignOptions, Wallet,
};
use std::{collections::BTreeSet, io::Write};
use tokio::time::{sleep, Duration};
use tokio::time::{Duration, sleep};

const SEND_AMOUNT: Amount = Amount::from_sat(5000);
const STOP_GAP: usize = 5;
Expand Down
4 changes: 2 additions & 2 deletions examples/esplora_blocking.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
use bdk_esplora::{esplora_client, EsploraExt};
use bdk_esplora::{EsploraExt, esplora_client};
use bdk_wallet::rusqlite::Connection;
use bdk_wallet::{
KeychainKind, SignOptions, Wallet,
bitcoin::{Amount, FeeRate, Network},
psbt::PsbtUtils,
KeychainKind, SignOptions, Wallet,
};
use std::thread::sleep;
use std::time::Duration;
Expand Down
2 changes: 1 addition & 1 deletion examples/mnemonic_to_descriptors.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
// licenses.

use anyhow::anyhow;
use bdk_wallet::bitcoin::NetworkKind;
use bdk_wallet::bitcoin::bip32::DerivationPath;
use bdk_wallet::bitcoin::secp256k1::Secp256k1;
use bdk_wallet::bitcoin::NetworkKind;
use bdk_wallet::descriptor;
use bdk_wallet::descriptor::IntoWalletDescriptor;
use bdk_wallet::keys::bip39::{Language, Mnemonic, WordCount};
Expand Down
2 changes: 1 addition & 1 deletion examples/policy.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ extern crate bdk_wallet;

use core::error::Error;

use bdk_wallet::descriptor::{policy::BuildSatisfaction, ExtractPolicy, IntoWalletDescriptor};
use bdk_wallet::descriptor::{ExtractPolicy, IntoWalletDescriptor, policy::BuildSatisfaction};
use bdk_wallet::signer::SignersContainer;
use bitcoin::NetworkKind;

Expand Down
4 changes: 3 additions & 1 deletion src/descriptor/checksum.rs
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ mod test {
#[test]
fn test_calc_checksum_invalid_character() {
let sparkle_heart = unsafe { core::str::from_utf8_unchecked(&[240, 159, 146, 150]) };
let invalid_desc = format!("wpkh(tprv8ZgxMBicQKsPdpkqS7Eair4YxjcuuvDPNYmKX3sCniCf16tHEVrjjiSXEkFRnUH77yXc6ZcwHHcL{sparkle_heart}fjdi5qUvw3VDfgYiH5mNsj5izuiu2N/1/2/*)");
let invalid_desc = format!(
"wpkh(tprv8ZgxMBicQKsPdpkqS7Eair4YxjcuuvDPNYmKX3sCniCf16tHEVrjjiSXEkFRnUH77yXc6ZcwHHcL{sparkle_heart}fjdi5qUvw3VDfgYiH5mNsj5izuiu2N/1/2/*)"
);

assert_matches!(
calc_checksum(&invalid_desc),
Expand Down
75 changes: 42 additions & 33 deletions src/descriptor/dsl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ macro_rules! impl_top_level_pk {
#[macro_export]
macro_rules! impl_top_level_tr {
( $internal_key:expr, $tap_tree:expr ) => {{
use $crate::miniscript::Tap;
use $crate::miniscript::descriptor::{
Descriptor, DescriptorPublicKey, KeyMap, TapTree, Tr,
};
use $crate::miniscript::Tap;

#[allow(unused_imports)]
use $crate::keys::{DescriptorKey, IntoDescriptorKey, ValidNetworkKinds};
Expand Down Expand Up @@ -361,27 +361,13 @@ macro_rules! apply_modifier {
})
}};

( a: $inner:expr ) => {{
$crate::apply_modifier!(Alt, $inner)
}};
( s: $inner:expr ) => {{
$crate::apply_modifier!(Swap, $inner)
}};
( c: $inner:expr ) => {{
$crate::apply_modifier!(Check, $inner)
}};
( d: $inner:expr ) => {{
$crate::apply_modifier!(DupIf, $inner)
}};
( v: $inner:expr ) => {{
$crate::apply_modifier!(Verify, $inner)
}};
( j: $inner:expr ) => {{
$crate::apply_modifier!(NonZero, $inner)
}};
( n: $inner:expr ) => {{
$crate::apply_modifier!(ZeroNotEqual, $inner)
}};
( a: $inner:expr ) => {{ $crate::apply_modifier!(Alt, $inner) }};
( s: $inner:expr ) => {{ $crate::apply_modifier!(Swap, $inner) }};
( c: $inner:expr ) => {{ $crate::apply_modifier!(Check, $inner) }};
( d: $inner:expr ) => {{ $crate::apply_modifier!(DupIf, $inner) }};
( v: $inner:expr ) => {{ $crate::apply_modifier!(Verify, $inner) }};
( j: $inner:expr ) => {{ $crate::apply_modifier!(NonZero, $inner) }};
( n: $inner:expr ) => {{ $crate::apply_modifier!(ZeroNotEqual, $inner) }};

// Modifiers expanded to other operators
( t: $inner:expr ) => {{
Expand Down Expand Up @@ -833,10 +819,10 @@ mod test {
use alloc::string::ToString;
use core::str::FromStr;

use bitcoin::{bip32, secp256k1::Secp256k1, Network, NetworkKind, PrivateKey};
use bitcoin::{Network, NetworkKind, PrivateKey, bip32, secp256k1::Secp256k1};
use miniscript::{
descriptor::{DescriptorPublicKey, KeyMap},
Descriptor, Legacy, Segwitv0,
descriptor::{DescriptorPublicKey, KeyMap},
};

use crate::descriptor::{DescriptorError, DescriptorMeta};
Expand Down Expand Up @@ -888,10 +874,12 @@ mod test {
.unwrap();

check(
descriptor!(bare(multi(1,pubkey1,pubkey2))),
descriptor!(bare(multi(1, pubkey1, pubkey2))),
false,
true,
&["512103a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd21032e58afe51f9ed8ad3cc7897f634d881fdbe49a81564629ded8156bebd2ffd1af52ae"],
&[
"512103a34b99f22c790c4e36b2b3c2c35a36db06226e41c692fc82b8b56ac1c540c5bd21032e58afe51f9ed8ad3cc7897f634d881fdbe49a81564629ded8156bebd2ffd1af52ae",
],
);
check(
descriptor!(pk(pubkey1)),
Expand Down Expand Up @@ -1182,9 +1170,18 @@ mod test {
let (key1, _key_map, _valid_network_kinds) = desc_key1.extract(&secp).unwrap();
let (key2, _key_map, _valid_network_kinds) = desc_key2.extract(&secp).unwrap();
let (key3, _key_map, _valid_network_kinds) = desc_key3.extract(&secp).unwrap();
assert_eq!(key_map.get(&key1).unwrap().to_string(), "tprv8ZgxMBicQKsPcx5nBGsR63Pe8KnRUqmbJNENAfGftF3yuXoMMoVJJcYeUw5eVkm9WBPjWYt6HMWYJNesB5HaNVBaFc1M6dRjWSYnmewUMYy/0/*");
assert_eq!(key_map.get(&key2).unwrap().to_string(), "tprv8ZgxMBicQKsPegBHHnq7YEgM815dG24M2Jk5RVqipgDxF1HJ1tsnT815X5Fd5FRfMVUs8NZs9XCb6y9an8hRPThnhfwfXJ36intaekySHGF/2147483647'/0/*");
assert_eq!(key_map.get(&key3).unwrap().to_string(), "tprv8ZgxMBicQKsPdZXrcHNLf5JAJWFAoJ2TrstMRdSKtEggz6PddbuSkvHKM9oKJyFgZV1B7rw8oChspxyYbtmEXYyg1AjfWbL3ho3XHDpHRZf/10/20/30/40/*");
assert_eq!(
key_map.get(&key1).unwrap().to_string(),
"tprv8ZgxMBicQKsPcx5nBGsR63Pe8KnRUqmbJNENAfGftF3yuXoMMoVJJcYeUw5eVkm9WBPjWYt6HMWYJNesB5HaNVBaFc1M6dRjWSYnmewUMYy/0/*"
);
assert_eq!(
key_map.get(&key2).unwrap().to_string(),
"tprv8ZgxMBicQKsPegBHHnq7YEgM815dG24M2Jk5RVqipgDxF1HJ1tsnT815X5Fd5FRfMVUs8NZs9XCb6y9an8hRPThnhfwfXJ36intaekySHGF/2147483647'/0/*"
);
assert_eq!(
key_map.get(&key3).unwrap().to_string(),
"tprv8ZgxMBicQKsPdZXrcHNLf5JAJWFAoJ2TrstMRdSKtEggz6PddbuSkvHKM9oKJyFgZV1B7rw8oChspxyYbtmEXYyg1AjfWbL3ho3XHDpHRZf/10/20/30/40/*"
);
}

// Verify that the `ScriptContext` is correctly validated (i.e. passing a type that only
Expand All @@ -1197,7 +1194,10 @@ mod test {
let desc_key: DescriptorKey<Legacy> = (xprv, path).into_descriptor_key().unwrap();

let (desc, _key_map, _valid_network_kinds) = descriptor!(pkh(desc_key)).unwrap();
assert_eq!(desc.to_string(), "pkh(tpubD6NzVbkrYhZ4WR7a4vY1VT3khMJMeAxVsfq9TBJyJWrNk247zCJtV7AWf6UJP7rAVsn8NNKdJi3gFyKPTmWZS9iukb91xbn2HbFSMQm2igY/0/*)#yrnz9pp2");
assert_eq!(
desc.to_string(),
"pkh(tpubD6NzVbkrYhZ4WR7a4vY1VT3khMJMeAxVsfq9TBJyJWrNk247zCJtV7AWf6UJP7rAVsn8NNKdJi3gFyKPTmWZS9iukb91xbn2HbFSMQm2igY/0/*)#yrnz9pp2"
);
}

#[test]
Expand All @@ -1207,7 +1207,10 @@ mod test {
let (descriptor, _, _) =
descriptor!(wsh(thresh(2,n:d:v:older(1),s:pk(private_key),s:pk(private_key)))).unwrap();

assert_eq!(descriptor.to_string(), "wsh(thresh(2,ndv:older(1),s:pk(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c),s:pk(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c)))#zzk3ux8g")
assert_eq!(
descriptor.to_string(),
"wsh(thresh(2,ndv:older(1),s:pk(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c),s:pk(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c)))#zzk3ux8g"
)
}

#[test]
Expand Down Expand Up @@ -1239,7 +1242,10 @@ mod test {
let (descriptor, _, _) =
descriptor!(tr(private_key, { pk(private_key), pk(private_key) })).unwrap();

assert_eq!(descriptor.to_string(), "tr(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c,{pk(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c),pk(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c)})#xy5fjw6d")
assert_eq!(
descriptor.to_string(),
"tr(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c,{pk(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c),pk(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c)})#xy5fjw6d"
)
}

#[test]
Expand All @@ -1248,6 +1254,9 @@ mod test {
PrivateKey::from_wif("cSQPHDBwXGjVzWRqAHm6zfvQhaTuj1f2bFH58h55ghbjtFwvmeXR").unwrap();
let (descriptor, _, _) = descriptor!(tr(private_key, pk(private_key))).unwrap();

assert_eq!(descriptor.to_string(), "tr(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c,pk(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c))#lzl2vmc7")
assert_eq!(
descriptor.to_string(),
"tr(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c,pk(02e96fe52ef0e22d2f131dd425ce1893073a3c6ad20e8cac36726393dfb4856a4c))#lzl2vmc7"
)
}
}
51 changes: 33 additions & 18 deletions src/descriptor/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,10 @@ use alloc::string::String;
use alloc::vec::Vec;

use bitcoin::{
NetworkKind, PublicKey, TxOut,
bip32::{ChildNumber, DerivationPath, Fingerprint, KeySource, Xpub},
key::XOnlyPublicKey,
psbt, secp256k1, taproot, NetworkKind, PublicKey, TxOut,
psbt, secp256k1, taproot,
};
use miniscript::descriptor::{
DefiniteDescriptorKey, DescriptorMultiXKey, DescriptorSecretKey, DescriptorType,
Expand Down Expand Up @@ -237,7 +238,7 @@ impl IntoWalletDescriptor for DescriptorTemplateOut {
// reset the `network_kind` to make sure the wallet struct gets a
// descriptor with the right `network_kind` everywhere.
let pk = match pk {
DescriptorPublicKey::XPub(ref xpub) => {
DescriptorPublicKey::XPub(xpub) => {
let mut xpub = xpub.clone();
xpub.xkey.network = self.network_kind;

Expand Down Expand Up @@ -618,8 +619,8 @@ mod test {
use assert_matches::assert_matches;
use bitcoin::hex::FromHex;
use bitcoin::secp256k1::Secp256k1;
use bitcoin::{bip32, Psbt};
use bitcoin::{NetworkKind, ScriptBuf};
use bitcoin::{Psbt, bip32};

use super::*;
use crate::psbt::PsbtUtils;
Expand All @@ -642,9 +643,11 @@ mod test {
)
.unwrap();

assert!(descriptor
.derive_from_psbt_input(&psbt.inputs[0], psbt.get_utxo_for(0), &Secp256k1::new())
.is_some());
assert!(
descriptor
.derive_from_psbt_input(&psbt.inputs[0], psbt.get_utxo_for(0), &Secp256k1::new())
.is_some()
);
}

#[test]
Expand Down Expand Up @@ -673,9 +676,11 @@ mod test {
)
.unwrap();

assert!(descriptor
.derive_from_psbt_input(&psbt.inputs[0], psbt.get_utxo_for(0), &Secp256k1::new())
.is_some());
assert!(
descriptor
.derive_from_psbt_input(&psbt.inputs[0], psbt.get_utxo_for(0), &Secp256k1::new())
.is_some()
);
}

#[test]
Expand All @@ -697,9 +702,11 @@ mod test {
)
.unwrap();

assert!(descriptor
.derive_from_psbt_input(&psbt.inputs[0], psbt.get_utxo_for(0), &Secp256k1::new())
.is_some());
assert!(
descriptor
.derive_from_psbt_input(&psbt.inputs[0], psbt.get_utxo_for(0), &Secp256k1::new())
.is_some()
);
}

#[test]
Expand Down Expand Up @@ -727,14 +734,16 @@ mod test {
)
.unwrap();

assert!(descriptor
.derive_from_psbt_input(&psbt.inputs[0], psbt.get_utxo_for(0), &Secp256k1::new())
.is_some());
assert!(
descriptor
.derive_from_psbt_input(&psbt.inputs[0], psbt.get_utxo_for(0), &Secp256k1::new())
.is_some()
);
}

#[test]
fn test_to_wallet_descriptor_fixup_network_kinds() {
use crate::keys::{any_network_kind, IntoDescriptorKey};
use crate::keys::{IntoDescriptorKey, any_network_kind};

let secp = Secp256k1::new();

Expand Down Expand Up @@ -766,7 +775,10 @@ mod test {
wildcard: Wildcard::Unhardened,
});

assert_eq!(wallet_desc.to_string(), "wpkh(tpubD6NzVbkrYhZ4XtJzoDja5snUjBNQRP5B3f4Hyn1T1x6PVPxzzVjvw6nJx2D8RBCxog9GEVjZoyStfepTz7TtKoBVdkCtnc7VCJh9dD4RAU9/0/*)#a3svx0ha");
assert_eq!(
wallet_desc.to_string(),
"wpkh(tpubD6NzVbkrYhZ4XtJzoDja5snUjBNQRP5B3f4Hyn1T1x6PVPxzzVjvw6nJx2D8RBCxog9GEVjZoyStfepTz7TtKoBVdkCtnc7VCJh9dD4RAU9/0/*)#a3svx0ha"
);
assert_eq!(
keymap
.get(&desc_pubkey)
Expand Down Expand Up @@ -870,7 +882,10 @@ mod test {
.into_wallet_descriptor(&secp, NetworkKind::Test)
.unwrap();
let wallet_desc_str = wallet_desc.to_string();
assert_eq!(wallet_desc_str, "wpkh(tpubD6NzVbkrYhZ4XHndKkuB8FifXm8r5FQHwrN6oZuWCz13qb93rtgKvD4PQsqC4HP4yhV3tA2fqr2RbY5mNXfM7RxXUoeABoDtsFUq2zJq6YK/1/2/*)#67ju93jw");
assert_eq!(
wallet_desc_str,
"wpkh(tpubD6NzVbkrYhZ4XHndKkuB8FifXm8r5FQHwrN6oZuWCz13qb93rtgKvD4PQsqC4HP4yhV3tA2fqr2RbY5mNXfM7RxXUoeABoDtsFUq2zJq6YK/1/2/*)#67ju93jw"
);

let (wallet_desc2, _) = wallet_desc_str
.into_wallet_descriptor(&secp, NetworkKind::Test)
Expand Down
Loading