Struct ClaimedHTLC

pub struct ClaimedHTLC {
    pub channel_id: ChannelId,
    pub user_channel_id: u128,
    pub cltv_expiry: u32,
    pub value_msat: u64,
    pub counterparty_skimmed_fee_msat: u64,
}

Information about an HTLC that is part of a payment that can be claimed.

Fields

channel_id: ChannelId

The channel_id of the channel over which the HTLC was received.

user_channel_id: u128

The user_channel_id of the channel over which the HTLC was received. This is the value passed in to ChannelManager::create_channel for outbound channels, or to ChannelManager::accept_inbound_channel for inbound channels if UserConfig::manually_accept_inbound_channels config flag is set to true. Otherwise user_channel_id will be randomized for an inbound channel.

This field will be zero for a payment that was serialized prior to LDK version 0.0.117. (This should only happen in the case that a payment was claimable prior to LDK version 0.0.117, but was not actually claimed until after upgrading.)

cltv_expiry: u32

The block height at which this HTLC expires.

value_msat: u64

The amount (in msats) of this part of an MPP.

counterparty_skimmed_fee_msat: u64

The extra fee our counterparty skimmed off the top of this HTLC, if any.

This value will always be 0 for ClaimedHTLCs serialized with LDK versions prior to 0.0.119.

Trait Implementations

impl Clone for ClaimedHTLC

fn clone(&self) -> ClaimedHTLC

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClaimedHTLC

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

Formats the value using the given formatter.

impl PartialEq for ClaimedHTLC

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

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

Reads a Self in from the given Read.

impl Writeable for ClaimedHTLC

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 Eq for ClaimedHTLC

impl StructuralPartialEq for ClaimedHTLC