Module bdk_wallet::wallet::export

source Â·

Expand description

Wallet export

+bdk_wallet::wallet::export - Rust

Module bdk_wallet::wallet::export

source Â·

Expand description

Wallet export

This modules implements the wallet export format used by FullyNoded.

Â§Examples

Â§Import from JSON

let import = r#"{
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/export/struct.FullyNodedExport.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/export/struct.FullyNodedExport.html
index b465e9e296..cc2e478d3d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/export/struct.FullyNodedExport.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/export/struct.FullyNodedExport.html
@@ -6,7 +6,7 @@
 For a usage example see this moduleâs documentation.

`FieldsÂ§`

Â§blockheight: u32Earliest block to rescan when looking for the walletâs transactions
 
Â§label: StringArbitrary label for the wallet
-
ImplementationsÂ§
sourceÂ§impl FullyNodedExport
sourcepub fn export_wallet(
+
ImplementationsÂ§
sourceÂ§impl FullyNodedExport
sourcepub fn export_wallet(
     wallet: &Wallet,
     label: &str,
     include_blockheight: bool
@@ -18,8 +18,8 @@ and others.
 for the oldest transaction it knows and use that as the earliest block to rescan.
 If the database is empty or include_blockheight is false, the blockheight field
 returned will be 0.
-
sourcepub fn descriptor(&self) -> String
Return the external descriptor
-
sourcepub fn change_descriptor(&self) -> Option<String>
Return the internal descriptor, if present
+
sourcepub fn descriptor(&self) -> String
Return the external descriptor
+
sourcepub fn change_descriptor(&self) -> Option<String>
Return the internal descriptor, if present
 
Trait ImplementationsÂ§
sourceÂ§impl Debug for FullyNodedExport
sourceÂ§fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
sourceÂ§impl<'de> Deserialize<'de> for FullyNodedExport
sourceÂ§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
     __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceÂ§impl Display for FullyNodedExport
sourceÂ§fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
sourceÂ§impl FromStr for FullyNodedExport
Â§type Err = Error
The associated error which can be returned from parsing.
sourceÂ§fn from_str(s: &str) -> Result<Self, Self::Err>
Parses a string s to return a value of this type. Read more
sourceÂ§impl Serialize for FullyNodedExport
sourceÂ§fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
     __S: Serializer,
Serialize this value into the given Serde serializer. Read more
Auto Trait ImplementationsÂ§
Â§impl Freeze for FullyNodedExport
Â§impl RefUnwindSafe for FullyNodedExport
Â§impl Send for FullyNodedExport
Â§impl Sync for FullyNodedExport
Â§impl Unpin for FullyNodedExport
Â§impl UnwindSafe for FullyNodedExport
Blanket ImplementationsÂ§
sourceÂ§impl<T> Any for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html
index ed83b068d6..6c06b832c0 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/help.html
@@ -1 +1 @@
-Help
Rustdoc1.80.0-nightly
(78a775127 2024-05-11)
Help
Rustdoc help
Back

\ No newline at end of file
+Help
Rustdoc1.80.0-nightly
(78a775127 2024-05-11)
Help
Rustdoc help
Back

\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html
index 3878c99472..9c45266049 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/settings.html
@@ -1 +1 @@
-Settings
Rustdoc1.80.0-nightly
(78a775127 2024-05-11)
Settings
Rustdoc settings
Back

\ No newline at end of file
+Settings
Rustdoc1.80.0-nightly
(78a775127 2024-05-11)
Settings
Rustdoc settings
Back

\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/export.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/export.rs.html
index f6996aed7b..5d5a615387 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/export.rs.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk_wallet/wallet/export.rs.html
@@ -339,6 +339,19 @@
 339
 340
 341
+342
+343
+344
+345
+346
+347
+348
+349
+350
+351
+352
+353
+354
 
// Bitcoin Dev Kit
 // Written in 2020 by Alekos Filini <alekos.filini@gmail.com>
 //
@@ -530,6 +543,7 @@
                 WshInner::SortedMulti(_) => Ok(()),
                 WshInner::Ms(ms) => check_ms(&ms.node),
             },
+            Descriptor::Tr(_) => Ok(()),
             _ => Err("The descriptor is not compatible with Bitcoin Core"),
         }
     }
@@ -655,6 +669,18 @@
         assert_eq!(export.label, "Test Label");
     }
 
