Module invoice_utils

Convenient utilities to create an invoice.

Functions

create_invoice_from_channelmanagerDeprecated

Utility to construct an invoice. Generally, unless you want to do something like a custom cltv_expiry, this is what you should be using to create an invoice. The reason being, this method stores the invoice’s payment secret and preimage in ChannelManager, so (a) the user doesn’t have to store preimage/payment secret information and (b) ChannelManager can verify that the payment secret is valid when the invoice is paid.

create_invoice_from_channelmanager_with_description_hashDeprecated

Utility to construct an invoice. Generally, unless you want to do something like a custom cltv_expiry, this is what you should be using to create an invoice. The reason being, this method stores the invoice’s payment secret and preimage in ChannelManager, so (a) the user doesn’t have to store preimage/payment secret information and (b) ChannelManager can verify that the payment secret is valid when the invoice is paid. Use this variant if you want to pass the description_hash to the invoice.

create_invoice_from_channelmanager_with_description_hash_and_payment_hashDeprecated

See create_invoice_from_channelmanager.

create_invoice_from_channelmanager_with_payment_hashDeprecated

See create_invoice_from_channelmanager.

create_phantom_invoice

Utility to create an invoice that can be paid to one of multiple nodes, or a “phantom invoice.” See PhantomKeysManager for more information on phantom node payments.

create_phantom_invoice_with_description_hash

Utility to create an invoice that can be paid to one of multiple nodes, or a “phantom invoice.” See PhantomKeysManager for more information on phantom node payments.