Struct lightning::routing::scoring::FixedPenaltyScorer

pub struct FixedPenaltyScorer { /* private fields */ }

ScoreLookUp implementation that uses a fixed penalty.

Implementations

impl FixedPenaltyScorer

pub fn with_penalty(penalty_msat: u64) -> Self

Creates a new scorer using penalty_msat.

Trait Implementations

impl Clone for FixedPenaltyScorer

fn clone(&self) -> FixedPenaltyScorer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ReadableArgs<u64> for FixedPenaltyScorer

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

Reads a Self in from the given Read.

impl ScoreLookUp for FixedPenaltyScorer

type ScoreParams = ()

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, _: &CandidateRouteHop<'_>, _: ChannelUsage, _score_params: &Self::ScoreParams ) -> 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.

impl ScoreUpdate for FixedPenaltyScorer

fn payment_path_failed( &mut self, _path: &Path, _short_channel_id: u64, _duration_since_epoch: Duration )

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

fn payment_path_successful( &mut self, _path: &Path, _duration_since_epoch: Duration )

Handles updating channel penalties after successfully routing along a path.

fn probe_failed( &mut self, _path: &Path, _short_channel_id: u64, _duration_since_epoch: Duration )

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

fn probe_successful(&mut self, _path: &Path, _duration_since_epoch: Duration)

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

fn time_passed(&mut self, _duration_since_epoch: Duration)

Scorers may wish to reduce their certainty of channel liquidity information over time. Thus, this method is provided to allow scorers to observe the passage of time - the holder of this object should call this method regularly (generally via the lightning-background-processor crate).

impl Writeable for FixedPenaltyScorer

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

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.