Struct lightning::ln::router::Router

pub struct Router { /* fields omitted */ }

Tracks a view of the network, receiving updates from peers and generating Routes to payment destinations.

Methods

impl Router

pub fn new(
    our_pubkey: PublicKey,
    chain_monitor: Arc<dyn ChainWatchInterface>,
    logger: Arc<dyn Logger>
) -> Router

Creates a new router with the given node_id to be used as the source for get_route()

pub fn trace_state(&self)

Dumps the entire network view of this Router to the logger provided in the constructor at level Trace

pub fn get_addresses(&self, pubkey: &PublicKey) -> Option<Vec<NetAddress>>

Get network addresses by node id

pub fn mark_node_bad(&self, _node_id: &PublicKey, _blamed_upstream_node: bool)

Marks a node as having failed a route. This will avoid re-using the node in routes for now, with an exponential decay in node "badness". Note that there is deliberately no mark_channel_bad as a node may simply lie and suggest that an upstream channel from it is what failed the route and not the node itself. Instead, setting the blamed_upstream_node boolean will reduce the penalty, returning the node to usability faster. If the node is behaving correctly, it will disable the failing channel and we will use it again next time.

pub fn get_route(
    &self,
    target: &PublicKey,
    first_hops: Option<&[ChannelDetails]>,
    last_hops: &[RouteHint],
    final_value_msat: u64,
    final_cltv: u32
) -> Result<Route, LightningError>

Gets a route from us to the given target node.

Extra routing hops between known nodes and the target will be used if they are included in last_hops.

If some channels aren't announced, it may be useful to fill in a first_hops with the results from a local ChannelManager::list_usable_channels() call. If it is filled in, our (this Router's) view of our local channels will be ignored, and only those in first_hops will be used.

Panics if first_hops contains channels without short_channel_ids (ChannelManager::list_usable_channels will never include such channels).

The fees on channels from us to next-hops are ignored (as they are assumed to all be equal), however the enabled/disabled bit on such channels as well as the htlc_minimum_msat is checked as they may change based on the receiving node.

Trait Implementations

impl ReadableArgs<RouterReadArgs> for Router

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

Reads a Self in from the given Read

impl RoutingMessageHandler for Router

fn handle_node_announcement(
    &self,
    msg: &NodeAnnouncement
) -> Result<bool, LightningError>

Handle an incoming node_announcement message, returning true if it should be forwarded on, false or returning an Err otherwise.

fn handle_channel_announcement(
    &self,
    msg: &ChannelAnnouncement
) -> Result<bool, LightningError>

Handle a channel_announcement message, returning true if it should be forwarded on, false or returning an Err otherwise.

fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate)

Handle some updates to the route graph that we learned due to an outbound failed payment.

fn handle_channel_update(
    &self,
    msg: &ChannelUpdate
) -> Result<bool, LightningError>

Handle an incoming channel_update message, returning true if it should be forwarded on, false or returning an Err otherwise.

fn get_next_channel_announcements(
    &self,
    starting_point: u64,
    batch_amount: u8
) -> Vec<(ChannelAnnouncement, Option<ChannelUpdate>, Option<ChannelUpdate>)>

Gets a subset of the channel announcements and updates required to dump our routing table to a remote node, starting at the short_channel_id indicated by starting_point and including the batch_amount entries immediately higher in numerical value than starting_point.

fn get_next_node_announcements(
    &self,
    starting_point: Option<&PublicKey>,
    batch_amount: u8
) -> Vec<NodeAnnouncement>

Gets a subset of the node announcements required to dump our routing table to a remote node, starting at the node after the provided publickey and including batch_amount entries immediately higher (as defined by ::cmp) than starting_point. If None is provided for starting_point, we start at the first node.

fn should_request_full_sync(&self, _node_id: &PublicKey) -> bool

Returns whether a full sync should be requested from a peer.

impl Writeable for Router

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

Writes self out to the given Writer

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

Writes self out to a Vec

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

Writes self out to a Vec