Struct bdk::wallet::export::WalletExport

pub struct WalletExport {
    pub blockheight: u32,
    pub label: String,
    // some fields omitted
}

Structure that contains the export of a wallet

For a usage example see this module's documentation.

Fields

blockheight: u32

Earliest block to rescan when looking for the wallet's transactions

label: String

Arbitrary label for the wallet

Implementations

impl WalletExport

pub fn export_wallet<B: BlockchainMarker, D: BatchDatabase>(
    wallet: &Wallet<B, D>,
    label: &str,
    include_blockheight: bool
) -> Result<Self, &'static str>

Export a wallet

This function returns an error if it determines that the wallet's descriptor(s) are not supported by Bitcoin Core or don't follow the standard derivation paths defined by BIP44 and others.

If include_blockheight is true, this function will look into the wallet's database 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

Return the external descriptor

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

Return the internal descriptor, if present

Trait Implementations

impl Debug for WalletExport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WalletExport

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

Deserialize this value from the given Serde deserializer.

impl FromStr for WalletExport

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Serialize for WalletExport

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

Serialize this value into the given Serde serializer.

impl ToString for WalletExport

fn to_string(&self) -> String

Converts the given value to a String.