Struct Wsh

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

A Segwitv0 wsh descriptor

Implementations

impl<Pk: MiniscriptKey> Wsh<Pk>

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

Get the Inner

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

Get a reference to inner

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

Create a new wsh descriptor

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

Create a new sortedmulti wsh descriptor

pub fn to_string_no_checksum(&self) -> String

Get the descriptor without the checksum

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

pub fn spk(&self) -> Script

Obtain the corresponding script pubkey for this descriptor Non failing verion of DescriptorTrait::script_pubkey for this descriptor

Examples found in repository

examples/parse.rs (line 50)

fn main() {
    let my_descriptor = miniscript::Descriptor::<bitcoin::PublicKey>::from_str(
        "wsh(c:pk_k(020202020202020202020202020202020202020202020202020202020202020202))",
    )
    .unwrap();

    // Check whether the descriptor is safe
    // This checks whether all spend paths are accessible in bitcoin network.
    // It maybe possible that some of the spend require more than 100 elements in Wsh scripts
    // Or they contain a combination of timelock and heightlock.
    assert!(my_descriptor.sanity_check().is_ok());

    // Compute the script pubkey. As mentioned in the documentation, script_pubkey only fails
    // for Tr descriptors that don't have some pre-computed data
    assert_eq!(
        format!("{:x}", my_descriptor.script_pubkey()),
        "0020daef16dd7c946a3e735a6e43310cb2ce33dfd14a04f76bf8241a16654cb2f0f9"
    );

    // Another way to compute script pubkey
    // We can also compute the type of descriptor
    let desc_type = my_descriptor.desc_type();
    assert_eq!(desc_type, DescriptorType::Wsh);
    // Since we know the type of descriptor, we can get the Wsh struct from Descriptor
    // This allows us to call infallible methods for getting script pubkey
    if let Descriptor::Wsh(wsh) = &my_descriptor {
        assert_eq!(
            format!("{:x}", wsh.spk()),
            "0020daef16dd7c946a3e735a6e43310cb2ce33dfd14a04f76bf8241a16654cb2f0f9"
        );
    } else {
        // We checked for the descriptor type earlier
    }

    // Get the inner script inside the descriptor
    assert_eq!(
        format!(
            "{:x}",
            my_descriptor
                .explicit_script()
                .expect("Wsh descriptors have inner scripts")
        ),
        "21020202020202020202020202020202020202020202020202020202020202020202ac"
    );

    let desc = miniscript::Descriptor::<bitcoin::PublicKey>::from_str(
        "sh(wsh(c:pk_k(020202020202020202020202020202020202020202020202020202020202020202)))",
    )
    .unwrap();

    assert!(desc.desc_type() == DescriptorType::ShWsh);
}

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

Obtain the corresponding script pubkey for this descriptor Non failing verion of DescriptorTrait::address for this descriptor

pub fn inner_script(&self) -> Script

Obtain the underlying miniscript for this descriptor Non failing verion of DescriptorTrait::explicit_script for this descriptor

pub fn ecdsa_sighash_script_code(&self) -> Script

Obtain the pre bip-340 signature script code for this descriptor Non failing verion of DescriptorTrait::script_code for this descriptor

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

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. Errors:

fn script_pubkey(&self) -> Script

where Pk: ToPublicKey,

Computes the scriptpubkey of the descriptor

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.

fn explicit_script(&self) -> Result<Script, Error>

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. For Tr descriptors, this will error as there is no underlying script

fn get_satisfaction<S>( &self, satisfier: S, ) -> Result<(Vec<Vec<u8>>, Script), Error>

where Pk: ToPublicKey, S: Satisfier<Pk>,

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

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

where Pk: ToPublicKey, S: Satisfier<Pk>,

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

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. Returns Error when the descriptor is impossible to safisfy (ex: sh(OP_FALSE))

fn script_code(&self) -> Result<Script, Error>

where Pk: ToPublicKey,

Get the scriptCode of a transaction output.

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

where Pk: ToPublicKey, 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<Pk: MiniscriptKey> Display for Wsh<Pk>

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

Formats the value using the given formatter.

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

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

fn for_any_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 any key

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

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

Converts to this type from the input type.

impl<Pk> FromStr for Wsh<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.

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

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

impl<Pk> FromTree for Wsh<Pk>

where Pk: MiniscriptKey + FromStr, Pk::Hash: FromStr, <Pk as FromStr>::Err: ToString, <<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString,

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

Extract a structure from Tree representation

impl<Pk: Hash + MiniscriptKey> Hash for Wsh<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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

Convert the object into an abstract policy

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

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<Pk: MiniscriptKey> PreTaprootDescriptorTrait<Pk> for Wsh<Pk>

fn explicit_script(&self) -> Script

where Pk: ToPublicKey,

Same as DescriptorTrait::explicit_script, but a non failing version. All PreTaproot descriptors have a unique explicit script

fn script_code(&self) -> Script

where Pk: ToPublicKey,

Same as DescriptorTrait::script_code, but a non failing version. All PreTaproot descriptors have a script code

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

type Output = Wsh<Q>

The associated output type. This must be Self

fn translate_pk<Fpk, Fpkh, E>( &self, translatefpk: Fpk, 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

fn translate_pk_infallible<Fpk, Fpkh>( &self, translatefpk: Fpk, translatefpkh: Fpkh, ) -> Self::Output

where Fpk: FnMut(&P) -> Q, Fpkh: FnMut(&P::Hash) -> Q::Hash,

Calls translate_pk with conversion functions that cannot fail

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

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