Struct OutboundHTLCDetails

pub struct OutboundHTLCDetails {
    pub htlc_id: Option<u64>,
    pub amount_msat: u64,
    pub cltv_expiry: u32,
    pub payment_hash: PaymentHash,
    pub state: Option<OutboundHTLCStateDetails>,
    pub skimmed_fee_msat: Option<u64>,
    pub is_dust: bool,
}

Exposes details around pending outbound HTLCs.

Fields

htlc_id: Option<u64>

The HTLC ID. The IDs are incremented by 1 starting from 0 for each offered HTLC. They are unique per channel and inbound/outbound direction, unless an HTLC was only announced and not part of any commitment transaction.

Not present when we are awaiting a remote revocation and the HTLC is not added yet.

amount_msat: u64

The amount in msat.

cltv_expiry: u32

The block height at which this HTLC expires.

payment_hash: PaymentHash

The payment hash.

state: Option<OutboundHTLCStateDetails>

The state of the HTLC in the state machine.

Determines on which commitment transactions the HTLC is included and what message the HTLC is waiting for to advance to the next state.

See OutboundHTLCStateDetails for information on the specific states.

LDK will always fill this field in, but when downgrading to prior versions of LDK, new states may result in None here.

skimmed_fee_msat: Option<u64>

The extra fee being skimmed off the top of this HTLC.

is_dust: bool

Whether the HTLC has an output below the local dust limit. If so, the output will be trimmed from the local commitment transaction and added to the commitment transaction fee. For non-anchor channels, this takes into account the cost of the second-stage HTLC transactions as well.

When the local commitment transaction is broadcasted as part of a unilateral closure, the value of this HTLC will therefore not be claimable but instead burned as a transaction fee.

Note that dust limits are specific to each party. An HTLC can be dust for the local commitment transaction but not for the counterparty’s commitment transaction and vice versa.

Trait Implementations

impl Clone for OutboundHTLCDetails

fn clone(&self) -> OutboundHTLCDetails

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutboundHTLCDetails

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

Formats the value using the given formatter.

impl PartialEq for OutboundHTLCDetails

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

fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl Writeable for OutboundHTLCDetails

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

impl StructuralPartialEq for OutboundHTLCDetails