Enum ChannelShutdownState

pub enum ChannelShutdownState {
    NotShuttingDown,
    ShutdownInitiated,
    ResolvingHTLCs,
    NegotiatingClosingFee,
    ShutdownComplete,
}

Further information on the details of the channel shutdown. Upon channels being forced closed (i.e. commitment transaction confirmation detected by ChainMonitor), ChannelShutdownState will be set to ShutdownComplete or the channel will be removed shortly. Also note, that in normal operation, peers could disconnect at any of these states and require peer re-connection before making progress onto other states

Variants

NotShuttingDown

Channel has not sent or received a shutdown message.

ShutdownInitiated

Local node has sent a shutdown message for this channel.

ResolvingHTLCs

Shutdown message exchanges have concluded and the channels are in the midst of resolving all existing open HTLCs before closing can continue.

NegotiatingClosingFee

All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.

ShutdownComplete

We’ve successfully negotiated a closing_signed dance. At this point ChannelManager is about to drop the channel.

Trait Implementations

impl Clone for ChannelShutdownState

fn clone(&self) -> ChannelShutdownState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelShutdownState

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

Formats the value using the given formatter.

impl PartialEq for ChannelShutdownState

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

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

Reads a Self in from the given Read.

impl Writeable for ChannelShutdownState

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 Copy for ChannelShutdownState

impl Eq for ChannelShutdownState

impl StructuralPartialEq for ChannelShutdownState