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, DescriptorError>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, DescriptorError>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 c7837505d1..8f701dd117 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 @@ -1,5 +1,5 @@ bdk::wallet - Rust

Module bdk::wallet

source Â·

Expand description

Wallet

+

Module wallet

Module bdk::wallet

source Â·

Expand description

Wallet

This module defines the Wallet.

Modules

coin_selection

Coin selection

error

Errors that can be thrown by the Wallet

export

Wallet export

signer

Generalized signers

tx_builder

Transaction builder

Structs

AddressInfo

A derived address and the index it was found at. For convenience this automatically derefs to Address

Balance

Balance, differentiated into various categories.

ChangeSet

The changes made to a wallet by applying an Update.

Update

An update to Wallet.

Wallet

A Bitcoin wallet

Enums

AddressIndex

The address index selection strategy to use to derived an address from the walletâs external 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 2f4e4e02a5..30dbdb3d4a 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 @@ -22,7 +22,7 @@ be returned for any

Panics
 This panics when the caller requests for an address of derivation index greater than the
 BIP32 max index.
-

sourceÂ§impl<D> Wallet<D>

sourcepub fn new<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: D,
    network: Network
) -> Result<Self, NewError<D::WriteError>>where
    D: PersistBackend<ChangeSet>,

Initialize an empty Wallet.

sourceÂ§impl<D> Wallet<D>

sourcepub fn new<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: D,
    network: Network
) -> Result<Self, NewError<D::WriteError>>where
    D: PersistBackend<ChangeSet>,

Initialize an empty Wallet.

sourcepub fn new_with_genesis_hash<E: IntoWalletDescriptor>(
    descriptor: E,
    change_descriptor: Option<E>,
    db: D,
    network: Network,
    genesis_hash: BlockHash
) -> Result<Self, NewError<D::WriteError>>where
    D: PersistBackend<ChangeSet>,

Initialize an empty Wallet with a custom genesis hash.


 This is like Wallet::new with an additional genesis_hash parameter. This is useful
 for syncing from alternative networks.
@@ -85,7 +85,7 @@ manually insert the TxOut(s) into the tx graph using the Examples
 let tx = wallet.get_tx(txid).expect("transaction").tx_node.tx;
-let fee = wallet.calculate_fee(tx).expect("fee");
+let fee = wallet.calculate_fee(&tx).expect("fee");

let tx = &psbt.clone().extract_tx();
 let fee = wallet.calculate_fee(tx).expect("fee");

@@ -95,21 +95,21 @@ manually insert the TxOut(s) into the tx graph using the Examples

let tx = wallet.get_tx(txid).expect("transaction").tx_node.tx;
-let fee_rate = wallet.calculate_fee_rate(tx).expect("fee rate");

+let fee_rate = wallet.calculate_fee_rate(&tx).expect("fee rate");

-

let tx = &psbt.clone().extract_tx();
-let fee_rate = wallet.calculate_fee_rate(tx).expect("fee rate");

+

let tx = psbt.clone().extract_tx();
+let fee_rate = wallet.calculate_fee_rate(&tx).expect("fee rate");

Trait ImplementationsÂ§

impl<Pk> Clone for Descriptor<Pk>where Pk: Clone + MiniscriptKey,

fn clone(&self) -> Descriptor<Pk>

fn clone_from(&mut self, source: &Self)

impl<Pk> Debug for Descriptor<Pk>where Pk: MiniscriptKey,

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

impl DescriptorExt for Descriptor<DescriptorPublicKey>

fn dust_value(&self) -> u64

fn deserialize<D>( deserializer: D) -> Result<Descriptor<Pk>, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

impl<Pk> Display for Descriptor<Pk>where Pk: MiniscriptKey,

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

impl ExtractPolicy for Descriptor<DescriptorPublicKey>

