Class Event.PaymentForwarded

  • Enclosing class:
    Event

    public static final class Event.PaymentForwarded
    extends Event
    This event is generated when a payment has been successfully forwarded through us and a forwarding fee earned.
    • Field Detail

      • prev_channel_id

        @Nullable
        public final byte[] prev_channel_id
        The incoming channel between the previous node and us. This is only `None` for events generated or serialized by versions prior to 0.0.107. Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
      • next_channel_id

        @Nullable
        public final byte[] next_channel_id
        The outgoing channel between the next node and us. This is only `None` for events generated or serialized by versions prior to 0.0.107. Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
      • fee_earned_msat

        public final Option_u64Z fee_earned_msat
        The fee, in milli-satoshis, which was earned as a result of the payment. Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC was pending, the amount the next hop claimed will have been rounded down to the nearest whole satoshi. Thus, the fee calculated here may be higher than expected as we still claimed the full value in millisatoshis from the source. In this case, `claim_from_onchain_tx` will be set. If the channel which sent us the payment has been force-closed, we will claim the funds via an on-chain transaction. In that case we do not yet know the on-chain transaction fees which we will spend and will instead set this to `None`. It is possible duplicate `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is `None`.
      • claim_from_onchain_tx

        public final boolean claim_from_onchain_tx
        If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain transaction.
      • outbound_amount_forwarded_msat

        public final Option_u64Z outbound_amount_forwarded_msat
        The final amount forwarded, in milli-satoshis, after the fee is deducted. The caveat described above the `fee_earned_msat` field applies here as well.