+ /**
+ * Used to indicate that we've intercepted an HTLC forward. This event will only be generated if
+ * you've encoded an intercept scid in the receiver's invoice route hints using
+ * [`ChannelManager::get_intercept_scid`] and have set [`UserConfig::accept_intercept_htlcs`].
+ *
+ * [`ChannelManager::forward_intercepted_htlc`] or
+ * [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to this event. See
+ * their docs for more information.
+ *
+ * [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
+ * [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
+ * [`ChannelManager::forward_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::forward_intercepted_htlc
+ * [`ChannelManager::fail_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::fail_intercepted_htlc
+ */
+ public final static class HTLCIntercepted extends Event {
+ /**
+ * An id to help LDK identify which HTLC is being forwarded or failed.
+ */
+ public final byte[] intercept_id;
+ /**
+ * The fake scid that was programmed as the next hop's scid, generated using
+ * [`ChannelManager::get_intercept_scid`].
+ *
+ * [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
+ */
+ public final long requested_next_hop_scid;
+ /**
+ * The payment hash used for this HTLC.
+ */
+ public final byte[] payment_hash;
+ /**
+ * How many msats were received on the inbound edge of this HTLC.
+ */
+ public final long inbound_amount_msat;
+ /**
+ * How many msats the payer intended to route to the next node. Depending on the reason you are
+ * intercepting this payment, you might take a fee by forwarding less than this amount.
+ *
+ * Note that LDK will NOT check that expected fees were factored into this value. You MUST
+ * check that whatever fee you want has been included here or subtract it as required. Further,
+ * LDK will not stop you from forwarding more than you received.
+ */
+ public final long expected_outbound_amount_msat;
+ private HTLCIntercepted(long ptr, bindings.LDKEvent.HTLCIntercepted obj) {
+ super(null, ptr);
+ this.intercept_id = obj.intercept_id;
+ this.requested_next_hop_scid = obj.requested_next_hop_scid;
+ this.payment_hash = obj.payment_hash;
+ this.inbound_amount_msat = obj.inbound_amount_msat;
+ this.expected_outbound_amount_msat = obj.expected_outbound_amount_msat;
+ }
+ }