Enum sapio_miniscript::PreTaprootDescriptor

pub enum PreTaprootDescriptor<Pk: MiniscriptKey> {
    Bare(Bare<Pk>),
    Pkh(Pkh<Pk>),
    Wpkh(Wpkh<Pk>),
    Sh(Sh<Pk>),
    Wsh(Wsh<Pk>),
}

Script descriptor

Variants

Bare(Bare<Pk>)

Bare descriptor

Pkh(Pkh<Pk>)

Pay-to-PubKey-Hash

Wpkh(Wpkh<Pk>)

Pay-to-Witness-PubKey-Hash

Sh(Sh<Pk>)

Pay-to-ScriptHash(includes nested wsh/wpkh/sorted multi)

Wsh(Wsh<Pk>)

Pay-to-Witness-ScriptHash with Segwitv0 context

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey> DescriptorTrait<Pk> for PreTaprootDescriptor<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

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.

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).

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

• When the descriptor is Tr

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 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 a possilbly mallable satisfying non-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 signatures are 73 bytes, including push opcode and sighash suffix. Includes the weight of the VarInts encoding the scriptSig and witness stack length.

fn script_code(&self) -> Result<Script, Error> where
    Pk: ToPublicKey, 

Get the scriptCode of a transaction output.

The scriptCode is the Script of the previous transaction output being serialized in the sighash when evaluating a CHECKSIG & co. OP code. Returns Error for Tr descriptors

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 PreTaprootDescriptor<Pk>

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

Formats the value using the given formatter.

impl<Pk> FromStr for PreTaprootDescriptor<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<PreTaprootDescriptor<Pk>, Error>

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

impl<Pk> FromTree for PreTaprootDescriptor<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<PreTaprootDescriptor<Pk>, Error>

Parse an expression tree into a descriptor

impl<Pk: Hash + MiniscriptKey> Hash for PreTaprootDescriptor<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: Ord + MiniscriptKey> Ord for PreTaprootDescriptor<Pk>

fn cmp(&self, other: &PreTaprootDescriptor<Pk>) -> 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

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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<Pk: MiniscriptKey> PreTaprootDescriptorTrait<Pk> for PreTaprootDescriptor<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<Pk: Eq + MiniscriptKey> Eq for PreTaprootDescriptor<Pk>

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

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