Struct HarkLeafVtxoPolicy

pub struct HarkLeafVtxoPolicy {
    pub user_pubkey: PublicKey,
    pub unlock_hash: UnlockHash,
}

Policy for hArk leaf outputs (intermediate outputs spent by leaf txs).

These are the outputs that feed into the final leaf transactions in a signed VTXO tree. They are locked by:

1. An expiry clause allowing the server to sweep after expiry
2. An unlock clause requiring a preimage and a signature from user+server

The internal key is set to the MuSig of user’s VTXO key + server pubkey.

Fields

user_pubkey: PublicKey

unlock_hash: UnlockHash

Implementations

impl HarkLeafVtxoPolicy

pub fn expiry_clause( &self, expiry_height: BlockHeight, server_pubkey: PublicKey, ) -> TimelockSignClause

Creates the expiry clause allowing the server to sweep after expiry.

pub fn unlock_clause(&self, server_pubkey: PublicKey) -> HashSignClause

Creates the unlock clause requiring a preimage and aggregate signature.

pub fn clauses( &self, expiry_height: BlockHeight, server_pubkey: PublicKey, ) -> Vec<VtxoClause>

Returns the clauses for this policy.

pub fn taproot( &self, server_pubkey: PublicKey, expiry_height: BlockHeight, ) -> TaprootSpendInfo

Build the taproot spend info for this policy.

Trait Implementations

impl Clone for HarkLeafVtxoPolicy

fn clone(&self) -> HarkLeafVtxoPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HarkLeafVtxoPolicy

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

Formats the value using the given formatter.

impl From<HarkLeafVtxoPolicy> for ServerVtxoPolicy

fn from(p: HarkLeafVtxoPolicy) -> Self

Converts to this type from the input type.

impl Hash for HarkLeafVtxoPolicy

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 Ord for HarkLeafVtxoPolicy

fn cmp(&self, other: &HarkLeafVtxoPolicy) -> 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 PartialEq for HarkLeafVtxoPolicy

fn eq(&self, other: &HarkLeafVtxoPolicy) -> 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 PartialOrd for HarkLeafVtxoPolicy

fn partial_cmp(&self, other: &HarkLeafVtxoPolicy) -> 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 Eq for HarkLeafVtxoPolicy

impl StructuralPartialEq for HarkLeafVtxoPolicy