Struct miniscript::descriptor::Sh

pub struct Sh<Pk: MiniscriptKey> { /* private fields */ }

A Legacy p2sh Descriptor

Implementations

impl<Pk: MiniscriptKey> Sh<Pk>

pub fn into_inner(self) -> ShInner<Pk>

Get the Inner

pub fn as_inner(&self) -> &ShInner<Pk>

Get a reference to inner

pub fn new(ms: Miniscript<Pk, Legacy>) -> Result<Self, Error>

Create a new p2sh descriptor with the raw miniscript

pub fn new_sortedmulti(k: usize, pks: Vec<Pk>) -> Result<Self, Error>

Create a new p2sh sortedmulti descriptor with threshold k and Vec of pks.

pub fn new_wsh(ms: Miniscript<Pk, Segwitv0>) -> Result<Self, Error>

Create a new p2sh wrapped wsh descriptor with the raw miniscript

pub fn new_with_wsh(wsh: Wsh<Pk>) -> Self

Create a new p2sh wrapper for the given wsh descriptor

pub fn sanity_check(&self) -> Result<(), Error>

Checks whether the descriptor is safe.

pub fn new_wsh_sortedmulti(k: usize, pks: Vec<Pk>) -> Result<Self, Error>

Create a new p2sh wrapped wsh sortedmulti descriptor from threshold k and Vec of pks

pub fn new_wpkh(pk: Pk) -> Result<Self, Error>

Create a new p2sh wrapped wpkh from Pk

pub fn new_with_wpkh(wpkh: Wpkh<Pk>) -> Self

Create a new p2sh wrapper for the given wpkh descriptor

pub fn max_satisfaction_weight(&self) -> Result<usize, Error>

Computes an upper bound on the weight of a satisfying witness to the transaction.

Assumes all ec-signatures are 73 bytes, including push opcode and sighash suffix. Includes the weight of the VarInts encoding the scriptSig and witness stack length.

Errors

When the descriptor is impossible to safisfy (ex: sh(OP_FALSE)).

impl<Pk: MiniscriptKey + ToPublicKey> Sh<Pk>

pub fn script_pubkey(&self) -> Script

Obtains the corresponding script pubkey for this descriptor.

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

Obtains the corresponding address for this descriptor.

pub fn inner_script(&self) -> Script

Obtain the underlying miniscript for this descriptor

pub fn ecdsa_sighash_script_code(&self) -> Script

Obtains the pre bip-340 signature script code for this 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 get_satisfaction<S>(
    &self,
    satisfier: S
) -> Result<(Vec<Vec<u8>>, Script), Error>where
    S: Satisfier<Pk>,

Returns satisfying non-malleable witness and scriptSig with minimum weight to spend an output controlled by the given descriptor if it is possible to construct one using the satisfier.

pub fn get_satisfaction_mall<S>(
    &self,
    satisfier: S
) -> Result<(Vec<Vec<u8>>, Script), Error>where
    S: Satisfier<Pk>,

Returns satisfying, possibly malleable, witness and scriptSig with minimum weight to spend an output controlled by the given descriptor if it is possible to construct one using the satisfier.

Trait Implementations

impl<Pk: Clone + MiniscriptKey> Clone for Sh<Pk>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Pk: MiniscriptKey> Debug for Sh<Pk>

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey> Display for Sh<Pk>

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey> ForEachKey<Pk> for Sh<Pk>

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

Run a predicate on every key in the descriptor, returning whether the predicate returned true for every key

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

Run a predicate on every key in the descriptor, returning whether the predicate returned true for any key

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

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

Converts to this type from the input type.

impl<Pk> FromStr for Sh<Pk>where
    Pk: MiniscriptKey + FromStr,
    Pk::Sha256: FromStr,
    Pk::Hash256: FromStr,
    Pk::Ripemd160: FromStr,
    Pk::Hash160: FromStr,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Sha256 as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash256 as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Ripemd160 as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash160 as FromStr>::Err: ToString,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl<Pk> FromTree for Sh<Pk>where
    Pk: MiniscriptKey + FromStr,
    Pk::Sha256: FromStr,
    Pk::Hash256: FromStr,
    Pk::Ripemd160: FromStr,
    Pk::Hash160: FromStr,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Sha256 as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash256 as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Ripemd160 as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash160 as FromStr>::Err: ToString,

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

Extract a structure from Tree representation

impl<Pk: Hash + MiniscriptKey> Hash for Sh<Pk>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<Pk: MiniscriptKey> Liftable<Pk> for Sh<Pk>

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

Convert the object into an abstract policy

impl<Pk: Ord + MiniscriptKey> Ord for Sh<Pk>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<Pk: PartialEq + MiniscriptKey> PartialEq<Sh<Pk>> for Sh<Pk>

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

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

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Pk: PartialOrd + MiniscriptKey> PartialOrd<Sh<Pk>> for Sh<Pk>

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

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

const fn lt(&self, other: &Rhs) -> bool

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

const fn le(&self, other: &Rhs) -> bool

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

const fn gt(&self, other: &Rhs) -> bool

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

const fn ge(&self, other: &Rhs) -> bool

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

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

type Output = Sh<Q>

The associated output type. This must be Self<Q>.

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

Translates a struct from one generic to another where the translations for Pk are provided by the given Translator.

impl<Pk: Eq + MiniscriptKey> Eq for Sh<Pk>

impl<Pk: MiniscriptKey> StructuralEq for Sh<Pk>

impl<Pk: MiniscriptKey> StructuralPartialEq for Sh<Pk>