Struct bdk::descriptor::policy::Policy

pub struct Policy {
    pub id: String,
    pub item: SatisfiableItem,
    pub satisfaction: Satisfaction,
    pub contribution: Satisfaction,
}

Descriptor spending policy

Fields

id: String

Identifier for this policy node

item: SatisfiableItem

Type of this policy node

satisfaction: Satisfaction

How a much given PSBT already satisfies this polcy node (currently unused)

contribution: Satisfaction

How the wallet's descriptor can satisfy this policy node

Implementations

impl Policy

pub fn requires_path(&self) -> bool

Return whether or not a specific path in the policy tree is required to unambiguously create a transaction

What this means is that for some spending policies the user should select which paths in the tree it intends to satisfy while signing, because the transaction must be created differently based on that.

pub fn get_condition(
    &self,
    path: &BTreeMap<String, Vec<usize>>
) -> Result<Condition, PolicyError>

Return the conditions that are set by the spending policy for a given path in the policy tree

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Policy

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

Formats the value using the given formatter.

impl From<SatisfiableItem> for Policy

fn from(other: SatisfiableItem) -> Self

Performs the conversion.

impl Serialize for Policy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.