Enum miniscript::descriptor::Descriptor

pub enum Descriptor<P> {
    Bare(Miniscript<P>),
    Pkh(P),
    Wpkh(P),
    ShWpkh(P),
    Sh(Miniscript<P>),
    Wsh(Miniscript<P>),
    ShWsh(Miniscript<P>),
}

Script descriptor

Variants

Bare(Miniscript<P>)

A raw scriptpubkey (including pay-to-pubkey)

Pkh(P)

Pay-to-PubKey-Hash

Wpkh(P)

Pay-to-Witness-PubKey-Hash

ShWpkh(P)

Pay-to-Witness-PubKey-Hash inside P2SH

Sh(Miniscript<P>)

Pay-to-ScriptHash

Wsh(Miniscript<P>)

Pay-to-Witness-ScriptHash

ShWsh(Miniscript<P>)

P2SH-P2WSH

Methods

impl<P> Descriptor<P>

pub fn translate<F, Q, E>(&self, translatefn: F) -> Result<Descriptor<Q>, E> where
    F: FnMut(&P) -> Result<Q, E>, 

Convert a descriptor using abstract keys to one using specific keys

impl<P: Clone> Descriptor<P>

pub fn abstract_policy(&self) -> AbstractPolicy<P>

Abstract the script into an "abstract policy" which can be filtered and analyzed

impl<P: ToPublicKey> Descriptor<P>

pub fn script_pubkey(&self) -> Script

Computes the scriptpubkey of the descriptor

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<F, H>(
    &self,
    txin: &mut TxIn,
    sigfn: Option<F>,
    hashfn: Option<H>,
    age: u32
) -> Result<(), Error> where
    F: FnMut(&P) -> Option<(Signature, Option<SigHashType>)>,
    H: FnMut(Hash) -> Option<[u8; 32]>, 

Attempts to produce a satisfying witness or scriptSig, as the case may be, for the descriptor, and add it to a TxIn object in the appropriate place

Trait Implementations

impl<P: FromStr> FromTree for Descriptor<P> where
    <P as FromStr>::Err: ToString, 

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

Parse an expression tree into a descriptor

impl<P: PartialOrd> PartialOrd<Descriptor<P>> for Descriptor<P>

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

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

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

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

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

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

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

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

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

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

impl<P: PartialEq> PartialEq<Descriptor<P>> for Descriptor<P>

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

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

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

This method tests for !=.

impl<P: Clone> Clone for Descriptor<P>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Ord> Ord for Descriptor<P>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl<P: Eq> Eq for Descriptor<P>

impl<P: Display> Display for Descriptor<P>

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

Formats the value using the given formatter.

impl<P: Debug> Debug for Descriptor<P>

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

Formats the value using the given formatter.

impl<P: FromStr> FromStr for Descriptor<P> where
    <P as FromStr>::Err: ToString, 

type Err = Error

The associated error which can be returned from parsing.

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

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