Enum bdk::descriptor::Descriptor

pub enum Descriptor<Pk>where
    Pk: MiniscriptKey,{
+

`Descriptor`

`Enum bdk::descriptor::Descriptor`

pub enum Descriptor<Pk>where
    Pk: MiniscriptKey,{
     Bare(Bare<Pk>),
     Pkh(Pkh<Pk>),
     Wpkh(Wpkh<Pk>),
@@ -64,7 +64,7 @@ that input was satisfied with the largest possible witness:
 â
for i in 0..transaction.input.len() {
     assert_eq!(
         descriptor_for_input[i].max_weight_to_satisfy(),
-        transaction.input[i].segwit_weight() - Txin::default().segwit_weight()
+        transaction.input[i].segwit_weight() - TxIn::default().segwit_weight()
     );
 }
 Instead, for legacy transactions, the following will hold for each input
@@ -73,7 +73,7 @@ if that input was satisfied with the largest possible witness:
 â
for i in 0..transaction.input.len() {
     assert_eq!(
         descriptor_for_input[i].max_weight_to_satisfy(),
-        transaction.input[i].legacy_weight() - Txin::default().legacy_weight()
+        transaction.input[i].legacy_weight() - TxIn::default().legacy_weight()
     );
 }
 Assumes all ECDSA signatures are 73 bytes, including push opcode and
@@ -119,6 +119,10 @@ construct one using the satisfier S.

`pub fn satisfy<S>(&self, txin: &mut TxIn, satisfier: S) -> Result<(), Error>where S: Satisfier<Pk>,`

Attempts to produce a non-malleable satisfying witness and scriptSig to spend an output controlled by the given descriptor; add the data to a given TxIn output.

Â§impl Descriptor<DefiniteDescriptorKey>

`pub fn plan<P>( self, provider: &P ) -> Result<Plan, Descriptor<DefiniteDescriptorKey>>where P: AssetProvider<DefiniteDescriptorKey>,`

Returns a plan if the provided assets are sufficient to produce a non-malleable satisfaction


+If the assets arenât sufficient for generating a Plan, the descriptor is returned
+

`pub fn plan_mall<P>( self, provider: &P ) -> Result<Plan, Descriptor<DefiniteDescriptorKey>>where P: AssetProvider<DefiniteDescriptorKey>,`

Returns a plan if the provided assets are sufficient to produce a malleable satisfaction


+If the assets arenât sufficient for generating a Plan, the descriptor is returned

Â§impl Descriptor<DescriptorPublicKey>

`pub fn is_deriveable(&self) -> bool`

ðDeprecated: use has_wildcards instead

Whether or not the descriptor has any wildcards

`pub fn has_wildcard(&self) -> bool`

Whether or not the descriptor has any wildcards i.e. /*.

`pub fn at_derivation_index( &self, index: u32 ) -> Result<Descriptor<DefiniteDescriptorKey>, ConversionError>`

Replaces all wildcards (i.e. /*) in the descriptor with a particular derivation index, @@ -139,10 +143,10 @@ default(0x02) y-coordinate.


 See at_derivation_index and [derived_descriptor] for more documentation.
 Errors
 This function will return an error if hardened derivation is attempted.
-

`pub fn parse_descriptor<C>( secp: &Secp256k1<C>, s: &str ) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>where C: Signing,`

Parse a descriptor that may contain secret keys

`pub fn parse_descriptor<C>( secp: &Secp256k1<C>, s: &str ) -> Result<(Descriptor<DescriptorPublicKey>, BTreeMap<DescriptorPublicKey, DescriptorSecretKey, Global>), Error>where C: Signing,`

Parse a descriptor that may contain secret keys


 Internally turns every secret key found into the corresponding public key and then returns a
 a descriptor that only contains public keys and a map to lookup the secret key given a public key.
-

`pub fn to_string_with_secret( &self, key_map: &HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState> ) -> String`

Serialize a descriptor to string with its secret keys

`pub fn to_string_with_secret( &self, key_map: &BTreeMap<DescriptorPublicKey, DescriptorSecretKey, Global> ) -> String`

Serialize a descriptor to string with its secret keys

`pub fn find_derivation_index_for_spk<C>( &self, secp: &Secp256k1<C>, script_pubkey: &Script, range: Range<u32> ) -> Result<Option<(u32, Descriptor<PublicKey>)>, ConversionError>where C: Verification,`

Utility method for deriving the descriptor at each index in a range to find one matching script_pubkey.


 If it finds a match then it returns the index it was derived at and the concrete
@@ -153,7 +157,7 @@ returned will be meaningless).

`pub fn into_single_descriptors( self ) -> Result<Vec<Descriptor<DescriptorPublicKey>, Global>, Error>`

Get as many descriptors as different paths in this descriptor.


 For multipath descriptors it will return as many descriptors as there is
 âparallelâ paths. For regular descriptors it will just return itself.
-

Â§impl Descriptor<DefiniteDescriptorKey>

`pub fn derived_descriptor<C>( &self, secp: &Secp256k1<C> ) -> Result<Descriptor<PublicKey>, ConversionError>where C: Verification,`

Convert all the public keys in the descriptor to [bitcoin::PublicKey] by deriving them or +

Â§impl Descriptor<DefiniteDescriptorKey>

`pub fn derived_descriptor<C>( &self, secp: &Secp256k1<C> ) -> Result<Descriptor<PublicKey>, ConversionError>where C: Verification,`

Convert all the public keys in the descriptor to [bitcoin::PublicKey] by deriving them or otherwise converting them. All [bitcoin::secp256k1::XOnlyPublicKey]s are converted to by adding a default(0x02) y-coordinate.


 Examples
@@ -169,11 +173,11 @@ default(0x02) y-coordinate.
 assert_eq!(result.to_string(), "tr(03cc8a4bc64d897bddc5fbc2f670f7a8ba0b386779106cf1223c6fc5d7cd6fc115)#6qm9h8ym");


 Errors
 This function will return an error if hardened derivation is attempted.
-

Enum bdk::descriptor::Descriptor

Enum bdk::descriptor::Descriptor

pub fn satisfy<S>(&self, txin: &mut TxIn, satisfier: S) -> Result<(), Error>where S: Satisfier<Pk>,

impl Descriptor<DefiniteDescriptorKey>

pub fn plan<P>( self, provider: &P) -> Result<Plan, Descriptor<DefiniteDescriptorKey>>where P: AssetProvider<DefiniteDescriptorKey>,

pub fn plan_mall<P>( self, provider: &P) -> Result<Plan, Descriptor<DefiniteDescriptorKey>>where P: AssetProvider<DefiniteDescriptorKey>,

impl Descriptor<DescriptorPublicKey>

pub fn is_deriveable(&self) -> bool

pub fn has_wildcard(&self) -> bool

pub fn at_derivation_index( &self, index: u32) -> Result<Descriptor<DefiniteDescriptorKey>, ConversionError>

pub fn parse_descriptor<C>( secp: &Secp256k1<C>, s: &str) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>where C: Signing,

pub fn parse_descriptor<C>( secp: &Secp256k1<C>, s: &str) -> Result<(Descriptor<DescriptorPublicKey>, BTreeMap<DescriptorPublicKey, DescriptorSecretKey, Global>), Error>where C: Signing,

pub fn to_string_with_secret( &self, key_map: &HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>) -> String

pub fn to_string_with_secret( &self, key_map: &BTreeMap<DescriptorPublicKey, DescriptorSecretKey, Global>) -> String

pub fn find_derivation_index_for_spk<C>( &self, secp: &Secp256k1<C>, script_pubkey: &Script, range: Range<u32>) -> Result<Option<(u32, Descriptor<PublicKey>)>, ConversionError>where C: Verification,

pub fn into_single_descriptors( self) -> Result<Vec<Descriptor<DescriptorPublicKey>, Global>, Error>

impl Descriptor<DefiniteDescriptorKey>

pub fn derived_descriptor<C>( &self, secp: &Secp256k1<C>) -> Result<Descriptor<PublicKey>, ConversionError>where C: Verification,

impl Descriptor<DefiniteDescriptorKey>

pub fn derived_descriptor<C>( &self, secp: &Secp256k1<C>) -> Result<Descriptor<PublicKey>, ConversionError>where C: Verification,

Trait ImplementationsÂ§

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

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

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

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

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

impl DescriptorExt for Descriptor<DescriptorPublicKey>

fn dust_value(&self) -> u64

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

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

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

impl ExtractPolicy for Descriptor<DescriptorPublicKey>

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

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

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

Trait ImplementationsÂ§

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

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

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

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

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

impl DescriptorExt for Descriptor<DescriptorPublicKey>

fn dust_value(&self) -> u64

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

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

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

impl ExtractPolicy for Descriptor<DescriptorPublicKey>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type Err = Error

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

`Enum bdk::descriptor::Descriptor`

`pub fn satisfy<S>(&self, txin: &mut TxIn, satisfier: S) -> Result<(), Error>where S: Satisfier<Pk>,`

`pub fn plan<P>( self, provider: &P ) -> Result<Plan, Descriptor<DefiniteDescriptorKey>>where P: AssetProvider<DefiniteDescriptorKey>,`

`pub fn plan_mall<P>( self, provider: &P ) -> Result<Plan, Descriptor<DefiniteDescriptorKey>>where P: AssetProvider<DefiniteDescriptorKey>,`

`pub fn is_deriveable(&self) -> bool`

`pub fn has_wildcard(&self) -> bool`

`pub fn at_derivation_index( &self, index: u32 ) -> Result<Descriptor<DefiniteDescriptorKey>, ConversionError>`

`pub fn parse_descriptor<C>( secp: &Secp256k1<C>, s: &str ) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>where C: Signing,`

`pub fn parse_descriptor<C>( secp: &Secp256k1<C>, s: &str ) -> Result<(Descriptor<DescriptorPublicKey>, BTreeMap<DescriptorPublicKey, DescriptorSecretKey, Global>), Error>where C: Signing,`

`pub fn to_string_with_secret( &self, key_map: &HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState> ) -> String`

`pub fn to_string_with_secret( &self, key_map: &BTreeMap<DescriptorPublicKey, DescriptorSecretKey, Global> ) -> String`

`pub fn find_derivation_index_for_spk<C>( &self, secp: &Secp256k1<C>, script_pubkey: &Script, range: Range<u32> ) -> Result<Option<(u32, Descriptor<PublicKey>)>, ConversionError>where C: Verification,`

`pub fn into_single_descriptors( self ) -> Result<Vec<Descriptor<DescriptorPublicKey>, Global>, Error>`

`pub fn derived_descriptor<C>( &self, secp: &Secp256k1<C> ) -> Result<Descriptor<PublicKey>, ConversionError>where C: Verification,`

`pub fn derived_descriptor<C>( &self, secp: &Secp256k1<C> ) -> Result<Descriptor<PublicKey>, ConversionError>where C: Verification,`

`Trait ImplementationsÂ§`

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

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

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

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

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

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

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

`Trait ImplementationsÂ§`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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