Struct SendPaymentWithRouterParams 

pub struct SendPaymentWithRouterParams {
    pub payment_hash: Option<Hash256>,
    pub router: Vec<RouterHop>,
    pub invoice: Option<String>,
    pub custom_records: Option<PaymentCustomRecords>,
    pub keysend: Option<bool>,
    pub udt_type_script: Option<Script>,
    pub dry_run: Option<bool>,
}

Parameters for sending a payment with a specified router.

Fields

payment_hash: Option<Hash256>

the hash to use within the payment’s HTLC. If not set and keysend is set to true, a random hash will be generated. If not set and there is a payment_hash in the invoice, it will be used. Otherwise, payment_hash need to be set.

router: Vec<RouterHop>

The router to use for the payment

invoice: Option<String>

the encoded invoice to send to the recipient

custom_records: Option<PaymentCustomRecords>

Some custom records for the payment which contains a map of u32 to Vec The key is the record type, and the value is the serialized data. Limits: the sum size of values can not exceed 2048 bytes.

For example:

"custom_records": {
   "0x1": "0x01020304",
   "0x2": "0x05060708",
   "0x3": "0x090a0b0c",
   "0x4": "0x0d0e0f10010d090a0b0c"
 }

keysend: Option<bool>

keysend payment

udt_type_script: Option<Script>

udt type script for the payment

dry_run: Option<bool>

dry_run for payment, used for check whether we can build valid router and the fee for this payment, it’s useful for the sender to double check the payment before sending it to the network, default is false

Trait Implementations

impl Debug for SendPaymentWithRouterParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SendPaymentWithRouterParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SendPaymentWithRouterParams

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for SendPaymentWithRouterParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.