Struct ServerHtlcRecvVtxoPolicy

pub struct ServerHtlcRecvVtxoPolicy {
    pub user_pubkey: PublicKey,
    pub payment_hash: PaymentHash,
    pub htlc_expiry_delta: BlockDelta,
    pub htlc_expiry: BlockHeight,
}

Policy enabling incoming Lightning payments.

This will build a taproot with 3 clauses:

1. The keyspend path allows Alice and Server to collaborate to spend the HTLC. This is the expected path to be used. Server should only accept to collaborate if Alice reveals the preimage.

2. The script-spend path contains one leaf that allows Server to spend the HTLC after the expiry, with an exit delta delay. Server can use this path if Alice tries to spend the HTLC using the 3rd path after the HTLC expiry

3. The second leaf allows Alice to spend the HTLC if she knows the preimage, but with a greater exit delta delay than server’s clause. Alice must use this path if she revealed the preimage but Server refused to collaborate.

Fields

user_pubkey: PublicKey

payment_hash: PaymentHash

htlc_expiry_delta: BlockDelta

htlc_expiry: BlockHeight

Implementations

impl ServerHtlcRecvVtxoPolicy

pub fn user_reveals_preimage_clause( &self, exit_delta: BlockDelta, ) -> HashDelaySignClause

Allows Alice to spend the HTLC if she knows the preimage, but with a greater exit delta delay than server’s clause. Alice must use this path if she revealed the preimage but server refused to cosign claim VTXO.

pub fn server_claim_after_expiry_clause( &self, server_pubkey: PublicKey, exit_delta: BlockDelta, ) -> DelayedTimelockSignClause

Allows Server to spend the HTLC after the HTLC expiry, with an exit delta delay. Server can use this path if Alice tries to spend the HTLC using her clause after the HTLC expiry.

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 ServerHtlcRecvVtxoPolicy

fn clone(&self) -> ServerHtlcRecvVtxoPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerHtlcRecvVtxoPolicy

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

Formats the value using the given formatter.

impl From<ServerHtlcRecvVtxoPolicy> for VtxoPolicy

fn from(policy: ServerHtlcRecvVtxoPolicy) -> Self

Converts to this type from the input type.

impl Hash for ServerHtlcRecvVtxoPolicy

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 ServerHtlcRecvVtxoPolicy

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

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

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

impl StructuralPartialEq for ServerHtlcRecvVtxoPolicy