Class 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
    • 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::chain::keysinterface::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.
      • purpose

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