-

Enum bdk::wallet::AddressIndex

pub enum AddressIndex {
+    Enum bdk::wallet::AddressIndex
source Â· [−]

pub enum AddressIndex {
     New,
     LastUnused,
     Peek(u32),
@@ -31,7 +31,7 @@ then the returned address and subsequent addresses returned by calls to Ad
 and AddressIndex::LastUsed may have already been used. Also if the index is reset to a
 value earlier than the crate::blockchain::Blockchain stop_gap (default is 20) then a
 larger stop_gap should be used to monitor for all possibly used addresses.
-

`Trait Implementations`

source

impl Debug for AddressIndex

source

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

Formats the value using the given formatter. Read more

`Trait Implementations`

source

impl Debug for AddressIndex

source

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

Formats the value using the given formatter. Read more

`Auto Trait Implementations`

impl RefUnwindSafe for AddressIndex

impl Send for AddressIndex

impl Sync for AddressIndex

impl Unpin for AddressIndex

impl UnwindSafe for AddressIndex

`Blanket Implementations`

source

impl<T> Any for T where
    T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
    T: ?Sized,

const: unstable Â· source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
    T: ?Sized,

const: unstable Â· source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more


diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/fn.get_funded_wallet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/fn.get_funded_wallet.html
index 17b07dbaca..39ecdc2a8f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/fn.get_funded_wallet.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/fn.get_funded_wallet.html
@@ -6,6 +6,6 @@


         In bdk::wallet

                         

-    Function bdk::wallet::get_funded_wallet
source Â· [−]
pub fn get_funded_wallet(
    descriptor: &str
) -> (Wallet<AnyDatabase>, (String, Option<String>), Txid)
Expand description
Return a fake wallet that appears to be funded for testing.
+    Function bdk::wallet::get_funded_wallet
source Â· [−]
pub fn get_funded_wallet(
    descriptor: &str
) -> (Wallet<AnyDatabase>, (String, Option<String>), Txid)
Expand description
Return a fake wallet that appears to be funded for testing.
 

 
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/fn.wallet_name_from_descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/fn.wallet_name_from_descriptor.html
index 79d3f59d96..89005ffc8f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/fn.wallet_name_from_descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/fn.wallet_name_from_descriptor.html
@@ -6,7 +6,7 @@


         In bdk::wallet

                         

-    Function bdk::wallet::wallet_name_from_descriptor
source Â· [−]
pub fn wallet_name_from_descriptor<T>(
    descriptor: T, 
    change_descriptor: Option<T>, 
    network: Network, 
    secp: &Secp256k1<All>
) -> Result<String, Error> where
    T: IntoWalletDescriptor, 
Expand description
Deterministically generate a unique name given the descriptors defining the wallet
+    Function bdk::wallet::wallet_name_from_descriptor
source Â· [−]
pub fn wallet_name_from_descriptor<T>(
    descriptor: T, 
    change_descriptor: Option<T>, 
    network: Network, 
    secp: &Secp256k1<All>
) -> Result<String, Error> where
    T: IntoWalletDescriptor, 
Expand description
Deterministically generate a unique name given the descriptors defining the wallet
 Compatible with wallet_name_from_descriptor
 

 
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/index.html
index 2adc6095f7..09f7bcf709 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/index.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/index.html
@@ -6,7 +6,7 @@


         Module wallet
Modules
Structs
Enums
Traits
Functions

                         

-    Module bdk::wallet
source Â· [−]
Expand description
Wallet
+    Module bdk::wallet
source Â· [−]
Expand description
Wallet
 This module defines the Wallet structure.
 
Modules
 address_validator
Address validation callbacks
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.AddressInfo.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.AddressInfo.html
index 4c9613fa9f..9b4e27e3fa 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.AddressInfo.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.AddressInfo.html
@@ -6,7 +6,7 @@
                     