+    #[test]
+    fn test_export_tr() {
+        let descriptor = "tr([73c5da0a/86'/0'/0']tprv8fMn4hSKPRC1oaCPqxDb1JWtgkpeiQvZhsr8W2xuy3GEMkzoArcAWTfJxYb6Wj8XNNDWEjfYKK4wGQXh3ZUXhDF2NcnsALpWTeSwarJt7Vc/0/*)";
+        let change_descriptor = "tr([73c5da0a/86'/0'/0']tprv8fMn4hSKPRC1oaCPqxDb1JWtgkpeiQvZhsr8W2xuy3GEMkzoArcAWTfJxYb6Wj8XNNDWEjfYKK4wGQXh3ZUXhDF2NcnsALpWTeSwarJt7Vc/1/*)";
+        let wallet = get_test_wallet(descriptor, Some(change_descriptor), Network::Testnet);
+        let export = FullyNodedExport::export_wallet(&wallet, "Test Label", true).unwrap();
+        assert_eq!(export.descriptor(), descriptor);
+        assert_eq!(export.change_descriptor(), Some(change_descriptor.into()));
+        assert_eq!(export.blockheight, 5000);
+        assert_eq!(export.label, "Test Label");
+    }
+
     #[test]
     fn test_export_to_json() {
         let descriptor = "wpkh(xprv9s21ZrQH143K4CTb63EaMxja1YiTnSEWKMbn23uoEnAzxjdUJRQkazCAtzxGm4LSoTSVTptoV9RbchnKPW9HxKtZumdyxyikZFDLhogJ5Uj/44'/0'/0'/0/*)";
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_wallet/wallet/export/struct.FullyNodedExport.js b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_wallet/wallet/export/struct.FullyNodedExport.js
index e0a2afe26c..0e1976f865 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_wallet/wallet/export/struct.FullyNodedExport.js
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/type.impl/bdk_wallet/wallet/export/struct.FullyNodedExport.js
@@ -1,3 +1,3 @@
 (function() {var type_impls = {
-"bdk_wallet":[["sourceÂ§impl Debug for FullyNodedExport
sourceÂ§fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
","Debug","bdk_wallet::wallet::export::WalletExport"],["sourceÂ§impl<'de> Deserialize<'de> for FullyNodedExport
sourceÂ§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where\n    __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
","Deserialize<'de>","bdk_wallet::wallet::export::WalletExport"],["sourceÂ§impl Display for FullyNodedExport
sourceÂ§fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
","Display","bdk_wallet::wallet::export::WalletExport"],["sourceÂ§impl FromStr for FullyNodedExport
Â§type Err = Error
The associated error which can be returned from parsing.
sourceÂ§fn from_str(s: &str) -> Result<Self, Self::Err>
Parses a string s to return a value of this type. Read more
","FromStr","bdk_wallet::wallet::export::WalletExport"],["sourceÂ§impl FullyNodedExport
sourcepub fn export_wallet(\n    wallet: &Wallet,\n    label: &str,\n    include_blockheight: bool\n) -> Result<Self, &'static str>
Export a wallet
\nThis function returns an error if it determines that the walletâs descriptor(s) are not\nsupported by Bitcoin Core or donât follow the standard derivation paths defined by BIP44\nand others.
\nIf include_blockheight is true, this function will look into the walletâs database\nfor the oldest transaction it knows and use that as the earliest block to rescan.
\nIf the database is empty or include_blockheight is false, the blockheight field\nreturned will be 0.
\n
sourcepub fn descriptor(&self) -> String
Return the external descriptor
\n
sourcepub fn change_descriptor(&self) -> Option<String>
Return the internal descriptor, if present
\n
",0,"bdk_wallet::wallet::export::WalletExport"],["sourceÂ§impl Serialize for FullyNodedExport
sourceÂ§fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where\n    __S: Serializer,
Serialize this value into the given Serde serializer. Read more","Serialize","bdk_wallet::wallet::export::WalletExport"]]
+"bdk_wallet":[["sourceÂ§impl Debug for FullyNodedExport
sourceÂ§fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
","Debug","bdk_wallet::wallet::export::WalletExport"],["sourceÂ§impl<'de> Deserialize<'de> for FullyNodedExport
sourceÂ§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where\n    __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
","Deserialize<'de>","bdk_wallet::wallet::export::WalletExport"],["sourceÂ§impl Display for FullyNodedExport
sourceÂ§fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
","Display","bdk_wallet::wallet::export::WalletExport"],["sourceÂ§impl FromStr for FullyNodedExport
Â§type Err = Error
The associated error which can be returned from parsing.
sourceÂ§fn from_str(s: &str) -> Result<Self, Self::Err>
Parses a string s to return a value of this type. Read more
","FromStr","bdk_wallet::wallet::export::WalletExport"],["sourceÂ§impl FullyNodedExport
sourcepub fn export_wallet(\n    wallet: &Wallet,\n    label: &str,\n    include_blockheight: bool\n) -> Result<Self, &'static str>
Export a wallet
\nThis function returns an error if it determines that the walletâs descriptor(s) are not\nsupported by Bitcoin Core or donât follow the standard derivation paths defined by BIP44\nand others.
\nIf include_blockheight is true, this function will look into the walletâs database\nfor the oldest transaction it knows and use that as the earliest block to rescan.
\nIf the database is empty or include_blockheight is false, the blockheight field\nreturned will be 0.
\n
sourcepub fn descriptor(&self) -> String
Return the external descriptor
\n
sourcepub fn change_descriptor(&self) -> Option<String>
Return the internal descriptor, if present
\n
",0,"bdk_wallet::wallet::export::WalletExport"],["sourceÂ§impl Serialize for FullyNodedExport
sourceÂ§fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where\n    __S: Serializer,
Serialize this value into the given Serde serializer. Read more","Serialize","bdk_wallet::wallet::export::WalletExport"]]
 };if (window.register_type_impls) {window.register_type_impls(type_impls);} else {window.pending_type_impls = type_impls;}})()
\ No newline at end of file

Module bdk_wallet::wallet::exportCopy item path

Module bdk_wallet::wallet::exportCopy item path

Â§Examples

Â§Import from JSON

FieldsÂ§

ImplementationsÂ§

impl FullyNodedExport

pub fn export_wallet( +

ImplementationsÂ§

impl FullyNodedExport

pub fn export_wallet( wallet: &Wallet, label: &str, include_blockheight: bool @@ -18,8 +18,8 @@ and others. for the oldest transaction it knows and use that as the earliest block to rescan. If the database is empty or include_blockheight is false, the blockheight field returned will be 0. -

pub fn descriptor(&self) -> String

pub fn change_descriptor(&self) -> Option<String>

pub fn descriptor(&self) -> String

pub fn change_descriptor(&self) -> Option<String>

Trait ImplementationsÂ§

impl Debug for FullyNodedExport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<'de> Deserialize<'de> for FullyNodedExport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl Display for FullyNodedExport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl FromStr for FullyNodedExport

type Err = Error

fn from_str(s: &str) -> Result<Self, Self::Err>

impl Serialize for FullyNodedExport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Auto Trait ImplementationsÂ§

impl Freeze for FullyNodedExport

impl RefUnwindSafe for FullyNodedExport

impl Send for FullyNodedExport

impl Sync for FullyNodedExport

impl Unpin for FullyNodedExport

impl UnwindSafe for FullyNodedExport

Blanket ImplementationsÂ§

Rustdoc help

Rustdoc help

Rustdoc settings

Rustdoc settings

impl Debug for FullyNodedExport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<'de> Deserialize<'de> for FullyNodedExport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where\n __D: Deserializer<'de>,

impl Display for FullyNodedExport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl FromStr for FullyNodedExport

type Err = Error

fn from_str(s: &str) -> Result<Self, Self::Err>

impl FullyNodedExport

pub fn export_wallet(\n wallet: &Wallet,\n label: &str,\n include_blockheight: bool\n) -> Result<Self, &'static str>

pub fn descriptor(&self) -> String

pub fn change_descriptor(&self) -> Option<String>

impl Serialize for FullyNodedExport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where\n __S: Serializer,

impl Debug for FullyNodedExport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<'de> Deserialize<'de> for FullyNodedExport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where\n __D: Deserializer<'de>,

impl Display for FullyNodedExport

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl FromStr for FullyNodedExport

type Err = Error

fn from_str(s: &str) -> Result<Self, Self::Err>

impl FullyNodedExport

pub fn export_wallet(\n wallet: &Wallet,\n label: &str,\n include_blockheight: bool\n) -> Result<Self, &'static str>

pub fn descriptor(&self) -> String

pub fn change_descriptor(&self) -> Option<String>

impl Serialize for FullyNodedExport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where\n __S: Serializer,

Module bdk_wallet::wallet::export

Module bdk_wallet::wallet::export

`FieldsÂ§`

pub fn export_wallet( wallet: &Wallet, label: &str, include_blockheight: bool @@ -18,8 +18,8 @@ and others.
for the oldest transaction it knows and use that as the earliest block to rescan.

If the database is empty or `include_blockheight` is false, the `blockheight` field returned will be `0`.
-

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where\n __D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where\n S: Serializer,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where\n __D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where\n S: Serializer,