fn extract_policy( &self, signers: &SignersContainer, build_sat: BuildSatisfaction<'_>, secp: &Secp256k1<All>) -> Result<Option<Policy>, Error>

impl<Pk> ForEachKey<Pk> for Descriptor<Pk>where Pk: MiniscriptKey,

fn for_each_key<'a, F>(&'a self, pred: F) -> boolwhere F: FnMut(&'a Pk) -> bool,

fn for_any_key<'a, F>(&'a self, pred: F) -> boolwhere F: FnMut(&'a Pk) -> bool, Pk: 'a,

impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Bare<Pk>) -> Descriptor<Pk>

impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Pkh<Pk>) -> Descriptor<Pk>

impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Sh<Pk>) -> Descriptor<Pk>

impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Tr<Pk>) -> Descriptor<Pk>

impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>

impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Wsh<Pk>) -> Descriptor<Pk>

type Err = Error

fn from_str(s: &str) -> Result<Descriptor<Pk>, Error>

fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>

impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Bare<Pk>) -> Descriptor<Pk>

impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Pkh<Pk>) -> Descriptor<Pk>

impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Sh<Pk>) -> Descriptor<Pk>

impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Tr<Pk>) -> Descriptor<Pk>

impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>

impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where Pk: MiniscriptKey,

fn from(inner: Wsh<Pk>) -> Descriptor<Pk>

type Err = Error

fn from_str(s: &str) -> Result<Descriptor<Pk>, Error>

fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>

impl<Pk> Hash for Descriptor<Pk>where Pk: Hash + MiniscriptKey,

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl<Pk> Liftable<Pk> for Descriptor<Pk>where Pk: MiniscriptKey,

fn lift(&self) -> Result<Policy<Pk>, Error>

impl<Pk> Ord for Descriptor<Pk>where Pk: Ord + MiniscriptKey,

fn cmp(&self, other: &Descriptor<Pk>) -> Ordering

fn max(self, other: Self) -> Selfwhere Self: Sized,

fn min(self, other: Self) -> Selfwhere Self: Sized,

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

impl<Pk> PartialEq<Descriptor<Pk>> for Descriptor<Pk>where Pk: PartialEq<Pk> + MiniscriptKey,

fn eq(&self, other: &Descriptor<Pk>) -> bool

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

impl<Pk> PartialOrd<Descriptor<Pk>> for Descriptor<Pk>where Pk: PartialOrd<Pk> + MiniscriptKey,

fn partial_cmp(&self, other: &Descriptor<Pk>) -> Option<Ordering>

fn lt(&self, other: &Rhs) -> bool

fn le(&self, other: &Rhs) -> bool

Function bdk::wallet::wallet_name_from_descriptor

Function bdk::wallet::wallet_name_from_descriptor

Module bdk::wallet

Module bdk::wallet

impl<D> Wallet<D>

pub fn new<E: IntoWalletDescriptor>( descriptor: E, change_descriptor: Option<E>, db: D, network: Network) -> Result<Self, NewError<D::WriteError>>where D: PersistBackend<ChangeSet>,

impl<D> Wallet<D>

pub fn new<E: IntoWalletDescriptor>( descriptor: E, change_descriptor: Option<E>, db: D, network: Network) -> Result<Self, NewError<D::WriteError>>where D: PersistBackend<ChangeSet>,

pub fn new_with_genesis_hash<E: IntoWalletDescriptor>( descriptor: E, change_descriptor: Option<E>, db: D, network: Network, genesis_hash: BlockHash) -> Result<Self, NewError<D::WriteError>>where D: PersistBackend<ChangeSet>,

pub fn sent_and_received(&self, tx: &Transaction) -> (u64, u64)

pub fn get_tx( &self, txid: Txid) -> Option<CanonicalTx<'_, Transaction, ConfirmationTimeHeightAnchor>>

pub fn get_tx( &self, txid: Txid) -> Option<CanonicalTx<'_, Arc<Transaction>, ConfirmationTimeHeightAnchor>>

pub fn transactions( &self) -> impl Iterator<Item = CanonicalTx<'_, Transaction, ConfirmationTimeHeightAnchor>> + '_

pub fn get_balance(&self) -> Balance

pub fn transactions( &self) -> impl Iterator<Item = CanonicalTx<'_, Arc<Transaction>, ConfirmationTimeHeightAnchor>> + '_

