Event.PaymentClaimed (LDK Java Bindings and Binaries 0.0.117.0 API)

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::PaymentClaimable`]. However, if we previously crashed during a [`ChannelManager::claim_funds`] call you may see this event without a corresponding [`Event::PaymentClaimable`] event. # Note LDK will not stop an inbound payment from being paid multiple times, so multiple `PaymentClaimable` events may be generated for the same payment. If you then call [`ChannelManager::claim_funds`] twice for the same [`Event::PaymentClaimable`] 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.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
`long`	`amount_msat`	The value, in thousandths of a satoshi, that this payment is for.
`ClaimedHTLC[]`	`htlcs`	The HTLCs that comprise the claimed payment.
`byte[]`	`payment_hash`	The payment hash of the claimed payment.
`PaymentPurpose`	`purpose`	The purpose of the claimed payment, i.e.
`byte[]`	`receiver_node_id`	The node that received the payment.
`Option_u64Z`	`sender_intended_total_msat`	The sender-intended sum total of all the MPP parts.

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
  - receiver_node_id
```
@Nullable
public final byte[] receiver_node_id
```
    The node that received the payment. This is useful to identify payments which were received via [phantom nodes]. This field will always be filled in when the event was generated by LDK versions 0.0.113 and above. [phantom nodes]: crate::sign::PhantomKeysManager Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
  - 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. May be greater than the invoice amount.
  - purpose
```
public final PaymentPurpose purpose
```
    The purpose of the claimed payment, i.e. whether the payment was for an invoice or a spontaneous payment.
  - htlcs
```
public final ClaimedHTLC[] htlcs
```
    The HTLCs that comprise the claimed payment. This will be empty for events serialized prior to LDK version 0.0.117.
  - sender_intended_total_msat
```
public final Option_u64Z sender_intended_total_msat
```
    The sender-intended sum total of all the MPP parts. This will be `None` for events serialized prior to LDK version 0.0.117.