Class 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.
    • Field Detail

      • payment_id

        public final byte[] payment_id
        The id returned by [`ChannelManager::send_payment`] and used with [`ChannelManager::retry_payment`]. [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
      • payment_hash

        @Nullable
        public final byte[] payment_hash
        The hash that was given 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
      • path

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