Enum lightning::util::events::HTLCDestination

pub enum HTLCDestination {
    NextHopChannel {
        node_id: Option<PublicKey>,
        channel_id: [u8; 32],
    },
    UnknownNextHop {
        requested_forward_scid: u64,
    },
    FailedPayment {
        payment_hash: PaymentHash,
    },
}

Intended destination of a failed HTLC as indicated in Event::HTLCHandlingFailed.

Variants

NextHopChannel

Fields

node_id: Option<PublicKey>

The node_id of the next node. For backwards compatibility, this field is marked as optional, versions prior to 0.0.110 may not always be able to provide counterparty node information.

channel_id: [u8; 32]

The outgoing channel_id between us and the next node.

We tried forwarding to a channel but failed to do so. An example of such an instance is when there is insufficient capacity in our outbound channel.

UnknownNextHop

Fields

requested_forward_scid: u64

Short channel id we are requesting to forward an HTLC to.

Scenario where we are unsure of the next node to forward the HTLC to.

FailedPayment

Fields

payment_hash: PaymentHash

The payment hash of the payment we attempted to process.

Failure scenario where an HTLC may have been forwarded to be intended for us, but is invalid for some reason, so we reject it.

Some of the reasons may include:

• HTLC Timeouts
• Expected MPP amount to claim does not equal HTLC total
• Claimable amount does not match expected amount

Trait Implementations

impl Clone for HTLCDestination

fn clone(&self) -> HTLCDestination

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HTLCDestination

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

Formats the value using the given formatter.

impl MaybeReadable for HTLCDestination

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

Reads a Self in from the given Read

impl PartialEq<HTLCDestination> for HTLCDestination

fn eq(&self, other: &HTLCDestination) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HTLCDestination) -> bool

This method tests for !=.

impl Writeable for HTLCDestination

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

Writes self out to the given Writer

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

Writes self out to a Vec

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 HTLCDestination