Struct elements_miniscript::descriptor::CovenantDescriptor

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

The covenant descriptor

Implementations

impl<Pk: MiniscriptKey> CovenantDescriptor<Pk>

pub fn pk(&self) -> &Pk

Get the pk from covenant

pub fn to_ms(&self) -> &Miniscript<Pk, Segwitv0>

Get a reference to Miniscript inside covenant

pub fn into_ms(self) -> Miniscript<Pk, Segwitv0>

Consume self and return inner miniscript

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

Create a new Self from components

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

Encode

pub fn satisfy<S: Satisfier<Pk>>(&self, s: S) -> Result<Vec<Vec<u8>>, Error> where
    Pk: ToPublicKey, 

Create a satisfaction for the Covenant Descriptor

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

Script code for signing with covenant publickey. Use this script_code for sighash method when signing with the covenant pk. Use the DescriptorTrait script_code method for getting sighash for regular miniscripts.

impl CovenantDescriptor<PublicKey>

pub fn parse_insane(script: &Script) -> Result<Self, Error>

Parse a descriptor from script. While parsing other descriptors, we only parse the inner miniscript with ScriptContext. But Covenant descriptors only applicable under Wsh context to avoid implementation complexity.

pub fn parse(script: &Script) -> Result<Self, Error>

Parse a descriptor with additional local sanity checks. See Miniscript::sanity_check for all the checks. Use [parse_insane] to allow parsing insane scripts

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey> DescriptorTrait<Pk> for CovenantDescriptor<Pk> where
    Pk: FromStr,
    Pk::Hash: FromStr,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString, 

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

This returns the entire explicit script as the script code. You will need this script code when singing with pks that inside Miniscript. Use the [cov_script_code] method to get the script code for signing with covenant 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, params: &'static AddressParams) -> 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.

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

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.

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

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

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey> ElementsTrait<Pk> for CovenantDescriptor<Pk> where
    Pk: FromStr,
    Pk::Hash: FromStr,
    <Pk as FromStr>::Err: ToString,
    <<Pk as MiniscriptKey>::Hash as FromStr>::Err: ToString, 

fn blind_addr(
    &self,
    blinder: Option<PublicKey>,
    params: &'static AddressParams
) -> Result<Address, Error> where
    Pk: ToPublicKey, 

Compute a blinded address

impl<Pk: MiniscriptKey> ForEachKey<Pk> for CovenantDescriptor<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>(&'a self, pred: F) -> bool where
    Pk: 'a,
    F: FnMut(ForEach<'a, Pk>) -> bool,
    <Pk as MiniscriptKey>::Hash: 'a, 

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

impl<Pk: MiniscriptKey> FromStr for CovenantDescriptor<Pk> where
    Pk: 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: MiniscriptKey> FromTree for CovenantDescriptor<Pk> where
    Pk: 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: Ord + MiniscriptKey> Ord for CovenantDescriptor<Pk>

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

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

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

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

This method tests for !=.

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

fn partial_cmp(&self, other: &CovenantDescriptor<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<P: MiniscriptKey, Q: MiniscriptKey> TranslatePk<P, Q> for CovenantDescriptor<P>

type Output = CovenantDescriptor<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 as MiniscriptKey>::Hash) -> <Q as MiniscriptKey>::Hash, 

Calls translate_pk with conversion functions that cannot fail

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

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

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