Struct SpontaneousPayment 

pub struct SpontaneousPayment { /* private fields */ }

A payment handler allowing to send spontaneous (“keysend”) payments.

Should be retrieved by calling Node::spontaneous_payment.

Implementations

impl SpontaneousPayment

pub fn send( &self, amount_msat: u64, node_id: PublicKey, route_parameters: Option<RouteParametersConfig>, ) -> Result<PaymentId, Error>

Send a spontaneous aka. “keysend”, payment.

If route_parameters are provided they will override the default as well as the node-wide parameters configured via Config::route_parameters on a per-field basis.

pub fn send_with_custom_tlvs( &self, amount_msat: u64, node_id: PublicKey, route_parameters: Option<RouteParametersConfig>, custom_tlvs: Vec<CustomTlvRecord>, ) -> Result<PaymentId, Error>

Send a spontaneous payment including a list of custom TLVs.

pub fn send_with_preimage( &self, amount_msat: u64, node_id: PublicKey, preimage: PaymentPreimage, route_parameters: Option<RouteParametersConfig>, ) -> Result<PaymentId, Error>

Send a spontaneous payment with custom preimage

pub fn send_with_preimage_and_custom_tlvs( &self, amount_msat: u64, node_id: PublicKey, custom_tlvs: Vec<CustomTlvRecord>, preimage: PaymentPreimage, route_parameters: Option<RouteParametersConfig>, ) -> Result<PaymentId, Error>

Send a spontaneous payment with custom preimage including a list of custom TLVs.

pub fn send_probes( &self, amount_msat: u64, node_id: PublicKey, ) -> Result<(), Error>

Sends payment probes over all paths of a route that would be used to pay the given amount to the given node_id.

See Bolt11Payment::send_probes for more information.