Struct LegacyCSFSCov

pub struct LegacyCSFSCov<Pk: MiniscriptKey, Ext: Extension> { /* private fields */ }

The covenant descriptor

Implementations

impl<Pk: MiniscriptKey, Ext: Extension> LegacyCSFSCov<Pk, Ext>

pub fn pk(&self) -> &Pk

Get the pk from covenant

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

Get a reference to Miniscript inside covenant

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

Consume self and return inner miniscript

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

Create a new Self from components

pub fn encode(&self) -> Script

where Pk: ToPublicKey, Ext: ParseableExt,

Encode

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

where Pk: ToPublicKey, Ext: ParseableExt,

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.

impl<Ext: ParseableExt> LegacyCSFSCov<PublicKey, Ext>

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 Miniscript::parse_insane to allow parsing insane scripts

impl<Pk, Ext> LegacyCSFSCov<Pk, Ext>

where Pk: MiniscriptKey, Ext: Extension,

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

Sanity checks for this covenant descriptor

pub fn address( &self, blinder: Option<PublicKey>, params: &'static AddressParams, ) -> Address

where Pk: ToPublicKey, Ext: ParseableExt,

Obtains the blinded address for this descriptor.

pub fn script_pubkey(&self) -> Script

where Pk: ToPublicKey, Ext: ParseableExt,

Obtains the script pubkey for this 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.

pub fn inner_script(&self) -> Script

where Pk: ToPublicKey, Ext: ParseableExt,

Computes the the underlying script before any hashing is done.

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

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

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.

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

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

pub fn ecdsa_sighash_script_code(&self) -> Script

where Pk: ToPublicKey, Ext: ParseableExt,

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 Self::cov_script_code method to get the script code for signing with covenant pk

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

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

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.

Trait Implementations

impl<Pk: Clone + MiniscriptKey, Ext: Clone + Extension> Clone for LegacyCSFSCov<Pk, Ext>

fn clone(&self) -> LegacyCSFSCov<Pk, Ext>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Pk, Ext> Debug for LegacyCSFSCov<Pk, Ext>

where Pk: MiniscriptKey, Ext: Extension,

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

Formats the value using the given formatter.

impl<Pk, Ext> Display for LegacyCSFSCov<Pk, Ext>

where Pk: MiniscriptKey, Ext: Extension,

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey, Ext: Extension> ForEachKey<Pk> for LegacyCSFSCov<Pk, Ext>

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

where 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>(&'a self, pred: F) -> bool

where F: FnMut(&'a Pk) -> bool, Pk: 'a,

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

impl<Pk: MiniscriptKey, Arg: ExtParam> From<LegacyCSFSCov<Pk, CovenantExt<Arg>>> for Descriptor<Pk, CovenantExt<Arg>>

fn from(inner: LegacyCSFSCov<Pk, CovenantExt<Arg>>) -> Self

Converts to this type from the input type.

impl<Pk, Ext> FromStr for LegacyCSFSCov<Pk, Ext>

where Pk: FromStrKey, Ext: Extension,

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, Ext> FromTree for LegacyCSFSCov<Pk, Ext>

where Pk: FromStrKey, Ext: Extension,

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

Extract a structure from Tree representation

impl<Pk: Ord + MiniscriptKey, Ext: Ord + Extension> Ord for LegacyCSFSCov<Pk, Ext>

fn cmp(&self, other: &LegacyCSFSCov<Pk, Ext>) -> 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, Ext: PartialEq + Extension> PartialEq for LegacyCSFSCov<Pk, Ext>

fn eq(&self, other: &LegacyCSFSCov<Pk, Ext>) -> 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, Ext: PartialOrd + Extension> PartialOrd for LegacyCSFSCov<Pk, Ext>

fn partial_cmp(&self, other: &LegacyCSFSCov<Pk, Ext>) -> 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, Ext, ExtQ> TranslateExt<Ext, ExtQ> for LegacyCSFSCov<Pk, Ext>

where Pk: MiniscriptKey, Ext: Extension + TranslateExt<Ext, ExtQ, Output = ExtQ>, ExtQ: Extension,

type Output = LegacyCSFSCov<Pk, ExtQ>

The associated output type.

fn translate_ext<T, E>(&self, translator: &mut T) -> Result<Self::Output, E>

where T: ExtTranslator<Ext, ExtQ, E>,

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

impl<P, Q, Ext> TranslatePk<P, Q> for LegacyCSFSCov<P, Ext>

where P: MiniscriptKey, Q: MiniscriptKey, Ext: Extension,

type Output = LegacyCSFSCov<Q, Ext>

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, Ext: Eq + Extension> Eq for LegacyCSFSCov<Pk, Ext>

impl<Pk: MiniscriptKey, Ext: Extension> StructuralPartialEq for LegacyCSFSCov<Pk, Ext>