Struct breez_sdk_liquid::lightning::routing::scoring::ProbabilisticScorerUsingTime

pub struct ProbabilisticScorerUsingTime<G, L, T>
where
    G: Deref<Target = NetworkGraph<L>>,
    L: Deref,
    T: Time,
    <L as Deref>::Target: Logger,
{ /* private fields */ }

Probabilistic Score implementation.

This is not exported to bindings users generally all users should use the ProbabilisticScorer type alias.

Implementations

impl<G, L, T> ProbabilisticScorerUsingTime<G, L, T>

where G: Deref<Target = NetworkGraph<L>>, L: Deref, T: Time, <L as Deref>::Target: Logger,

pub fn new( decay_params: ProbabilisticScoringDecayParameters, network_graph: G, logger: L, ) -> ProbabilisticScorerUsingTime<G, L, T>

Creates a new scorer using the given scoring parameters for sending payments from a node through a network graph.

pub fn debug_log_liquidity_stats(&self)

Dump the contents of this scorer into the configured logger.

Note that this writes roughly one line per channel for which we have a liquidity estimate, which may be a substantial amount of log output.

pub fn estimated_channel_liquidity_range( &self, scid: u64, target: &NodeId, ) -> Option<(u64, u64)>

Query the estimated minimum and maximum liquidity available for sending a payment over the channel with scid towards the given target node.

pub fn historical_estimated_channel_liquidity_probabilities( &self, scid: u64, target: &NodeId, ) -> Option<([u16; 8], [u16; 8])>

Query the historical estimated minimum and maximum liquidity available for sending a payment over the channel with scid towards the given target node.

Returns two sets of 8 buckets. The first set describes the octiles for lower-bound liquidity estimates, the second set describes the octiles for upper-bound liquidity estimates. Each bucket describes the relative frequency at which we’ve seen a liquidity bound in the octile relative to the channel’s total capacity, on an arbitrary scale. Because the values are slowly decayed, more recent data points are weighted more heavily than older datapoints.

When scoring, the estimated probability that an upper-/lower-bound lies in a given octile relative to the channel’s total capacity is calculated by dividing that bucket’s value with the total of all buckets for the given bound.

For example, a value of [0, 0, 0, 0, 0, 0, 32] indicates that we believe the probability of a bound being in the top octile to be 100%, and have never (recently) seen it in any other octiles. A value of [31, 0, 0, 0, 0, 0, 0, 32] indicates we’ve seen the bound being both in the top and bottom octile, and roughly with similar (recent) frequency.

Because the datapoints are decayed slowly over time, values will eventually return to Some(([0; 8], [0; 8])).

Trait Implementations

impl<G, L, T> ReadableArgs<(ProbabilisticScoringDecayParameters, G, L)> for ProbabilisticScorerUsingTime<G, L, T>

where G: Deref<Target = NetworkGraph<L>>, L: Deref, T: Time, <L as Deref>::Target: Logger,

fn read<R>( r: &mut R, args: (ProbabilisticScoringDecayParameters, G, L), ) -> Result<ProbabilisticScorerUsingTime<G, L, T>, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl<G, L, T> Score for ProbabilisticScorerUsingTime<G, L, T>

where G: Deref<Target = NetworkGraph<L>>, L: Deref, T: Time, <L as Deref>::Target: Logger,

type ScoreParams = ProbabilisticScoringFeeParameters

A configurable type which should contain various passed-in parameters for configuring the scorer, on a per-routefinding-call basis through to the scorer methods, which are used to determine the parameters for the suitability of channels for use.

fn channel_penalty_msat( &self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage, score_params: &ProbabilisticScoringFeeParameters, ) -> u64

Returns the fee in msats willing to be paid to avoid routing send_amt_msat through the given channel in the direction from source to target.

fn payment_path_failed(&mut self, path: &Path, short_channel_id: u64)

Handles updating channel penalties after failing to route through a channel.

fn payment_path_successful(&mut self, path: &Path)

Handles updating channel penalties after successfully routing along a path.

fn probe_failed(&mut self, path: &Path, short_channel_id: u64)

Handles updating channel penalties after a probe over the given path failed.

fn probe_successful(&mut self, path: &Path)

Handles updating channel penalties after a probe over the given path succeeded.

impl<G, L, T> Writeable for ProbabilisticScorerUsingTime<G, L, T>

where G: Deref<Target = NetworkGraph<L>>, L: Deref, T: Time, <L as Deref>::Target: Logger,

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

where W: Writer,

Writes self out to the given Writer.

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

Writes self out to a Vec<u8>.

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.