Struct lightning_invoice::utils::DefaultRouter

pub struct DefaultRouter<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref>where
    L::Target: Logger,
    S::Target: for<'a> LockableScore<'a>,{ /* private fields */ }

A Router implemented using find_route.

Implementations

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> DefaultRouter<G, L, S>where
    L::Target: Logger,
    S::Target: for<'a> LockableScore<'a>,

pub fn new(
    network_graph: G,
    logger: L,
    random_seed_bytes: [u8; 32],
    scorer: S
) -> Self

Creates a new router using the given NetworkGraph, a Logger, and a randomness source random_seed_bytes.

Trait Implementations

impl<G: Deref<Target = NetworkGraph<L>>, L: Deref, S: Deref> Router for DefaultRouter<G, L, S>where
    L::Target: Logger,
    S::Target: for<'a> LockableScore<'a>,

fn find_route(
    &self,
    payer: &PublicKey,
    params: &RouteParameters,
    _payment_hash: &PaymentHash,
    first_hops: Option<&[&ChannelDetails]>,
    inflight_htlcs: InFlightHtlcs
) -> Result<Route, LightningError>

Finds a Route between payer and payee for a payment with the given values.

fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64)

Lets the router know that payment through a specific path has failed.

fn notify_payment_path_successful(&self, path: &[&RouteHop])

Lets the router know that payment through a specific path was successful.

fn notify_payment_probe_successful(&self, path: &[&RouteHop])

Lets the router know that a payment probe was successful.

fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64)

Lets the router know that a payment probe failed.