Struct RouteParameters

pub struct RouteParameters {
    pub payment_params: PaymentParameters,
    pub final_value_msat: u64,
    pub max_total_routing_fee_msat: Option<u64>,
}

Parameters needed to find a Route.

Passed to find_route and build_route_from_hops.

Fields

payment_params: PaymentParameters

The parameters of the failed payment path.

final_value_msat: u64

The amount in msats sent on the failed payment path.

max_total_routing_fee_msat: Option<u64>

The maximum total fees, in millisatoshi, that may accrue during route finding.

This limit also applies to the total fees that may arise while retrying failed payment paths.

Note that values below a few sats may result in some paths being spuriously ignored.

Implementations

impl RouteParameters

pub fn from_payment_params_and_value( payment_params: PaymentParameters, final_value_msat: u64, ) -> Self

Constructs RouteParameters from the given PaymentParameters and a payment amount.

Self::max_total_routing_fee_msat defaults to 1% of the payment amount + 50 sats

pub fn set_max_path_length( &mut self, recipient_onion: &RecipientOnionFields, is_keysend: bool, best_block_height: u32, ) -> Result<(), ()>

Sets the maximum number of hops that can be included in a payment path, based on the provided RecipientOnionFields and blinded paths.

Trait Implementations

impl Clone for RouteParameters

fn clone(&self) -> RouteParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteParameters

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

Formats the value using the given formatter.

impl Hash for RouteParameters

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 RouteParameters

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Readable for RouteParameters

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

Reads a Self in from the given Read.

impl Writeable for RouteParameters

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<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.

impl Eq for RouteParameters

impl StructuralPartialEq for RouteParameters