From 21d977ab3845954d2b033e792fb78e87e5609d3e Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 24 Nov 2022 17:41:21 +0000 Subject: [PATCH] Publish autogenerated nightly docs --- .../nightly/latest/bdk/descriptor/index.html | 2 +- .../template/type.DescriptorTemplateOut.html | 2 +- .../bdk/descriptor/trait.ExtractPolicy.html | 4 +- .../trait.IntoWalletDescriptor.html | 6 +- .../descriptor/type.DerivedDescriptor.html | 2 +- .../descriptor/type.ExtendedDescriptor.html | 4 +- .../bdk/descriptor/type.HdKeyPaths.html | 2 +- .../bdk/descriptor/type.TapKeyOrigins.html | 2 +- .../latest/src/bdk/descriptor/mod.rs.html | 96 +++++++++++++++++-- 9 files changed, 99 insertions(+), 21 deletions(-) diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/index.html index 526a40bee5..3dea62f5b4 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/index.html @@ -6,7 +6,7 @@ logo

Module descriptor

logo
-

Module bdk::descriptor

source · [−]
Expand description

Descriptors

+

Module bdk::descriptor

source · [−]
Expand description

Descriptors

This module contains generic utilities to work with descriptors, plus some re-exported types from [miniscript].

Re-exports

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/type.DescriptorTemplateOut.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/type.DescriptorTemplateOut.html index c0ae492f89..a23105ed6d 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/type.DescriptorTemplateOut.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/template/type.DescriptorTemplateOut.html @@ -7,6 +7,6 @@

DescriptorTemplateOut

Trait Implementations

IntoWalletDescriptor

In bdk::descriptor::template

logo

Type Definition bdk::descriptor::template::DescriptorTemplateOut

source · [−]
pub type DescriptorTemplateOut = (ExtendedDescriptor, KeyMap, ValidNetworks);
Expand description

Type alias for the return type of DescriptorTemplate, descriptor! and others

-

Trait Implementations

Convert to wallet descriptor

+

Trait Implementations

Convert to wallet descriptor

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/trait.ExtractPolicy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/trait.ExtractPolicy.html index c82bc19c3f..9d53692305 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/trait.ExtractPolicy.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/trait.ExtractPolicy.html @@ -6,9 +6,9 @@ logo

ExtractPolicy

Required Methods

extract_policy

Implementors

In bdk::descriptor

logo
-

Trait bdk::descriptor::ExtractPolicy

