Enum FailureCode

pub enum FailureCode {
    TemporaryNodeFailure,
    RequiredNodeFeatureMissing,
    IncorrectOrUnknownPaymentDetails,
    InvalidOnionPayload(Option<(u64, u16)>),
}

This enum is used to specify which error data to send to peers when failing back an HTLC using ChannelManager::fail_htlc_backwards_with_reason.

For more info on failure codes, see https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages.

Variants

TemporaryNodeFailure

We had a temporary error processing the payment. Useful if no other error codes fit and you want to indicate that the payer may want to retry.

RequiredNodeFeatureMissing

We have a required feature which was not in this onion. For example, you may require some additional metadata that was not provided with this payment.

IncorrectOrUnknownPaymentDetails

You may wish to use this when a payment_preimage is unknown, or the CLTV expiry of the HTLC is too close to the current block height for safe handling. Using this failure code in ChannelManager::fail_htlc_backwards_with_reason is equivalent to calling ChannelManager::fail_htlc_backwards.

InvalidOnionPayload(Option<(u64, u16)>)

We failed to process the payload after the onion was decrypted. You may wish to use this when receiving custom HTLC TLVs with even type numbers that you don’t recognize.

If available, the tuple data may include the type number and byte offset in the decrypted byte stream where the failure occurred.

Trait Implementations

impl Clone for FailureCode

fn clone(&self) -> FailureCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Into<u16> for FailureCode

fn into(self) -> u16

Converts this type into the (usually inferred) input type.

impl Copy for FailureCode