Struct SendingParameters

pub struct SendingParameters {
    pub max_total_routing_fee_msat: Option<Option<u64>>,
    pub max_total_cltv_expiry_delta: Option<u32>,
    pub max_path_count: Option<u8>,
    pub max_channel_saturation_power_of_half: Option<u8>,
}

Represents information used to send a payment.

Fields

max_total_routing_fee_msat: Option<Option<u64>>

Available on non-crate feature uniffi only.

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.

max_total_cltv_expiry_delta: Option<u32>

The maximum total CLTV delta we accept for the route.

Defaults to DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA.

max_path_count: Option<u8>

The maximum number of paths that may be used by (MPP) payments.

Defaults to DEFAULT_MAX_PATH_COUNT.

max_channel_saturation_power_of_half: Option<u8>

Selects the maximum share of a channel’s total capacity which will be sent over a channel, as a power of 1/2.

A higher value prefers to send the payment using more MPP parts whereas a lower value prefers to send larger MPP parts, potentially saturating channels and increasing failure probability for those paths.

Note that this restriction will be relaxed during pathfinding after paths which meet this restriction have been found. While paths which meet this criteria will be searched for, it is ultimately up to the scorer to select them over other paths.

Examples:

Value	Max Proportion of Channel Capacity Used
0	Up to 100% of the channel’s capacity
1	Up to 50% of the channel’s capacity
2	Up to 25% of the channel’s capacity
3	Up to 12.5% of the channel’s capacity

Default value: 2

Trait Implementations

impl Clone for SendingParameters

fn clone(&self) -> SendingParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SendingParameters

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

Formats the value using the given formatter.

impl PartialEq for SendingParameters

fn eq(&self, other: &SendingParameters) -> 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 StructuralPartialEq for SendingParameters