Package org.ldk.structs
Class Event.PaymentSent
- java.lang.Object
-
- org.ldk.structs.Event
-
- org.ldk.structs.Event.PaymentSent
-
- Enclosing class:
- Event
public static final class Event.PaymentSent extends Event
Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target and we got back the payment preimage for it). Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed` event. In this situation, you SHOULD treat this payment as having succeeded.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.ldk.structs.Event
Event.ChannelClosed, Event.ChannelPending, Event.ChannelReady, Event.DiscardFunding, Event.FundingGenerationReady, Event.HTLCHandlingFailed, Event.HTLCIntercepted, Event.OpenChannelRequest, Event.PaymentClaimable, Event.PaymentClaimed, Event.PaymentFailed, Event.PaymentForwarded, Event.PaymentPathFailed, Event.PaymentPathSuccessful, Event.PaymentSent, Event.PendingHTLCsForwardable, Event.ProbeFailed, Event.ProbeSuccessful, Event.SpendableOutputs
-
-
Field Summary
Fields Modifier and Type Field Description Option_u64Z
fee_paid_msat
The total fee which was spent at intermediate hops in this payment, across all paths.byte[]
payment_hash
The hash that was given to [`ChannelManager::send_payment`].byte[]
payment_id
The `payment_id` passed to [`ChannelManager::send_payment`].byte[]
payment_preimage
The preimage to the hash given to ChannelManager::send_payment.
-
Method Summary
-
Methods inherited from class org.ldk.structs.Event
channel_closed, channel_pending, channel_ready, clone, discard_funding, eq, equals, finalize, funding_generation_ready, htlchandling_failed, htlcintercepted, open_channel_request, payment_claimable, payment_claimed, payment_failed, payment_forwarded, payment_path_failed, payment_path_successful, payment_sent, pending_htlcs_forwardable, probe_failed, probe_successful, spendable_outputs, write
-
-
-
-
Field Detail
-
payment_id
@Nullable public final byte[] payment_id
The `payment_id` passed to [`ChannelManager::send_payment`]. [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
-
payment_preimage
public final byte[] payment_preimage
The preimage to the hash given to ChannelManager::send_payment. Note that this serves as a payment receipt, if you wish to have such a thing, you must store it somehow!
-
payment_hash
public final byte[] payment_hash
The hash that was given to [`ChannelManager::send_payment`]. [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
-
fee_paid_msat
public final Option_u64Z fee_paid_msat
The total fee which was spent at intermediate hops in this payment, across all paths. Note that, like [`Route::get_total_fees`] this does *not* include any potential overpayment to the recipient node. If the recipient or an intermediate node misbehaves and gives us free money, this may overstate the amount paid, though this is unlikely. [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
-
-