Enum EffectiveCapacity

pub enum EffectiveCapacity {
    ExactLiquidity {
        liquidity_msat: u64,
    },
    AdvertisedMaxHTLC {
        amount_msat: u64,
    },
    Total {
        capacity_msat: u64,
        htlc_maximum_msat: u64,
    },
    Infinite,
    HintMaxHTLC {
        amount_msat: u64,
    },
    Unknown,
}

The effective capacity of a channel for routing purposes.

While this may be smaller than the actual channel capacity, amounts greater than Self::as_msat should not be routed through the channel.

Variants

ExactLiquidity

The available liquidity in the channel known from being a channel counterparty, and thus a direct hop.

Fields

liquidity_msat: u64

Either the inbound or outbound liquidity depending on the direction, denominated in millisatoshi.

AdvertisedMaxHTLC

The maximum HTLC amount in one direction as advertised on the gossip network.

Fields

amount_msat: u64

The maximum HTLC amount denominated in millisatoshi.

Total

The total capacity of the channel as determined by the funding transaction.

Fields

capacity_msat: u64

The funding amount denominated in millisatoshi.

htlc_maximum_msat: u64

The maximum HTLC amount denominated in millisatoshi.

Infinite

A capacity sufficient to route any payment, typically used for private channels provided by an invoice.

HintMaxHTLC

The maximum HTLC amount as provided by an invoice route hint.

Fields

amount_msat: u64

The maximum HTLC amount denominated in millisatoshi.

Unknown

A capacity that is unknown possibly because either the chain state is unavailable to know the total capacity or the htlc_maximum_msat was not advertised on the gossip network.

Implementations

impl EffectiveCapacity

pub fn as_msat(&self) -> u64

Returns the effective capacity denominated in millisatoshi.

Trait Implementations

impl Clone for EffectiveCapacity

fn clone(&self) -> EffectiveCapacity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EffectiveCapacity

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

Formats the value using the given formatter.

impl PartialEq for EffectiveCapacity

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

impl StructuralPartialEq for EffectiveCapacity