Struct Arith

pub struct Arith<T: ExtParam> { /* private fields */ }

Wrapper around [ArithInner] that ensures that the expression is valid. See [ArithInner] for more details.

Note that the library allows construction of unchecked [Expr], but [Arith`] is always checked.

Implementations

impl<T: ExtParam> Arith<T>

pub fn new(expr: ArithInner<T>) -> Result<Self, TypeError>

Create a new Arith expression. This is the only constructor

pub fn inner(&self) -> &ArithInner<T>

Obtains the inner expression

impl<T: ExtParam> Arith<T>

pub fn depth(&self) -> usize

Obtains the depth of this expression

pub fn script_size(&self) -> usize

Obtains the script size

impl Arith<CovExtArgs>

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

Evaluate this expression with context given transaction and spent utxos

pub fn satisfy_helper<Pk: ToPublicKey>( &self, env: &TxEnv<'_, '_>, sat: &dyn Satisfier<Pk>, ) -> Result<Satisfaction, EvalError>

Internal satisfaction helper for Arith. This allows us to cleanly write code that we can use “?” for early returns. The trait implementation of satisfy just calls this function with unwrap_or impossible.

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

Push this script to builder

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<T: ExtParam> Extension for Arith<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 segwit_ctx_checks(&self) -> Result<(), ScriptContextError>

Validity rules for fragment in segwit context

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 tap_ctx_checks(&self) -> Result<(), ScriptContextError>

Validity rules for fragment in tap context

impl<T: ExtParam> FromStr for Arith<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: Hash + ExtParam> Hash for Arith<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 Arith<T>

fn cmp(&self, other: &Arith<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 Arith<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 Arith<T>

fn eq(&self, other: &Arith<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 Arith<T>

fn partial_cmp(&self, other: &Arith<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> TranslateExtParam<PArg, QArg> for Arith<PArg>

where PArg: ExtParam, QArg: ExtParam,

type Output = Arith<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 Arith<T>

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