pub fn get_balance(&self) -> Balance

pub fn add_signer( &mut self, keychain: KeychainKind, ordering: SignerOrdering, signer: Arc<dyn TransactionSigner>)

impl<Pk> Clone for Descriptor<Pk>where
Pk: Clone + MiniscriptKey,

impl<Pk> Debug for Descriptor<Pk>where
Pk: MiniscriptKey,

fn deserialize<D>(
deserializer: D
) -> Result<Descriptor<Pk>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,

impl<Pk> Display for Descriptor<Pk>where
Pk: MiniscriptKey,

fn extract_policy(
&self,
signers: &SignersContainer,
build_sat: BuildSatisfaction<'_>,
secp: &Secp256k1<All>
) -> Result<Option<Policy>, Error>

impl<Pk> ForEachKey<Pk> for Descriptor<Pk>where
Pk: MiniscriptKey,

fn for_each_key<'a, F>(&'a self, pred: F) -> boolwhere
F: FnMut(&'a Pk) -> bool,

fn for_any_key<'a, F>(&'a self, pred: F) -> boolwhere
F: FnMut(&'a Pk) -> bool,
Pk: 'a,

impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> Hash for Descriptor<Pk>where
Pk: Hash + MiniscriptKey,

fn hash<H>(&self, state: &mut H)where
__H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,
Self: Sized,

impl<Pk> Liftable<Pk> for Descriptor<Pk>where
Pk: MiniscriptKey,

impl<Pk> Ord for Descriptor<Pk>where
Pk: Ord + MiniscriptKey,

fn max(self, other: Self) -> Selfwhere
Self: Sized,

fn min(self, other: Self) -> Selfwhere
Self: Sized,

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

impl<Pk> PartialEq<Descriptor<Pk>> for Descriptor<Pk>where
Pk: PartialEq<Pk> + MiniscriptKey,

impl<Pk> PartialOrd<Descriptor<Pk>> for Descriptor<Pk>where
Pk: PartialOrd<Pk> + MiniscriptKey,

pub fn new<E: IntoWalletDescriptor>(
descriptor: E,
change_descriptor: Option<E>,
db: D,
network: Network
) -> Result<Self, NewError<D::WriteError>>where
D: PersistBackend<ChangeSet>,

pub fn new<E: IntoWalletDescriptor>(
descriptor: E,
change_descriptor: Option<E>,
db: D,
network: Network
) -> Result<Self, NewError<D::WriteError>>where
D: PersistBackend<ChangeSet>,

pub fn new_with_genesis_hash<E: IntoWalletDescriptor>(
descriptor: E,
change_descriptor: Option<E>,
db: D,
network: Network,
genesis_hash: BlockHash
) -> Result<Self, NewError<D::WriteError>>where
D: PersistBackend<ChangeSet>,

pub fn get_tx(
&self,
txid: Txid
) -> Option<CanonicalTx<'_, Transaction, ConfirmationTimeHeightAnchor>>

pub fn get_tx(
&self,
txid: Txid
) -> Option<CanonicalTx<'_, Arc<Transaction>, ConfirmationTimeHeightAnchor>>

pub fn transactions(
&self
) -> impl Iterator<Item = CanonicalTx<'_, Transaction, ConfirmationTimeHeightAnchor>> + '_

pub fn transactions(
&self
) -> impl Iterator<Item = CanonicalTx<'_, Arc<Transaction>, ConfirmationTimeHeightAnchor>> + '_

pub fn add_signer(
&mut self,
keychain: KeychainKind,
ordering: SignerOrdering,
signer: Arc<dyn TransactionSigner>
)

pub fn add_signer(
&mut self,
keychain: KeychainKind,
ordering: SignerOrdering,
signer: Arc<dyn TransactionSigner>
)

pub fn build_tx(
&mut self
) -> TxBuilder<'_, D, DefaultCoinSelectionAlgorithm, CreateTx>

pub fn build_tx(
&mut self
) -> TxBuilder<'_, D, DefaultCoinSelectionAlgorithm, CreateTx>

pub fn build_fee_bump(
&mut self,
txid: Txid
) -> Result<TxBuilder<'_, D, DefaultCoinSelectionAlgorithm, BumpFee>, BuildFeeBumpError>

pub fn build_fee_bump(
&mut self,
txid: Txid
) -> Result<TxBuilder<'_, D, DefaultCoinSelectionAlgorithm, BumpFee>, BuildFeeBumpError>

pub fn sign(
&self,
psbt: &mut PartiallySignedTransaction,
sign_options: SignOptions
) -> Result<bool, SignerError>

pub fn sign(
&self,
psbt: &mut PartiallySignedTransaction,
sign_options: SignOptions
) -> Result<bool, SignerError>

pub fn policies(
&self,
keychain: KeychainKind
) -> Result<Option<Policy>, DescriptorError>

pub fn public_descriptor(
&self,
keychain: KeychainKind
) -> Option<&ExtendedDescriptor>

pub fn policies(
&self,
keychain: KeychainKind
) -> Result<Option<Policy>, DescriptorError>

pub fn public_descriptor(
&self,
keychain: KeychainKind
) -> Option<&ExtendedDescriptor>

pub fn finalize_psbt(
&self,
psbt: &mut PartiallySignedTransaction,
sign_options: SignOptions
) -> Result<bool, SignerError>

pub fn finalize_psbt(
&self,
psbt: &mut PartiallySignedTransaction,
sign_options: SignOptions
) -> Result<bool, SignerError>

pub fn get_descriptor_for_keychain(
&self,
keychain: KeychainKind
) -> &ExtendedDescriptor

pub fn get_descriptor_for_keychain(
&self,
keychain: KeychainKind
) -> &ExtendedDescriptor

pub fn get_psbt_input(
&self,
utxo: LocalOutput,
sighash_type: Option<PsbtSighashType>,
only_witness_utxo: bool
) -> Result<Input, CreateTxError<D::WriteError>>where
D: PersistBackend<ChangeSet>,

pub fn get_psbt_input(
&self,
utxo: LocalOutput,
sighash_type: Option<PsbtSighashType>,
only_witness_utxo: bool
) -> Result<Input, CreateTxError<D::WriteError>>where
D: PersistBackend<ChangeSet>,

pub fn apply_update(&mut self, update: Update) -> Result<(), CannotConnectError>where
D: PersistBackend<ChangeSet>,

pub fn apply_update(&mut self, update: Update) -> Result<(), CannotConnectError>where
D: PersistBackend<ChangeSet>,

pub fn commit(&mut self) -> Result<bool, D::WriteError>where
D: PersistBackend<ChangeSet>,

pub fn commit(&mut self) -> Result<bool, D::WriteError>where
D: PersistBackend<ChangeSet>,

pub fn staged(&self) -> &ChangeSetwhere
D: PersistBackend<ChangeSet>,

pub fn apply_block(
&mut self,
block: &Block,
height: u32
) -> Result<(), CannotConnectError>where
D: PersistBackend<ChangeSet>,

pub fn staged(&self) -> &ChangeSetwhere
D: PersistBackend<ChangeSet>,

pub fn apply_block(
&mut self,
block: &Block,
height: u32
) -> Result<(), CannotConnectError>where
D: PersistBackend<ChangeSet>,

pub fn apply_block_connected_to(
&mut self,
block: &Block,
height: u32,
connected_to: BlockId
) -> Result<(), ApplyHeaderError>where
D: PersistBackend<ChangeSet>,

pub fn apply_block_connected_to(
&mut self,
block: &Block,
height: u32,
connected_to: BlockId
) -> Result<(), ApplyHeaderError>where
D: PersistBackend<ChangeSet>,

pub fn apply_unconfirmed_txs<'t>(
&mut self,
unconfirmed_txs: impl IntoIterator<Item = (&'t Transaction, u64)>
)where
D: PersistBackend<ChangeSet>,

pub fn apply_unconfirmed_txs<'t>(
&mut self,
unconfirmed_txs: impl IntoIterator<Item = (&'t Transaction, u64)>
)where
D: PersistBackend<ChangeSet>,