Enum CovOps

pub enum CovOps<T: ExtParam> {
    IsExpAsset(AssetExpr<T>),
    IsExpValue(ValueExpr<T>),
    AssetEq(AssetExpr<T>, AssetExpr<T>),
    ValueEq(ValueExpr<T>, ValueExpr<T>),
    SpkEq(SpkExpr<T>, SpkExpr<T>),
    CurrIndEq(usize),
    IdxEq(IdxExpr, IdxExpr),
}

Miniscript Fragment containing arith expressions Expr cannot be directly used a miniscript fragment because it pushes a 64 bit value on stack. Two expressions can be combined with Arith to something is of Base type B to be used in miniscript expressions

Variants

IsExpAsset(AssetExpr<T>)

Checks that asset is explicit [X] <1> EQUAL NIP

IsExpValue(ValueExpr<T>)

Checks if the value is explicit [X] <1> EQUAL NIP The script translation is same as that of IsExpAsset, but the data structure distinguishes them for clarity.

AssetEq(AssetExpr<T>, AssetExpr<T>)

Checks that both assets are equal (maybe confidential) [X] TOALTSTACK [Y] FROMALTSTACK EQUAL TOALTSTACK EQUAL FROMALTSTACK BOOLAND

ValueEq(ValueExpr<T>, ValueExpr<T>)

Checks that both values are equal (maybe confidential) [X] TOALTSTACK [Y] FROMALTSTACK EQUAL TOALTSTACK EQUAL FROMALTSTACK BOOLAND

SpkEq(SpkExpr<T>, SpkExpr<T>)

Script pubkey equal. Checks the witness version and program. Also works for legacy programs. [X] TOALTSTACK [Y] FROMALTSTACK EQUAL TOALTSTACK EQUAL FROMALTSTACK BOOLAND

CurrIndEq(usize)

Current input index equality <i> PUSHCURRENTINPUTINDEX EQUAL

IdxEq(IdxExpr, IdxExpr)

Index equality [X] [Y] EQUAL

Implementations

impl CovOps<CovExtArgs>

pub fn push_to_builder(&self, builder: Builder) -> Builder

Push this script to builder

pub fn eval(&self, env: &TxEnv<'_, '_>) -> Result<bool, EvalError>

Evaluate this expression

pub fn from_tokens(tks: &[Tk<'_>]) -> Option<(Self, usize)>

Returns (self, start_pos) parsed reversed form tokens starting with index end_pos Expression is parsed from tokens[start:end_pos]

Trait Implementations

impl<T: Clone + ExtParam> Clone for CovOps<T>

fn clone(&self) -> CovOps<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ExtParam> Debug for CovOps<T>

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

Formats the value using the given formatter.

impl<T: ExtParam> Display for CovOps<T>

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

Formats the value using the given formatter.

impl<T, PArg, QArg, E> ExtTranslator<CovOps<PArg>, CovOps<QArg>, E> for T

where T: ExtParamTranslator<PArg, QArg, E>, PArg: ExtParam, QArg: ExtParam,

fn ext(&mut self, cov_ops: &CovOps<PArg>) -> Result<CovOps<QArg>, E>

Translates one extension to another

impl<T: ExtParam> Extension for CovOps<T>

fn corr_prop(&self) -> Correctness

Calculate the correctness property for the leaf fragment. See miniscript reference for more info on different types

fn mall_prop(&self) -> Malleability

Calculate the malleability property for the leaf fragment. See miniscript reference for more info on different types

fn extra_prop(&self) -> ExtData

Calculate the Extra properties property for the leaf fragment. See current implementation for different fragments in extra_props.rs

fn script_size(&self) -> usize

Get the script size of the current fragment

fn from_name_tree( name: &str, children: &[Tree<'_>], ) -> Result<Self, FromTokenIterError>

Create an instance of this object from a Tree with root name and children as Vec<Tree>.

fn segwit_ctx_checks(&self) -> Result<(), ScriptContextError>

Validity rules for fragment in segwit context

fn tap_ctx_checks(&self) -> Result<(), ScriptContextError>

Validity rules for fragment in tap context

impl<T: ExtParam> FromStr for CovOps<T>

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<T: ExtParam> FromTree for CovOps<T>

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

Extract a structure from Tree representation

impl<T: Hash + ExtParam> Hash for CovOps<T>

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<T: Ord + ExtParam> Ord for CovOps<T>

fn cmp(&self, other: &CovOps<T>) -> 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 ParseableExt for CovOps<CovExtArgs>

fn satisfy<Pk, S>(&self, sat: &S) -> Satisfaction

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

Produce a satisfaction for this from satisfier. See satisfaction code in satisfy.rs for example Note that the Satisfaction struct also covers the case when satisfaction is impossible/unavailable

fn dissatisfy<Pk, S>(&self, sat: &S) -> Satisfaction

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

Produce a satisfaction for this from satisfier. See satisfaction code in satisfy.rs for example Note that the Satisfaction struct also covers the case when dissatisfaction is impossible/unavailable

fn push_to_builder(&self, builder: Builder) -> Builder

Encoding of the current fragment

fn from_token_iter( tokens: &mut TokenIter<'_>, ) -> Result<Self, FromTokenIterError>

Parse the terminal from TokenIter. Implementers of this trait are responsible for making sure tokens is mutated correctly. If parsing is not successful, the tokens should not be consumed.

fn evaluate( &self, stack: &mut Stack<'_>, txenv: Option<&TxEnv<'_, '_>>, ) -> Result<bool, Error>

Interpreter support Evaluate the fragment based on inputs from stack. If an implementation of this is provided the user can use the interpreter API to parse scripts from blockchain and check which constraints are satisfied Output Ok(true) when the ext fragment is satisfied. Output Ok(false) when the ext fragment is dissatisfied, Output Some(Err) when there is an error in interpreter value.

impl<T: PartialEq + ExtParam> PartialEq for CovOps<T>

fn eq(&self, other: &CovOps<T>) -> 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<T: PartialOrd + ExtParam> PartialOrd for CovOps<T>

fn partial_cmp(&self, other: &CovOps<T>) -> 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<PArg, QArg> TranslateExt<CovOps<PArg>, CovOps<QArg>> for CovOps<PArg>

where CovOps<PArg>: Extension, CovOps<QArg>: Extension, PArg: ExtParam, QArg: ExtParam,

type Output = CovOps<QArg>

The associated output type.

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

where T: ExtTranslator<CovOps<PArg>, CovOps<QArg>, E>,

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

impl<PArg, QArg> TranslateExtParam<PArg, QArg> for CovOps<PArg>

where PArg: ExtParam, QArg: ExtParam,

type Output = CovOps<QArg>

The associated output type.

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

where T: ExtParamTranslator<PArg, QArg, E>,

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

impl<T: Eq + ExtParam> Eq for CovOps<T>

impl<T: ExtParam> StructuralPartialEq for CovOps<T>