Enum ChannelState 

pub enum ChannelState {
    NegotiatingFunding(NegotiatingFundingFlags),
    CollaboratingFundingTx(CollaboratingFundingTxFlags),
    SigningCommitment(SigningCommitmentFlags),
    AwaitingTxSignatures(AwaitingTxSignaturesFlags),
    AwaitingChannelReady(AwaitingChannelReadyFlags),
    ChannelReady,
    ShuttingDown(ShuttingDownFlags),
    Closed(CloseFlags),
    Stale,
}

The state of a channel.

Serialized with adjacently-tagged representation using PascalCase variant names and flags. This is different from the internal ChannelState in fiber-types which uses default serde for bincode compatibility.

Variants

NegotiatingFunding(NegotiatingFundingFlags)

We are negotiating the parameters required for the channel prior to funding it. For channels opened with external funding, this state is also used together with NegotiatingFundingFlags::AWAITING_EXTERNAL_FUNDING to indicate that we are waiting for the user to sign and submit the funding transaction externally.

CollaboratingFundingTx(CollaboratingFundingTxFlags)

We’re collaborating with the other party on the funding transaction.

SigningCommitment(SigningCommitmentFlags)

We have collaborated over the funding and are now waiting for CommitmentSigned messages.

AwaitingTxSignatures(AwaitingTxSignaturesFlags)

We’ve received and sent commitment_signed and are now waiting for both party to collaborate on creating a valid funding transaction.

AwaitingChannelReady(AwaitingChannelReadyFlags)

We’ve received/sent funding_created and funding_signed and are thus now waiting on the funding transaction to confirm.

ChannelReady

Both we and our counterparty consider the funding transaction confirmed and the channel is now operational.

ShuttingDown(ShuttingDownFlags)

We’ve successfully negotiated a closing_signed dance. At this point, the ChannelManager

Closed(CloseFlags)

This channel is closed.

Stale

The channel state is potentially outdated (e.g., after a database restore). We must perform a passive audit with the peer before resuming operations.

Trait Implementations

impl Clone for ChannelState

fn clone(&self) -> ChannelState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ChannelState

impl Debug for ChannelState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ChannelState

impl JsonSchema for ChannelState

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ChannelState

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ChannelState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChannelState