Struct lightning::routing::router::RouteHop

pub struct RouteHop {
    pub pubkey: PublicKey,
    pub node_features: NodeFeatures,
    pub short_channel_id: u64,
    pub channel_features: ChannelFeatures,
    pub fee_msat: u64,
    pub cltv_expiry_delta: u32,
    pub maybe_announced_channel: bool,
}

A hop in a route, and additional metadata about it. “Hop” is defined as a node and the channel that leads to it.

Fields

pubkey: PublicKey

The node_id of the node at this hop.

node_features: NodeFeatures

The node_announcement features of the node at this hop. For the last hop, these may be amended to match the features present in the invoice this node generated.

short_channel_id: u64

The channel that should be used from the previous hop to reach this node.

channel_features: ChannelFeatures

The channel_announcement features of the channel that should be used from the previous hop to reach this node.

fee_msat: u64

The fee taken on this hop (for paying for the use of the next channel in the path). If this is the last hop in Path::hops:

• if we’re sending to a BlindedPath, this is the fee paid for use of the entire blinded path
• otherwise, this is the full value of this Path’s part of the payment

cltv_expiry_delta: u32

The CLTV delta added for this hop. If this is the last hop in Path::hops:

• if we’re sending to a BlindedPath, this is the CLTV delta for the entire blinded path
• otherwise, this is the CLTV delta expected at the destination

maybe_announced_channel: bool

Indicates whether this hop is possibly announced in the public network graph.

Will be true if there is a possibility that the channel is publicly known, i.e., if we either know for sure it’s announced in the public graph, or if any public channels exist for which the given short_channel_id could be an alias for. Will be false if we believe the channel to be unannounced.

Will be true for objects serialized with LDK version 0.0.116 and before.

Trait Implementations

impl Clone for RouteHop

fn clone(&self) -> RouteHop

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteHop

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

Formats the value using the given formatter.

impl Hash for RouteHop

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Readable for RouteHop

fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl Writeable for RouteHop

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

impl Eq for RouteHop

impl StructuralPartialEq for RouteHop