Package org.ldk.structs

Class Event.PaymentPathSuccessful

java.lang.Object

org.ldk.structs.Event

org.ldk.structs.Event.PaymentPathSuccessful

Enclosing class:

Event

public static final class Event.PaymentPathSuccessful
extends Event

Indicates that a path for an outbound payment was successful. Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See [`Event::PaymentSent`] for obtaining the payment preimage.

Nested Class Summary

Nested classes/interfaces inherited from class org.ldk.structs.Event

Event.BumpTransaction, 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
Path	path	The payment path that was successful.
Option_ThirtyTwoBytesZ	payment_hash	The hash that was given to [`ChannelManager::send_payment`].
byte[]	payment_id	The `payment_id` passed to [`ChannelManager::send_payment`].

Method Summary

Methods inherited from class org.ldk.structs.Event

bump_transaction, 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

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

payment_id

public final byte[] payment_id

The `payment_id` passed to [`ChannelManager::send_payment`]. [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment

payment_hash

public final Option_ThirtyTwoBytesZ payment_hash

The hash that was given to [`ChannelManager::send_payment`]. This will be `Some` for all payments which completed on LDK 0.0.104 or later. [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment

path

public final Path path

The payment path that was successful. May contain a closed channel if the HTLC sent along the path was fulfilled on chain.