Enum HTLCHandlingFailureType

pub enum HTLCHandlingFailureType {
    Forward {
        node_id: Option<PublicKey>,
        channel_id: ChannelId,
    },
    UnknownNextHop {
        requested_forward_scid: u64,
    },
    InvalidForward {
        requested_forward_scid: u64,
    },
    InvalidOnion,
    Receive {
        payment_hash: PaymentHash,
    },
}

The type of HTLC handling performed in Event::HTLCHandlingFailed.

Variants

Forward

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.

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: ChannelId

The outgoing channel_id between us and the next node.

UnknownNextHop

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

Deprecated: will only be used in versions before LDK v0.2.0. Downgrades will result in this type being represented as Self::InvalidForward.

Fields

requested_forward_scid: u64

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

InvalidForward

We couldn’t forward to the outgoing scid. An example would be attempting to send a duplicate intercept HTLC.

In LDK v0.2.0 and greater, this variant replaces Self::UnknownNextHop.

Fields

requested_forward_scid: u64

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

InvalidOnion

We couldn’t decode the incoming onion to obtain the forwarding details.

Receive

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
• Excess HTLCs for a payment that we have already fully received, over-paying for the payment,
• The counterparty node modified the HTLC in transit,
• A probing attack where an intermediary node is trying to detect if we are the ultimate recipient for a payment.

Fields

payment_hash: PaymentHash

The payment hash of the payment we attempted to process.

Trait Implementations

impl Clone for HTLCHandlingFailureType

fn clone(&self) -> HTLCHandlingFailureType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HTLCHandlingFailureType

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

Formats the value using the given formatter.

impl MaybeReadable for HTLCHandlingFailureType

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

Reads a Self in from the given Read.

impl PartialEq for HTLCHandlingFailureType

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

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

impl StructuralPartialEq for HTLCHandlingFailureType