Struct HTLCOutputInCommitment

pub struct HTLCOutputInCommitment {
    pub offered: bool,
    pub amount_msat: u64,
    pub cltv_expiry: u32,
    pub payment_hash: PaymentHash,
    pub transaction_output_index: Option<u32>,
}

Information about an HTLC as it appears in a commitment transaction

Fields

offered: bool

Whether the HTLC was “offered” (ie outbound in relation to this commitment transaction). Note that this is not the same as whether it is ountbound from us. To determine that you need to compare this value to whether the commitment transaction in question is that of the counterparty or our own.

amount_msat: u64

The value, in msat, of the HTLC. The value as it appears in the commitment transaction is this divided by 1000.

cltv_expiry: u32

The CLTV lock-time at which this HTLC expires.

payment_hash: PaymentHash

The hash of the preimage which unlocks this HTLC.

transaction_output_index: Option<u32>

The position within the commitment transactions’ outputs. This may be None if the value is below the dust limit (in which case no output appears in the commitment transaction and the value is spent to additional transaction fees).

Implementations

impl HTLCOutputInCommitment

pub const fn to_bitcoin_amount(&self) -> Amount

Converts HTLC’s value with millisatoshi precision into bitcoin::Amount with satoshi precision. Typically this conversion is needed when transitioning from LN into base-layer Bitcoin, e. g. in commitment transactions.

Trait Implementations

impl Clone for HTLCOutputInCommitment

fn clone(&self) -> HTLCOutputInCommitment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HTLCOutputInCommitment

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

Formats the value using the given formatter.

impl PartialEq for HTLCOutputInCommitment

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

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

Reads a Self in from the given Read.

impl Writeable for HTLCOutputInCommitment

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 HTLCOutputInCommitment

impl StructuralPartialEq for HTLCOutputInCommitment