Enum Policy

pub enum Policy<Pk: SimplicityKey> {
    Unsatisfiable(FailEntropy),
    Trivial,
    Key(Pk),
    After(u32),
    Older(u16),
    Sha256(Pk::Sha256),
    And {
        left: Arc<Policy<Pk>>,
        right: Arc<Policy<Pk>>,
    },
    Or {
        left: Arc<Policy<Pk>>,
        right: Arc<Policy<Pk>>,
    },
    Threshold(usize, Vec<Policy<Pk>>),
    Assembly(Cmr),
}

Policy that expresses spending conditions for Simplicity.

The policy can be compiled into a Simplicity program and executed on the Bit Machine, given a witness.

Furthermore, the policy can be normalized and is amenable to semantic analysis.

Variants

Unsatisfiable(FailEntropy)

Unsatisfiable

Trivial

Trivially satisfiable

Key(Pk)

Provide a signature that matches the given public key and some given message hash

After(u32)

Absolute timelock

Older(u16)

Relative timelock

Sha256(Pk::Sha256)

Provide the preimage of the given SHA256 hash image

And

Satisfy both of the given sub-policies

Fields

left: Arc<Policy<Pk>>

right: Arc<Policy<Pk>>

Or

Satisfy exactly one of the given sub-policies

Fields

left: Arc<Policy<Pk>>

right: Arc<Policy<Pk>>

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

Satisfy exactly k of the given sub-policies

Assembly(Cmr)

Satisfy the program with the given CMR

Implementations

impl<Pk: ToXOnlyPubkey> Policy<Pk>

pub fn commit(&self) -> Option<Arc<CommitNode<Elements>>>

Return the program commitment of the policy.

pub fn cmr(&self) -> Cmr

Return the CMR of the policy.

impl<Pk: SimplicityKey> Policy<Pk>

pub fn translate<T, Q, E>(&self, translator: &mut T) -> Result<Policy<Q>, E>

where T: Translator<Pk, Q, E>, Q: SimplicityKey,

Convert a policy using one kind of public key to another type of public key

pub fn normalized(self) -> Policy<Pk>

Flatten out trees of Ands and Ors; eliminate Trivial and Unsatisfiables. Does not reorder any branches; use .sort.

pub fn sorted(self) -> Policy<Pk>

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

pub fn iter(&self) -> PolicyIter<'_, Pk>

Return an iterator over the fragments of the policy.

pub fn iter_pk(&self) -> impl Iterator<Item = Pk> + '_

Return an iterator over the public keys of the policy.

impl<Pk: ToXOnlyPubkey> Policy<Pk>

pub fn satisfy<S: Satisfier<Pk>>( &self, satisfier: &S, env: &ElementsEnv<Arc<Transaction>>, ) -> Result<Arc<RedeemNode<Elements>>, SatisfierError>

Return the policy program with satisfying witness data.

The program is run on the Bit Machine for pruning, so the transaction environment needs to be provided.

Trait Implementations

impl<Pk: Clone + SimplicityKey> Clone for Policy<Pk>

where Pk::Sha256: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Pk: SimplicityKey> Debug for Policy<Pk>

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

Formats the value using the given formatter.

impl<Pk: SimplicityKey> Display for Policy<Pk>

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

Formats the value using the given formatter.

impl<Pk: Hash + SimplicityKey> Hash for Policy<Pk>

where Pk::Sha256: Hash,

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<Pk: Ord + SimplicityKey> Ord for Policy<Pk>

where Pk::Sha256: Ord,

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

where Pk::Sha256: PartialEq,

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

where Pk::Sha256: PartialOrd,

fn partial_cmp(&self, other: &Policy<Pk>) -> 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: Eq + SimplicityKey> Eq for Policy<Pk>

where Pk::Sha256: Eq,

impl<Pk: SimplicityKey> StructuralPartialEq for Policy<Pk>