Struct miniscript::descriptor::Sh

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

A Legacy p2sh Descriptor

Implementations

impl<Pk: MiniscriptKey> Sh<Pk>

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_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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Whether the descriptor is safe Checks whether all the spend paths in the descriptor are possible on the bitcoin network under the current standardness and consensus rules Also checks whether the descriptor requires signauture on all spend paths And whether the script is malleable. In general, all the guarantees of miniscript hold only for safe scripts. All the analysis guarantees of miniscript only hold safe scripts. The signer may not be able to find satisfactions even if one exists

pub fn address(&self, network: Network) -> Result<Address, Error> where
    Pk: ToPublicKey, 

Computes the Bitcoin address of the descriptor, if one exists Some descriptors like pk() don't have any address.

pub fn script_pubkey(&self) -> Script where
    Pk: ToPublicKey, 

Computes the scriptpubkey of the descriptor

pub fn unsigned_script_sig(&self) -> Script where
    Pk: ToPublicKey, 

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.

pub fn explicit_script(&self) -> Script where
    Pk: ToPublicKey, 

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 get_satisfaction<S>(
    &self,
    satisfier: S
) -> Result<(Vec<Vec<u8>>, Script), Error> where
    Pk: ToPublicKey,
    S: Satisfier<Pk>, 

Returns satisfying witness and scriptSig to spend an output controlled by the given descriptor if it possible to construct one using the satisfier S.

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 signatures are 73 bytes, including push opcode and sighash suffix. Includes the weight of the VarInts encoding the scriptSig and witness stack length. Returns Error when the descriptor is impossible to safisfy (ex: sh(OP_FALSE))

pub fn script_code(&self) -> Script where
    Pk: ToPublicKey, 

Get the scriptCode of a transaction output.

pub fn satisfy<S>(&self, txin: &mut TxIn, satisfier: S) -> Result<(), Error> where
    Pk: ToPublicKey,
    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.

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

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

Formats the value using the given formatter.

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

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

pub fn for_each_key<'a, F: FnMut(ForEach<'a, Pk>) -> bool>(
    &'a self,
    pred: F
) -> bool where
    Pk: 'a,
    Pk::Hash: 'a, 

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

pub fn for_any_key<'a, F: FnMut(ForEach<'a, Pk>) -> bool>(
    &'a self,
    mut pred: F
) -> bool where
    Pk: 'a,
    Pk::Hash: 'a, 

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

impl<Pk> FromStr for Sh<Pk> where
    Pk: MiniscriptKey + FromStr,
    Pk::Hash: FromStr,
    <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.

pub 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::Hash: FromStr,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString, 

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

Extract a structure from Tree representation

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

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

Convert the object into an abstract policy

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type Output = Sh<Q>

The associated output type. This must be Self

pub fn translate_pk<Fpk, Fpkh, E>(
    &self,
    mut translatefpk: Fpk,
    mut translatefpkh: Fpkh
) -> Result<Self::Output, E> where
    Fpk: FnMut(&P) -> Result<Q, E>,
    Fpkh: FnMut(&P::Hash) -> Result<Q::Hash, E>,
    Q: MiniscriptKey, 

Translate a struct from one Generic to another where the translation for Pk is provided by translatefpk, and translation for PkH is provided by translatefpkh

pub fn translate_pk_infallible<Fpk, Fpkh>(
    &self,
    mut translatefpk: Fpk,
    mut translatefpkh: Fpkh
) -> Self::Output where
    Fpk: FnMut(&P) -> Q,
    Fpkh: FnMut(&P::Hash) -> Q::Hash, 

Calls translate_pk with conversion functions that cannot fail