Enum InboundHTLCStateDetails

pub enum InboundHTLCStateDetails {
    AwaitingRemoteRevokeToAdd,
    Committed,
    AwaitingRemoteRevokeToRemoveFulfill,
    AwaitingRemoteRevokeToRemoveFail,
}

Exposes the state of pending inbound HTLCs.

At a high level, an HTLC being forwarded from one Lightning node to another Lightning node goes through the following states in the state machine:

• Announced for addition by the originating node through the update_add_htlc message.
• Added to the commitment transaction of the receiving node and originating node in turn through the exchange of commitment_signed and revoke_and_ack messages.
• Announced for resolution (fulfillment or failure) by the receiving node through either one of the update_fulfill_htlc, update_fail_htlc, and update_fail_malformed_htlc messages.
• Removed from the commitment transaction of the originating node and receiving node in turn through the exchange of commitment_signed and revoke_and_ack messages.

This can be used to inspect what next message an HTLC is waiting for to advance its state.

Variants

AwaitingRemoteRevokeToAdd

We have added this HTLC in our commitment transaction by receiving commitment_signed and returning revoke_and_ack. We are awaiting the appropriate revoke_and_ack’s from the remote before this HTLC is included on the remote commitment transaction.

Committed

This HTLC has been included in the commitment_signed and revoke_and_ack messages on both sides and is included in both commitment transactions.

This HTLC is now safe to either forward or be claimed as a payment by us. The HTLC will remain in this state until the forwarded upstream HTLC has been resolved and we resolve this HTLC correspondingly, or until we claim it as a payment. If it is part of a multipart payment, it will only be claimed together with other required parts.

AwaitingRemoteRevokeToRemoveFulfill

We have received the preimage for this HTLC and it is being removed by fulfilling it with update_fulfill_htlc. This HTLC is still on both commitment transactions, but we are awaiting the appropriate revoke_and_ack’s from the remote before this HTLC is removed from the remote commitment transaction after update_fulfill_htlc.

AwaitingRemoteRevokeToRemoveFail

The HTLC is being removed by failing it with update_fail_htlc or update_fail_malformed_htlc. This HTLC is still on both commitment transactions, but we are awaiting the appropriate revoke_and_ack’s from the remote before this HTLC is removed from the remote commitment transaction.

Trait Implementations

impl Clone for InboundHTLCStateDetails

fn clone(&self) -> InboundHTLCStateDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InboundHTLCStateDetails

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

Formats the value using the given formatter.

impl MaybeReadable for InboundHTLCStateDetails

fn read<R>( reader: &mut R, ) -> Result<Option<InboundHTLCStateDetails>, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl PartialEq for InboundHTLCStateDetails

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

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

where W: Writer,

Writes self out to the given Writer.

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

Writes self out to a Vec<u8>.

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.

impl StructuralPartialEq for InboundHTLCStateDetails