         AddressInfo
Fields
addressindexkeychain
Associated Constants
ALIGN
Methods from Deref<Target=Address>
address_typeis_related_to_pubkeyis_related_to_xonly_pubkeyis_standardis_valid_for_networkscript_pubkeyto_qr_uri
Trait Implementations
DebugDerefDisplayPartialEq<AddressInfo>StructuralPartialEq
Auto Trait Implementations
RefUnwindSafeSendSyncUnpinUnwindSafe
Blanket Implementations
AnyBorrow<T>BorrowMut<T>From<T>Into<U>PointableToStringTryFrom<U>TryInto<U>VZip<V>
In bdk::wallet

                         

-    Struct bdk::wallet::AddressInfo
source Â· [−]
pub struct AddressInfo {
+    Struct bdk::wallet::AddressInfo
source Â· [−]
pub struct AddressInfo {
     pub index: u32,
     pub address: Address,
     pub keychain: KeychainKind,
@@ -52,14 +52,14 @@ given key. For taproot addresses, the supplied key is assumed to be tweaked
 
pub fn is_related_to_xonly_pubkey(&self, xonly_pubkey: &XOnlyPublicKey) -> bool
Returns true if the supplied xonly public key can be used to derive the address.

 This will only work for Taproot addresses. The Public Key is
 assumed to have already been tweaked.
-
Trait Implementations
source
impl Debug for AddressInfo
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more

-
source
impl Deref for AddressInfo
type Target = Address
The resulting type after dereferencing.

-
source
fn deref(&self) -> &Self::Target
Dereferences the value.

-
source
impl Display for AddressInfo
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more

-
source
impl PartialEq<AddressInfo> for AddressInfo
source
fn eq(&self, other: &AddressInfo) -> bool
This method tests for self and other values to be equal, and is used
+
Trait Implementations
source
impl Debug for AddressInfo
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more

+
source
impl Deref for AddressInfo
type Target = Address
The resulting type after dereferencing.

+
source
fn deref(&self) -> &Self::Target
Dereferences the value.

+
source
impl Display for AddressInfo
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more

+
source
impl PartialEq<AddressInfo> for AddressInfo
source
fn eq(&self, other: &AddressInfo) -> bool
This method tests for self and other values to be equal, and is used
 by ==. Read more

-
source
fn ne(&self, other: &AddressInfo) -> bool
This method tests for !=.

-
source
impl StructuralPartialEq for AddressInfo
Auto Trait Implementations
impl RefUnwindSafe for AddressInfo
impl Send for AddressInfo
impl Sync for AddressInfo
impl Unpin for AddressInfo
impl UnwindSafe for AddressInfo
Blanket Implementations
source
impl<T> Any for T where
    T: 'static + ?Sized, 
source
pub fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more

+
source
fn ne(&self, other: &AddressInfo) -> bool
This method tests for !=.

+
source
impl StructuralPartialEq for AddressInfo
Auto Trait Implementations
impl RefUnwindSafe for AddressInfo
impl Send for AddressInfo
impl Sync for AddressInfo
impl Unpin for AddressInfo
impl UnwindSafe for AddressInfo
Blanket Implementations
source
impl<T> Any for T where
    T: 'static + ?Sized, 
source
pub fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more

 
source
impl<T> Borrow<T> for T where
    T: ?Sized, 
const: unstable Â· source
pub fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more

 
source
impl<T> BorrowMut<T> for T where
    T: ?Sized, 
const: unstable Â· source
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more

 
source
impl<T> From<T> for T
const: unstable Â· source
pub fn from(t: T) -> T
Performs the conversion.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.SyncOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.SyncOptions.html
index 88bd66da0b..d9bd383708 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.SyncOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.SyncOptions.html
@@ -6,12 +6,12 @@
                     

