Struct bdk_chain::local_chain::MissingGenesisError
source · pub struct MissingGenesisError;Expand description
An error which occurs when a LocalChain is constructed without a genesis checkpoint.
Trait Implementations§
source§impl Clone for MissingGenesisError
impl Clone for MissingGenesisError
source§fn clone(&self) -> MissingGenesisError
fn clone(&self) -> MissingGenesisError
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for MissingGenesisError
impl Debug for MissingGenesisError
source§impl Display for MissingGenesisError
impl Display for MissingGenesisError
source§impl Error for MissingGenesisError
impl Error for MissingGenesisError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
source§impl PartialEq for MissingGenesisError
impl PartialEq for MissingGenesisError
source§fn eq(&self, other: &MissingGenesisError) -> bool
fn eq(&self, other: &MissingGenesisError) -> bool
This method tests for
self and other values to be equal, and is used
+Trait Implementations§
source§impl Clone for MissingGenesisError
impl Clone for MissingGenesisError
source§fn clone(&self) -> MissingGenesisError
fn clone(&self) -> MissingGenesisError
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for MissingGenesisError
impl Debug for MissingGenesisError
source§impl Display for MissingGenesisError
impl Display for MissingGenesisError
source§impl Error for MissingGenesisError
impl Error for MissingGenesisError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
source§impl PartialEq for MissingGenesisError
impl PartialEq for MissingGenesisError
source§fn eq(&self, other: &MissingGenesisError) -> bool
fn eq(&self, other: &MissingGenesisError) -> bool
This method tests for
self and other values to be equal, and is used
by ==.impl StructuralPartialEq for MissingGenesisError
Auto Trait Implementations§
impl Freeze for MissingGenesisError
impl RefUnwindSafe for MissingGenesisError
impl Send for MissingGenesisError
impl Sync for MissingGenesisError
impl Unpin for MissingGenesisError
impl UnwindSafe for MissingGenesisError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.CombinedChangeSet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.CombinedChangeSet.html
index 40def7567f..69a360c048 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.CombinedChangeSet.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.CombinedChangeSet.html
@@ -9,7 +9,7 @@
Trait Implementations§
source§impl<K: Clone, A: Clone> Clone for CombinedChangeSet<K, A>
source§fn clone(&self) -> CombinedChangeSet<K, A>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, A> Default for CombinedChangeSet<K, A>
source§impl<'de, K, A> Deserialize<'de> for CombinedChangeSet<K, A>
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
- __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl<K, A> From<ChangeSet<K>> for CombinedChangeSet<K, A>
source§impl<K: PartialEq, A: PartialEq> PartialEq for CombinedChangeSet<K, A>
source§impl<K, A> From<ChangeSet<K>> for CombinedChangeSet<K, A>
source§impl<K: PartialEq, A: PartialEq> PartialEq for CombinedChangeSet<K, A>
source§fn eq(&self, other: &CombinedChangeSet<K, A>) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl<K, A> Serialize for CombinedChangeSet<K, A>where
A: Ord + Serialize,
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
index c23089e7c4..210c26af2a 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
@@ -6,15 +6,15 @@
Tuple Fields§
§0: HashImplementations§
source§impl DescriptorId
sourcepub fn from_raw_hash(inner: Hash) -> DescriptorId
Creates this wrapper type from the inner hash type.
sourcepub fn to_raw_hash(self) -> Hash
Returns the inner hash (sha256, sh256d etc.).
sourcepub fn as_raw_hash(&self) -> &Hash
Returns a reference to the inner hash (sha256, sh256d etc.).
-Trait Implementations§
source§impl AsRef<[u8]> for DescriptorId
source§impl Borrow<[u8]> for DescriptorId
source§impl Clone for DescriptorId
source§fn clone(&self) -> DescriptorId
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for DescriptorId
source§impl<'de> Deserialize<'de> for DescriptorId
source§fn deserialize<D: Deserializer<'de>>(d: D) -> Result<DescriptorId, D::Error>
Deserialize this value from the given Serde deserializer. Read moresource§impl Display for DescriptorId
source§impl From<DescriptorId> for Hash
source§fn from(hashtype: DescriptorId) -> Hash
Converts to this type from the input type.source§impl From<Hash> for DescriptorId
source§fn from(inner: Hash) -> DescriptorId
Converts to this type from the input type.source§impl FromStr for DescriptorId
source§impl Hash for DescriptorId
Trait Implementations§
source§impl AsRef<[u8]> for DescriptorId
source§impl Borrow<[u8]> for DescriptorId
source§impl Clone for DescriptorId
source§fn clone(&self) -> DescriptorId
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for DescriptorId
source§impl<'de> Deserialize<'de> for DescriptorId
source§fn deserialize<D: Deserializer<'de>>(d: D) -> Result<DescriptorId, D::Error>
Deserialize this value from the given Serde deserializer. Read moresource§impl Display for DescriptorId
source§impl From<DescriptorId> for Hash
source§fn from(hashtype: DescriptorId) -> Hash
Converts to this type from the input type.source§impl From<Hash> for DescriptorId
source§fn from(inner: Hash) -> DescriptorId
Converts to this type from the input type.source§impl FromStr for DescriptorId
source§impl Hash for DescriptorId
source§impl Hash for DescriptorId
§type Engine = <Hash as Hash>::Engine
A hashing engine which bytes can be serialized into. It is expected
to implement the io::Write trait, and to never return errors under
any conditions.source§const DISPLAY_BACKWARD: bool = false
Flag indicating whether user-visible serializations of this hash
should be backward. For some reason Satoshi decided this should be
-true for Sha256dHash, so here we are.source§fn from_engine(e: Self::Engine) -> Self
Produces a hash from the current state of a given engine.source§fn from_slice(sl: &[u8]) -> Result<DescriptorId, FromSliceError>
Copies a byte slice into a hash object.source§fn from_byte_array(bytes: Self::Bytes) -> Self
Constructs a hash from the underlying byte array.source§fn to_byte_array(self) -> Self::Bytes
Returns the underlying byte array.source§fn as_byte_array(&self) -> &Self::Bytes
Returns a reference to the underlying byte array.§fn hash_byte_chunks<B, I>(byte_slices: I) -> Selfwhere
+true for Sha256dHash, so here we are.
source§fn from_engine(e: Self::Engine) -> Self
Produces a hash from the current state of a given engine.source§fn from_slice(sl: &[u8]) -> Result<DescriptorId, FromSliceError>
Copies a byte slice into a hash object.source§fn from_byte_array(bytes: Self::Bytes) -> Self
Constructs a hash from the underlying byte array.source§fn to_byte_array(self) -> Self::Bytes
Returns the underlying byte array.source§fn as_byte_array(&self) -> &Self::Bytes
Returns a reference to the underlying byte array.§fn hash_byte_chunks<B, I>(byte_slices: I) -> Self
Hashes all the byte slices retrieved from the iterator together.source§impl Hash for DescriptorId
source§impl<I: SliceIndex<[u8]>> Index<I> for DescriptorId
source§impl LowerHex for DescriptorId
source§impl Ord for DescriptorId
source§impl<I: SliceIndex<[u8]>> Index<I> for DescriptorId
source§impl LowerHex for DescriptorId
source§impl Ord for DescriptorId
source§fn cmp(&self, other: &DescriptorId) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read moresource§impl PartialEq for DescriptorId
source§fn eq(&self, other: &DescriptorId) -> bool
This method tests for self and other values to be equal, and is used
@@ -25,8 +25,8 @@
&self,
s: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
- S: Serializer,Do serde serialization.§fn deserialize<'de, D>(d: D) -> Result<Self, <D as Deserializer<'de>>::Error>where
- D: Deserializer<'de>,
Do serde deserialization.source§impl Serialize for DescriptorId
source§impl UpperHex for DescriptorId
source§impl Copy for DescriptorId
source§impl Eq for DescriptorId
source§impl StructuralPartialEq for DescriptorId
Auto Trait Implementations§
§impl Freeze for DescriptorId
§impl RefUnwindSafe for DescriptorId
§impl Send for DescriptorId
§impl Sync for DescriptorId
§impl Unpin for DescriptorId
§impl UnwindSafe for DescriptorId
Blanket Implementations§
source§impl<T> Any for Twhere
+ S: Serializer,
Do serde serialization.§fn deserialize<'de, D>(d: D) -> Result<Self, <D as Deserializer<'de>>::Error>where
+ D: Deserializer<'de>,
Do serde deserialization.source§impl Serialize for DescriptorId
source§impl UpperHex for DescriptorId
source§impl Copy for DescriptorId
source§impl Eq for DescriptorId
source§impl StructuralPartialEq for DescriptorId
Auto Trait Implementations§
§impl Freeze for DescriptorId
§impl RefUnwindSafe for DescriptorId
§impl Send for DescriptorId
§impl Sync for DescriptorId
§impl Unpin for DescriptorId
§impl UnwindSafe for DescriptorId
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html
index a578b2837b..24beb02cc6 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html
@@ -276,7 +276,7 @@ §Error
trust_predicate: impl FnMut(&OI, &Script) -> bool
) -> BalanceGet the total balance of outpoints that are in chain of chain_tip.
This is the infallible version of try_balance.
-Trait Implementations§
source§impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>
Trait Implementations§
source§impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>
source§impl<A: PartialEq> PartialEq for TxGraph<A>
source§impl<A> StructuralPartialEq for TxGraph<A>
Auto Trait Implementations§
§impl<A> Freeze for TxGraph<A>
§impl<A> RefUnwindSafe for TxGraph<A>where
A: RefUnwindSafe,
§impl<A> Send for TxGraph<A>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html
index 772e048ae5..6f84ac3e06 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html
@@ -2,7 +2,7 @@
Rounds(usize),
Duration(Duration),
}Expand description
Determines how we should limit rounds of branch and bound.
-Variants§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for BnbLimit
§impl RefUnwindSafe for BnbLimit
§impl Send for BnbLimit
§impl Sync for BnbLimit
§impl Unpin for BnbLimit
§impl UnwindSafe for BnbLimit
Blanket Implementations§
Variants§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for BnbLimit
§impl RefUnwindSafe for BnbLimit
§impl Send for BnbLimit
§impl Sync for BnbLimit
§impl Unpin for BnbLimit
§impl UnwindSafe for BnbLimit
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html
index 54033098a4..717004edae 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html
@@ -2,7 +2,7 @@
ToFee,
ToRecipient,
ToDrain,
-}Variants§
Trait Implementations§
source§impl Clone for ExcessStrategyKind
source§fn clone(&self) -> ExcessStrategyKind
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ExcessStrategyKind
source§impl Display for ExcessStrategyKind
source§impl Hash for ExcessStrategyKind
1.3.0 · source§fn hash_slice<H>(data: &[Self], state: &mut H)where
+}Variants§
Trait Implementations§
source§impl Clone for ExcessStrategyKind
source§fn clone(&self) -> ExcessStrategyKind
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ExcessStrategyKind
source§impl Display for ExcessStrategyKind
source§impl Hash for ExcessStrategyKind
source§impl Ord for ExcessStrategyKind
source§fn cmp(&self, other: &ExcessStrategyKind) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more1.21.0 · source§fn min(self, other: Self) -> Selfwhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
index 502fd1ffe5..3aa459992e 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
@@ -7,7 +7,7 @@
§TargetFee
The target fee (given the feerate) is not met
§MinAbsoluteFee
Min absolute fee is not met
§MinDrainValue
Min drain value is not met
-
Trait Implementations§
source§impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for SelectionConstraint
source§impl Eq for SelectionConstraint
source§impl StructuralPartialEq for SelectionConstraint
Auto Trait Implementations§
§impl Freeze for SelectionConstraint
§impl RefUnwindSafe for SelectionConstraint
§impl Send for SelectionConstraint
§impl Sync for SelectionConstraint
§impl Unpin for SelectionConstraint
§impl UnwindSafe for SelectionConstraint
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
index 8858f44b2f..888e52bff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
@@ -1,4 +1,4 @@
-SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> Any for Twhere
+SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
index d92a311c41..ef6f96d2d4 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
@@ -1,4 +1,4 @@
-EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
+EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
// Required methods
fn full_scan<K: Ord + Clone>(
&self,
@@ -13,7 +13,7 @@
) -> Result<SyncResult, Error>;
}
Expand description
Trait to extend the functionality of [esplora_client::BlockingClient].
Refer to crate-level documentation for more.
-Required Methods§
Required Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl EsploraExt for BlockingClient
source§fn full_scan<K: Ord + Clone>(
&self,
request: FullScanRequest<K>,
stop_gap: usize,
parallel_requests: usize
-) -> Result<FullScanResult<K>, Error>
source§fn sync(
+) -> Result<FullScanResult<K>, Error>
source§fn sync(
&self,
request: SyncRequest,
parallel_requests: usize
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
index ef36d38dd5..a747392a67 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
@@ -1,2 +1,2 @@
-Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
+Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);
Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
index 84c23d6e0b..1a6586014d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
@@ -4,7 +4,7 @@
}Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
§iter_error: IterErrorThe error returned by EntryIter.
-Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.CombinedChangeSet.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.CombinedChangeSet.html
index 40def7567f..69a360c048 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.CombinedChangeSet.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.CombinedChangeSet.html
@@ -9,7 +9,7 @@
Trait Implementations§
source§impl<K: Clone, A: Clone> Clone for CombinedChangeSet<K, A>
source§fn clone(&self) -> CombinedChangeSet<K, A>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, A> Default for CombinedChangeSet<K, A>
source§impl<'de, K, A> Deserialize<'de> for CombinedChangeSet<K, A>
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
- __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl<K, A> From<ChangeSet<K>> for CombinedChangeSet<K, A>
source§impl<K: PartialEq, A: PartialEq> PartialEq for CombinedChangeSet<K, A>
source§impl<K, A> From<ChangeSet<K>> for CombinedChangeSet<K, A>
source§impl<K: PartialEq, A: PartialEq> PartialEq for CombinedChangeSet<K, A>
source§fn eq(&self, other: &CombinedChangeSet<K, A>) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl<K, A> Serialize for CombinedChangeSet<K, A>where
A: Ord + Serialize,
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
index c23089e7c4..210c26af2a 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
@@ -6,15 +6,15 @@
Tuple Fields§
§0: HashImplementations§
source§impl DescriptorId
sourcepub fn from_raw_hash(inner: Hash) -> DescriptorId
Creates this wrapper type from the inner hash type.
sourcepub fn to_raw_hash(self) -> Hash
Returns the inner hash (sha256, sh256d etc.).
sourcepub fn as_raw_hash(&self) -> &Hash
Returns a reference to the inner hash (sha256, sh256d etc.).
-Trait Implementations§
source§impl AsRef<[u8]> for DescriptorId
source§impl Borrow<[u8]> for DescriptorId
source§impl Clone for DescriptorId
source§fn clone(&self) -> DescriptorId
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for DescriptorId
source§impl<'de> Deserialize<'de> for DescriptorId
source§fn deserialize<D: Deserializer<'de>>(d: D) -> Result<DescriptorId, D::Error>
Deserialize this value from the given Serde deserializer. Read moresource§impl Display for DescriptorId
source§impl From<DescriptorId> for Hash
source§fn from(hashtype: DescriptorId) -> Hash
Converts to this type from the input type.source§impl From<Hash> for DescriptorId
source§fn from(inner: Hash) -> DescriptorId
Converts to this type from the input type.source§impl FromStr for DescriptorId
source§impl Hash for DescriptorId
Trait Implementations§
source§impl AsRef<[u8]> for DescriptorId
source§impl Borrow<[u8]> for DescriptorId
source§impl Clone for DescriptorId
source§fn clone(&self) -> DescriptorId
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for DescriptorId
source§impl<'de> Deserialize<'de> for DescriptorId
source§fn deserialize<D: Deserializer<'de>>(d: D) -> Result<DescriptorId, D::Error>
Deserialize this value from the given Serde deserializer. Read moresource§impl Display for DescriptorId
source§impl From<DescriptorId> for Hash
source§fn from(hashtype: DescriptorId) -> Hash
Converts to this type from the input type.source§impl From<Hash> for DescriptorId
source§fn from(inner: Hash) -> DescriptorId
Converts to this type from the input type.source§impl FromStr for DescriptorId
source§impl Hash for DescriptorId
source§impl Hash for DescriptorId
§type Engine = <Hash as Hash>::Engine
A hashing engine which bytes can be serialized into. It is expected
to implement the io::Write trait, and to never return errors under
any conditions.source§const DISPLAY_BACKWARD: bool = false
Flag indicating whether user-visible serializations of this hash
should be backward. For some reason Satoshi decided this should be
-true for Sha256dHash, so here we are.source§fn from_engine(e: Self::Engine) -> Self
Produces a hash from the current state of a given engine.source§fn from_slice(sl: &[u8]) -> Result<DescriptorId, FromSliceError>
Copies a byte slice into a hash object.source§fn from_byte_array(bytes: Self::Bytes) -> Self
Constructs a hash from the underlying byte array.source§fn to_byte_array(self) -> Self::Bytes
Returns the underlying byte array.source§fn as_byte_array(&self) -> &Self::Bytes
Returns a reference to the underlying byte array.§fn hash_byte_chunks<B, I>(byte_slices: I) -> Selfwhere
+true for Sha256dHash, so here we are.
source§fn from_engine(e: Self::Engine) -> Self
Produces a hash from the current state of a given engine.source§fn from_slice(sl: &[u8]) -> Result<DescriptorId, FromSliceError>
Copies a byte slice into a hash object.source§fn from_byte_array(bytes: Self::Bytes) -> Self
Constructs a hash from the underlying byte array.source§fn to_byte_array(self) -> Self::Bytes
Returns the underlying byte array.source§fn as_byte_array(&self) -> &Self::Bytes
Returns a reference to the underlying byte array.§fn hash_byte_chunks<B, I>(byte_slices: I) -> Self
Hashes all the byte slices retrieved from the iterator together.source§impl Hash for DescriptorId
source§impl<I: SliceIndex<[u8]>> Index<I> for DescriptorId
source§impl LowerHex for DescriptorId
source§impl Ord for DescriptorId
source§impl<I: SliceIndex<[u8]>> Index<I> for DescriptorId
source§impl LowerHex for DescriptorId
source§impl Ord for DescriptorId
source§fn cmp(&self, other: &DescriptorId) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read moresource§impl PartialEq for DescriptorId
source§fn eq(&self, other: &DescriptorId) -> bool
This method tests for self and other values to be equal, and is used
@@ -25,8 +25,8 @@
&self,
s: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
- S: Serializer,Do serde serialization.§fn deserialize<'de, D>(d: D) -> Result<Self, <D as Deserializer<'de>>::Error>where
- D: Deserializer<'de>,
Do serde deserialization.source§impl Serialize for DescriptorId
source§impl UpperHex for DescriptorId
source§impl Copy for DescriptorId
source§impl Eq for DescriptorId
source§impl StructuralPartialEq for DescriptorId
Auto Trait Implementations§
§impl Freeze for DescriptorId
§impl RefUnwindSafe for DescriptorId
§impl Send for DescriptorId
§impl Sync for DescriptorId
§impl Unpin for DescriptorId
§impl UnwindSafe for DescriptorId
Blanket Implementations§
source§impl<T> Any for Twhere
+ S: Serializer,
Do serde serialization.§fn deserialize<'de, D>(d: D) -> Result<Self, <D as Deserializer<'de>>::Error>where
+ D: Deserializer<'de>,
Do serde deserialization.source§impl Serialize for DescriptorId
source§impl UpperHex for DescriptorId
source§impl Copy for DescriptorId
source§impl Eq for DescriptorId
source§impl StructuralPartialEq for DescriptorId
Auto Trait Implementations§
§impl Freeze for DescriptorId
§impl RefUnwindSafe for DescriptorId
§impl Send for DescriptorId
§impl Sync for DescriptorId
§impl Unpin for DescriptorId
§impl UnwindSafe for DescriptorId
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html
index a578b2837b..24beb02cc6 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html
@@ -276,7 +276,7 @@ §Error
trust_predicate: impl FnMut(&OI, &Script) -> bool
) -> BalanceGet the total balance of outpoints that are in chain of chain_tip.
This is the infallible version of try_balance.
-Trait Implementations§
source§impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>
Trait Implementations§
source§impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>
source§impl<A: PartialEq> PartialEq for TxGraph<A>
source§impl<A> StructuralPartialEq for TxGraph<A>
Auto Trait Implementations§
§impl<A> Freeze for TxGraph<A>
§impl<A> RefUnwindSafe for TxGraph<A>where
A: RefUnwindSafe,
§impl<A> Send for TxGraph<A>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html
index 772e048ae5..6f84ac3e06 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html
@@ -2,7 +2,7 @@
Rounds(usize),
Duration(Duration),
}Expand description
Determines how we should limit rounds of branch and bound.
-Variants§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for BnbLimit
§impl RefUnwindSafe for BnbLimit
§impl Send for BnbLimit
§impl Sync for BnbLimit
§impl Unpin for BnbLimit
§impl UnwindSafe for BnbLimit
Blanket Implementations§
Variants§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for BnbLimit
§impl RefUnwindSafe for BnbLimit
§impl Send for BnbLimit
§impl Sync for BnbLimit
§impl Unpin for BnbLimit
§impl UnwindSafe for BnbLimit
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html
index 54033098a4..717004edae 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html
@@ -2,7 +2,7 @@
ToFee,
ToRecipient,
ToDrain,
-}Variants§
Trait Implementations§
source§impl Clone for ExcessStrategyKind
source§fn clone(&self) -> ExcessStrategyKind
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ExcessStrategyKind
source§impl Display for ExcessStrategyKind
source§impl Hash for ExcessStrategyKind
1.3.0 · source§fn hash_slice<H>(data: &[Self], state: &mut H)where
+}Variants§
Trait Implementations§
source§impl Clone for ExcessStrategyKind
source§fn clone(&self) -> ExcessStrategyKind
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ExcessStrategyKind
source§impl Display for ExcessStrategyKind
source§impl Hash for ExcessStrategyKind
source§impl Ord for ExcessStrategyKind
source§fn cmp(&self, other: &ExcessStrategyKind) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more1.21.0 · source§fn min(self, other: Self) -> Selfwhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
index 502fd1ffe5..3aa459992e 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
@@ -7,7 +7,7 @@
§TargetFee
The target fee (given the feerate) is not met
§MinAbsoluteFee
Min absolute fee is not met
§MinDrainValue
Min drain value is not met
-
Trait Implementations§
source§impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for SelectionConstraint
source§impl Eq for SelectionConstraint
source§impl StructuralPartialEq for SelectionConstraint
Auto Trait Implementations§
§impl Freeze for SelectionConstraint
§impl RefUnwindSafe for SelectionConstraint
§impl Send for SelectionConstraint
§impl Sync for SelectionConstraint
§impl Unpin for SelectionConstraint
§impl UnwindSafe for SelectionConstraint
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
index 8858f44b2f..888e52bff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
@@ -1,4 +1,4 @@
-SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> Any for Twhere
+SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
index d92a311c41..ef6f96d2d4 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
@@ -1,4 +1,4 @@
-EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
+EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
// Required methods
fn full_scan<K: Ord + Clone>(
&self,
@@ -13,7 +13,7 @@
) -> Result<SyncResult, Error>;
}
Expand description
Trait to extend the functionality of [esplora_client::BlockingClient].
Refer to crate-level documentation for more.
-Required Methods§
Required Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl EsploraExt for BlockingClient
source§fn full_scan<K: Ord + Clone>(
&self,
request: FullScanRequest<K>,
stop_gap: usize,
parallel_requests: usize
-) -> Result<FullScanResult<K>, Error>
source§fn sync(
+) -> Result<FullScanResult<K>, Error>
source§fn sync(
&self,
request: SyncRequest,
parallel_requests: usize
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
index ef36d38dd5..a747392a67 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
@@ -1,2 +1,2 @@
-Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
+Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);
Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
index 84c23d6e0b..1a6586014d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
@@ -4,7 +4,7 @@
}Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
§iter_error: IterErrorThe error returned by EntryIter.
-Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
source§impl<K: Clone, A: Clone> Clone for CombinedChangeSet<K, A>
impl<K: Clone, A: Clone> Clone for CombinedChangeSet<K, A>
source§fn clone(&self) -> CombinedChangeSet<K, A>
fn clone(&self) -> CombinedChangeSet<K, A>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl<K, A> Default for CombinedChangeSet<K, A>
impl<K, A> Default for CombinedChangeSet<K, A>
source§impl<'de, K, A> Deserialize<'de> for CombinedChangeSet<K, A>
impl<'de, K, A> Deserialize<'de> for CombinedChangeSet<K, A>
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
- __D: Deserializer<'de>,
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<K, A> From<ChangeSet<K>> for CombinedChangeSet<K, A>
impl<K, A> From<ChangeSet<K>> for CombinedChangeSet<K, A>
source§impl<K: PartialEq, A: PartialEq> PartialEq for CombinedChangeSet<K, A>
impl<K: PartialEq, A: PartialEq> PartialEq for CombinedChangeSet<K, A>
source§impl<K, A> From<ChangeSet<K>> for CombinedChangeSet<K, A>
impl<K, A> From<ChangeSet<K>> for CombinedChangeSet<K, A>
source§impl<K: PartialEq, A: PartialEq> PartialEq for CombinedChangeSet<K, A>
impl<K: PartialEq, A: PartialEq> PartialEq for CombinedChangeSet<K, A>
source§fn eq(&self, other: &CombinedChangeSet<K, A>) -> bool
fn eq(&self, other: &CombinedChangeSet<K, A>) -> bool
This method tests for
self and other values to be equal, and is used
by ==.source§impl<K, A> Serialize for CombinedChangeSet<K, A>where
A: Ord + Serialize,
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
index c23089e7c4..210c26af2a 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
@@ -6,15 +6,15 @@
impl<K, A> Serialize for CombinedChangeSet<K, A>where
A: Ord + Serialize,
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
index c23089e7c4..210c26af2a 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/struct.DescriptorId.html
@@ -6,15 +6,15 @@
Tuple Fields§
§0: HashImplementations§
source§impl DescriptorId
impl DescriptorId
sourcepub fn from_raw_hash(inner: Hash) -> DescriptorId
pub fn from_raw_hash(inner: Hash) -> DescriptorId
Creates this wrapper type from the inner hash type.
sourcepub fn to_raw_hash(self) -> Hash
pub fn to_raw_hash(self) -> Hash
Returns the inner hash (sha256, sh256d etc.).
sourcepub fn as_raw_hash(&self) -> &Hash
pub fn as_raw_hash(&self) -> &Hash
Returns a reference to the inner hash (sha256, sh256d etc.).
-Trait Implementations§
source§impl AsRef<[u8]> for DescriptorId
impl AsRef<[u8]> for DescriptorId
source§impl Borrow<[u8]> for DescriptorId
impl Borrow<[u8]> for DescriptorId
source§impl Clone for DescriptorId
impl Clone for DescriptorId
source§fn clone(&self) -> DescriptorId
fn clone(&self) -> DescriptorId
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for DescriptorId
impl Debug for DescriptorId
source§impl<'de> Deserialize<'de> for DescriptorId
impl<'de> Deserialize<'de> for DescriptorId
source§fn deserialize<D: Deserializer<'de>>(d: D) -> Result<DescriptorId, D::Error>
fn deserialize<D: Deserializer<'de>>(d: D) -> Result<DescriptorId, D::Error>
Deserialize this value from the given Serde deserializer. Read more
source§impl Display for DescriptorId
impl Display for DescriptorId
source§impl From<DescriptorId> for Hash
impl From<DescriptorId> for Hash
source§fn from(hashtype: DescriptorId) -> Hash
fn from(hashtype: DescriptorId) -> Hash
Converts to this type from the input type.
source§impl From<Hash> for DescriptorId
impl From<Hash> for DescriptorId
source§fn from(inner: Hash) -> DescriptorId
fn from(inner: Hash) -> DescriptorId
Converts to this type from the input type.
source§impl FromStr for DescriptorId
impl FromStr for DescriptorId
source§impl Hash for DescriptorId
impl Hash for DescriptorId
Trait Implementations§
source§impl AsRef<[u8]> for DescriptorId
impl AsRef<[u8]> for DescriptorId
source§impl Borrow<[u8]> for DescriptorId
impl Borrow<[u8]> for DescriptorId
source§impl Clone for DescriptorId
impl Clone for DescriptorId
source§fn clone(&self) -> DescriptorId
fn clone(&self) -> DescriptorId
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for DescriptorId
impl Debug for DescriptorId
source§impl<'de> Deserialize<'de> for DescriptorId
impl<'de> Deserialize<'de> for DescriptorId
source§fn deserialize<D: Deserializer<'de>>(d: D) -> Result<DescriptorId, D::Error>
fn deserialize<D: Deserializer<'de>>(d: D) -> Result<DescriptorId, D::Error>
Deserialize this value from the given Serde deserializer. Read more
source§impl Display for DescriptorId
impl Display for DescriptorId
source§impl From<DescriptorId> for Hash
impl From<DescriptorId> for Hash
source§fn from(hashtype: DescriptorId) -> Hash
fn from(hashtype: DescriptorId) -> Hash
Converts to this type from the input type.
source§impl From<Hash> for DescriptorId
impl From<Hash> for DescriptorId
source§fn from(inner: Hash) -> DescriptorId
fn from(inner: Hash) -> DescriptorId
Converts to this type from the input type.
source§impl FromStr for DescriptorId
impl FromStr for DescriptorId
source§impl Hash for DescriptorId
impl Hash for DescriptorId
source§impl Hash for DescriptorId
impl Hash for DescriptorId
§type Engine = <Hash as Hash>::Engine
type Engine = <Hash as Hash>::Engine
A hashing engine which bytes can be serialized into. It is expected
to implement the
io::Write trait, and to never return errors under
any conditions.source§const DISPLAY_BACKWARD: bool = false
const DISPLAY_BACKWARD: bool = false
Flag indicating whether user-visible serializations of this hash
should be backward. For some reason Satoshi decided this should be
-true for
Sha256dHash, so here we are.source§fn from_engine(e: Self::Engine) -> Self
fn from_engine(e: Self::Engine) -> Self
Produces a hash from the current state of a given engine.
source§fn from_slice(sl: &[u8]) -> Result<DescriptorId, FromSliceError>
fn from_slice(sl: &[u8]) -> Result<DescriptorId, FromSliceError>
Copies a byte slice into a hash object.
source§fn from_byte_array(bytes: Self::Bytes) -> Self
fn from_byte_array(bytes: Self::Bytes) -> Self
Constructs a hash from the underlying byte array.
source§fn to_byte_array(self) -> Self::Bytes
fn to_byte_array(self) -> Self::Bytes
Returns the underlying byte array.
source§fn as_byte_array(&self) -> &Self::Bytes
fn as_byte_array(&self) -> &Self::Bytes
Returns a reference to the underlying byte array.
§fn hash_byte_chunks<B, I>(byte_slices: I) -> Selfwhere
+true for Sha256dHash, so here we are.
fn hash_byte_chunks<B, I>(byte_slices: I) -> Selfwhere
+true for Sha256dHash, so here we are.
Sha256dHash, so here we are.source§fn from_engine(e: Self::Engine) -> Self
fn from_engine(e: Self::Engine) -> Self
Produces a hash from the current state of a given engine.
source§fn from_slice(sl: &[u8]) -> Result<DescriptorId, FromSliceError>
fn from_slice(sl: &[u8]) -> Result<DescriptorId, FromSliceError>
Copies a byte slice into a hash object.
source§fn from_byte_array(bytes: Self::Bytes) -> Self
fn from_byte_array(bytes: Self::Bytes) -> Self
Constructs a hash from the underlying byte array.
source§fn to_byte_array(self) -> Self::Bytes
fn to_byte_array(self) -> Self::Bytes
Returns the underlying byte array.
source§fn as_byte_array(&self) -> &Self::Bytes
fn as_byte_array(&self) -> &Self::Bytes
Returns a reference to the underlying byte array.
§fn hash_byte_chunks<B, I>(byte_slices: I) -> Self
fn hash_byte_chunks<B, I>(byte_slices: I) -> Self
Hashes all the byte slices retrieved from the iterator together.
source§impl Hash for DescriptorId
impl Hash for DescriptorId
source§impl<I: SliceIndex<[u8]>> Index<I> for DescriptorId
impl<I: SliceIndex<[u8]>> Index<I> for DescriptorId
source§impl LowerHex for DescriptorId
impl LowerHex for DescriptorId
source§impl Ord for DescriptorId
impl Ord for DescriptorId
source§impl<I: SliceIndex<[u8]>> Index<I> for DescriptorId
impl<I: SliceIndex<[u8]>> Index<I> for DescriptorId
source§impl LowerHex for DescriptorId
impl LowerHex for DescriptorId
source§impl Ord for DescriptorId
impl Ord for DescriptorId
source§fn cmp(&self, other: &DescriptorId) -> Ordering
fn cmp(&self, other: &DescriptorId) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
source§impl PartialEq for DescriptorId
impl PartialEq for DescriptorId
source§fn eq(&self, other: &DescriptorId) -> bool
fn eq(&self, other: &DescriptorId) -> bool
This method tests for
self and other values to be equal, and is used
@@ -25,8 +25,8 @@
&self,
s: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
- S: Serializer,
Do serde serialization.
§fn deserialize<'de, D>(d: D) -> Result<Self, <D as Deserializer<'de>>::Error>where
- D: Deserializer<'de>,
fn deserialize<'de, D>(d: D) -> Result<Self, <D as Deserializer<'de>>::Error>where
- D: Deserializer<'de>,
Do serde deserialization.
source§impl Serialize for DescriptorId
impl Serialize for DescriptorId
source§impl UpperHex for DescriptorId
impl UpperHex for DescriptorId
impl Copy for DescriptorId
impl Eq for DescriptorId
impl StructuralPartialEq for DescriptorId
Auto Trait Implementations§
impl Freeze for DescriptorId
impl RefUnwindSafe for DescriptorId
impl Send for DescriptorId
impl Sync for DescriptorId
impl Unpin for DescriptorId
impl UnwindSafe for DescriptorId
Blanket Implementations§
source§impl<T> Any for Twhere
+ S: Serializer,
impl<T> Any for Twhere
+ S: Serializer,
Do serde serialization.
§fn deserialize<'de, D>(d: D) -> Result<Self, <D as Deserializer<'de>>::Error>where
+ D: Deserializer<'de>,
fn deserialize<'de, D>(d: D) -> Result<Self, <D as Deserializer<'de>>::Error>where
+ D: Deserializer<'de>,
Do serde deserialization.
source§impl Serialize for DescriptorId
impl Serialize for DescriptorId
source§impl UpperHex for DescriptorId
impl UpperHex for DescriptorId
impl Copy for DescriptorId
impl Eq for DescriptorId
impl StructuralPartialEq for DescriptorId
Auto Trait Implementations§
impl Freeze for DescriptorId
impl RefUnwindSafe for DescriptorId
impl Send for DescriptorId
impl Sync for DescriptorId
impl Unpin for DescriptorId
impl UnwindSafe for DescriptorId
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> From<T> for T
impl<T> From<T> for T
source§fn from(t: T) -> T
fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html index a578b2837b..24beb02cc6 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_chain/tx_graph/struct.TxGraph.html @@ -276,7 +276,7 @@§Error
trust_predicate: impl FnMut(&OI, &Script) -> bool ) -> BalanceGet the total balance of outpoints that are in chain of chain_tip.
This is the infallible version of try_balance.
Trait Implementations§
source§impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>
impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>
Trait Implementations§
source§impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>
impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I>
source§impl<A: PartialEq> PartialEq for TxGraph<A>
impl<A: PartialEq> PartialEq for TxGraph<A>
impl<A> StructuralPartialEq for TxGraph<A>
Auto Trait Implementations§
impl<A> Freeze for TxGraph<A>
impl<A> RefUnwindSafe for TxGraph<A>where
A: RefUnwindSafe,
impl<A> Send for TxGraph<A>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html
index 772e048ae5..6f84ac3e06 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.BnbLimit.html
@@ -2,7 +2,7 @@
Rounds(usize),
Duration(Duration),
}Expand description
Determines how we should limit rounds of branch and bound.
-Variants§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for BnbLimit
§impl RefUnwindSafe for BnbLimit
§impl Send for BnbLimit
§impl Sync for BnbLimit
§impl Unpin for BnbLimit
§impl UnwindSafe for BnbLimit
Blanket Implementations§
Variants§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for BnbLimit
§impl RefUnwindSafe for BnbLimit
§impl Send for BnbLimit
§impl Sync for BnbLimit
§impl Unpin for BnbLimit
§impl UnwindSafe for BnbLimit
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html
index 54033098a4..717004edae 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html
@@ -2,7 +2,7 @@
ToFee,
ToRecipient,
ToDrain,
-}Variants§
Trait Implementations§
source§impl Clone for ExcessStrategyKind
source§fn clone(&self) -> ExcessStrategyKind
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ExcessStrategyKind
source§impl Display for ExcessStrategyKind
source§impl Hash for ExcessStrategyKind
1.3.0 · source§fn hash_slice<H>(data: &[Self], state: &mut H)where
+}Variants§
Trait Implementations§
source§impl Clone for ExcessStrategyKind
source§fn clone(&self) -> ExcessStrategyKind
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ExcessStrategyKind
source§impl Display for ExcessStrategyKind
source§impl Hash for ExcessStrategyKind
source§impl Ord for ExcessStrategyKind
source§fn cmp(&self, other: &ExcessStrategyKind) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more1.21.0 · source§fn min(self, other: Self) -> Selfwhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
index 502fd1ffe5..3aa459992e 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
@@ -7,7 +7,7 @@
§TargetFee
The target fee (given the feerate) is not met
§MinAbsoluteFee
Min absolute fee is not met
§MinDrainValue
Min drain value is not met
-
Trait Implementations§
source§impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for SelectionConstraint
source§impl Eq for SelectionConstraint
source§impl StructuralPartialEq for SelectionConstraint
Auto Trait Implementations§
§impl Freeze for SelectionConstraint
§impl RefUnwindSafe for SelectionConstraint
§impl Send for SelectionConstraint
§impl Sync for SelectionConstraint
§impl Unpin for SelectionConstraint
§impl UnwindSafe for SelectionConstraint
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
index 8858f44b2f..888e52bff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
@@ -1,4 +1,4 @@
-SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> Any for Twhere
+SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
index d92a311c41..ef6f96d2d4 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
@@ -1,4 +1,4 @@
-EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
+EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
// Required methods
fn full_scan<K: Ord + Clone>(
&self,
@@ -13,7 +13,7 @@
) -> Result<SyncResult, Error>;
}
Expand description
Trait to extend the functionality of [esplora_client::BlockingClient].
Refer to crate-level documentation for more.
-Required Methods§
Required Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl EsploraExt for BlockingClient
source§fn full_scan<K: Ord + Clone>(
&self,
request: FullScanRequest<K>,
stop_gap: usize,
parallel_requests: usize
-) -> Result<FullScanResult<K>, Error>
source§fn sync(
+) -> Result<FullScanResult<K>, Error>
source§fn sync(
&self,
request: SyncRequest,
parallel_requests: usize
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
index ef36d38dd5..a747392a67 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
@@ -1,2 +1,2 @@
-Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
+Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);
Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
index 84c23d6e0b..1a6586014d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
@@ -4,7 +4,7 @@
}Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
§iter_error: IterErrorThe error returned by EntryIter.
-Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
Expand description
Determines how we should limit rounds of branch and bound.
-Variants§
Trait Implementations§
Auto Trait Implementations§
impl Freeze for BnbLimit
impl RefUnwindSafe for BnbLimit
impl Send for BnbLimit
impl Sync for BnbLimit
impl Unpin for BnbLimit
impl UnwindSafe for BnbLimit
Blanket Implementations§
Variants§
Trait Implementations§
Auto Trait Implementations§
impl Freeze for BnbLimit
impl RefUnwindSafe for BnbLimit
impl Send for BnbLimit
impl Sync for BnbLimit
impl Unpin for BnbLimit
impl UnwindSafe for BnbLimit
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> From<T> for T
impl<T> From<T> for T
source§fn from(t: T) -> T
fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html index 54033098a4..717004edae 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.ExcessStrategyKind.html @@ -2,7 +2,7 @@ ToFee, ToRecipient, ToDrain, -}Variants§
Trait Implementations§
source§impl Clone for ExcessStrategyKind
impl Clone for ExcessStrategyKind
source§fn clone(&self) -> ExcessStrategyKind
fn clone(&self) -> ExcessStrategyKind
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for ExcessStrategyKind
impl Debug for ExcessStrategyKind
source§impl Display for ExcessStrategyKind
impl Display for ExcessStrategyKind
source§impl Hash for ExcessStrategyKind
impl Hash for ExcessStrategyKind
1.3.0 · source§fn hash_slice<H>(data: &[Self], state: &mut H)where
+}Variants§
Trait Implementations§
source§impl Clone for ExcessStrategyKind
source§fn clone(&self) -> ExcessStrategyKind
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ExcessStrategyKind
source§impl Display for ExcessStrategyKind
source§impl Hash for ExcessStrategyKind
source§impl Ord for ExcessStrategyKind
source§fn cmp(&self, other: &ExcessStrategyKind) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more1.21.0 · source§fn min(self, other: Self) -> Selfwhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
index 502fd1ffe5..3aa459992e 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
@@ -7,7 +7,7 @@
§TargetFee
The target fee (given the feerate) is not met
§MinAbsoluteFee
Min absolute fee is not met
§MinDrainValue
Min drain value is not met
-
Trait Implementations§
source§impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for SelectionConstraint
source§impl Eq for SelectionConstraint
source§impl StructuralPartialEq for SelectionConstraint
Auto Trait Implementations§
§impl Freeze for SelectionConstraint
§impl RefUnwindSafe for SelectionConstraint
§impl Send for SelectionConstraint
§impl Sync for SelectionConstraint
§impl Unpin for SelectionConstraint
§impl UnwindSafe for SelectionConstraint
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
index 8858f44b2f..888e52bff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
@@ -1,4 +1,4 @@
-SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> Any for Twhere
+SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
index d92a311c41..ef6f96d2d4 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
@@ -1,4 +1,4 @@
-EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
+EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
// Required methods
fn full_scan<K: Ord + Clone>(
&self,
@@ -13,7 +13,7 @@
) -> Result<SyncResult, Error>;
}
Expand description
Trait to extend the functionality of [esplora_client::BlockingClient].
Refer to crate-level documentation for more.
-Required Methods§
Required Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl EsploraExt for BlockingClient
source§fn full_scan<K: Ord + Clone>(
&self,
request: FullScanRequest<K>,
stop_gap: usize,
parallel_requests: usize
-) -> Result<FullScanResult<K>, Error>
source§fn sync(
+) -> Result<FullScanResult<K>, Error>
source§fn sync(
&self,
request: SyncRequest,
parallel_requests: usize
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
index ef36d38dd5..a747392a67 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
@@ -1,2 +1,2 @@
-Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
+Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);
Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
index 84c23d6e0b..1a6586014d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
@@ -4,7 +4,7 @@
}Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
§iter_error: IterErrorThe error returned by EntryIter.
-Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
fn hash_slice<H>(data: &[Self], state: &mut H)where
+}Variants§
Trait Implementations§
source§impl Clone for ExcessStrategyKind
source§fn clone(&self) -> ExcessStrategyKind
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ExcessStrategyKind
source§impl Display for ExcessStrategyKind
source§impl Hash for ExcessStrategyKind
source§impl Ord for ExcessStrategyKind
source§fn cmp(&self, other: &ExcessStrategyKind) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more1.21.0 · source§fn min(self, other: Self) -> Selfwhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
index 502fd1ffe5..3aa459992e 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
@@ -7,7 +7,7 @@
§TargetFee
The target fee (given the feerate) is not met
§MinAbsoluteFee
Min absolute fee is not met
§MinDrainValue
Min drain value is not met
-
Trait Implementations§
source§impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for SelectionConstraint
source§impl Eq for SelectionConstraint
source§impl StructuralPartialEq for SelectionConstraint
Auto Trait Implementations§
§impl Freeze for SelectionConstraint
§impl RefUnwindSafe for SelectionConstraint
§impl Send for SelectionConstraint
§impl Sync for SelectionConstraint
§impl Unpin for SelectionConstraint
§impl UnwindSafe for SelectionConstraint
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
index 8858f44b2f..888e52bff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
@@ -1,4 +1,4 @@
-SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> Any for Twhere
+SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
index d92a311c41..ef6f96d2d4 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
@@ -1,4 +1,4 @@
-EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
+EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
// Required methods
fn full_scan<K: Ord + Clone>(
&self,
@@ -13,7 +13,7 @@
) -> Result<SyncResult, Error>;
}
Expand description
Trait to extend the functionality of [esplora_client::BlockingClient].
Refer to crate-level documentation for more.
-Required Methods§
Required Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl EsploraExt for BlockingClient
source§fn full_scan<K: Ord + Clone>(
&self,
request: FullScanRequest<K>,
stop_gap: usize,
parallel_requests: usize
-) -> Result<FullScanResult<K>, Error>
source§fn sync(
+) -> Result<FullScanResult<K>, Error>
source§fn sync(
&self,
request: SyncRequest,
parallel_requests: usize
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
index ef36d38dd5..a747392a67 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
@@ -1,2 +1,2 @@
-Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
+Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);
Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
index 84c23d6e0b..1a6586014d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
@@ -4,7 +4,7 @@
}Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
§iter_error: IterErrorThe error returned by EntryIter.
-Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
Variants§
Trait Implementations§
source§impl Clone for ExcessStrategyKind
impl Clone for ExcessStrategyKind
source§fn clone(&self) -> ExcessStrategyKind
fn clone(&self) -> ExcessStrategyKind
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for ExcessStrategyKind
impl Debug for ExcessStrategyKind
source§impl Display for ExcessStrategyKind
impl Display for ExcessStrategyKind
source§impl Hash for ExcessStrategyKind
impl Hash for ExcessStrategyKind
source§impl Ord for ExcessStrategyKind
impl Ord for ExcessStrategyKind
source§fn cmp(&self, other: &ExcessStrategyKind) -> Ordering
fn cmp(&self, other: &ExcessStrategyKind) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0 · source§fn min(self, other: Self) -> Selfwhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
index 502fd1ffe5..3aa459992e 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
@@ -7,7 +7,7 @@
§TargetFee
The target fee (given the feerate) is not met
§MinAbsoluteFee
Min absolute fee is not met
§MinDrainValue
Min drain value is not met
-
fn min(self, other: Self) -> Selfwhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
index 502fd1ffe5..3aa459992e 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/enum.SelectionConstraint.html
@@ -7,7 +7,7 @@
§TargetFee
The target fee (given the feerate) is not met
§MinAbsoluteFee
Min absolute fee is not met
§MinDrainValue
Min drain value is not met
-
TargetFee
The target fee (given the feerate) is not met
MinAbsoluteFee
Min absolute fee is not met
MinDrainValue
Min drain value is not met
-Trait Implementations§
source§impl Clone for SelectionConstraint
impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for SelectionConstraint
impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for
self and other values to be equal, and is used
+Trait Implementations§
source§impl Clone for SelectionConstraint
impl Clone for SelectionConstraint
source§fn clone(&self) -> SelectionConstraint
fn clone(&self) -> SelectionConstraint
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for SelectionConstraint
impl Debug for SelectionConstraint
source§impl Display for SelectionConstraint
impl Display for SelectionConstraint
source§impl PartialEq for SelectionConstraint
impl PartialEq for SelectionConstraint
source§fn eq(&self, other: &SelectionConstraint) -> bool
fn eq(&self, other: &SelectionConstraint) -> bool
This method tests for
self and other values to be equal, and is used
by ==.impl Copy for SelectionConstraint
impl Eq for SelectionConstraint
impl StructuralPartialEq for SelectionConstraint
Auto Trait Implementations§
impl Freeze for SelectionConstraint
impl RefUnwindSafe for SelectionConstraint
impl Send for SelectionConstraint
impl Sync for SelectionConstraint
impl Unpin for SelectionConstraint
impl UnwindSafe for SelectionConstraint
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
index 8858f44b2f..888e52bff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
@@ -1,4 +1,4 @@
-SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> Any for Twhere
+SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
index d92a311c41..ef6f96d2d4 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
@@ -1,4 +1,4 @@
-EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
+EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
// Required methods
fn full_scan<K: Ord + Clone>(
&self,
@@ -13,7 +13,7 @@
) -> Result<SyncResult, Error>;
}
Expand description
Trait to extend the functionality of [esplora_client::BlockingClient].
Refer to crate-level documentation for more.
-Required Methods§
Required Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl EsploraExt for BlockingClient
source§fn full_scan<K: Ord + Clone>(
&self,
request: FullScanRequest<K>,
stop_gap: usize,
parallel_requests: usize
-) -> Result<FullScanResult<K>, Error>
source§fn sync(
+) -> Result<FullScanResult<K>, Error>
source§fn sync(
&self,
request: SyncRequest,
parallel_requests: usize
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
index ef36d38dd5..a747392a67 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
@@ -1,2 +1,2 @@
-Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
+Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);
Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
index 84c23d6e0b..1a6586014d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
@@ -4,7 +4,7 @@
}Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
§iter_error: IterErrorThe error returned by EntryIter.
-Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
index 8858f44b2f..888e52bff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_coin_select/struct.SelectionError.html
@@ -1,4 +1,4 @@
-SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> Any for Twhere
+SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
index d92a311c41..ef6f96d2d4 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
@@ -1,4 +1,4 @@
-EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
+EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
// Required methods
fn full_scan<K: Ord + Clone>(
&self,
@@ -13,7 +13,7 @@
) -> Result<SyncResult, Error>;
}
Expand description
Trait to extend the functionality of [esplora_client::BlockingClient].
Refer to crate-level documentation for more.
-Required Methods§
Required Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl EsploraExt for BlockingClient
source§fn full_scan<K: Ord + Clone>(
&self,
request: FullScanRequest<K>,
stop_gap: usize,
parallel_requests: usize
-) -> Result<FullScanResult<K>, Error>
source§fn sync(
+) -> Result<FullScanResult<K>, Error>
source§fn sync(
&self,
request: SyncRequest,
parallel_requests: usize
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
index ef36d38dd5..a747392a67 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
@@ -1,2 +1,2 @@
-Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
+Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);
Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
index 84c23d6e0b..1a6586014d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
@@ -4,7 +4,7 @@
}Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
§iter_error: IterErrorThe error returned by EntryIter.
-Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }Trait Implementations§
source§impl Clone for SelectionError
impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
fn clone(&self) -> SelectionError
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for SelectionError
impl Debug for SelectionError
source§impl Display for SelectionError
impl Display for SelectionError
source§impl Error for SelectionError
impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
Auto Trait Implementations§
impl Freeze for SelectionError
impl RefUnwindSafe for SelectionError
impl Send for SelectionError
impl Sync for SelectionError
impl Unpin for SelectionError
impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> Any for Twhere
+SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
index d92a311c41..ef6f96d2d4 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
@@ -1,4 +1,4 @@
-EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
+EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
// Required methods
fn full_scan<K: Ord + Clone>(
&self,
@@ -13,7 +13,7 @@
) -> Result<SyncResult, Error>;
}
Expand description
Trait to extend the functionality of [esplora_client::BlockingClient].
Refer to crate-level documentation for more.
-Required Methods§
Required Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl EsploraExt for BlockingClient
source§fn full_scan<K: Ord + Clone>(
&self,
request: FullScanRequest<K>,
stop_gap: usize,
parallel_requests: usize
-) -> Result<FullScanResult<K>, Error>
source§fn sync(
+) -> Result<FullScanResult<K>, Error>
source§fn sync(
&self,
request: SyncRequest,
parallel_requests: usize
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
index ef36d38dd5..a747392a67 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
@@ -1,2 +1,2 @@
-Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
+Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);
Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
index 84c23d6e0b..1a6586014d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
@@ -4,7 +4,7 @@
}Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
§iter_error: IterErrorThe error returned by EntryIter.
-Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
impl<T> Any for Twhere
+SelectionError in bdk_coin_select - Rust Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }
Trait Implementations§
source§impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SelectionError
source§impl Display for SelectionError
source§impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for SelectionError
§impl RefUnwindSafe for SelectionError
§impl Send for SelectionError
§impl Sync for SelectionError
§impl Unpin for SelectionError
§impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
index d92a311c41..ef6f96d2d4 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html
@@ -1,4 +1,4 @@
-EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
+EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
// Required methods
fn full_scan<K: Ord + Clone>(
&self,
@@ -13,7 +13,7 @@
) -> Result<SyncResult, Error>;
}
Expand description
Trait to extend the functionality of [esplora_client::BlockingClient].
Refer to crate-level documentation for more.
-Required Methods§
Required Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl EsploraExt for BlockingClient
source§fn full_scan<K: Ord + Clone>(
&self,
request: FullScanRequest<K>,
stop_gap: usize,
parallel_requests: usize
-) -> Result<FullScanResult<K>, Error>
source§fn sync(
+) -> Result<FullScanResult<K>, Error>
source§fn sync(
&self,
request: SyncRequest,
parallel_requests: usize
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
index ef36d38dd5..a747392a67 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
@@ -1,2 +1,2 @@
-Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
+Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);
Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
index 84c23d6e0b..1a6586014d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
@@ -4,7 +4,7 @@
}Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
§iter_error: IterErrorThe error returned by EntryIter.
-Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
Struct bdk_coin_select::SelectionError
source · pub struct SelectionError { /* private fields */ }Trait Implementations§
source§impl Clone for SelectionError
impl Clone for SelectionError
source§fn clone(&self) -> SelectionError
fn clone(&self) -> SelectionError
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for SelectionError
impl Debug for SelectionError
source§impl Display for SelectionError
impl Display for SelectionError
source§impl Error for SelectionError
impl Error for SelectionError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
Auto Trait Implementations§
impl Freeze for SelectionError
impl RefUnwindSafe for SelectionError
impl Send for SelectionError
impl Sync for SelectionError
impl Unpin for SelectionError
impl UnwindSafe for SelectionError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> From<T> for T
impl<T> From<T> for T
source§fn from(t: T) -> T
fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html index d92a311c41..ef6f96d2d4 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/trait.EsploraExt.html @@ -1,4 +1,4 @@ -Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
+EsploraExt in bdk_esplora - Rust Trait bdk_esplora::EsploraExt
source · pub trait EsploraExt {
// Required methods
fn full_scan<K: Ord + Clone>(
&self,
@@ -13,7 +13,7 @@
) -> Result<SyncResult, Error>;
}
Expand description
Trait to extend the functionality of [esplora_client::BlockingClient].
Refer to crate-level documentation for more.
-Required Methods§
Required Methods§
Object Safety§
This trait is not object safe.
Implementations on Foreign Types§
Object Safety§
This trait is not object safe.
Implementations on Foreign Types§
source§impl EsploraExt for BlockingClient
impl EsploraExt for BlockingClient
fn full_scan<K: Ord + Clone>( &self, request: FullScanRequest<K>, stop_gap: usize, parallel_requests: usize -) -> Result<FullScanResult<K>, Error>
fn sync( +) -> Result<FullScanResult<K>, Error>
fn sync(
&self,
request: SyncRequest,
parallel_requests: usize
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
index ef36d38dd5..a747392a67 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_esplora/type.Error.html
@@ -1,2 +1,2 @@
-Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
+Error in bdk_esplora - Rust Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;
Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);
Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for IterError
§impl !RefUnwindSafe for IterError
§impl Send for IterError
§impl Sync for IterError
§impl Unpin for IterError
§impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
index 84c23d6e0b..1a6586014d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html
@@ -4,7 +4,7 @@
}Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
§iter_error: IterErrorThe error returned by EntryIter.
-Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;Expand description
[esplora_client::Error]
Type Alias bdk_esplora::Error
source · pub type Error = Box<Error>;Expand description
[esplora_client::Error]
Aliased Type§
struct Error(/* private fields */);Expand description
Error type for EntryIter.
Variants§
Trait Implementations§
source§impl Error for IterError
impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
Auto Trait Implementations§
impl Freeze for IterError
impl !RefUnwindSafe for IterError
impl Send for IterError
impl Sync for IterError
impl Unpin for IterError
impl !UnwindSafe for IterError
Blanket Implementations§
Trait Implementations§
source§impl Error for IterError
impl Error for IterError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
Auto Trait Implementations§
impl Freeze for IterError
impl !RefUnwindSafe for IterError
impl Send for IterError
impl Sync for IterError
impl Unpin for IterError
impl !UnwindSafe for IterError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> From<T> for T
impl<T> From<T> for T
source§fn from(t: T) -> T
fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html index 84c23d6e0b..1a6586014d 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_file_store/struct.AggregateChangesetsError.html @@ -4,7 +4,7 @@ }Expand description
Error type for Store::aggregate_changesets.
Fields§
§changeset: Option<C>The partially-aggregated changeset.
iter_error: IterErrorThe error returned by EntryIter.
Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
Auto Trait Implementations§
impl<C> Freeze for AggregateChangesetsError<C>where
+Trait Implementations§
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
§impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
§impl<C> Send for AggregateChangesetsError<C>where
C: Send,
§impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
§impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
source§impl<C: Debug> Debug for AggregateChangesetsError<C>
impl<C: Debug> Debug for AggregateChangesetsError<C>
source§impl<C> Display for AggregateChangesetsError<C>
impl<C> Display for AggregateChangesetsError<C>
source§impl<C: Debug> Error for AggregateChangesetsError<C>
impl<C: Debug> Error for AggregateChangesetsError<C>
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
impl<C> Freeze for AggregateChangesetsError<C>where
C: Freeze,
impl<C> !RefUnwindSafe for AggregateChangesetsError<C>
impl<C> Send for AggregateChangesetsError<C>where
C: Send,
impl<C> Sync for AggregateChangesetsError<C>where
C: Sync,
impl<C> Unpin for AggregateChangesetsError<C>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
index 86727d4294..32c2fe81fd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_sqlite/enum.Error.html
@@ -7,7 +7,7 @@
}Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
§Network
Invalid network, cannot change the one already stored in the database.
§Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
index 86474994ea..c3a4667dfd 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html
@@ -2,7 +2,7 @@
SigHashP2wpkh(P2wpkhError),
SigHashTaproot(TaprootError),
DerivationError(Error),
-}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
Expand description
Error that occurs while reading or writing change sets with the SQLite database.
Variants§
Network
Invalid network, cannot change the one already stored in the database.
Sqlite(Error)
SQLite error.
-Trait Implementations§
source§impl Error for Error
impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
Auto Trait Implementations§
impl Freeze for Error
impl !RefUnwindSafe for Error
impl Send for Error
impl Sync for Error
impl Unpin for Error
impl !UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
Auto Trait Implementations§
impl Freeze for Error
impl !RefUnwindSafe for Error
impl Send for Error
impl Sync for Error
impl Unpin for Error
impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> From<T> for T
impl<T> From<T> for T
source§fn from(t: T) -> T
fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html index 86474994ea..c3a4667dfd 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_tmp_plan/enum.SigningError.html @@ -2,7 +2,7 @@ SigHashP2wpkh(P2wpkhError), SigHashTaproot(TaprootError), DerivationError(Error), -}Variants§
Trait Implementations§
source§impl Clone for SigningError
impl Clone for SigningError
source§fn clone(&self) -> SigningError
fn clone(&self) -> SigningError
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for SigningError
impl Debug for SigningError
source§impl Display for SigningError
impl Display for SigningError
source§impl Error for SigningError
impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
source§impl From<Error> for SigningError
impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
impl Freeze for SigningError
impl RefUnwindSafe for SigningError
impl Send for SigningError
impl Sync for SigningError
impl Unpin for SigningError
impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
impl<T> Any for Twhere
+}Variants§
Trait Implementations§
source§impl Clone for SigningError
source§fn clone(&self) -> SigningError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for SigningError
source§impl Display for SigningError
source§impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
§impl Freeze for SigningError
§impl RefUnwindSafe for SigningError
§impl Send for SigningError
§impl Sync for SigningError
§impl Unpin for SigningError
§impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
index 6fb42daec0..15f0077bec 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html
@@ -255,12 +255,12 @@ §Errors
F: FnMut(&'a Pk) -> bool,
Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.§impl Eq for Legacy
§impl StructuralPartialEq for Legacy
Auto Trait Implementations§
§impl Freeze for Legacy
§impl RefUnwindSafe for Legacy
§impl Send for Legacy
§impl Sync for Legacy
§impl Unpin for Legacy
§impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
index 5e8b714fac..4f02256169 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html
@@ -79,8 +79,8 @@
Pk: MiniscriptKey,
Check top level consensus rules.§impl Eq for Segwitv0
§impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
§impl Freeze for Segwitv0
§impl RefUnwindSafe for Segwitv0
§impl Send for Segwitv0
§impl Sync for Segwitv0
§impl Unpin for Segwitv0
§impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0source§fn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
index 46b5c7fb21..c2431ab8e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html
@@ -26,7 +26,7 @@
§Miniscript(Error)
Miniscript error
§Hex(HexToBytesError)
Hex decoding error
§ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
index 43d71a502e..8bac101f36 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html
@@ -12,7 +12,7 @@
§AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
§MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
§IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
source§impl Display for PolicyError
source§impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
Converts to this type from the input type.source§impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Eq for PolicyError
source§impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
§impl Freeze for PolicyError
§impl RefUnwindSafe for PolicyError
§impl Send for PolicyError
§impl Sync for PolicyError
§impl Unpin for PolicyError
§impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
Variants§
Trait Implementations§
source§impl Clone for SigningError
impl Clone for SigningError
source§fn clone(&self) -> SigningError
fn clone(&self) -> SigningError
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for SigningError
impl Debug for SigningError
source§impl Display for SigningError
impl Display for SigningError
source§impl Error for SigningError
impl Error for SigningError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
source§impl From<Error> for SigningError
impl From<Error> for SigningError
source§impl From<P2wpkhError> for SigningError
impl From<P2wpkhError> for SigningError
Auto Trait Implementations§
impl Freeze for SigningError
impl RefUnwindSafe for SigningError
impl Send for SigningError
impl Sync for SigningError
impl Unpin for SigningError
impl UnwindSafe for SigningError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> From<T> for T
impl<T> From<T> for T
source§fn from(t: T) -> T
fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html index 6fb42daec0..15f0077bec 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Descriptor.html @@ -255,12 +255,12 @@§Errors
F: FnMut(&'a Pk) -> bool, Pk: 'a,Run a predicate on every key in the descriptor, returning whether
the predicate returned true for any key
§impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
impl<Pk> From<Bare<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.
§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Bare<Pk>) -> Descriptor<Pk>
fn from(inner: Bare<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.
§impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
impl<Pk> From<Pkh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
fn from(inner: Pkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.
§impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
impl<Pk> From<Sh<Pk>> for Descriptor<Pk>where
Pk: MiniscriptKey,
§fn from(inner: Sh<Pk>) -> Descriptor<Pk>
fn from(inner: Sh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.
§impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
impl<Pk> From<Tr<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.
§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.
§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
- Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.
§impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
impl<Pk> FromStr for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Tr<Pk>) -> Descriptor<Pk>
fn from(inner: Tr<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.
§impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
impl<Pk> From<Wpkh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
fn from(inner: Wpkh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.
§impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
impl<Pk> From<Wsh<Pk>> for Descriptor<Pk>where
+ Pk: MiniscriptKey,
§fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
fn from(inner: Wsh<Pk>) -> Descriptor<Pk>
Converts to this type from the input type.
§impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
impl<Pk> FromStr for Descriptor<Pk>where
Pk: FromStrKey,
§impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
impl<Pk> FromTree for Descriptor<Pk>where
Pk: FromStrKey,
§fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
fn from_tree(top: &Tree<'_>) -> Result<Descriptor<Pk>, Error>
Parse an expression tree into a descriptor.
§impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
impl<Pk> Hash for Descriptor<Pk>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
index fa0ce7b5da..d046385a0d 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more
§Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string
s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
fn into_assets(self) -> Assets
Convert
self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a
DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
fn into_assets(self) -> Assets
Convert
self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a
DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
type Sha256 = Hash
The associated [
bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
type Hash256 = Hash
The associated [
miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
type Ripemd160 = Hash
The associated [
bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
type Hash160 = Hash
The associated [
bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
index f296525bec..45513d6ff1 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Legacy.html
@@ -82,8 +82,8 @@
Pk: MiniscriptKey,Check top level consensus rules.
impl Eq for Legacy
impl StructuralPartialEq for Legacy
Auto Trait Implementations§
impl Freeze for Legacy
impl RefUnwindSafe for Legacy
impl Send for Legacy
impl Sync for Legacy
impl Unpin for Legacy
impl UnwindSafe for Legacy
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
fn as_enum() -> ScriptContextEnum
Returns the
ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
fn is_segwit_v0() -> bool
Returns whether the script context is
Segwitv0source§fn is_taproot() -> bool
fn is_taproot() -> bool
Returns whether the script context is
Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
impl<T> From<T> for T
source§fn from(t: T) -> T
fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
fn as_enum() -> ScriptContextEnum
Returns the
ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
fn is_segwit_v0() -> bool
Returns whether the script context is
Segwitv0source§fn is_taproot() -> bool
fn is_taproot() -> bool
Returns whether the script context is
Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html index 5e8b714fac..4f02256169 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/enum.Segwitv0.html @@ -79,8 +79,8 @@ Pk: MiniscriptKey,
Check top level consensus rules.
impl Eq for Segwitv0
impl StructuralPartialEq for Segwitv0
Auto Trait Implementations§
impl Freeze for Segwitv0
impl RefUnwindSafe for Segwitv0
impl Send for Segwitv0
impl Sync for Segwitv0
impl Unpin for Segwitv0
impl UnwindSafe for Segwitv0
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
impl<Ctx> ExtScriptContext for Ctxwhere
- Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
fn as_enum() -> ScriptContextEnum
Returns the
ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
fn is_segwit_v0() -> bool
Returns whether the script context is
Segwitv0source§fn is_taproot() -> bool
fn is_taproot() -> bool
Returns whether the script context is
Tap, aka Taproot or Segwit V1source§impl<T> From<T> for T
impl<T> From<T> for T
source§fn from(t: T) -> T
fn from(t: T) -> T
Returns the argument unchanged.
+ T: ?Sized,source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
impl<Ctx> ExtScriptContext for Ctxwhere
+ Ctx: ScriptContext + 'static,
source§fn as_enum() -> ScriptContextEnum
fn as_enum() -> ScriptContextEnum
Returns the
ScriptContext as a ScriptContextEnumsource§fn is_segwit_v0() -> bool
fn is_segwit_v0() -> bool
Returns whether the script context is
Segwitv0source§fn is_taproot() -> bool
fn is_taproot() -> bool
Returns whether the script context is
Tap, aka Taproot or Segwit V1source§impl<T, U> Into<U> for Twhere
U: From<T>,
impl<T, U> Into<U> for Twhere
U: From<T>,
source§fn into(self) -> U
fn into(self) -> U
Calls U::from(self).
That is, this conversion is whatever the implementation of diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html index 46b5c7fb21..c2431ab8e2 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/error/enum.Error.html @@ -26,7 +26,7 @@
Miniscript(Error)
Miniscript error
Hex(HexToBytesError)
Hex decoding error
ExternalAndInternalAreTheSame
The provided wallet descriptors are identical
-Trait Implementations§
source§impl Error for Error
impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
source§impl From<Error> for CreateTxError
impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
fn from(err: PolicyError) -> Self
Converts to this type from the input type.
Auto Trait Implementations§
impl Freeze for Error
impl RefUnwindSafe for Error
impl Send for Error
impl Sync for Error
impl Unpin for Error
impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
source§impl From<Error> for CreateTxError
impl From<Error> for CreateTxError
source§impl From<PolicyError> for Error
impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
fn from(err: PolicyError) -> Self
Converts to this type from the input type.
Auto Trait Implementations§
impl Freeze for Error
impl RefUnwindSafe for Error
impl Send for Error
impl Sync for Error
impl Unpin for Error
impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> From<T> for T
impl<T> From<T> for T
source§fn from(t: T) -> T
fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html index 43d71a502e..8bac101f36 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/descriptor/policy/enum.PolicyError.html @@ -12,7 +12,7 @@AddOnPartialComplete
Can not add to an item that is Satisfaction::PartialComplete
MixedTimelockUnits
Can not merge CSV or timelock values unless both are less than or both are equal or greater than 500_000_000
IncompatibleConditions
Incompatible conditions (not currently used)
-Trait Implementations§
source§impl Debug for PolicyError
impl Debug for PolicyError
source§impl Display for PolicyError
impl Display for PolicyError
source§impl Error for PolicyError
impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
source§impl From<PolicyError> for CreateTxError
impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
fn from(err: PolicyError) -> Self
Converts to this type from the input type.
source§impl From<PolicyError> for Error
impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
fn from(err: PolicyError) -> Self
Converts to this type from the input type.
source§impl PartialEq for PolicyError
impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
fn eq(&self, other: &PolicyError) -> bool
This method tests for
self and other values to be equal, and is used
+Trait Implementations§
source§impl Debug for PolicyError
impl Debug for PolicyError
source§impl Display for PolicyError
impl Display for PolicyError
source§impl Error for PolicyError
impl Error for PolicyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
1.0.0 · source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()
source§impl From<PolicyError> for CreateTxError
impl From<PolicyError> for CreateTxError
source§fn from(err: PolicyError) -> Self
fn from(err: PolicyError) -> Self
Converts to this type from the input type.
source§impl From<PolicyError> for Error
impl From<PolicyError> for Error
source§fn from(err: PolicyError) -> Self
fn from(err: PolicyError) -> Self
Converts to this type from the input type.
source§impl PartialEq for PolicyError
impl PartialEq for PolicyError
source§fn eq(&self, other: &PolicyError) -> bool
fn eq(&self, other: &PolicyError) -> bool
This method tests for
self and other values to be equal, and is used
by ==.impl Eq for PolicyError
impl StructuralPartialEq for PolicyError
Auto Trait Implementations§
impl Freeze for PolicyError
impl RefUnwindSafe for PolicyError
impl Send for PolicyError
impl Sync for PolicyError
impl Unpin for PolicyError
impl UnwindSafe for PolicyError
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
impl<T> Borrow<T> for Twhere
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 b08c21566e..83d163d6f5 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
@@ -57,30 +57,28 @@ §Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
index e85af60660..eb10b74bd5 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorKey.html
@@ -1,11 +1,11 @@
-DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn
§Persistence
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}
+// Get a new address to receive bitcoin.
+let receive_address = wallet.reveal_next_address(KeychainKind::External);
+// Persist staged wallet data changes to the file store.
+let staged_changeset = wallet.take_staged();
+if let Some(changeset) = staged_changeset {
+ db.append_changeset(&changeset)
+ .expect("must commit changes to database");
+}
+println!("Your new receive address is: {}", receive_address.address);
use bdk_wallet::{bitcoin::Network, KeychainKind, wallet::{ChangeSet, Wallet}};
-fn main() {
- // Open or create a new file store for wallet data.
- let mut db =
- bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
- .expect("create store");
+// Open or create a new file store for wallet data.
+let mut db =
+ bdk_file_store::Store::<ChangeSet>::open_or_create_new(b"magic_bytes", "/tmp/my_wallet.db")
+ .expect("create store");
- // Create a wallet with initial wallet data read from the file store.
- let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
- let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
- let changeset = db.aggregate_changesets().expect("changeset loaded");
- let mut wallet =
- Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
- .expect("create or load wallet");
+// Create a wallet with initial wallet data read from the file store.
+let descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/0/*)";
+let change_descriptor = "wpkh(tprv8ZgxMBicQKsPdcAqYBpzAFwU5yxBUo88ggoBqu1qPcHUfSbKK1sKMLmC7EAk438btHQrSdu3jGGQa6PA71nvH5nkDexhLteJqkM4dQmWF9g/84'/1'/0'/1/*)";
+let changeset = db.aggregate_changesets().expect("changeset loaded");
+let mut wallet =
+ Wallet::new_or_load(descriptor, change_descriptor, changeset, Network::Testnet)
+ .expect("create or load wallet");
- // Get a new address to receive bitcoin.
- let receive_address = wallet.reveal_next_address(KeychainKind::External);
- // Persist staged wallet data changes to the file store.
- let staged_changeset = wallet.take_staged();
- if let Some(changeset) = staged_changeset {
- db.append_changeset(&changeset)
- .expect("must commit changes to database");
- }
- println!("Your new receive address is: {}", receive_address.address);
-}Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
+DescriptorKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::DescriptorKey
source · pub enum DescriptorKey<Ctx: ScriptContext> {
// some variants omitted
}
Expand description
Container for public or secret keys
-Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
-sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
-sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
-Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
+Implementations§
source§impl<Ctx: ScriptContext> DescriptorKey<Ctx>
sourcepub fn from_public(public: DescriptorPublicKey, networks: ValidNetworks) -> Self
Create an instance given a public key and a set of valid networks
+sourcepub fn from_secret(secret: DescriptorSecretKey, networks: ValidNetworks) -> Self
Create an instance given a secret key and a set of valid networks
+sourcepub fn override_valid_networks(self, networks: ValidNetworks) -> Self
Override the computed set of valid networks
+Trait Implementations§
source§impl<Ctx: Debug + ScriptContext> Debug for DescriptorKey<Ctx>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<Ctx> Freeze for DescriptorKey<Ctx>
§impl<Ctx> RefUnwindSafe for DescriptorKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for DescriptorKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for DescriptorKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for DescriptorKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
index 6bfda325fd..b6e1d7c3b2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorPublicKey.html
@@ -52,7 +52,7 @@ §Errors
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>Parses a string s to return a value of this type. Read more§impl Hash for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§impl IntoAssets for DescriptorPublicKey
§fn into_assets(self) -> Assets
Convert self into a Assets structsource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl MiniscriptKey for DescriptorPublicKey
§type Sha256 = Hash
The associated [bitcoin::hashes::sha256::Hash] for this [MiniscriptKey], used in the
sha256 fragment.§type Hash256 = Hash
The associated [miniscript::hash256::Hash] for this [MiniscriptKey], used in the
hash256 fragment.§type Ripemd160 = Hash
The associated [bitcoin::hashes::ripemd160::Hash] for this [MiniscriptKey] type, used
in the ripemd160 fragment.§type Hash160 = Hash
The associated [bitcoin::hashes::hash160::Hash] for this [MiniscriptKey] type, used in
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
index afb4e9b8db..598766547f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.DescriptorSecretKey.html
@@ -23,7 +23,7 @@
path.
Trait Implementations§
§impl Clone for DescriptorSecretKey
§fn clone(&self) -> DescriptorSecretKey
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more§impl Debug for DescriptorSecretKey
§impl Display for DescriptorSecretKey
§impl FromStr for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
+) -> Result<DescriptorSecretKey, <DescriptorSecretKey as FromStr>::Err>Parses a string s to return a value of this type. Read moresource§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext§impl PartialEq for DescriptorSecretKey
§fn eq(&self, other: &DescriptorSecretKey) -> bool
This method tests for self and other values to be equal, and is used
by ==.§impl Eq for DescriptorSecretKey
§impl StructuralPartialEq for DescriptorSecretKey
Auto Trait Implementations§
§impl Freeze for DescriptorSecretKey
§impl RefUnwindSafe for DescriptorSecretKey
§impl Send for DescriptorSecretKey
§impl Sync for DescriptorSecretKey
§impl Unpin for DescriptorSecretKey
§impl UnwindSafe for DescriptorSecretKey
Blanket Implementations§
source§impl<T> Borrow<T> for Twhere
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
index 6e9aad882f..4dc408b9dc 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ExtendedKey.html
@@ -1,4 +1,4 @@
-ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
+ExtendedKey in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ExtendedKey
source · pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
Private((Xpriv, PhantomData<Ctx>)),
Public((Xpub, PhantomData<Ctx>)),
}
Expand description
Enum for extended keys that can be either xprv or xpub
@@ -7,22 +7,22 @@
Defaults to the Legacy context.
Variants§
§Private((Xpriv, PhantomData<Ctx>))
A private extended key, aka an xprv
§Public((Xpub, PhantomData<Ctx>))
A public extended key, aka an xpub
-Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
-sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
+
Implementations§
source§impl<Ctx: ScriptContext> ExtendedKey<Ctx>
sourcepub fn has_secret(&self) -> bool
Return whether or not the key contains the private data
+sourcepub fn into_xprv(self, network: Network) -> Option<Xpriv>
Transform the ExtendedKey into an Xpriv for the
given [Network], if the key contains the private data
-sourcepub fn into_xpub<C: Signing>(
self,
network: Network,
secp: &Secp256k1<C>
) -> Xpub
Transform the ExtendedKey into an Xpub for the
given [Network]
-Trait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
-source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeyTrait Implementations§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
+key origin and derivation path
source§impl<Ctx: ScriptContext> From<Xpriv> for ExtendedKey<Ctx>
source§impl<Ctx: ScriptContext> From<Xpub> for ExtendedKey<Ctx>
Auto Trait Implementations§
§impl<Ctx> Freeze for ExtendedKey<Ctx>
§impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx>where
Ctx: RefUnwindSafe,
§impl<Ctx> Send for ExtendedKey<Ctx>where
Ctx: Send,
§impl<Ctx> Sync for ExtendedKey<Ctx>where
Ctx: Sync,
§impl<Ctx> Unpin for ExtendedKey<Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
index d4787f644c..1ad7a50661 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.KeyError.html
@@ -1,4 +1,4 @@
-KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
+KeyError in bdk_wallet::keys - Rust Enum bdk_wallet::keys::KeyError
source · pub enum KeyError {
InvalidScriptContext,
InvalidNetwork,
InvalidChecksum,
@@ -12,7 +12,7 @@
§Message(String)
Custom error message
§Bip32(Error)
BIP32 error
§Miniscript(Error)
Miniscript error
-
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
Trait Implementations§
source§impl Error for KeyError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for KeyError
§impl RefUnwindSafe for KeyError
§impl Send for KeyError
§impl Sync for KeyError
§impl Unpin for KeyError
§impl UnwindSafe for KeyError
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
index 05356abfa7..44a688a401 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/enum.ScriptContextEnum.html
@@ -1,4 +1,4 @@
-ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
+ScriptContextEnum in bdk_wallet::keys - Rust Enum bdk_wallet::keys::ScriptContextEnum
source · pub enum ScriptContextEnum {
Legacy,
Segwitv0,
Tap,
@@ -6,12 +6,12 @@
Variants§
Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
-sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
-sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
-Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
+Implementations§
source§impl ScriptContextEnum
sourcepub fn is_legacy(&self) -> bool
Returns whether the script context is ScriptContextEnum::Legacy
+sourcepub fn is_segwit_v0(&self) -> bool
Returns whether the script context is ScriptContextEnum::Segwitv0
+sourcepub fn is_taproot(&self) -> bool
Returns whether the script context is ScriptContextEnum::Tap
+Trait Implementations§
source§impl Clone for ScriptContextEnum
source§fn clone(&self) -> ScriptContextEnum
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for ScriptContextEnum
source§impl PartialEq for ScriptContextEnum
source§fn eq(&self, other: &ScriptContextEnum) -> bool
This method tests for self and other values to be equal, and is used
by ==.source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl Copy for ScriptContextEnum
source§impl Eq for ScriptContextEnum
source§impl StructuralPartialEq for ScriptContextEnum
Auto Trait Implementations§
§impl Freeze for ScriptContextEnum
§impl RefUnwindSafe for ScriptContextEnum
§impl Send for ScriptContextEnum
§impl Sync for ScriptContextEnum
§impl Unpin for ScriptContextEnum
§impl UnwindSafe for ScriptContextEnum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
index e192f6d87d..77f03324cf 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/fn.any_network.html
@@ -1,2 +1,2 @@
-any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
+any_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::any_network
source · pub fn any_network() -> ValidNetworks
Expand description
Create a set containing mainnet, testnet, signet, and regtest
mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
+mainnet_network in bdk_wallet::keys - Rust Function bdk_wallet::keys::mainnet_network
source · pub fn mainnet_network() -> ValidNetworks
Expand description
Create a set only containing mainnet
merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
+merge_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::merge_networks
source · pub fn merge_networks(a: &ValidNetworks, b: &ValidNetworks) -> ValidNetworks
Expand description
Compute the intersection of two sets
test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
+test_networks in bdk_wallet::keys - Rust Function bdk_wallet::keys::test_networks
source · pub fn test_networks() -> ValidNetworks
Expand description
Create a set containing testnet and regtest
bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
+bdk_wallet::keys - Rust Module bdk_wallet::keys
source · Expand description
Key formats
Structs§
- Output of a
GeneratableKey key generation - Options for generating a [
PrivateKey] - A descriptor [
bitcoin::PrivateKey] with optional origin information. - A descriptor
SinglePubKey with optional origin information. - Contents of a “sortedmulti” descriptor
Enums§
- Container for public or secret keys
- The descriptor pubkey, either a single pubkey or an xpub.
- The descriptor secret key, either a single private key or an xprv.
- Enum for extended keys that can be either
xprv or xpub - Errors thrown while working with
keys - Enum representation of the known valid
ScriptContexts - Single public key without any origin or range information.
Traits§
- Trait for keys that can be derived.
- Trait that adds extra useful methods to
ScriptContexts - Trait that allows generating a key with the default options
- Trait for keys that can be generated
- Trait for objects that can be turned into a public or secret
DescriptorKey - The ScriptContext for Miniscript. Additional type information associated with
miniscript that is used for carrying out checks that dependent on the
context under which the script is used.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
index 8e2b189814..a63e290833 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.GeneratedKey.html
@@ -1,15 +1,15 @@
-
GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
-Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+GeneratedKey in bdk_wallet::keys - Rust Struct bdk_wallet::keys::GeneratedKey
source · pub struct GeneratedKey<K, Ctx: ScriptContext> { /* private fields */ }
Expand description
Output of a GeneratableKey key generation
+Implementations§
source§impl<K, Ctx: ScriptContext> GeneratedKey<K, Ctx>
Trait Implementations§
source§impl<K: Clone, Ctx: ScriptContext> Clone for GeneratedKey<K, Ctx>
source§fn clone(&self) -> GeneratedKey<K, Ctx>
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl<K, Ctx: ScriptContext> Deref for GeneratedKey<K, Ctx>
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
+ K: DerivableKey<Ctx>,
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKeysource§fn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
-key origin and derivation pathsource§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+key origin and derivation path
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
+ K: IntoDescriptorKey<Ctx>,
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContextAuto Trait Implementations§
§impl<K, Ctx> Freeze for GeneratedKey<K, Ctx>where
K: Freeze,
§impl<K, Ctx> RefUnwindSafe for GeneratedKey<K, Ctx>where
K: RefUnwindSafe,
Ctx: RefUnwindSafe,
§impl<K, Ctx> Send for GeneratedKey<K, Ctx>where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
index 7fdd8a4578..befb16e539 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/struct.PrivateKeyGenerateOptions.html
@@ -1,9 +1,9 @@
-PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
+PrivateKeyGenerateOptions in bdk_wallet::keys - Rust Struct bdk_wallet::keys::PrivateKeyGenerateOptions
source · pub struct PrivateKeyGenerateOptions {
pub compressed: bool,
}
Expand description
Options for generating a [PrivateKey]
Defaults to creating compressed keys, which save on-chain bytes and fees
Fields§
§compressed: boolWhether the generated key should be “compressed” or not
-Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> Any for Twhere
+Trait Implementations§
source§impl Clone for PrivateKeyGenerateOptions
source§fn clone(&self) -> PrivateKeyGenerateOptions
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for PrivateKeyGenerateOptions
source§impl Default for PrivateKeyGenerateOptions
source§impl Copy for PrivateKeyGenerateOptions
Auto Trait Implementations§
§impl Freeze for PrivateKeyGenerateOptions
§impl RefUnwindSafe for PrivateKeyGenerateOptions
§impl Send for PrivateKeyGenerateOptions
§impl Sync for PrivateKeyGenerateOptions
§impl Unpin for PrivateKeyGenerateOptions
§impl UnwindSafe for PrivateKeyGenerateOptions
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
index e5891209ea..44f701039f 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.DerivableKey.html
@@ -1,4 +1,4 @@
-DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
+DerivableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::DerivableKey
source · pub trait DerivableKey<Ctx: ScriptContext = Legacy>: Sized {
// Required method
fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>;
@@ -86,14 +86,14 @@ §Examples
Ok(descriptor_key.override_valid_networks(any_network()))
}
}
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
-Provided Methods§
Required Methods§
sourcefn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Consume self and turn it into an ExtendedKey
+Provided Methods§
sourcefn into_descriptor_key(
self,
origin: Option<KeySource>,
derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>
Consume self and turn it into a DescriptorKey by adding the extra metadata, such as
key origin and derivation path
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
+
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpriv
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for Xpub
source§fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> DerivableKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: DerivableKey<Ctx>,
source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
+ K: DerivableKey<Ctx>,source§impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>
Identity conversion
ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
+ExtScriptContext in bdk_wallet::keys - Rust Trait bdk_wallet::keys::ExtScriptContext
source · pub trait ExtScriptContext: ScriptContext {
// Required method
fn as_enum() -> ScriptContextEnum;
@@ -7,8 +7,8 @@
fn is_segwit_v0() -> bool { ... }
fn is_taproot() -> bool { ... }
}
Expand description
Trait that adds extra useful methods to ScriptContexts
-Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
-Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
-sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
Required Methods§
sourcefn as_enum() -> ScriptContextEnum
Returns the ScriptContext as a ScriptContextEnum
+Provided Methods§
sourcefn is_segwit_v0() -> bool
Returns whether the script context is Segwitv0
+sourcefn is_taproot() -> bool
Returns whether the script context is Tap, aka Taproot or Segwit V1
+Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx: ScriptContext + 'static> ExtScriptContext for Ctx
\ No newline at end of file
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
index d2d16f8508..a12d1282e2 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableDefaultOptions.html
@@ -1,4 +1,4 @@
-GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>where
+GeneratableDefaultOptions in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableDefaultOptions
source · pub trait GeneratableDefaultOptions<Ctx>: GeneratableKey<Ctx>{
// Provided methods
@@ -6,13 +6,21 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
fn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait that allows generating a key with the default options
This trait is automatically implemented if the GeneratableKey::Options implements Default.
-Provided Methods§
Provided Methods§
sourcefn generate_with_entropy_default(
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a given entropy
-sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
-Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for Kwhere
+sourcefn generate_default() -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses the thread-local random number generator.
+sourcefn generate_default_with_aux_rand(
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key with the default options and a random entropy
+Uses a provided random number generator (rng).
+
Object Safety§
This trait is not object safe.Implementors§
source§impl<Ctx, K> GeneratableDefaultOptions<Ctx> for K
Automatic implementation of GeneratableDefaultOptions for GeneratableKeys where
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
index 7110824ef7..38004fde09 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/keys/trait.GeneratableKey.html
@@ -1,4 +1,4 @@
-
GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
+GeneratableKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::GeneratableKey
source · pub trait GeneratableKey<Ctx: ScriptContext>: Sized {
type Entropy: AsMut<[u8]> + Default;
type Options;
type Error: Debug;
@@ -9,30 +9,40 @@
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>;
- // Provided method
+ // Provided methods
fn generate(
options: Self::Options
) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
+ fn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+ ) -> Result<GeneratedKey<Self, Ctx>, Self::Error> { ... }
}
Expand description
Trait for keys that can be generated
The same rules about ScriptContext and ValidNetworks from IntoDescriptorKey apply.
This trait is particularly useful when combined with DerivableKey: if Self
implements it, the returned GeneratedKey will also implement it. The same is true for
IntoDescriptorKey: the generated keys can be directly used in descriptors if Self is also
IntoDescriptorKey.
-Required Associated Types§
Required Methods§
Required Associated Types§
Required Methods§
sourcefn generate_with_entropy(
options: Self::Options,
entropy: Self::Entropy
) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the extra options and the entropy
-Provided Methods§
Provided Methods§
Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
§type Entropy = [u8; 32]
§type Options = PrivateKeyGenerateOptions
§type Error = Error
source§fn generate_with_entropy(
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses the thread-local random number generator.
+sourcefn generate_with_aux_rand(
+ options: Self::Options,
+ rng: &mut (impl CryptoRng + RngCore)
+) -> Result<GeneratedKey<Self, Ctx>, Self::Error>
Generate a key given the options with random entropy.
+Uses a provided random number generator (rng).
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for PrivateKey
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
source§impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Xpriv
Implementors§
IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
+IntoDescriptorKey in bdk_wallet::keys - Rust Trait bdk_wallet::keys::IntoDescriptorKey
source · pub trait IntoDescriptorKey<Ctx: ScriptContext>: Sized {
// Required method
fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>;
}
Expand description
Trait for objects that can be turned into a public or secret DescriptorKey
@@ -103,8 +103,8 @@ §Examples
let (descriptor, _, _) = bdk_wallet::descriptor!(pkh(key))?;
// ^^^^^ changing this to `wpkh` would make it compile
-Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
-Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
+Required Methods§
sourcefn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Turn the key into a DescriptorKey within the requested ScriptContext
+Object Safety§
This trait is not object safe.Implementations on Foreign Types§
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for &str
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PrivateKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for PublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for XOnlyPublicKey
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
source§impl<Ctx: ScriptContext, T: DerivableKey<Ctx>> IntoDescriptorKey<Ctx> for (T, KeySource, DerivationPath)
source§fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>
Implementors§
source§impl<Ctx, K> IntoDescriptorKey<Ctx> for GeneratedKey<K, Ctx>where
Ctx: ScriptContext,
- K: IntoDescriptorKey<Ctx>,
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
-source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorKey<Ctx>
The “identity” conversion is used internally by some bdk_wallet::fragments
+source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey
source§impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorSecretKey
ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
+ValidNetworks in bdk_wallet::keys - Rust Type Alias bdk_wallet::keys::ValidNetworks
source · pub type ValidNetworks = HashSet<Network>;
Expand description
Set of valid networks for a key
Aliased Type§
struct ValidNetworks { /* private fields */ }
Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
+Error in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Error
source · pub enum Error {
InsufficientFunds {
needed: u64,
available: u64,
@@ -13,7 +13,7 @@
the desired outputs plus fee, if there is not such combination this error is thrown
§BnBTotalTriesExceeded
Branch and bound coin selection possible attempts with sufficiently big UTXO set could grow
exponentially, thus a limit is set, and when hit, this error is thrown
-
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
Trait Implementations§
source§impl Error for Error
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
index e4b6ea33ea..f3f48f4d26 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/enum.Excess.html
@@ -1,4 +1,4 @@
-Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
+Excess in bdk_wallet::wallet::coin_selection - Rust Enum bdk_wallet::wallet::coin_selection::Excess
source · pub enum Excess {
NoChange {
dust_threshold: u64,
remaining_amount: u64,
@@ -16,7 +16,7 @@
§Change
It’s possible to create spendable output from excess using the current drain output
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for Excess
§impl RefUnwindSafe for Excess
§impl Send for Excess
§impl Sync for Excess
§impl Unpin for Excess
§impl UnwindSafe for Excess
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
index e433ddd9a6..5bc7d6d523 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/fn.decide_change.html
@@ -1,4 +1,4 @@
-decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
+decide_change in bdk_wallet::wallet::coin_selection - Rust Function bdk_wallet::wallet::coin_selection::decide_change
source · pub fn decide_change(
remaining_amount: u64,
fee_rate: FeeRate,
drain_script: &Script
diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
index 201b3ef630..721bb37f40 100644
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk_wallet/wallet/coin_selection/struct.BranchAndBoundCoinSelection.html
@@ -1,14 +1,14 @@
-BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
+BranchAndBoundCoinSelection in bdk_wallet::wallet::coin_selection - Rust pub struct BranchAndBoundCoinSelection { /* private fields */ }
Expand description
Branch and bound coin selection
Code adapted from Bitcoin Core’s implementation and from Mark Erhardt Master’s Thesis: http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf
-Implementations§
source§impl BranchAndBoundCoinSelection
sourcepub fn