Skip to main content

Policy

Enum Policy 

Source
pub enum Policy {
    Key([u8; 33]),
    After(u32),
    Older(u32),
    Sha256([u8; 32]),
    Ripemd160([u8; 20]),
    Hash160([u8; 20]),
    And(Vec<Policy>),
    Or(Vec<Policy>),
    Threshold(usize, Vec<Policy>),
    Unsatisfiable,
    Trivial,
}
Expand description

A high-level spending policy.

Policies describe what conditions must be satisfied, without specifying how they are encoded in Bitcoin Script.

Variants§

§

Key([u8; 33])

Require a signature for this public key (33-byte compressed).

§

After(u32)

Absolute timelock (BIP-65 CLTV).

§

Older(u32)

Relative timelock (BIP-112 CSV).

§

Sha256([u8; 32])

SHA-256 hash preimage lock.

§

Ripemd160([u8; 20])

RIPEMD-160 hash preimage lock.

§

Hash160([u8; 20])

HASH-160 (SHA-256 → RIPEMD-160) preimage lock.

§

And(Vec<Policy>)

All sub-policies must be satisfied (AND).

§

Or(Vec<Policy>)

Any one sub-policy must be satisfied (OR with equal weights).

§

Threshold(usize, Vec<Policy>)

k-of-n threshold: at least k sub-policies must be satisfied.

§

Unsatisfiable

Always fails (un-spendable).

§

Trivial

Always succeeds (trivially satisfiable).

Implementations§

Source§

impl Policy

Source

pub fn compile(&self) -> Result<Miniscript, SignerError>

Compile this policy to a Miniscript fragment.

Returns Err if the policy is malformed (e.g., empty threshold, threshold k > n, or empty AND/OR).

Trait Implementations§

Source§

impl Clone for Policy

Source§

fn clone(&self) -> Policy

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Policy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Policy

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Policy

Source§

impl StructuralPartialEq for Policy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.