Struct lightning_types::routing::RouteHintHop

pub struct RouteHintHop {
    pub src_node_id: PublicKey,
    pub short_channel_id: u64,
    pub fees: RoutingFees,
    pub cltv_expiry_delta: u16,
    pub htlc_minimum_msat: Option<u64>,
    pub htlc_maximum_msat: Option<u64>,
}

A channel descriptor for a hop along a payment path.

While this generally comes from BOLT 11’s r field, this struct includes more fields than are available in BOLT 11. Thus, encoding and decoding this via lightning-invoice is lossy, as fields not supported in BOLT 11 will be stripped.

Fields

src_node_id: PublicKey

The node_id of the non-target end of the route

short_channel_id: u64

The short_channel_id of this channel

fees: RoutingFees

The fees which must be paid to use this channel

cltv_expiry_delta: u16

The difference in CLTV values between this node and the next node.

htlc_minimum_msat: Option<u64>

The minimum value, in msat, which must be relayed to the next hop.

htlc_maximum_msat: Option<u64>

The maximum value in msat available for routing with a single HTLC.

Trait Implementations

impl Clone for RouteHintHop

fn clone(&self) -> RouteHintHop

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteHintHop

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

Formats the value using the given formatter.

impl Hash for RouteHintHop

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RouteHintHop

fn cmp(&self, other: &RouteHintHop) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RouteHintHop

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

fn partial_cmp(&self, other: &RouteHintHop) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for RouteHintHop

impl StructuralPartialEq for RouteHintHop