Package org.ldk.structs
Class PaymentPurpose.InvoicePayment
- java.lang.Object
-
- org.ldk.structs.PaymentPurpose
-
- org.ldk.structs.PaymentPurpose.InvoicePayment
-
- Enclosing class:
- PaymentPurpose
public static final class PaymentPurpose.InvoicePayment extends PaymentPurpose
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.ldk.structs.PaymentPurpose
PaymentPurpose.InvoicePayment, PaymentPurpose.SpontaneousPayment
-
-
Field Summary
Fields Modifier and Type Field Description byte[]
payment_preimage
The preimage to the payment_hash, if the payment hash (and secret) were fetched via [`ChannelManager::create_inbound_payment`].byte[]
payment_secret
The \"payment secret\".long
user_payment_id
This is the `user_payment_id` which was provided to [`ChannelManager::create_inbound_payment_for_hash`] or [`ChannelManager::create_inbound_payment`].
-
Method Summary
-
Methods inherited from class org.ldk.structs.PaymentPurpose
clone, finalize, invoice_payment, spontaneous_payment
-
-
-
-
Field Detail
-
payment_preimage
@Nullable public final byte[] payment_preimage
The preimage to the payment_hash, if the payment hash (and secret) were fetched via [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to [`ChannelManager::claim_funds`]. [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
-
payment_secret
public final byte[] payment_secret
The \"payment secret\". This authenticates the sender to the recipient, preventing a number of deanonymization attacks during the routing process. It is provided here for your reference, however its accuracy is enforced directly by [`ChannelManager`] using the values you previously provided to [`ChannelManager::create_inbound_payment`] or [`ChannelManager::create_inbound_payment_for_hash`]. [`ChannelManager`]: crate::ln::channelmanager::ChannelManager [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
-
user_payment_id
public final long user_payment_id
This is the `user_payment_id` which was provided to [`ChannelManager::create_inbound_payment_for_hash`] or [`ChannelManager::create_inbound_payment`]. It has no meaning inside of LDK and is simply copied here. It may be used to correlate PaymentReceived events with invoice metadata stored elsewhere. [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
-
-