Module payment

Convenient utilities for paying Lightning invoices.

Enums

PaymentError

An error that may occur when making a payment.

ProbingError

An error that may occur when sending a payment probe.

Functions

pay_invoice

Pays the given Bolt11Invoice, retrying if needed based on Retry.

pay_invoice_with_id

Pays the given Bolt11Invoice with a custom idempotency key, retrying if needed based on Retry.

pay_zero_value_invoice

Pays the given zero-value Bolt11Invoice using the given amount, retrying if needed based on Retry.

pay_zero_value_invoice_with_id

Pays the given zero-value Bolt11Invoice using the given amount and custom idempotency key, retrying if needed based on Retry.

preflight_probe_invoice

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

preflight_probe_zero_value_invoice

Sends payment probes over all paths of a route that would be used to pay the given zero-value invoice using the given amount.