Struct ChannelDetails

pub struct ChannelDetails {
    pub channel_id: ChannelId,
    pub user_channel_id: UserChannelId,
    pub funding_txo: Option<OutPoint>,
    pub is_usable: bool,
    pub channel_value: Amount,
    pub our_balance: Amount,
    pub their_balance: Amount,
    pub punishment_reserve: Amount,
    pub outbound_capacity: Amount,
    pub inbound_capacity: Amount,
}

Details about one of this node’s Lightning channels.

Fields

channel_id: ChannelId

The id of the channel.

user_channel_id: UserChannelId

A user-provided id for this channel that’s associated with the channel throughout its whole lifetime, as the Lightning protocol channel id is only known after negotiating the channel and creating the funding tx.

funding_txo: Option<OutPoint>

The channel’s funding transaction output, or None if the funding transaction has not yet been confirmed.

is_usable: bool

Whether the channel is ready and its counterparty is online, so it can send and receive payments right now.

channel_value: Amount

The total value of the channel.

our_balance: Amount

Our balance in the channel.

their_balance: Amount

The counterparty’s balance in the channel.

punishment_reserve: Amount

The portion of our balance that the counterparty requires us to keep in reserve as anti-cheating collateral. This is unspendable and does not count towards outbound_capacity.

outbound_capacity: Amount

How much of our balance is currently available to send.

inbound_capacity: Amount

How much of the counterparty’s balance is available for us to receive.

Trait Implementations

impl<'de> Deserialize<'de> for ChannelDetails

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<LxChannelDetails> for ChannelDetails

fn from(details: LxChannelDetails) -> Self

Converts to this type from the input type.

impl Serialize for ChannelDetails

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

where __S: Serializer,

Serialize this value into the given Serde serializer.