Struct ServerHtlcSendVtxoPolicy

pub struct ServerHtlcSendVtxoPolicy {
    pub user_pubkey: PublicKey,
    pub payment_hash: PaymentHash,
    pub htlc_expiry: BlockHeight,
}

Policy enabling outgoing Lightning payments.

This will build a taproot with 3 clauses:

1. The keyspend path allows Alice and Server to collaborate to spend the HTLC. The Server can use this path to revoke the HTLC if payment failed

2. The script-spend path contains one leaf that allows Server to spend the HTLC after the expiry, if it knows the preimage. Server can use this path if Alice tries to spend using her clause.

3. The second leaf allows Alice to spend the HTLC after its expiry and with a delay. Alice must use this path if the server fails to provide the preimage and refuse to revoke the HTLC. It will either force the Server to reveal the preimage (by spending using her clause) or give Alice her money back.

Fields

user_pubkey: PublicKey

payment_hash: PaymentHash

htlc_expiry: BlockHeight

Implementations

impl ServerHtlcSendVtxoPolicy

pub fn server_reveals_preimage_clause( &self, server_pubkey: PublicKey, exit_delta: BlockDelta, ) -> HashDelaySignClause

Allows Server to spend the HTLC after the delta, if it knows the preimage. Server can use this path if Alice tries to spend using her clause.

pub fn user_claim_after_expiry_clause( &self, exit_delta: BlockDelta, ) -> DelayedTimelockSignClause

Allows Alice to spend the HTLC after its expiry and with a delay. Alice must use this path if the server fails to provide the preimage and refuse to revoke the HTLC. It will either force the server to reveal the preimage (by spending using its clause) or give Alice her money back.

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

pub fn taproot( &self, server_pubkey: PublicKey, exit_delta: BlockDelta, ) -> TaprootSpendInfo

Trait Implementations

impl Clone for ServerHtlcSendVtxoPolicy

fn clone(&self) -> ServerHtlcSendVtxoPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerHtlcSendVtxoPolicy

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

Formats the value using the given formatter.

impl From<ServerHtlcSendVtxoPolicy> for VtxoPolicy

fn from(policy: ServerHtlcSendVtxoPolicy) -> Self

Converts to this type from the input type.

impl Hash for ServerHtlcSendVtxoPolicy

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 ServerHtlcSendVtxoPolicy

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

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

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

impl StructuralPartialEq for ServerHtlcSendVtxoPolicy