Enum ChannelState 

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

The state of a channel.

Note: fiber-lib uses default serde (bincode-compatible), while fiber-json-types uses #[serde(tag = "state_name", content = "state_flags")] for JSON. This definition uses the default (bincode-compatible) representation. The JSON-specific tagged version is defined in fiber-json-types.

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.

Closed(CloseFlags)

This channel is closed.

Implementations

impl ChannelState

pub fn is_awaiting_external_funding(&self) -> bool

pub fn is_closed(&self) -> bool

pub fn can_abort_funding(&self) -> bool

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 PartialEq for ChannelState

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