         SyncOptions
Fields
progress
Associated Constants
ALIGN
Trait Implementations
DebugDefault
Auto Trait Implementations
!RefUnwindSafeSend!SyncUnpin!UnwindSafe
Blanket Implementations
AnyBorrow<T>BorrowMut<T>From<T>Into<U>PointableTryFrom<U>TryInto<U>VZip<V>
In bdk::wallet

                         

-    Struct bdk::wallet::SyncOptions
source Â· [−]
pub struct SyncOptions {
+    Struct bdk::wallet::SyncOptions
source Â· [−]
pub struct SyncOptions {
     pub progress: Option<Box<dyn Progress>>,
 }
Expand description
Options to a sync.

 
Fields
progress: Option<Box<dyn Progress>>The progress tracker which may be informed when progress is made.
-
Trait Implementationssource
impl Debug for SyncOptions
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
-source
impl Default for SyncOptionssource
fn default() -> SyncOptions
Returns the âdefault valueâ for a type. Read more
+
Trait Implementations
source
impl Debug for SyncOptions
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
+
source
impl Default for SyncOptions
source
fn default() -> SyncOptions
Returns the âdefault valueâ for a type. Read more
 
Auto Trait Implementations
impl !RefUnwindSafe for SyncOptions
impl Send for SyncOptions
impl !Sync for SyncOptions
impl Unpin for SyncOptions
impl !UnwindSafe for SyncOptions
Blanket Implementationssource
impl<T> Any for T where
    T: 'static + ?Sized, 
source
pub fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
 
source
impl<T> Borrow<T> for T where
    T: ?Sized, 
const: unstable Â· source
pub fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
 source
impl<T> BorrowMut<T> for T where
    T: ?Sized, const: unstable Â· source
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html
index d7ad763ffd..1c38af6b15 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/wallet/struct.Wallet.html
@@ -6,7 +6,7 @@
                     