source · [−]
pub trait ExtractPolicy {
+    
Trait bdk::descriptor::ExtractPolicy
source · [−]
pub trait ExtractPolicy {
     fn extract_policy(
        &self, 
        signers: &SignersContainer, 
        psbt: BuildSatisfaction<'_>, 
        secp: &Secp256k1<All>
    ) -> Result<Option<Policy>, DescriptorError>;
 }
Expand description

Trait implemented on Descriptors to add a method to extract the spending policy

-

Required methods

Extract the spending policy

+

Required methods

Extract the spending policy

Implementors

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/trait.IntoWalletDescriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/trait.IntoWalletDescriptor.html index f6ed879da1..ae70c61ade 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/trait.IntoWalletDescriptor.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/trait.IntoWalletDescriptor.html @@ -6,11 +6,11 @@ logo

IntoWalletDescriptor

Required Methods

into_wallet_descriptor

Implementations on Foreign Types

&String&str(ExtendedDescriptor, KeyMap)

Implementors

In bdk::descriptor

logo
-

Trait bdk::descriptor::IntoWalletDescriptor

source · [−]
pub trait IntoWalletDescriptor {
+    
Trait bdk::descriptor::IntoWalletDescriptor
source · [−]
pub trait IntoWalletDescriptor {
     fn into_wallet_descriptor(
        self, 
        secp: &Secp256k1<All>, 
        network: Network
    ) -> Result<(ExtendedDescriptor, KeyMap), DescriptorError>;
 }
Expand description

Trait for types which can be converted into an ExtendedDescriptor and a KeyMap usable by a wallet in a specific [Network]

-

Required methods

Convert to wallet descriptor

-

Implementations on Foreign Types

Implementors

Turns a DescriptorTemplate into a valid wallet descriptor by calling its +

Required methods

Convert to wallet descriptor

+

Implementations on Foreign Types

Implementors

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.DerivedDescriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.DerivedDescriptor.html index 61921e485b..2d709eaaac 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.DerivedDescriptor.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.DerivedDescriptor.html @@ -6,6 +6,6 @@ logo

DerivedDescriptor

In bdk::descriptor

logo
-

Type Definition bdk::descriptor::DerivedDescriptor

source · [−]
pub type DerivedDescriptor = Descriptor<DefiniteDescriptorKey>;
Expand description

Alias for a Descriptor that contains extended derived keys

+

Type Definition bdk::descriptor::DerivedDescriptor

source · [−]
pub type DerivedDescriptor = Descriptor<DefiniteDescriptorKey>;
Expand description

Alias for a Descriptor that contains extended derived keys

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.ExtendedDescriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.ExtendedDescriptor.html index 849f178faf..5996ad5aca 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.ExtendedDescriptor.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.ExtendedDescriptor.html @@ -6,7 +6,7 @@ logo

ExtendedDescriptor

Trait Implementations

IntoWalletDescriptor

In bdk::descriptor

logo
-

Type Definition bdk::descriptor::ExtendedDescriptor

source · [−]
pub type ExtendedDescriptor = Descriptor<DescriptorPublicKey>;
Expand description

Alias for a Descriptor that can contain extended keys using DescriptorPublicKey

-

Trait Implementations

Convert to wallet descriptor

+

Type Definition bdk::descriptor::ExtendedDescriptor

source · [−]
pub type ExtendedDescriptor = Descriptor<DescriptorPublicKey>;
Expand description

Alias for a Descriptor that can contain extended keys using DescriptorPublicKey

+

Trait Implementations

Convert to wallet descriptor

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.HdKeyPaths.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.HdKeyPaths.html index 630683d8b3..d4205ec9b8 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.HdKeyPaths.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.HdKeyPaths.html @@ -6,7 +6,7 @@ logo

HdKeyPaths

In bdk::descriptor

logo
-

Type Definition bdk::descriptor::HdKeyPaths

source · [−]
pub type HdKeyPaths = BTreeMap<PublicKey, KeySource>;
Expand description

Alias for the type of maps that represent derivation paths in a psbt::Input or +

Type Definition bdk::descriptor::HdKeyPaths

source · [−]
pub type HdKeyPaths = BTreeMap<PublicKey, KeySource>;
Expand description

Alias for the type of maps that represent derivation paths in a psbt::Input or psbt::Output

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.TapKeyOrigins.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.TapKeyOrigins.html index f0359d80ec..6521a88838 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.TapKeyOrigins.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/descriptor/type.TapKeyOrigins.html @@ -6,7 +6,7 @@ logo

TapKeyOrigins

In bdk::descriptor

logo
-

Type Definition bdk::descriptor::TapKeyOrigins

source · [−]
pub type TapKeyOrigins = BTreeMap<XOnlyPublicKey, (Vec<TapLeafHash>, KeySource)>;
Expand description

Alias for the type of maps that represent taproot key origins in a psbt::Input or +

Type Definition bdk::descriptor::TapKeyOrigins

source · [−]
pub type TapKeyOrigins = BTreeMap<XOnlyPublicKey, (Vec<TapLeafHash>, KeySource)>;
Expand description

Alias for the type of maps that represent taproot key origins in a psbt::Input or psbt::Output

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/descriptor/mod.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/descriptor/mod.rs.html index 6ef9fd0c6b..089b7b97b9 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/descriptor/mod.rs.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/descriptor/mod.rs.html @@ -854,6 +854,45 @@ 847 848 849 +850 +851 +852 +853 +854 +855 +856 +857 +858 +859 +860 +861 +862 +863 +864 +865 +866 +867 +868 +869 +870 +871 +872 +873 +874 +875 +876 +877 +878 +879 +880 +881 +882 +883 +884 +885 +886 +887 +888 
// Bitcoin Dev Kit
 // Written in 2020 by Alekos Filini <alekos.filini@gmail.com>
 //
@@ -877,7 +916,9 @@
 use bitcoin::{secp256k1, PublicKey, XOnlyPublicKey};
 use bitcoin::{Network, TxOut};
 
-use miniscript::descriptor::{DefiniteDescriptorKey, DescriptorType, InnerXKey, SinglePubKey};
+use miniscript::descriptor::{
+    DefiniteDescriptorKey, DescriptorSecretKey, DescriptorType, InnerXKey, SinglePubKey,
+};
 pub use miniscript::{
     descriptor::DescriptorXKey, descriptor::KeyMap, descriptor::Wildcard, Descriptor,
     DescriptorPublicKey, Legacy, Miniscript, ScriptContext, Segwitv0,
@@ -1096,14 +1137,34 @@
             );
         }
 
-        if !self.2.contains(&network) {
+        let (desc, keymap, networks) = self;
+
+        if !networks.contains(&network) {
             return Err(DescriptorError::Key(KeyError::InvalidNetwork));
         }
 
-        // fixup the network for keys that need it
-        let translated = self.0.translate_pk(&mut Translator { network })?;
+        // fixup the network for keys that need it in the descriptor
+        let translated = desc.translate_pk(&mut Translator { network })?;
+        // ...and in the key map
+        let fixed_keymap = keymap
+            .into_iter()
+            .map(|(mut k, mut v)| {
+                match (&mut k, &mut v) {
+                    (DescriptorPublicKey::XPub(xpub), DescriptorSecretKey::XPrv(xprv)) => {
+                        xpub.xkey.network = network;
+                        xprv.xkey.network = network;
+                    }
+                    (_, DescriptorSecretKey::Single(key)) => {
+                        key.key.network = network;
+                    }
+                    _ => {}
+                }
 
-        Ok((translated, self.1))
+                (k, v)
+            })
+            .collect();
+
+        Ok((translated, fixed_keymap))
     }
 }
 
