Package org.ldk.structs

Class Event.PaymentClaimed

java.lang.Object

org.ldk.structs.Event

org.ldk.structs.Event.PaymentClaimed

Enclosing class:

Event

public static final class Event.PaymentClaimed
extends Event

Indicates a payment has been claimed and we've received money! This most likely occurs when [`ChannelManager::claim_funds`] has been called in response to an [`Event::PaymentReceived`]. However, if we previously crashed during a [`ChannelManager::claim_funds`] call you may see this event without a corresponding [`Event::PaymentReceived`] event. # Note LDK will not stop an inbound payment from being paid multiple times, so multiple `PaymentReceived` events may be generated for the same payment. If you then call [`ChannelManager::claim_funds`] twice for the same [`Event::PaymentReceived`] you may get multiple `PaymentClaimed` events. [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds

Nested Class Summary

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

Event.ChannelClosed, Event.DiscardFunding, Event.FundingGenerationReady, Event.HTLCHandlingFailed, Event.OpenChannelRequest, Event.PaymentClaimed, Event.PaymentFailed, Event.PaymentForwarded, Event.PaymentPathFailed, Event.PaymentPathSuccessful, Event.PaymentReceived, Event.PaymentSent, Event.PendingHTLCsForwardable, Event.ProbeFailed, Event.ProbeSuccessful, Event.SpendableOutputs

Field Summary

Fields

Modifier and Type	Field	Description
long	amount_msat	The value, in thousandths of a satoshi, that this payment is for.
byte[]	payment_hash	The payment hash of the claimed payment.
PaymentPurpose	purpose	The purpose of this claimed payment, i.e.

Method Summary

Methods inherited from class org.ldk.structs.Event

channel_closed, clone, discard_funding, finalize, funding_generation_ready, htlchandling_failed, open_channel_request, payment_claimed, payment_failed, payment_forwarded, payment_path_failed, payment_path_successful, payment_received, payment_sent, pending_htlcs_forwardable, probe_failed, probe_successful, spendable_outputs, write

Methods inherited from class java.lang.Object

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

Field Detail

payment_hash

public final byte[] payment_hash

The payment hash of the claimed payment. Note that LDK will not stop you from registering duplicate payment hashes for inbound payments.

amount_msat

public final long amount_msat

The value, in thousandths of a satoshi, that this payment is for.

purpose

public final PaymentPurpose purpose

The purpose of this claimed payment, i.e. whether the payment was for an invoice or a spontaneous payment.