Enum lightning::util::events::ClosureReason

pub enum ClosureReason {
    CounterpartyForceClosed {
        peer_msg: String,
    },
    HolderForceClosed,
    CooperativeClosure,
    CommitmentTxConfirmed,
    FundingTimedOut,
    ProcessingError {
        err: String,
    },
    DisconnectedPeer,
    OutdatedChannelManager,
}

The reason the channel was closed. See individual variants more details.

Variants

CounterpartyForceClosed

Fields

peer_msg: String

The error which the peer sent us.

The string should be sanitized before it is used (e.g emitted to logs or printed to stdout). Otherwise, a well crafted error message may exploit a security vulnerability in the terminal emulator or the logging subsystem.

Closure generated from receiving a peer error message.

Our counterparty may have broadcasted their latest commitment state, and we have as well.

HolderForceClosed

Closure generated from ChannelManager::force_close_channel, called by the user.

CooperativeClosure

The channel was closed after negotiating a cooperative close and we’ve now broadcasted the cooperative close transaction. Note the shutdown may have been initiated by us.

CommitmentTxConfirmed

A commitment transaction was confirmed on chain, closing the channel. Most likely this commitment transaction came from our counterparty, but it may also have come from a copy of our own ChannelMonitor.

FundingTimedOut

The funding transaction failed to confirm in a timely manner on an inbound channel.

ProcessingError

Fields

err: String

A developer-readable error message which we generated.

Closure generated from processing an event, likely a HTLC forward/relay/reception.

DisconnectedPeer

The peer disconnected prior to funding completing. In this case the spec mandates that we forget the channel entirely - we can attempt again if the peer reconnects.

In LDK versions prior to 0.0.107 this could also occur if we were unable to connect to the peer because of mutual incompatibility between us and our channel counterparty.

OutdatedChannelManager

Closure generated from ChannelManager::read if the ChannelMonitor is newer than the ChannelManager deserialized.

Trait Implementations

impl Clone for ClosureReason

fn clone(&self) -> ClosureReason

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClosureReason

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

Formats the value using the given formatter.

impl Display for ClosureReason

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

Formats the value using the given formatter.

impl MaybeReadable for ClosureReason

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

Reads a Self in from the given Read

impl PartialEq<ClosureReason> for ClosureReason

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Writeable for ClosureReason

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 ClosureReason