@@ -1538,23 +1599,40 @@
 
         let secp = Secp256k1::new();
 
-        let xpub = bip32::ExtendedPubKey::from_str("xpub6ERApfZwUNrhLCkDtcHTcxd75RbzS1ed54G1LkBUHQVHQKqhMkhgbmJbZRkrgZw4koxb5JaHWkY4ALHY2grBGRjaDMzQLcgJvLJuZZvRcEL").unwrap();
+        let xprv = bip32::ExtendedPrivKey::from_str("xprv9s21ZrQH143K3c3gF1DUWpWNr2SG2XrG8oYPpqYh7hoWsJy9NjabErnzriJPpnGHyKz5NgdXmq1KVbqS1r4NXdCoKitWg5e86zqXHa8kxyB").unwrap();
         let path = bip32::DerivationPath::from_str("m/0").unwrap();
 
         // here `to_descriptor_key` will set the valid networks for the key to only mainnet, since
         // we are using an "xpub"
-        let key = (xpub, path).into_descriptor_key().unwrap();
+        let key = (xprv, path.clone()).into_descriptor_key().unwrap();
         // override it with any. this happens in some key conversions, like bip39
         let key = key.override_valid_networks(any_network());
 
         // make a descriptor out of it
         let desc = crate::descriptor!(wpkh(key)).unwrap();
         // this should convert the key that supports "any_network" to the right network (testnet)
-        let (wallet_desc, _) = desc
+        let (wallet_desc, keymap) = desc
             .into_wallet_descriptor(&secp, Network::Testnet)
             .unwrap();
 
-        assert_eq!(wallet_desc.to_string(), "wpkh(tpubDEnoLuPdBep9bzw5LoGYpsxUQYheRQ9gcgrJhJEcdKFB9cWQRyYmkCyRoTqeD4tJYiVVgt6A3rN6rWn9RYhR9sBsGxji29LYWHuKKbdb1ev/0/*)#y8p7e8kk");
+        let mut xprv_testnet = xprv;
+        xprv_testnet.network = Network::Testnet;
+
+        let xpub_testnet = bip32::ExtendedPubKey::from_priv(&secp, &xprv_testnet);
+        let desc_pubkey = DescriptorPublicKey::XPub(DescriptorXKey {
+            xkey: xpub_testnet,
+            origin: None,
+            derivation_path: path,
+            wildcard: Wildcard::Unhardened,
+        });
+
+        assert_eq!(wallet_desc.to_string(), "wpkh(tpubD6NzVbkrYhZ4XtJzoDja5snUjBNQRP5B3f4Hyn1T1x6PVPxzzVjvw6nJx2D8RBCxog9GEVjZoyStfepTz7TtKoBVdkCtnc7VCJh9dD4RAU9/0/*)#a3svx0ha");
+        assert_eq!(
+            keymap
+                .get(&desc_pubkey)
+                .map(|key| key.to_public(&secp).unwrap()),
+            Some(desc_pubkey)
+        );
     }
 
     // test IntoWalletDescriptor trait from &str with and without checksum appended
-- 
2.49.0