Enum miniscript::policy::AbstractPolicy

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

An "abstract" script policy that does not distinguish between functionally equivalent things. Designed to be filterable and analyzable, and to be created from either concrete Policys or even-concreter Miniscripts.

Variants

True

No requirements for satisfaction

Key(P)

A public key which must sign to satisfy the descriptor

Hash(Hash)

A SHA256 whose preimage must be provided to satisfy the descriptor

Time(u32)

A locktime restriction

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

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

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

A list of descriptors, all of which must be satisfied

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

A pair of descriptors, one of which must be satisfied

Methods

impl<P> AbstractPolicy<P>

pub fn timelocks(&self) -> Vec<u32>

Returns a list of all timelocks, not including 0, which appear in the policy

pub fn before_time(self, time: u32) -> Option<AbstractPolicy<P>>

Filter an abstract policy by eliminating any timelock constraints. If, after filtering, the policy cannot be satisfied, this function returns None.

pub fn n_keys(&self) -> usize

Count the number of public keys referenced in a policy. Note that duplicate keys will be double-counted.

pub fn minimum_n_keys(&self) -> usize

Count the minimum number of public keys for which signatures could be used to satisfy the policy.

impl<P: Ord> AbstractPolicy<P>

pub fn sort(self) -> AbstractPolicy<P>

"Sort" a policy to bring it into a canonical form to allow comparisons. This does not allow policies to be compared for functional equivalence; in general this appears to require Gröbner basis techniques that are not implemented.

Trait Implementations

impl<P: Eq> Eq for AbstractPolicy<P>

impl<P: Ord> Ord for AbstractPolicy<P>

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

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<P: PartialEq> PartialEq<AbstractPolicy<P>> for AbstractPolicy<P>

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

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

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

This method tests for !=.

impl<P: Clone> Clone for AbstractPolicy<P>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: PartialOrd> PartialOrd<AbstractPolicy<P>> for AbstractPolicy<P>

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

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

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

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

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

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

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

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

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

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

impl<P: Debug> Debug for AbstractPolicy<P>

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

Formats the value using the given formatter.