         Wallet
Associated Constants
ALIGN
Methods
add_address_validatoradd_signerbuild_fee_bumpbuild_txdatabasedescriptor_checksumensure_addresses_cachedfinalize_psbtget_addressget_address_validatorsget_balanceget_descriptor_for_keychainget_internal_addressget_psbt_inputget_signersget_txget_utxois_minelist_transactionslist_unspentnetworknewnew_offlinepoliciespublic_descriptorsecp_ctxsignsync
Trait Implementations
Debug
Auto Trait Implementations
!RefUnwindSafeSend!SyncUnpin!UnwindSafe
Blanket Implementations
AnyBorrow<T>BorrowMut<T>From<T>Into<U>PointableTryFrom<U>TryInto<U>VZip<V>
In bdk::wallet

                         

-    Struct bdk::wallet::Wallet
source Â· [−]
pub struct Wallet<D> { /* private fields */ }Expand description
A Bitcoin wallet
+    Struct bdk::wallet::Wallet
source Â· [−]
pub struct Wallet<D> { /* private fields */ }
Expand description
A Bitcoin wallet
 The Wallet struct acts as a way of coherently interfacing with output descriptors and related transactions.
 Its main components are:
 
@@ -14,37 +14,37 @@ Its main components are:
 A Database where it tracks transactions and utxos related to the descriptors.
 signers that can contribute signatures to addresses instantiated from the descriptors.
 
-
Implementationssource
impl<D> Wallet<D> where
    D: BatchDatabase, source
pub fn new_offline<E: IntoWalletDescriptor>(
    descriptor: E, 
    change_descriptor: Option<E>, 
    network: Network, 
    database: D
) -> Result<Self, Error>
ð Deprecated: Just use Wallet::new â all wallets are offline now!
+
Implementations
source
impl<D> Wallet<D> where
    D: BatchDatabase, 
source
pub fn new_offline<E: IntoWalletDescriptor>(
    descriptor: E, 
    change_descriptor: Option<E>, 
    network: Network, 
    database: D
) -> Result<Self, Error>
ð Deprecated: Just use Wallet::new â all wallets are offline now!
 
Create a new âofflineâ wallet
-
source
pub fn new<E: IntoWalletDescriptor>(
    descriptor: E, 
    change_descriptor: Option<E>, 
    network: Network, 
    database: D
) -> Result<Self, Error>
Create a wallet.
+
source
pub fn new<E: IntoWalletDescriptor>(
    descriptor: E, 
    change_descriptor: Option<E>, 
    network: Network, 
    database: D
) -> Result<Self, Error>
Create a wallet.
 The only way this can fail is if the descriptors passed in do not match the checksums in database.
-
source
pub fn network(&self) -> Network
Get the Bitcoin network the wallet is using.
-
source
pub fn get_address(
    &self, 
    address_index: AddressIndex
) -> Result<AddressInfo, Error>
Return a derived address using the external descriptor, see AddressIndex for
+
source
pub fn network(&self) -> Network
Get the Bitcoin network the wallet is using.
+
source
pub fn get_address(
    &self, 
    address_index: AddressIndex
) -> Result<AddressInfo, Error>
Return a derived address using the external descriptor, see AddressIndex for
 available address index selection strategies. If none of the keys in the descriptor are derivable
 (i.e. does not end with /*) then the same address will always be returned for any AddressIndex.
-
source
pub fn get_internal_address(
    &self, 
    address_index: AddressIndex
) -> Result<AddressInfo, Error>
Return a derived address using the internal (change) descriptor.
+
source
pub fn get_internal_address(
    &self, 
    address_index: AddressIndex
) -> Result<AddressInfo, Error>
Return a derived address using the internal (change) descriptor.
 If the wallet doesnât have an internal descriptor it will use the external descriptor.
 see AddressIndex for available address index selection strategies. If none of the keys
 in the descriptor are derivable (i.e. does not end with /*) then the same address will always
 be returned for any AddressIndex.
-
source
pub fn ensure_addresses_cached(&self, max_addresses: u32) -> Result<bool, Error>
Ensures that there are at least max_addresses addresses cached in the database if the
+
source
pub fn ensure_addresses_cached(&self, max_addresses: u32) -> Result<bool, Error>
Ensures that there are at least max_addresses addresses cached in the database if the
 descriptor is derivable, or 1 address if it is not.
 Will return Ok(true) if there are new addresses generated (either external or internal),
 and Ok(false) if all the required addresses are already cached. This function is useful to
 explicitly cache addresses in a wallet to do things like check Wallet::is_mine on
 transaction output scripts.
-
source
pub fn is_mine(&self, script: &Script) -> Result<bool, Error>
Return whether or not a script is part of this wallet (either internal or external)
-
source
pub fn list_unspent(&self) -> Result<Vec<LocalUtxo>, Error>
Return the list of unspent outputs of this wallet
+
source
pub fn is_mine(&self, script: &Script) -> Result<bool, Error>
Return whether or not a script is part of this wallet (either internal or external)
+
source
pub fn list_unspent(&self) -> Result<Vec<LocalUtxo>, Error>
Return the list of unspent outputs of this wallet
 Note that this method only operates on the internal database, which first needs to be
 Wallet::sync manually.
-
source
pub fn get_utxo(&self, outpoint: OutPoint) -> Result<Option<LocalUtxo>, Error>
Returns the UTXO owned by this wallet corresponding to outpoint if it exists in the
+
source
pub fn get_utxo(&self, outpoint: OutPoint) -> Result<Option<LocalUtxo>, Error>
Returns the UTXO owned by this wallet corresponding to outpoint if it exists in the
 walletâs database.
-
source
pub fn get_tx(
    &self, 
    txid: &Txid, 
    include_raw: bool
) -> Result<Option<TransactionDetails>, Error>
Return a single transactions made and received by the wallet
+
source
pub fn get_tx(
    &self, 
    txid: &Txid, 
    include_raw: bool
) -> Result<Option<TransactionDetails>, Error>
Return a single transactions made and received by the wallet
 Optionally fill the TransactionDetails::transaction field with the raw transaction if
 include_raw is true.
 Note that this method only operates on the internal database, which first needs to be
 Wallet::sync manually.
-
source
pub fn list_transactions(
    &self, 
    include_raw: bool
) -> Result<Vec<TransactionDetails>, Error>
Return an unsorted list of transactions made and received by the wallet
+
source
pub fn list_transactions(
    &self, 
    include_raw: bool
) -> Result<Vec<TransactionDetails>, Error>
Return an unsorted list of transactions made and received by the wallet
 Optionally fill the TransactionDetails::transaction field with the raw transaction if
 include_raw is true.
 To sort transactions, the following code can be used:
@@ -57,13 +57,13 @@ walletâs database.
 });
 Note that this method only operates on the internal database, which first needs to be
 Wallet::sync manually.
-
source
pub fn get_balance(&self) -> Result<Balance, Error>
Return the balance, separated into available, trusted-pending, untrusted-pending and immature
+
source
pub fn get_balance(&self) -> Result<Balance, Error>
Return the balance, separated into available, trusted-pending, untrusted-pending and immature
 values.
 Note that this method only operates on the internal database, which first needs to be
 Wallet::sync manually.
-
source
pub fn add_signer(
    &mut self, 
    keychain: KeychainKind, 
    ordering: SignerOrdering, 
    signer: Arc<dyn TransactionSigner>
)
Add an external signer
+
source
pub fn add_signer(
    &mut self, 
    keychain: KeychainKind, 
    ordering: SignerOrdering, 
    signer: Arc<dyn TransactionSigner>
)
Add an external signer
 See the signer module for an example.
-
source
pub fn get_signers(&self, keychain: KeychainKind) -> Arc<SignersContainer>
Get the signers
+
source
pub fn get_signers(&self, keychain: KeychainKind) -> Arc<SignersContainer>
Get the signers
 Example
 let wallet = Wallet::new("wpkh(tprv8ZgxMBicQKsPe73PBRSmNbTfbcsZnwWhz5eVmhHpi31HW29Z7mc9B4cWGRQzopNUzZUT391DeDJxL2PefNunWyLgqCKRMDkU1s2s8bAfoSk/84'/0'/0'/0/*)", None, Network::Testnet, MemoryDatabase::new())?;
 for secret_key in wallet.get_signers(KeychainKind::External).signers().iter().filter_map(|s| s.descriptor_secret_key()) {
@@ -72,11 +72,11 @@ values.
 }
 
 Ok::<(), Box<dyn std::error::Error>>(())
-
source
pub fn add_address_validator(&mut self, validator: Arc<dyn AddressValidator>)
ð Deprecated
Add an address validator
+
source
pub fn add_address_validator(&mut self, validator: Arc<dyn AddressValidator>)
ð Deprecated
Add an address validator
 See the address_validator module for an example.
-
source
pub fn get_address_validators(&self) -> &[Arc<dyn AddressValidator>]
ð Deprecated
Get the address validators
+
source
pub fn get_address_validators(&self) -> &[Arc<dyn AddressValidator>]
ð Deprecated
Get the address validators
 See the address_validator module.
-
source
pub fn build_tx(
    &self
) -> TxBuilder<'_, D, DefaultCoinSelectionAlgorithm, CreateTx>
Start building a transaction.
+
source
pub fn build_tx(
    &self
) -> TxBuilder<'_, D, DefaultCoinSelectionAlgorithm, CreateTx>
Start building a transaction.
 This returns a blank TxBuilder from which you can specify the parameters for the transaction.
 Example
 let (psbt, details) = {
@@ -87,7 +87,7 @@ values.
 };
 
 // sign and broadcast ...
-
source
pub fn build_fee_bump(
    &self, 
    txid: Txid
) -> Result<TxBuilder<'_, D, DefaultCoinSelectionAlgorithm, BumpFee>, Error>
Bump the fee of a transaction previously created with this wallet.
+source
pub fn build_fee_bump(
    &self, 
    txid: Txid
) -> Result<TxBuilder<'_, D, DefaultCoinSelectionAlgorithm, BumpFee>, Error>Bump the fee of a transaction previously created with this wallet.
 Returns an error if the transaction is already confirmed or doesnât explicitly signal
 replace by fee (RBF). If the transaction can be fee bumped then it returns a TxBuilder
 pre-populated with the inputs and outputs of the original transaction.
@@ -112,7 +112,7 @@ pre-populated with the inputs and outputs of the original transaction.
 let _ = wallet.sign(&mut psbt, SignOptions::default())?;
 let fee_bumped_tx = psbt.extract_tx();
 // broadcast fee_bumped_tx to replace original

-
source
pub fn sign(
    &self, 
    psbt: &mut PartiallySignedTransaction, 
    sign_options: SignOptions
) -> Result<bool, Error>
Sign a transaction with all the walletâs signers, in the order specified by every signerâs
+
source
pub fn sign(
    &self, 
    psbt: &mut PartiallySignedTransaction, 
    sign_options: SignOptions
) -> Result<bool, Error>
Sign a transaction with all the walletâs signers, in the order specified by every signerâs
 SignerOrdering

 The SignOptions can be used to tweak the behavior of the software signers, and the way
 the transaction is finalized at the end. Note that it canât be guaranteed that every
@@ -126,20 +126,20 @@ in this library will.
 };
 let  finalized = wallet.sign(&mut psbt, SignOptions::default())?;
 assert!(finalized, "we should have signed all the inputs");
-
source
pub fn policies(&self, keychain: KeychainKind) -> Result<Option<Policy>, Error>
Return the spending policies for the walletâs descriptor
-
source
pub fn public_descriptor(
    &self, 
    keychain: KeychainKind
) -> Result<Option<ExtendedDescriptor>, Error>
Return the âpublicâ version of the walletâs descriptor, meaning a new descriptor that has
+
source
pub fn policies(&self, keychain: KeychainKind) -> Result<Option<Policy>, Error>
Return the spending policies for the walletâs descriptor
+
source
pub fn public_descriptor(
    &self, 
    keychain: KeychainKind
) -> Result<Option<ExtendedDescriptor>, Error>
Return the âpublicâ version of the walletâs descriptor, meaning a new descriptor that has
 the same structure but with every secret key removed
 This can be used to build a watch-only version of a wallet
-
source
pub fn finalize_psbt(
    &self, 
    psbt: &mut PartiallySignedTransaction, 
    sign_options: SignOptions
) -> Result<bool, Error>
Try to finalize a PSBT
+
source
pub fn finalize_psbt(
    &self, 
    psbt: &mut PartiallySignedTransaction, 
    sign_options: SignOptions
) -> Result<bool, Error>
Try to finalize a PSBT
 The SignOptions can be used to tweak the behavior of the finalizer.
-
source
pub fn secp_ctx(&self) -> &Secp256k1<All>
Return the secp256k1 context used for all signing operations
-
source
pub fn get_descriptor_for_keychain(
    &self, 
    keychain: KeychainKind
) -> &ExtendedDescriptor
Returns the descriptor used to create addresses for a particular keychain.
-
source
pub fn get_psbt_input(
    &self, 
    utxo: LocalUtxo, 
    sighash_type: Option<PsbtSighashType>, 
    only_witness_utxo: bool
) -> Result<Input, Error>
get the corresponding PSBT Input for a LocalUtxo
-
source
pub fn database(&self) -> impl Deref<Target = D> + '_
Return an immutable reference to the internal database
-
source
pub fn sync<B: WalletSync + GetHeight>(
    &self, 
    blockchain: &B, 
    sync_opts: SyncOptions
) -> Result<(), Error>
Sync the internal database with the blockchain
-
source
pub fn descriptor_checksum(&self, keychain: KeychainKind) -> String
Return the checksum of the public descriptor associated to keychain
+
source
pub fn secp_ctx(&self) -> &Secp256k1<All>
Return the secp256k1 context used for all signing operations
+
source
pub fn get_descriptor_for_keychain(
    &self, 
    keychain: KeychainKind
) -> &ExtendedDescriptor
Returns the descriptor used to create addresses for a particular keychain.
+
source
pub fn get_psbt_input(
    &self, 
    utxo: LocalUtxo, 
    sighash_type: Option<PsbtSighashType>, 
    only_witness_utxo: bool
) -> Result<Input, Error>
get the corresponding PSBT Input for a LocalUtxo
+
source
pub fn database(&self) -> impl Deref<Target = D> + '_
Return an immutable reference to the internal database
+
source
pub fn sync<B: WalletSync + GetHeight>(
    &self, 
    blockchain: &B, 
    sync_opts: SyncOptions
) -> Result<(), Error>
Sync the internal database with the blockchain
+
source
pub fn descriptor_checksum(&self, keychain: KeychainKind) -> String
Return the checksum of the public descriptor associated to keychain
 Internally calls Self::get_descriptor_for_keychain to fetch the right descriptor
-
Trait Implementations
source
impl<D: Debug> Debug for Wallet<D>
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
+
Trait Implementations
source
impl<D: Debug> Debug for Wallet<D>
source
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
 
Auto Trait Implementations
impl<D> !RefUnwindSafe for Wallet<D>
impl<D> Send for Wallet<D> where
    D: Send, 
impl<D> !Sync for Wallet<D>
impl<D> Unpin for Wallet<D> where
    D: Unpin, 
impl<D> !UnwindSafe for Wallet<D>
Blanket Implementations
source
impl<T> Any for T where
    T: 'static + ?Sized, 
source
pub fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
 
source
impl<T> Borrow<T> for T where
    T: ?Sized, 
const: unstable Â· source
pub fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
 
source
impl<T> BorrowMut<T> for T where
    T: ?Sized, 
const: unstable Â· source
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/wallet/mod.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/wallet/mod.rs.html
index d8ca93af4d..0b4b03db5f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/wallet/mod.rs.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/wallet/mod.rs.html
@@ -5533,6 +5533,7 @@
 5526
 5527
 5528
+5529
 // Bitcoin Dev Kit
 // Written in 2020 by Alekos Filini <alekos.filini@gmail.com>
 //
@@ -5584,6 +5585,7 @@
 pub mod verify;
 
 #[cfg(feature = "hardware-signer")]
+#[cfg_attr(docsrs, doc(cfg(feature = "hardware-signer")))]
 pub mod hardwaresigner;
 
 pub use utils::IsDust;
-- 
2.49.0

In bdk::wallet

Enum bdk::wallet::AddressIndex

Enum bdk::wallet::AddressIndex

Trait Implementations

impl Debug for AddressIndex

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

Trait Implementations

impl Debug for AddressIndex

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

Auto Trait Implementations

impl RefUnwindSafe for AddressIndex

impl Send for AddressIndex

impl Sync for AddressIndex

impl Unpin for AddressIndex

impl UnwindSafe for AddressIndex

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

In bdk::wallet

Function bdk::wallet::get_funded_wallet

Function bdk::wallet::get_funded_wallet

In bdk::wallet

Function bdk::wallet::wallet_name_from_descriptor

Function bdk::wallet::wallet_name_from_descriptor

Module bdk::wallet

Module bdk::wallet

In bdk::wallet

Struct bdk::wallet::AddressInfo

Struct bdk::wallet::AddressInfo

pub fn is_related_to_xonly_pubkey(&self, xonly_pubkey: &XOnlyPublicKey) -> bool

Trait Implementations

impl Debug for AddressInfo

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

impl Deref for AddressInfo

type Target = Address

fn deref(&self) -> &Self::Target

impl Display for AddressInfo

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

impl PartialEq<AddressInfo> for AddressInfo

fn eq(&self, other: &AddressInfo) -> bool

Trait Implementations

impl Debug for AddressInfo

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

impl Deref for AddressInfo

type Target = Address

fn deref(&self) -> &Self::Target

impl Display for AddressInfo

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

impl PartialEq<AddressInfo> for AddressInfo

fn eq(&self, other: &AddressInfo) -> bool

fn ne(&self, other: &AddressInfo) -> bool

impl StructuralPartialEq for AddressInfo

Auto Trait Implementations

impl RefUnwindSafe for AddressInfo

impl Send for AddressInfo

impl Sync for AddressInfo

impl Unpin for AddressInfo

impl UnwindSafe for AddressInfo

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

fn ne(&self, other: &AddressInfo) -> bool

impl StructuralPartialEq for AddressInfo

Auto Trait Implementations

impl RefUnwindSafe for AddressInfo

impl Send for AddressInfo

impl Sync for AddressInfo

impl Unpin for AddressInfo

impl UnwindSafe for AddressInfo

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

`Trait Implementations`

`Trait Implementations`

`Auto Trait Implementations`

`Blanket Implementations`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

`Trait Implementations`

`Trait Implementations`

`Auto Trait Implementations`

`Blanket Implementations`

impl<T> Any for T where
T: 'static + ?Sized,

`Auto Trait Implementations`

`Blanket Implementations`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

`Fields`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<D> Wallet<D> where
D: BatchDatabase,

pub fn new_offline<E: IntoWalletDescriptor>(
descriptor: E,
change_descriptor: Option<E>,
network: Network,
database: D
) -> Result<Self, Error>

impl<D> Wallet<D> where
D: BatchDatabase,

pub fn new_offline<E: IntoWalletDescriptor>(
descriptor: E,
change_descriptor: Option<E>,
network: Network,
database: D
) -> Result<Self, Error>

pub fn new<E: IntoWalletDescriptor>(
descriptor: E,
change_descriptor: Option<E>,
network: Network,
database: D
) -> Result<Self, Error>

pub fn new<E: IntoWalletDescriptor>(
descriptor: E,
change_descriptor: Option<E>,
network: Network,
database: D
) -> Result<Self, Error>

pub fn get_address(
&self,
address_index: AddressIndex
) -> Result<AddressInfo, Error>