For raw public key and single-path extended keys it will return the key itself. For multipath extended keys it will return a single-path extended key per derivation path.

Trait ImplementationsÂ§

Auto Trait ImplementationsÂ§

Blanket ImplementationsÂ§

Auto Trait ImplementationsÂ§

Blanket ImplementationsÂ§

Trait ImplementationsÂ§

Auto Trait ImplementationsÂ§

Blanket ImplementationsÂ§

Auto Trait ImplementationsÂ§

Blanket ImplementationsÂ§

VariantsÂ§

ImplementationsÂ§

Trait ImplementationsÂ§

Auto Trait ImplementationsÂ§

Blanket ImplementationsÂ§

Auto Trait ImplementationsÂ§

Blanket ImplementationsÂ§

Enum bdk::Utxo

source Â·

pub enum Utxo {
-    Local(LocalUtxo),
+    Local(LocalOutput),
     Foreign {
         outpoint: OutPoint,
         psbt_input: Box<Input>,
     },
 }

Expand description

An unspent transaction output (UTXO).

VariantsÂ§

Â§

VariantsÂ§

Â§

Foreign

Fields

Â§outpoint: OutPoint

The location of the output.

Â§psbt_input: Box<Input>

The information about the input we require to add it to a PSBT.

A UTXO owned by another wallet.

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html index 725fb83f28..3cd83b0769 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html @@ -166,4 +166,4 @@ Right now this is Re-exports

pub extern crate bitcoin;

pub extern crate miniscript;

pub use descriptor::template;

pub use descriptor::HdKeyPaths;

pub use wallet::signer;

pub use wallet::signer::SignOptions;

pub use wallet::tx_builder::TxBuilder;

pub use wallet::Wallet;

pub use bdk_chain as chain;

Modules

descriptor

Descriptors

keys

Key formats

psbt

Additional functions on the rust-bitcoin PartiallySignedTransaction structure.

wallet

Wallet

Macros

descriptor

Macro to write full descriptors with code

fragment

Macro to write descriptor fragments with code

Structs

FeeRate

Fee rate

LocalUtxo

An unspent output owned by a Wallet.

WeightedUtxo

A Utxo with its satisfaction_weight.

Enums

KeychainKind

Types of keychains

Utxo

An unspent transaction output (UTXO).

Traits

Vbytes

Trait implemented by types that can be used to measure weight units.

Functions

version

Get the version of BDK at runtime

For raw public key and single-path extended keys it will return the key itself. For multipath extended keys it will return a single-path extended key per derivation path.

Trait ImplementationsÂ§

Auto Trait ImplementationsÂ§

Blanket ImplementationsÂ§

Auto Trait ImplementationsÂ§

Blanket ImplementationsÂ§

Struct bdk::LocalOutput

source Â·

pub struct LocalOutput {
+    pub outpoint: OutPoint,
+    pub txout: TxOut,
+    pub keychain: KeychainKind,
+    pub is_spent: bool,
+    pub derivation_index: u32,
+    pub confirmation_time: ConfirmationTime,
+}

Expand description

An unspent output owned by a Wallet.

FieldsÂ§

Â§outpoint: OutPoint

Reference to a transaction output

Â§txout: TxOut

Transaction output

Â§keychain: KeychainKind

Type of keychain

Â§is_spent: bool

Whether this UTXO is spent or not

Â§derivation_index: u32

The derivation index for the script pubkey in the wallet

Â§confirmation_time: ConfirmationTime

The confirmation time for transaction containing this utxo

List of all items

Structs

Enums

Traits

Macros

Functions

Type Definitions

Crate bdk

List of all items

Structs

Enums

Traits

Macros

Functions

Type Definitions

Errors

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 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,

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 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,

impl<'de, Pk> Serialize for Descriptor<Pk>where
Pk: MiniscriptKey,

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

impl<P, Q> TranslatePk<P, Q> for Descriptor<P>where
P: MiniscriptKey,
Q: MiniscriptKey,

fn translate_pk<T, E>(
&self,
t: &mut T
) -> Result<<Descriptor<P> as TranslatePk<P, Q>>::Output, TranslateErr<E>>where
T: Translator<P, Q, E>,

impl<'de, Pk> Serialize for Descriptor<Pk>where
Pk: MiniscriptKey,

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

impl<P, Q> TranslatePk<P, Q> for Descriptor<P>where
P: MiniscriptKey,
Q: MiniscriptKey,

fn translate_pk<T, E>(
&self,
t: &mut T
) -> Result<<Descriptor<P> as TranslatePk<P, Q>>::Output, TranslateErr<E>>where
T: Translator<P, Q, E>,

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

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

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

impl<Pk> RefUnwindSafe for Descriptor<Pk>where
Pk: RefUnwindSafe,
<Pk as MiniscriptKey>::Hash160: RefUnwindSafe,
<Pk as MiniscriptKey>::Hash256: RefUnwindSafe,
<Pk as MiniscriptKey>::Ripemd160: RefUnwindSafe,
<Pk as MiniscriptKey>::Sha256: RefUnwindSafe,

impl<Pk> Send for Descriptor<Pk>where
Pk: Send + Sync,
<Pk as MiniscriptKey>::Hash160: Send + Sync,
<Pk as MiniscriptKey>::Hash256: Send + Sync,
<Pk as MiniscriptKey>::Ripemd160: Send + Sync,
<Pk as MiniscriptKey>::Sha256: Send + Sync,

impl<Pk> Sync for Descriptor<Pk>where
Pk: Send + Sync,
<Pk as MiniscriptKey>::Hash160: Send + Sync,
<Pk as MiniscriptKey>::Hash256: Send + Sync,
<Pk as MiniscriptKey>::Ripemd160: Send + Sync,
<Pk as MiniscriptKey>::Sha256: Send + Sync,

impl<Pk> Unpin for Descriptor<Pk>where
Pk: Unpin,
<Pk as MiniscriptKey>::Hash160: Unpin,
<Pk as MiniscriptKey>::Hash256: Unpin,
<Pk as MiniscriptKey>::Ripemd160: Unpin,
<Pk as MiniscriptKey>::Sha256: Unpin,

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

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

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

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T> ToString for Twhere
T: Display + ?Sized,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T> ToString for Twhere
T: Display + ?Sized,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,