forward_event -- Notification for forwarding events
DESCRIPTION
The forward_event notification informs whenever the status of a forwarded HTLC changes.
NOTIFICATION PAYLOAD
- payment_hash (hash): The payment hash for the forwarded HTLC.
- in_channel (short_channel_id): The inbound channel that received the HTLC.
- in_msat (msat): The amount of the incoming HTLC.
- status (string) (one of "offered", "settled", "local_failed", "failed"): The current forwarding status.
- received_time (number): The UNIX timestamp when the HTLC was received.
- out_channel (short_channel_id, optional): The outbound channel used for the forward, if one was selected.
- out_msat (msat, optional): The amount forwarded to the outbound channel, if known.
- fee_msat (msat, optional): The fee earned on the forward, if an outbound amount is known.
- failcode (u32, optional): The BOLT 4 failcode when the forward failed locally.
- failreason (string, optional): The symbolic failcode name when the forward failed locally.
- failure_reason (string, optional) (one of "insufficient_outgoing_liquidity", "too_many_htlcs", "dust_limit", "htlc_below_minimum", "htlc_above_maximum", "fee_insufficient", "cltv_incorrect", "cltv_expiry_too_soon", "cltv_expiry_too_far", "unknown_next_peer", "outgoing_peer_offline", "channel_failed_permanent", "invalid_onion", "channel_shutting_down", "max_htlc_value_in_flight", "peer_cannot_afford_fee"): The root cause of the failure, more specific than failcode/failreason. Only set for local_failed forwards, and not always known.
insufficient_outgoing_liquidity means our own spendable balance on the outgoing channel was too low; peer_cannot_afford_fee means the peer opened the outgoing channel and cannot pay the commitment fee for another HTLC. (added v26.12) - style (string, optional) (one of "legacy", "tlv"): The onion format used for the forward, if known. (added v23.11)
- resolved_time (number, optional): The UNIX timestamp when the HTLC was resolved, if it has been resolved.