Struct clightningrpc::lightningrpc::PayOptions

pub struct PayOptions {
    pub msatoshi: Option<i64>,
    pub description: Option<String>,
    pub riskfactor: Option<f64>,
    pub maxfeepercent: Option<f64>,
    pub exemptfee: Option<i64>,
    pub retry_for: Option<i64>,
    pub maxdelay: Option<i64>,
}

Optional arguments for pay() request

Fields

msatoshi: Option<i64>

{msatoshi} (if and only if {bolt11} does not have amount)

description: Option<String>

{description} (required if {bolt11} uses description hash)

riskfactor: Option<f64>

{riskfactor} (default 1.0)

maxfeepercent: Option<f64>

{maxfeepercent} (default 0.5) the maximum acceptable fee as a percentage (e.g. 0.5 => 0.5%)

exemptfee: Option<i64>

{exemptfee} (default 5000 msat) disables the maxfeepercent check for fees below the threshold

retry_for: Option<i64>

{retry_for} (default 60) the integer number of seconds before we stop retrying

maxdelay: Option<i64>

{maxdelay} (default 500) the maximum number of blocks we allow the funds to possibly get locked

Trait Implementations

impl Debug for PayOptions

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

Formats the value using the given formatter.

impl Clone for PayOptions

fn clone(&self) -> PayOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PayOptions

fn default() -> PayOptions

Returns the "default value" for a type.