Enum miniscript::policy::Policy

pub enum Policy<P> {
    Key(P),
    Multi(usize, Vec<P>),
    Hash(Hash),
    Time(u32),
    Threshold(usize, Vec<Policy<P>>),
    And(Box<Policy<P>>, Box<Policy<P>>),
    Or(Box<Policy<P>>, Box<Policy<P>>),
    AsymmetricOr(Box<Policy<P>>, Box<Policy<P>>),
}

Script descriptor

Variants

Key(P)

A public key which must sign to satisfy the descriptor

Multi(usize, Vec<P>)

A set of keys, signatures must be provided for k of them

Hash(Hash)

A SHA256 whose preimage must be provided to satisfy the descriptor

Time(u32)

A locktime restriction

Threshold(usize, Vec<Policy<P>>)

A set of descriptors, satisfactions must be provided for k of them

And(Box<Policy<P>>, Box<Policy<P>>)

A list of descriptors, all of which must be satisfied

Or(Box<Policy<P>>, Box<Policy<P>>)

A pair of descriptors, one of which must be satisfied

AsymmetricOr(Box<Policy<P>>, Box<Policy<P>>)

Same as Or, but the second option is assumed to never be taken for costing purposes

Methods

impl<P: Clone + Debug> Policy<P>

pub fn compile(&self) -> Miniscript<P>

Compile the descriptor into an optimized Miniscript representation

pub fn abstract_policy(&self) -> AbstractPolicy<P>

Abstract the policy into an "abstract policy" which can be filtered and analyzed

impl<P> Policy<P>

pub fn translate<F, Q, E>(&self, translatefn: &F) -> Result<Policy<Q>, E> where
    F: Fn(&P) -> Result<Q, E>, 

Convert a policy using abstract keys to one using specific keys

Trait Implementations

impl<P: FromStr> FromTree for Policy<P> where
    P::Err: ToString + Debug, 

fn from_tree(top: &Tree) -> Result<Policy<P>, Error>

impl<P: PartialOrd> PartialOrd<Policy<P>> for Policy<P>

fn partial_cmp(&self, other: &Policy<P>) -> Option<Ordering>

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

fn lt(&self, other: &Policy<P>) -> bool

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

fn le(&self, other: &Policy<P>) -> bool

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

fn gt(&self, other: &Policy<P>) -> bool

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

fn ge(&self, other: &Policy<P>) -> bool

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

impl<P: PartialEq> PartialEq<Policy<P>> for Policy<P>

fn eq(&self, other: &Policy<P>) -> bool

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

fn ne(&self, other: &Policy<P>) -> bool

This method tests for !=.

impl<P: Clone> Clone for Policy<P>

fn clone(&self) -> Policy<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Ord> Ord for Policy<P>

fn cmp(&self, other: &Policy<P>) -> 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.

impl<P: Eq> Eq for Policy<P>

impl<P: Display> Display for Policy<P>

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

Formats the value using the given formatter.

impl<P: Debug> Debug for Policy<P>

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

Formats the value using the given formatter.

impl<P: FromStr> FromStr for Policy<P> where
    P::Err: ToString + Debug, 

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Policy<P>, Error>

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