Enum bdk::descriptor::Descriptor

pub enum Descriptor<Pk> where
    Pk: MiniscriptKey,  {
    Bare(Miniscript<Pk, Legacy>),
    Pk(Pk),
    Pkh(Pk),
    Wpkh(Pk),
    ShWpkh(Pk),
    Sh(Miniscript<Pk, Legacy>),
    Wsh(Miniscript<Pk, Segwitv0>),
    ShWsh(Miniscript<Pk, Segwitv0>),
}

Script descriptor

Variants

Bare(Miniscript<Pk, Legacy>)

A raw scriptpubkey (including pay-to-pubkey) under Legacy context

Pk(Pk)

Pay-to-Pubkey

Pkh(Pk)

Pay-to-PubKey-Hash

Wpkh(Pk)

Pay-to-Witness-PubKey-Hash

ShWpkh(Pk)

Pay-to-Witness-PubKey-Hash inside P2SH

Sh(Miniscript<Pk, Legacy>)

Pay-to-ScriptHash with Legacy context

Wsh(Miniscript<Pk, Segwitv0>)

Pay-to-Witness-ScriptHash with Segwitv0 context

ShWsh(Miniscript<Pk, Segwitv0>)

P2SH-P2WSH with Segwitv0 context

Implementations

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

pub fn translate_pk<Fpk, Fpkh, Q, E>(
    &self,
    translatefpk: Fpk,
    translatefpkh: Fpkh
) -> Result<Descriptor<Q>, E> where
    Fpk: FnMut(&Pk) -> Result<Q, E>,
    Fpkh: FnMut(&<Pk as MiniscriptKey>::Hash) -> Result<<Q as MiniscriptKey>::Hash, E>,
    Q: MiniscriptKey, 

Convert a descriptor using abstract keys to one using specific keys This will panic if translatefpk returns an uncompressed key when converting to a Segwit descriptor. To prevent this panic, ensure translatefpk returns an error in this case instead.

impl<Pk> Descriptor<Pk> where
    Pk: MiniscriptKey + ToPublicKey, 

pub fn address(&self, network: Network) -> Option<Address>

Computes the Bitcoin address of the descriptor, if one exists

pub fn script_pubkey(&self) -> Script

Computes the scriptpubkey of the descriptor

pub fn unsigned_script_sig(&self) -> Script

Computes the scriptSig that will be in place for an unsigned input spending an output with this descriptor. For pre-segwit descriptors, which use the scriptSig for signatures, this returns the empty script.

This is used in Segwit transactions to produce an unsigned transaction whose txid will not change during signing (since only the witness data will change).

pub fn witness_script(&self) -> Script

Computes the "witness script" of the descriptor, i.e. the underlying script before any hashing is done. For Bare, Pkh and Wpkh this is the scriptPubkey; for ShWpkh and Sh this is the redeemScript; for the others it is the witness script.

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

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

pub fn max_satisfaction_weight(&self) -> usize

Computes an upper bound on the weight of a satisfying witness to the transaction. Assumes all signatures are 73 bytes, including push opcode and sighash suffix. Includes the weight of the VarInts encoding the scriptSig and witness stack length.

impl Descriptor<DescriptorPublicKey>

pub fn derive(&self, path: &[ChildNumber]) -> Descriptor<DescriptorPublicKey>

Derives all wildcard keys in the descriptor using the supplied path

pub fn parse_secret(
    s: &str
) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

impl ExtractPolicy for Descriptor<DescriptorPublicKey>

fn extract_policy(
    &self,
    signers: Arc<SignersContainer<DescriptorPublicKey>>
) -> Result<Option<Policy>, Error>

impl<Pk> FromStr for Descriptor<Pk> where
    Pk: MiniscriptKey,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString, 

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl<Pk> FromTree for Descriptor<Pk> where
    Pk: MiniscriptKey,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString, 

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

Parse an expression tree into a descriptor

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

fn lift(&self) -> Policy<Pk>

Convert the object into an abstract policy

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

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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

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