Package org.ldk.structs

Interface Payer.PayerInterface

Enclosing class:

Payer

public static interface Payer.PayerInterface

Method Summary

Modifier and Type	Method	Description
void	abandon_payment(byte[] payment_id)	Signals that no further retries for the given payment will occur.
ChannelDetails[]	first_hops()	Returns the payer's channels.
InFlightHtlcs	inflight_htlcs()	Construct an [`InFlightHtlcs`] containing information about currently used up liquidity across payments.
byte[]	node_id()	Returns the payer's node id.
Result_NonePaymentSendFailureZ	retry_payment(Route route, byte[] payment_id)	Retries a failed payment path for the [`PaymentId`] using the given [`Route`].
Result_NonePaymentSendFailureZ	send_payment(Route route, byte[] payment_hash, byte[] payment_secret, byte[] payment_id)	Sends a payment over the Lightning Network using the given [`Route`].
Result_NonePaymentSendFailureZ	send_spontaneous_payment(Route route, byte[] payment_preimage, byte[] payment_id)	Sends a spontaneous payment over the Lightning Network using the given [`Route`].

Method Detail

node_id

byte[] node_id()

Returns the payer's node id.

first_hops

ChannelDetails[] first_hops()

Returns the payer's channels.

send_payment

Result_NonePaymentSendFailureZ send_payment(Route route,
                                            byte[] payment_hash,
                                            byte[] payment_secret,
                                            byte[] payment_id)

Sends a payment over the Lightning Network using the given [`Route`]. Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None

send_spontaneous_payment

Result_NonePaymentSendFailureZ send_spontaneous_payment(Route route,
                                                        byte[] payment_preimage,
                                                        byte[] payment_id)

Sends a spontaneous payment over the Lightning Network using the given [`Route`].

retry_payment

Result_NonePaymentSendFailureZ retry_payment(Route route,
                                             byte[] payment_id)

Retries a failed payment path for the [`PaymentId`] using the given [`Route`].

abandon_payment

void abandon_payment(byte[] payment_id)

Signals that no further retries for the given payment will occur.

inflight_htlcs

InFlightHtlcs inflight_htlcs()

Construct an [`InFlightHtlcs`] containing information about currently used up liquidity across payments.