if (raw_val.getClass() == bindings.LDKEvent.FundingGenerationReady.class) {
return new FundingGenerationReady(ptr, (bindings.LDKEvent.FundingGenerationReady)raw_val);
}
- if (raw_val.getClass() == bindings.LDKEvent.PaymentReceived.class) {
- return new PaymentReceived(ptr, (bindings.LDKEvent.PaymentReceived)raw_val);
+ if (raw_val.getClass() == bindings.LDKEvent.PaymentClaimable.class) {
+ return new PaymentClaimable(ptr, (bindings.LDKEvent.PaymentClaimable)raw_val);
}
if (raw_val.getClass() == bindings.LDKEvent.PaymentClaimed.class) {
return new PaymentClaimed(ptr, (bindings.LDKEvent.PaymentClaimed)raw_val);
}
+ if (raw_val.getClass() == bindings.LDKEvent.InvoiceRequestFailed.class) {
+ return new InvoiceRequestFailed(ptr, (bindings.LDKEvent.InvoiceRequestFailed)raw_val);
+ }
if (raw_val.getClass() == bindings.LDKEvent.PaymentSent.class) {
return new PaymentSent(ptr, (bindings.LDKEvent.PaymentSent)raw_val);
}
if (raw_val.getClass() == bindings.LDKEvent.PaymentPathFailed.class) {
return new PaymentPathFailed(ptr, (bindings.LDKEvent.PaymentPathFailed)raw_val);
}
+ if (raw_val.getClass() == bindings.LDKEvent.ProbeSuccessful.class) {
+ return new ProbeSuccessful(ptr, (bindings.LDKEvent.ProbeSuccessful)raw_val);
+ }
+ if (raw_val.getClass() == bindings.LDKEvent.ProbeFailed.class) {
+ return new ProbeFailed(ptr, (bindings.LDKEvent.ProbeFailed)raw_val);
+ }
if (raw_val.getClass() == bindings.LDKEvent.PendingHTLCsForwardable.class) {
return new PendingHTLCsForwardable(ptr, (bindings.LDKEvent.PendingHTLCsForwardable)raw_val);
}
+ if (raw_val.getClass() == bindings.LDKEvent.HTLCIntercepted.class) {
+ return new HTLCIntercepted(ptr, (bindings.LDKEvent.HTLCIntercepted)raw_val);
+ }
if (raw_val.getClass() == bindings.LDKEvent.SpendableOutputs.class) {
return new SpendableOutputs(ptr, (bindings.LDKEvent.SpendableOutputs)raw_val);
}
if (raw_val.getClass() == bindings.LDKEvent.PaymentForwarded.class) {
return new PaymentForwarded(ptr, (bindings.LDKEvent.PaymentForwarded)raw_val);
}
+ if (raw_val.getClass() == bindings.LDKEvent.ChannelPending.class) {
+ return new ChannelPending(ptr, (bindings.LDKEvent.ChannelPending)raw_val);
+ }
+ if (raw_val.getClass() == bindings.LDKEvent.ChannelReady.class) {
+ return new ChannelReady(ptr, (bindings.LDKEvent.ChannelReady)raw_val);
+ }
if (raw_val.getClass() == bindings.LDKEvent.ChannelClosed.class) {
return new ChannelClosed(ptr, (bindings.LDKEvent.ChannelClosed)raw_val);
}
if (raw_val.getClass() == bindings.LDKEvent.OpenChannelRequest.class) {
return new OpenChannelRequest(ptr, (bindings.LDKEvent.OpenChannelRequest)raw_val);
}
+ if (raw_val.getClass() == bindings.LDKEvent.HTLCHandlingFailed.class) {
+ return new HTLCHandlingFailed(ptr, (bindings.LDKEvent.HTLCHandlingFailed)raw_val);
+ }
+ if (raw_val.getClass() == bindings.LDKEvent.BumpTransaction.class) {
+ return new BumpTransaction(ptr, (bindings.LDKEvent.BumpTransaction)raw_val);
+ }
assert false; return null; // Unreachable without extending the (internal) bindings interface
}
*/
public final byte[] output_script;
/**
- * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
- * an inbound channel.
+ * The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
+ * channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
+ * [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
+ * `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
+ * serialized with LDK versions prior to 0.0.113.
*
* [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
+ * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
+ * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
*/
- public final long user_channel_id;
+ public final org.ldk.util.UInt128 user_channel_id;
private FundingGenerationReady(long ptr, bindings.LDKEvent.FundingGenerationReady obj) {
super(null, ptr);
this.temporary_channel_id = obj.temporary_channel_id;
this.counterparty_node_id = obj.counterparty_node_id;
this.channel_value_satoshis = obj.channel_value_satoshis;
this.output_script = obj.output_script;
- this.user_channel_id = obj.user_channel_id;
+ byte[] user_channel_id = obj.user_channel_id;
+ org.ldk.util.UInt128 user_channel_id_conv = new org.ldk.util.UInt128(user_channel_id);
+ this.user_channel_id = user_channel_id_conv;
}
}
/**
- * Indicates we've received (an offer of) money! Just gotta dig out that payment preimage and
- * feed it to [`ChannelManager::claim_funds`] to get it....
+ * Indicates that we've been offered a payment and it needs to be claimed via calling
+ * [`ChannelManager::claim_funds`] with the preimage given in [`PaymentPurpose`].
*
* Note that if the preimage is not known, you should call
- * [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
- * network congestion.
- * If you fail to call either [`ChannelManager::claim_funds`] or
- * [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
- * automatically failed.
+ * [`ChannelManager::fail_htlc_backwards`] or [`ChannelManager::fail_htlc_backwards_with_reason`]
+ * to free up resources for this HTLC and avoid network congestion.
+ *
+ * If [`Event::PaymentClaimable::onion_fields`] is `Some`, and includes custom TLVs with even type
+ * numbers, you should use [`ChannelManager::fail_htlc_backwards_with_reason`] with
+ * [`FailureCode::InvalidOnionPayload`] if you fail to understand and handle the contents, or
+ * [`ChannelManager::claim_funds_with_known_custom_tlvs`] upon successful handling.
+ * If you don't intend to check for custom TLVs, you can simply use
+ * [`ChannelManager::claim_funds`], which will automatically fail back even custom TLVs.
+ *
+ * If you fail to call [`ChannelManager::claim_funds`],
+ * [`ChannelManager::claim_funds_with_known_custom_tlvs`],
+ * [`ChannelManager::fail_htlc_backwards`], or
+ * [`ChannelManager::fail_htlc_backwards_with_reason`] within the HTLC's timeout, the HTLC will
+ * be automatically failed.
*
* # Note
* LDK will not stop an inbound payment from being paid multiple times, so multiple
- * `PaymentReceived` events may be generated for the same payment.
+ * `PaymentClaimable` events may be generated for the same payment. In such a case it is
+ * polite (and required in the lightning specification) to fail the payment the second time
+ * and give the sender their money back rather than accepting double payment.
+ *
+ * # Note
+ * This event used to be called `PaymentReceived` in LDK versions 0.0.112 and earlier.
*
* [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
+ * [`ChannelManager::claim_funds_with_known_custom_tlvs`]: crate::ln::channelmanager::ChannelManager::claim_funds_with_known_custom_tlvs
+ * [`FailureCode::InvalidOnionPayload`]: crate::ln::channelmanager::FailureCode::InvalidOnionPayload
* [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
+ * [`ChannelManager::fail_htlc_backwards_with_reason`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards_with_reason
*/
- public final static class PaymentReceived extends Event {
+ public final static class PaymentClaimable extends Event {
+ /**
+ * The node that will receive the payment after it has been claimed.
+ * This is useful to identify payments 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::sign::PhantomKeysManager
+ *
+ * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ @Nullable public final byte[] receiver_node_id;
/**
* The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
* not stop you from registering duplicate payment hashes for inbound payments.
*/
public final byte[] payment_hash;
/**
- * The value, in thousandths of a satoshi, that this payment is for.
+ * The fields in the onion which were received with each HTLC. Only fields which were
+ * identical in each HTLC involved in the payment will be included here.
+ *
+ * Payments received on LDK versions prior to 0.0.115 will have this field unset.
+ *
+ * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ @Nullable public final org.ldk.structs.RecipientOnionFields onion_fields;
+ /**
+ * The value, in thousandths of a satoshi, that this payment is claimable for. May be greater
+ * than the invoice amount.
+ *
+ * May be less than the invoice amount if [`ChannelConfig::accept_underpaying_htlcs`] is set
+ * and the previous hop took an extra fee.
+ *
+ * # Note
+ * If [`ChannelConfig::accept_underpaying_htlcs`] is set and you claim without verifying this
+ * field, you may lose money!
+ *
+ * [`ChannelConfig::accept_underpaying_htlcs`]: crate::util::config::ChannelConfig::accept_underpaying_htlcs
*/
public final long amount_msat;
+ /**
+ * The value, in thousands of a satoshi, that was skimmed off of this payment as an extra fee
+ * taken by our channel counterparty.
+ *
+ * Will always be 0 unless [`ChannelConfig::accept_underpaying_htlcs`] is set.
+ *
+ * [`ChannelConfig::accept_underpaying_htlcs`]: crate::util::config::ChannelConfig::accept_underpaying_htlcs
+ */
+ public final long counterparty_skimmed_fee_msat;
/**
* Information for claiming this received payment, based on whether the purpose of the
* payment is to pay an invoice or to send a spontaneous payment.
*/
public final org.ldk.structs.PaymentPurpose purpose;
- private PaymentReceived(long ptr, bindings.LDKEvent.PaymentReceived obj) {
+ /**
+ * The `channel_id` indicating over which channel we received the payment.
+ */
+ public final org.ldk.structs.Option_ThirtyTwoBytesZ via_channel_id;
+ /**
+ * The `user_channel_id` indicating over which channel we received the payment.
+ */
+ public final org.ldk.structs.Option_U128Z via_user_channel_id;
+ /**
+ * The block height at which this payment will be failed back and will no longer be
+ * eligible for claiming.
+ *
+ * Prior to this height, a call to [`ChannelManager::claim_funds`] is guaranteed to
+ * succeed, however you should wait for [`Event::PaymentClaimed`] to be sure.
+ *
+ * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
+ */
+ public final org.ldk.structs.Option_u32Z claim_deadline;
+ private PaymentClaimable(long ptr, bindings.LDKEvent.PaymentClaimable obj) {
super(null, ptr);
+ this.receiver_node_id = obj.receiver_node_id;
this.payment_hash = obj.payment_hash;
+ long onion_fields = obj.onion_fields;
+ org.ldk.structs.RecipientOnionFields onion_fields_hu_conv = null; if (onion_fields < 0 || onion_fields > 4096) { onion_fields_hu_conv = new org.ldk.structs.RecipientOnionFields(null, onion_fields); }
+ if (onion_fields_hu_conv != null) { onion_fields_hu_conv.ptrs_to.add(this); };
+ this.onion_fields = onion_fields_hu_conv;
this.amount_msat = obj.amount_msat;
+ this.counterparty_skimmed_fee_msat = obj.counterparty_skimmed_fee_msat;
long purpose = obj.purpose;
org.ldk.structs.PaymentPurpose purpose_hu_conv = org.ldk.structs.PaymentPurpose.constr_from_ptr(purpose);
- purpose_hu_conv.ptrs_to.add(this);
+ if (purpose_hu_conv != null) { purpose_hu_conv.ptrs_to.add(this); };
this.purpose = purpose_hu_conv;
+ long via_channel_id = obj.via_channel_id;
+ org.ldk.structs.Option_ThirtyTwoBytesZ via_channel_id_hu_conv = org.ldk.structs.Option_ThirtyTwoBytesZ.constr_from_ptr(via_channel_id);
+ if (via_channel_id_hu_conv != null) { via_channel_id_hu_conv.ptrs_to.add(this); };
+ this.via_channel_id = via_channel_id_hu_conv;
+ long via_user_channel_id = obj.via_user_channel_id;
+ org.ldk.structs.Option_U128Z via_user_channel_id_hu_conv = org.ldk.structs.Option_U128Z.constr_from_ptr(via_user_channel_id);
+ if (via_user_channel_id_hu_conv != null) { via_user_channel_id_hu_conv.ptrs_to.add(this); };
+ this.via_user_channel_id = via_user_channel_id_hu_conv;
+ long claim_deadline = obj.claim_deadline;
+ org.ldk.structs.Option_u32Z claim_deadline_hu_conv = org.ldk.structs.Option_u32Z.constr_from_ptr(claim_deadline);
+ if (claim_deadline_hu_conv != null) { claim_deadline_hu_conv.ptrs_to.add(this); };
+ this.claim_deadline = claim_deadline_hu_conv;
}
}
/**
* 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::PaymentReceived`]. However, if we previously crashed during a
+ * to an [`Event::PaymentClaimable`]. However, if we previously crashed during a
* [`ChannelManager::claim_funds`] call you may see this event without a corresponding
- * [`Event::PaymentReceived`] event.
+ * [`Event::PaymentClaimable`] event.
*
* # Note
* LDK will not stop an inbound payment from being paid multiple times, so multiple
- * `PaymentReceived` events may be generated for the same payment. If you then call
- * [`ChannelManager::claim_funds`] twice for the same [`Event::PaymentReceived`] you may get
+ * `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
*/
public final static class PaymentClaimed extends Event {
+ /**
+ * 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::sign::PhantomKeysManager
+ *
+ * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ @Nullable public final byte[] receiver_node_id;
/**
* The payment hash of the claimed payment. Note that LDK will not stop you from
* registering duplicate payment hashes for inbound payments.
*/
public final byte[] payment_hash;
/**
- * The value, in thousandths of a satoshi, that this payment is for.
+ * The value, in thousandths of a satoshi, that this payment is for. May be greater than the
+ * invoice amount.
*/
public final long amount_msat;
/**
- * The purpose of this claimed payment, i.e. whether the payment was for an invoice or a
+ * The purpose of the claimed payment, i.e. whether the payment was for an invoice or a
* spontaneous payment.
*/
public final org.ldk.structs.PaymentPurpose purpose;
+ /**
+ * The HTLCs that comprise the claimed payment. This will be empty for events serialized prior
+ * to LDK version 0.0.117.
+ */
+ public final ClaimedHTLC[] htlcs;
+ /**
+ * The sender-intended sum total of all the MPP parts. This will be `None` for events
+ * serialized prior to LDK version 0.0.117.
+ */
+ public final org.ldk.structs.Option_u64Z sender_intended_total_msat;
private PaymentClaimed(long ptr, bindings.LDKEvent.PaymentClaimed obj) {
super(null, ptr);
+ this.receiver_node_id = obj.receiver_node_id;
this.payment_hash = obj.payment_hash;
this.amount_msat = obj.amount_msat;
long purpose = obj.purpose;
org.ldk.structs.PaymentPurpose purpose_hu_conv = org.ldk.structs.PaymentPurpose.constr_from_ptr(purpose);
- purpose_hu_conv.ptrs_to.add(this);
+ if (purpose_hu_conv != null) { purpose_hu_conv.ptrs_to.add(this); };
this.purpose = purpose_hu_conv;
+ long[] htlcs = obj.htlcs;
+ int htlcs_conv_13_len = htlcs.length;
+ ClaimedHTLC[] htlcs_conv_13_arr = new ClaimedHTLC[htlcs_conv_13_len];
+ for (int n = 0; n < htlcs_conv_13_len; n++) {
+ long htlcs_conv_13 = htlcs[n];
+ org.ldk.structs.ClaimedHTLC htlcs_conv_13_hu_conv = null; if (htlcs_conv_13 < 0 || htlcs_conv_13 > 4096) { htlcs_conv_13_hu_conv = new org.ldk.structs.ClaimedHTLC(null, htlcs_conv_13); }
+ if (htlcs_conv_13_hu_conv != null) { htlcs_conv_13_hu_conv.ptrs_to.add(this); };
+ htlcs_conv_13_arr[n] = htlcs_conv_13_hu_conv;
+ }
+ this.htlcs = htlcs_conv_13_arr;
+ long sender_intended_total_msat = obj.sender_intended_total_msat;
+ org.ldk.structs.Option_u64Z sender_intended_total_msat_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(sender_intended_total_msat);
+ if (sender_intended_total_msat_hu_conv != null) { sender_intended_total_msat_hu_conv.ptrs_to.add(this); };
+ this.sender_intended_total_msat = sender_intended_total_msat_hu_conv;
+ }
+ }
+ /**
+ * Indicates a request for an invoice failed to yield a response in a reasonable amount of time
+ * or was explicitly abandoned by [`ChannelManager::abandon_payment`]. This may be for an
+ * [`InvoiceRequest`] sent for an [`Offer`] or for a [`Refund`] that hasn't been redeemed.
+ *
+ * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
+ * [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
+ * [`Offer`]: crate::offers::offer::Offer
+ * [`Refund`]: crate::offers::refund::Refund
+ */
+ public final static class InvoiceRequestFailed extends Event {
+ /**
+ * The `payment_id` to have been associated with payment for the requested invoice.
+ */
+ public final byte[] payment_id;
+ private InvoiceRequestFailed(long ptr, bindings.LDKEvent.InvoiceRequestFailed obj) {
+ super(null, ptr);
+ this.payment_id = obj.payment_id;
}
}
/**
*/
public final static class PaymentSent extends Event {
/**
- * The id returned by [`ChannelManager::send_payment`] and used with
- * [`ChannelManager::retry_payment`].
+ * The `payment_id` passed to [`ChannelManager::send_payment`].
*
* [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
- * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
- *
- * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
*/
- @Nullable public final byte[] payment_id;
+ public final org.ldk.structs.Option_ThirtyTwoBytesZ payment_id;
/**
* The preimage to the hash given to ChannelManager::send_payment.
* Note that this serves as a payment receipt, if you wish to have such a thing, you must
public final org.ldk.structs.Option_u64Z fee_paid_msat;
private PaymentSent(long ptr, bindings.LDKEvent.PaymentSent obj) {
super(null, ptr);
- this.payment_id = obj.payment_id;
+ long payment_id = obj.payment_id;
+ org.ldk.structs.Option_ThirtyTwoBytesZ payment_id_hu_conv = org.ldk.structs.Option_ThirtyTwoBytesZ.constr_from_ptr(payment_id);
+ if (payment_id_hu_conv != null) { payment_id_hu_conv.ptrs_to.add(this); };
+ this.payment_id = payment_id_hu_conv;
this.payment_preimage = obj.payment_preimage;
this.payment_hash = obj.payment_hash;
long fee_paid_msat = obj.fee_paid_msat;
org.ldk.structs.Option_u64Z fee_paid_msat_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(fee_paid_msat);
- fee_paid_msat_hu_conv.ptrs_to.add(this);
+ if (fee_paid_msat_hu_conv != null) { fee_paid_msat_hu_conv.ptrs_to.add(this); };
this.fee_paid_msat = fee_paid_msat_hu_conv;
}
}
/**
* Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
- * provide failure information for each MPP part in the payment.
+ * provide failure information for each path attempt in the payment, including retries.
*
* This event is provided once there are no further pending HTLCs for the payment and the
- * payment is no longer retryable, either due to a several-block timeout or because
- * [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
+ * payment is no longer retryable, due either to the [`Retry`] provided or
+ * [`ChannelManager::abandon_payment`] having been called for the corresponding payment.
+ *
+ * In exceedingly rare cases, it is possible that an [`Event::PaymentFailed`] is generated for
+ * a payment after an [`Event::PaymentSent`] event for this same payment has already been
+ * received and processed. In this case, the [`Event::PaymentFailed`] event MUST be ignored,
+ * and the payment MUST be treated as having succeeded.
*
+ * [`Retry`]: crate::ln::channelmanager::Retry
* [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
*/
public final static class PaymentFailed extends Event {
/**
- * The id returned by [`ChannelManager::send_payment`] and used with
- * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
+ * The `payment_id` passed to [`ChannelManager::send_payment`].
*
* [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
- * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
- * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
*/
public final byte[] payment_id;
/**
* [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
*/
public final byte[] payment_hash;
+ /**
+ * The reason the payment failed. This is only `None` for events generated or serialized
+ * by versions prior to 0.0.115.
+ */
+ public final org.ldk.structs.Option_PaymentFailureReasonZ reason;
private PaymentFailed(long ptr, bindings.LDKEvent.PaymentFailed obj) {
super(null, ptr);
this.payment_id = obj.payment_id;
this.payment_hash = obj.payment_hash;
+ long reason = obj.reason;
+ org.ldk.structs.Option_PaymentFailureReasonZ reason_hu_conv = org.ldk.structs.Option_PaymentFailureReasonZ.constr_from_ptr(reason);
+ if (reason_hu_conv != null) { reason_hu_conv.ptrs_to.add(this); };
+ this.reason = reason_hu_conv;
}
}
/**
*/
public final static class PaymentPathSuccessful extends Event {
/**
- * The id returned by [`ChannelManager::send_payment`] and used with
- * [`ChannelManager::retry_payment`].
+ * The `payment_id` passed to [`ChannelManager::send_payment`].
*
* [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
- * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
*/
public final byte[] payment_id;
/**
* The hash that was given to [`ChannelManager::send_payment`].
*
- * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
+ * This will be `Some` for all payments which completed on LDK 0.0.104 or later.
*
- * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
+ * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
*/
- @Nullable public final byte[] payment_hash;
+ public final org.ldk.structs.Option_ThirtyTwoBytesZ payment_hash;
/**
* The payment path that was successful.
*
* May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
*/
- public final RouteHop[] path;
+ public final org.ldk.structs.Path path;
private PaymentPathSuccessful(long ptr, bindings.LDKEvent.PaymentPathSuccessful obj) {
super(null, ptr);
this.payment_id = obj.payment_id;
- this.payment_hash = obj.payment_hash;
- long[] path = obj.path;
- int path_conv_10_len = path.length;
- RouteHop[] path_conv_10_arr = new RouteHop[path_conv_10_len];
- for (int k = 0; k < path_conv_10_len; k++) {
- long path_conv_10 = path[k];
- org.ldk.structs.RouteHop path_conv_10_hu_conv = null; if (path_conv_10 < 0 || path_conv_10 > 4096) { path_conv_10_hu_conv = new org.ldk.structs.RouteHop(null, path_conv_10); }
- path_conv_10_hu_conv.ptrs_to.add(this);
- path_conv_10_arr[k] = path_conv_10_hu_conv;
- }
- this.path = path_conv_10_arr;
+ long payment_hash = obj.payment_hash;
+ org.ldk.structs.Option_ThirtyTwoBytesZ payment_hash_hu_conv = org.ldk.structs.Option_ThirtyTwoBytesZ.constr_from_ptr(payment_hash);
+ if (payment_hash_hu_conv != null) { payment_hash_hu_conv.ptrs_to.add(this); };
+ this.payment_hash = payment_hash_hu_conv;
+ long path = obj.path;
+ org.ldk.structs.Path path_hu_conv = null; if (path < 0 || path > 4096) { path_hu_conv = new org.ldk.structs.Path(null, path); }
+ if (path_hu_conv != null) { path_hu_conv.ptrs_to.add(this); };
+ this.path = path_hu_conv;
}
}
/**
- * Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
- * something. You may wish to retry with a different route.
+ * Indicates an outbound HTLC we sent failed, likely due to an intermediary node being unable to
+ * handle the HTLC.
*
* Note that this does *not* indicate that all paths for an MPP payment have failed, see
- * [`Event::PaymentFailed`] and [`all_paths_failed`].
+ * [`Event::PaymentFailed`].
+ *
+ * See [`ChannelManager::abandon_payment`] for giving up on this payment before its retries have
+ * been exhausted.
*
- * [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
+ * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
*/
public final static class PaymentPathFailed extends Event {
/**
- * The id returned by [`ChannelManager::send_payment`] and used with
- * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
+ * The `payment_id` passed to [`ChannelManager::send_payment`].
+ *
+ * This will be `Some` for all payment paths which failed on LDK 0.0.103 or later.
*
* [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
- * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
* [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
- *
- * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
*/
- @Nullable public final byte[] payment_id;
+ public final org.ldk.structs.Option_ThirtyTwoBytesZ payment_id;
/**
* The hash that was given to [`ChannelManager::send_payment`].
*
public final byte[] payment_hash;
/**
* Indicates the payment was rejected for some reason by the recipient. This implies that
- * the payment has failed, not just the route in question. If this is not set, you may
- * retry the payment via a different route.
+ * the payment has failed, not just the route in question. If this is not set, the payment may
+ * be retried via a different route.
*/
- public final boolean rejected_by_dest;
+ public final boolean payment_failed_permanently;
/**
- * Any failure information conveyed via the Onion return packet by a node along the failed
- * payment route.
- *
- * Should be applied to the [`NetworkGraph`] so that routing decisions can take into
- * account the update.
+ * Extra error details based on the failure type. May contain an update that needs to be
+ * applied to the [`NetworkGraph`].
*
* [`NetworkGraph`]: crate::routing::gossip::NetworkGraph
*/
- public final org.ldk.structs.Option_NetworkUpdateZ network_update;
- /**
- * For both single-path and multi-path payments, this is set if all paths of the payment have
- * failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
- * larger MPP payment were still in flight when this event was generated.
- *
- * Note that if you are retrying individual MPP parts, using this value to determine if a
- * payment has fully failed is race-y. Because multiple failures can happen prior to events
- * being processed, you may retry in response to a first failure, with a second failure
- * (with `all_paths_failed` set) still pending. Then, when the second failure is processed
- * you will see `all_paths_failed` set even though the retry of the first failure still
- * has an associated in-flight HTLC. See (1) for an example of such a failure.
- *
- * If you wish to retry individual MPP parts and learn when a payment has failed, you must
- * call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
- *
- * (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
- *
- * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
- */
- public final boolean all_paths_failed;
+ public final org.ldk.structs.PathFailure failure;
/**
* The payment path that failed.
*/
- public final RouteHop[] path;
+ public final org.ldk.structs.Path path;
/**
* The channel responsible for the failed payment path.
*
* retried. May be `None` for older [`Event`] serializations.
*/
public final org.ldk.structs.Option_u64Z short_channel_id;
+ private PaymentPathFailed(long ptr, bindings.LDKEvent.PaymentPathFailed obj) {
+ super(null, ptr);
+ long payment_id = obj.payment_id;
+ org.ldk.structs.Option_ThirtyTwoBytesZ payment_id_hu_conv = org.ldk.structs.Option_ThirtyTwoBytesZ.constr_from_ptr(payment_id);
+ if (payment_id_hu_conv != null) { payment_id_hu_conv.ptrs_to.add(this); };
+ this.payment_id = payment_id_hu_conv;
+ this.payment_hash = obj.payment_hash;
+ this.payment_failed_permanently = obj.payment_failed_permanently;
+ long failure = obj.failure;
+ org.ldk.structs.PathFailure failure_hu_conv = org.ldk.structs.PathFailure.constr_from_ptr(failure);
+ if (failure_hu_conv != null) { failure_hu_conv.ptrs_to.add(this); };
+ this.failure = failure_hu_conv;
+ long path = obj.path;
+ org.ldk.structs.Path path_hu_conv = null; if (path < 0 || path > 4096) { path_hu_conv = new org.ldk.structs.Path(null, path); }
+ if (path_hu_conv != null) { path_hu_conv.ptrs_to.add(this); };
+ this.path = path_hu_conv;
+ long short_channel_id = obj.short_channel_id;
+ org.ldk.structs.Option_u64Z short_channel_id_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(short_channel_id);
+ if (short_channel_id_hu_conv != null) { short_channel_id_hu_conv.ptrs_to.add(this); };
+ this.short_channel_id = short_channel_id_hu_conv;
+ }
+ }
+ /**
+ * Indicates that a probe payment we sent returned successful, i.e., only failed at the destination.
+ */
+ public final static class ProbeSuccessful extends Event {
+ /**
+ * The id returned by [`ChannelManager::send_probe`].
+ *
+ * [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
+ */
+ public final byte[] payment_id;
/**
- * Parameters needed to compute a new [`Route`] when retrying the failed payment path.
+ * The hash generated by [`ChannelManager::send_probe`].
*
- * See [`find_route`] for details.
+ * [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
+ */
+ public final byte[] payment_hash;
+ /**
+ * The payment path that was successful.
+ */
+ public final org.ldk.structs.Path path;
+ private ProbeSuccessful(long ptr, bindings.LDKEvent.ProbeSuccessful obj) {
+ super(null, ptr);
+ this.payment_id = obj.payment_id;
+ this.payment_hash = obj.payment_hash;
+ long path = obj.path;
+ org.ldk.structs.Path path_hu_conv = null; if (path < 0 || path > 4096) { path_hu_conv = new org.ldk.structs.Path(null, path); }
+ if (path_hu_conv != null) { path_hu_conv.ptrs_to.add(this); };
+ this.path = path_hu_conv;
+ }
+ }
+ /**
+ * Indicates that a probe payment we sent failed at an intermediary node on the path.
+ */
+ public final static class ProbeFailed extends Event {
+ /**
+ * The id returned by [`ChannelManager::send_probe`].
*
- * [`Route`]: crate::routing::router::Route
- * [`find_route`]: crate::routing::router::find_route
+ * [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
+ */
+ public final byte[] payment_id;
+ /**
+ * The hash generated by [`ChannelManager::send_probe`].
*
- * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
+ * [`ChannelManager::send_probe`]: crate::ln::channelmanager::ChannelManager::send_probe
*/
- @Nullable public final org.ldk.structs.RouteParameters retry;
- private PaymentPathFailed(long ptr, bindings.LDKEvent.PaymentPathFailed obj) {
+ public final byte[] payment_hash;
+ /**
+ * The payment path that failed.
+ */
+ public final org.ldk.structs.Path path;
+ /**
+ * The channel responsible for the failed probe.
+ *
+ * Note that for route hints or for the first hop in a path this may be an SCID alias and
+ * may not refer to a channel in the public network graph. These aliases may also collide
+ * with channels in the public network graph.
+ */
+ public final org.ldk.structs.Option_u64Z short_channel_id;
+ private ProbeFailed(long ptr, bindings.LDKEvent.ProbeFailed obj) {
super(null, ptr);
this.payment_id = obj.payment_id;
this.payment_hash = obj.payment_hash;
- this.rejected_by_dest = obj.rejected_by_dest;
- long network_update = obj.network_update;
- org.ldk.structs.Option_NetworkUpdateZ network_update_hu_conv = org.ldk.structs.Option_NetworkUpdateZ.constr_from_ptr(network_update);
- network_update_hu_conv.ptrs_to.add(this);
- this.network_update = network_update_hu_conv;
- this.all_paths_failed = obj.all_paths_failed;
- long[] path = obj.path;
- int path_conv_10_len = path.length;
- RouteHop[] path_conv_10_arr = new RouteHop[path_conv_10_len];
- for (int k = 0; k < path_conv_10_len; k++) {
- long path_conv_10 = path[k];
- org.ldk.structs.RouteHop path_conv_10_hu_conv = null; if (path_conv_10 < 0 || path_conv_10 > 4096) { path_conv_10_hu_conv = new org.ldk.structs.RouteHop(null, path_conv_10); }
- path_conv_10_hu_conv.ptrs_to.add(this);
- path_conv_10_arr[k] = path_conv_10_hu_conv;
- }
- this.path = path_conv_10_arr;
+ long path = obj.path;
+ org.ldk.structs.Path path_hu_conv = null; if (path < 0 || path > 4096) { path_hu_conv = new org.ldk.structs.Path(null, path); }
+ if (path_hu_conv != null) { path_hu_conv.ptrs_to.add(this); };
+ this.path = path_hu_conv;
long short_channel_id = obj.short_channel_id;
org.ldk.structs.Option_u64Z short_channel_id_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(short_channel_id);
- short_channel_id_hu_conv.ptrs_to.add(this);
+ if (short_channel_id_hu_conv != null) { short_channel_id_hu_conv.ptrs_to.add(this); };
this.short_channel_id = short_channel_id_hu_conv;
- long retry = obj.retry;
- org.ldk.structs.RouteParameters retry_hu_conv = null; if (retry < 0 || retry > 4096) { retry_hu_conv = new org.ldk.structs.RouteParameters(null, retry); }
- retry_hu_conv.ptrs_to.add(this);
- this.retry = retry_hu_conv;
}
}
/**
this.time_forwardable = obj.time_forwardable;
}
}
+ /**
+ * 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.
+ * Forwarding less than this amount may break compatibility with LDK versions prior to 0.0.116.
+ *
+ * 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;
+ }
+ }
/**
* Used to indicate that an output which you should know how to spend was confirmed on chain
* and is now spendable.
* The outputs which you should store as spendable by you.
*/
public final SpendableOutputDescriptor[] outputs;
+ /**
+ * The `channel_id` indicating which channel the spendable outputs belong to.
+ *
+ * This will always be `Some` for events generated by LDK versions 0.0.117 and above.
+ */
+ public final org.ldk.structs.Option_ThirtyTwoBytesZ channel_id;
private SpendableOutputs(long ptr, bindings.LDKEvent.SpendableOutputs obj) {
super(null, ptr);
long[] outputs = obj.outputs;
for (int b = 0; b < outputs_conv_27_len; b++) {
long outputs_conv_27 = outputs[b];
org.ldk.structs.SpendableOutputDescriptor outputs_conv_27_hu_conv = org.ldk.structs.SpendableOutputDescriptor.constr_from_ptr(outputs_conv_27);
- outputs_conv_27_hu_conv.ptrs_to.add(this);
+ if (outputs_conv_27_hu_conv != null) { outputs_conv_27_hu_conv.ptrs_to.add(this); };
outputs_conv_27_arr[b] = outputs_conv_27_hu_conv;
}
this.outputs = outputs_conv_27_arr;
+ long channel_id = obj.channel_id;
+ org.ldk.structs.Option_ThirtyTwoBytesZ channel_id_hu_conv = org.ldk.structs.Option_ThirtyTwoBytesZ.constr_from_ptr(channel_id);
+ if (channel_id_hu_conv != null) { channel_id_hu_conv.ptrs_to.add(this); };
+ this.channel_id = channel_id_hu_conv;
}
}
/**
/**
* 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
*/
- @Nullable public final byte[] prev_channel_id;
+ public final org.ldk.structs.Option_ThirtyTwoBytesZ prev_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
*/
- @Nullable public final byte[] next_channel_id;
+ public final org.ldk.structs.Option_ThirtyTwoBytesZ next_channel_id;
/**
* The fee, in milli-satoshis, which was earned as a result of the payment.
*
* transaction.
*/
public final boolean claim_from_onchain_tx;
+ /**
+ * 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.
+ */
+ public final org.ldk.structs.Option_u64Z outbound_amount_forwarded_msat;
private PaymentForwarded(long ptr, bindings.LDKEvent.PaymentForwarded obj) {
super(null, ptr);
- this.prev_channel_id = obj.prev_channel_id;
- this.next_channel_id = obj.next_channel_id;
+ long prev_channel_id = obj.prev_channel_id;
+ org.ldk.structs.Option_ThirtyTwoBytesZ prev_channel_id_hu_conv = org.ldk.structs.Option_ThirtyTwoBytesZ.constr_from_ptr(prev_channel_id);
+ if (prev_channel_id_hu_conv != null) { prev_channel_id_hu_conv.ptrs_to.add(this); };
+ this.prev_channel_id = prev_channel_id_hu_conv;
+ long next_channel_id = obj.next_channel_id;
+ org.ldk.structs.Option_ThirtyTwoBytesZ next_channel_id_hu_conv = org.ldk.structs.Option_ThirtyTwoBytesZ.constr_from_ptr(next_channel_id);
+ if (next_channel_id_hu_conv != null) { next_channel_id_hu_conv.ptrs_to.add(this); };
+ this.next_channel_id = next_channel_id_hu_conv;
long fee_earned_msat = obj.fee_earned_msat;
org.ldk.structs.Option_u64Z fee_earned_msat_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(fee_earned_msat);
- fee_earned_msat_hu_conv.ptrs_to.add(this);
+ if (fee_earned_msat_hu_conv != null) { fee_earned_msat_hu_conv.ptrs_to.add(this); };
this.fee_earned_msat = fee_earned_msat_hu_conv;
this.claim_from_onchain_tx = obj.claim_from_onchain_tx;
+ long outbound_amount_forwarded_msat = obj.outbound_amount_forwarded_msat;
+ org.ldk.structs.Option_u64Z outbound_amount_forwarded_msat_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(outbound_amount_forwarded_msat);
+ if (outbound_amount_forwarded_msat_hu_conv != null) { outbound_amount_forwarded_msat_hu_conv.ptrs_to.add(this); };
+ this.outbound_amount_forwarded_msat = outbound_amount_forwarded_msat_hu_conv;
+ }
+ }
+ /**
+ * Used to indicate that a channel with the given `channel_id` is being opened and pending
+ * confirmation on-chain.
+ *
+ * This event is emitted when the funding transaction has been signed and is broadcast to the
+ * network. For 0conf channels it will be immediately followed by the corresponding
+ * [`Event::ChannelReady`] event.
+ */
+ public final static class ChannelPending extends Event {
+ /**
+ * The `channel_id` of the channel that is pending confirmation.
+ */
+ public final byte[] channel_id;
+ /**
+ * The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
+ * channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
+ * [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
+ * `user_channel_id` will be randomized for an inbound channel.
+ *
+ * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
+ * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
+ * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
+ */
+ public final org.ldk.util.UInt128 user_channel_id;
+ /**
+ * The `temporary_channel_id` this channel used to be known by during channel establishment.
+ *
+ * Will be `None` for channels created prior to LDK version 0.0.115.
+ */
+ public final org.ldk.structs.Option_ThirtyTwoBytesZ former_temporary_channel_id;
+ /**
+ * The `node_id` of the channel counterparty.
+ */
+ public final byte[] counterparty_node_id;
+ /**
+ * The outpoint of the channel's funding transaction.
+ */
+ public final org.ldk.structs.OutPoint funding_txo;
+ private ChannelPending(long ptr, bindings.LDKEvent.ChannelPending obj) {
+ super(null, ptr);
+ this.channel_id = obj.channel_id;
+ byte[] user_channel_id = obj.user_channel_id;
+ org.ldk.util.UInt128 user_channel_id_conv = new org.ldk.util.UInt128(user_channel_id);
+ this.user_channel_id = user_channel_id_conv;
+ long former_temporary_channel_id = obj.former_temporary_channel_id;
+ org.ldk.structs.Option_ThirtyTwoBytesZ former_temporary_channel_id_hu_conv = org.ldk.structs.Option_ThirtyTwoBytesZ.constr_from_ptr(former_temporary_channel_id);
+ if (former_temporary_channel_id_hu_conv != null) { former_temporary_channel_id_hu_conv.ptrs_to.add(this); };
+ this.former_temporary_channel_id = former_temporary_channel_id_hu_conv;
+ this.counterparty_node_id = obj.counterparty_node_id;
+ long funding_txo = obj.funding_txo;
+ org.ldk.structs.OutPoint funding_txo_hu_conv = null; if (funding_txo < 0 || funding_txo > 4096) { funding_txo_hu_conv = new org.ldk.structs.OutPoint(null, funding_txo); }
+ if (funding_txo_hu_conv != null) { funding_txo_hu_conv.ptrs_to.add(this); };
+ this.funding_txo = funding_txo_hu_conv;
+ }
+ }
+ /**
+ * Used to indicate that a channel with the given `channel_id` is ready to
+ * be used. This event is emitted either when the funding transaction has been confirmed
+ * on-chain, or, in case of a 0conf channel, when both parties have confirmed the channel
+ * establishment.
+ */
+ public final static class ChannelReady extends Event {
+ /**
+ * The `channel_id` of the channel that is ready.
+ */
+ public final byte[] channel_id;
+ /**
+ * The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
+ * channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
+ * [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
+ * `user_channel_id` will be randomized for an inbound channel.
+ *
+ * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
+ * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
+ * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
+ */
+ public final org.ldk.util.UInt128 user_channel_id;
+ /**
+ * The `node_id` of the channel counterparty.
+ */
+ public final byte[] counterparty_node_id;
+ /**
+ * The features that this channel will operate with.
+ */
+ public final org.ldk.structs.ChannelTypeFeatures channel_type;
+ private ChannelReady(long ptr, bindings.LDKEvent.ChannelReady obj) {
+ super(null, ptr);
+ this.channel_id = obj.channel_id;
+ byte[] user_channel_id = obj.user_channel_id;
+ org.ldk.util.UInt128 user_channel_id_conv = new org.ldk.util.UInt128(user_channel_id);
+ this.user_channel_id = user_channel_id_conv;
+ this.counterparty_node_id = obj.counterparty_node_id;
+ long channel_type = obj.channel_type;
+ org.ldk.structs.ChannelTypeFeatures channel_type_hu_conv = null; if (channel_type < 0 || channel_type > 4096) { channel_type_hu_conv = new org.ldk.structs.ChannelTypeFeatures(null, channel_type); }
+ if (channel_type_hu_conv != null) { channel_type_hu_conv.ptrs_to.add(this); };
+ this.channel_type = channel_type_hu_conv;
}
}
/**
* Used to indicate that a previously opened channel with the given `channel_id` is in the
* process of closure.
+ *
+ * Note that this event is only triggered for accepted channels: if the
+ * [`UserConfig::manually_accept_inbound_channels`] config flag is set to true and the channel is
+ * rejected, no `ChannelClosed` event will be sent.
+ *
+ * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
+ * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
*/
public final static class ChannelClosed extends Event {
/**
- * The channel_id of the channel which has been closed. Note that on-chain transactions
+ * The `channel_id` of the channel which has been closed. Note that on-chain transactions
* resolving the channel are likely still awaiting confirmation.
*/
public final byte[] channel_id;
* The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
* channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
* [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
- * `user_channel_id` will be 0 for an inbound channel.
- * This will always be zero for objects serialized with LDK versions prior to 0.0.102.
+ * `user_channel_id` will be randomized for inbound channels.
+ * This may be zero for inbound channels serialized prior to 0.0.113 and will always be
+ * zero for objects serialized with LDK versions prior to 0.0.102.
*
* [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
* [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
* [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
*/
- public final long user_channel_id;
+ public final org.ldk.util.UInt128 user_channel_id;
/**
* The reason the channel was closed.
*/
public final org.ldk.structs.ClosureReason reason;
+ /**
+ * Counterparty in the closed channel.
+ *
+ * This field will be `None` for objects serialized prior to LDK 0.0.117.
+ *
+ * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
+ */
+ @Nullable public final byte[] counterparty_node_id;
+ /**
+ * Channel capacity of the closing channel (sats).
+ *
+ * This field will be `None` for objects serialized prior to LDK 0.0.117.
+ */
+ public final org.ldk.structs.Option_u64Z channel_capacity_sats;
private ChannelClosed(long ptr, bindings.LDKEvent.ChannelClosed obj) {
super(null, ptr);
this.channel_id = obj.channel_id;
- this.user_channel_id = obj.user_channel_id;
+ byte[] user_channel_id = obj.user_channel_id;
+ org.ldk.util.UInt128 user_channel_id_conv = new org.ldk.util.UInt128(user_channel_id);
+ this.user_channel_id = user_channel_id_conv;
long reason = obj.reason;
org.ldk.structs.ClosureReason reason_hu_conv = org.ldk.structs.ClosureReason.constr_from_ptr(reason);
- reason_hu_conv.ptrs_to.add(this);
+ if (reason_hu_conv != null) { reason_hu_conv.ptrs_to.add(this); };
this.reason = reason_hu_conv;
+ this.counterparty_node_id = obj.counterparty_node_id;
+ long channel_capacity_sats = obj.channel_capacity_sats;
+ org.ldk.structs.Option_u64Z channel_capacity_sats_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(channel_capacity_sats);
+ if (channel_capacity_sats_hu_conv != null) { channel_capacity_sats_hu_conv.ptrs_to.add(this); };
+ this.channel_capacity_sats = channel_capacity_sats_hu_conv;
}
}
/**
* Used to indicate to the user that they can abandon the funding transaction and recycle the
* inputs for another purpose.
+ *
+ * This event is not guaranteed to be generated for channels that are closed due to a restart.
*/
public final static class DiscardFunding extends Event {
/**
/**
* Indicates a request to open a new channel by a peer.
*
- * To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
- * request, call [`ChannelManager::force_close_channel`].
+ * To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the request,
+ * call [`ChannelManager::force_close_without_broadcasting_txn`]. Note that a ['ChannelClosed`]
+ * event will _not_ be triggered if the channel is rejected.
*
* The event is only triggered when a new open channel request is received and the
* [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
*
* [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
- * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
+ * [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
* [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
*/
public final static class OpenChannelRequest extends Event {
*
* When responding to the request, the `temporary_channel_id` should be passed
* back to the ChannelManager through [`ChannelManager::accept_inbound_channel`] to accept,
- * or through [`ChannelManager::force_close_channel`] to reject.
+ * or through [`ChannelManager::force_close_without_broadcasting_txn`] to reject.
*
* [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
- * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
+ * [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
*/
public final byte[] temporary_channel_id;
/**
*
* When responding to the request, the `counterparty_node_id` should be passed
* back to the `ChannelManager` through [`ChannelManager::accept_inbound_channel`] to
- * accept the request, or through [`ChannelManager::force_close_channel`] to reject the
+ * accept the request, or through [`ChannelManager::force_close_without_broadcasting_txn`] to reject the
* request.
*
* [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
- * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
+ * [`ChannelManager::force_close_without_broadcasting_txn`]: crate::ln::channelmanager::ChannelManager::force_close_without_broadcasting_txn
*/
public final byte[] counterparty_node_id;
/**
this.push_msat = obj.push_msat;
long channel_type = obj.channel_type;
org.ldk.structs.ChannelTypeFeatures channel_type_hu_conv = null; if (channel_type < 0 || channel_type > 4096) { channel_type_hu_conv = new org.ldk.structs.ChannelTypeFeatures(null, channel_type); }
- channel_type_hu_conv.ptrs_to.add(this);
+ if (channel_type_hu_conv != null) { channel_type_hu_conv.ptrs_to.add(this); };
this.channel_type = channel_type_hu_conv;
}
}
+ /**
+ * Indicates that the HTLC was accepted, but could not be processed when or after attempting to
+ * forward it.
+ *
+ * Some scenarios where this event may be sent include:
+ * Insufficient capacity in the outbound channel
+ * While waiting to forward the HTLC, the channel it is meant to be forwarded through closes
+ * When an unknown SCID is requested for forwarding a payment.
+ * Expected MPP amount has already been reached
+ * The HTLC has timed out
+ *
+ * This event, however, does not get generated if an HTLC fails to meet the forwarding
+ * requirements (i.e. insufficient fees paid, or a CLTV that is too soon).
+ */
+ public final static class HTLCHandlingFailed extends Event {
+ /**
+ * The channel over which the HTLC was received.
+ */
+ public final byte[] prev_channel_id;
+ /**
+ * Destination of the HTLC that failed to be processed.
+ */
+ public final org.ldk.structs.HTLCDestination failed_next_destination;
+ private HTLCHandlingFailed(long ptr, bindings.LDKEvent.HTLCHandlingFailed obj) {
+ super(null, ptr);
+ this.prev_channel_id = obj.prev_channel_id;
+ long failed_next_destination = obj.failed_next_destination;
+ org.ldk.structs.HTLCDestination failed_next_destination_hu_conv = org.ldk.structs.HTLCDestination.constr_from_ptr(failed_next_destination);
+ if (failed_next_destination_hu_conv != null) { failed_next_destination_hu_conv.ptrs_to.add(this); };
+ this.failed_next_destination = failed_next_destination_hu_conv;
+ }
+ }
+ /**
+ * Indicates that a transaction originating from LDK needs to have its fee bumped. This event
+ * requires confirmed external funds to be readily available to spend.
+ *
+ * LDK does not currently generate this event unless the
+ * [`ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx`] config flag is set to true.
+ * It is limited to the scope of channels with anchor outputs.
+ *
+ * [`ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx`]: crate::util::config::ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx
+ */
+ public final static class BumpTransaction extends Event {
+ public final org.ldk.structs.BumpTransactionEvent bump_transaction;
+ private BumpTransaction(long ptr, bindings.LDKEvent.BumpTransaction obj) {
+ super(null, ptr);
+ long bump_transaction = obj.bump_transaction;
+ org.ldk.structs.BumpTransactionEvent bump_transaction_hu_conv = org.ldk.structs.BumpTransactionEvent.constr_from_ptr(bump_transaction);
+ if (bump_transaction_hu_conv != null) { bump_transaction_hu_conv.ptrs_to.add(this); };
+ this.bump_transaction = bump_transaction_hu_conv;
+ }
+ }
long clone_ptr() {
long ret = bindings.Event_clone_ptr(this.ptr);
Reference.reachabilityFence(this);
Reference.reachabilityFence(this);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(this);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new FundingGenerationReady-variant Event
*/
- public static Event funding_generation_ready(byte[] temporary_channel_id, byte[] counterparty_node_id, long channel_value_satoshis, byte[] output_script, long user_channel_id) {
- long ret = bindings.Event_funding_generation_ready(InternalUtils.check_arr_len(temporary_channel_id, 32), InternalUtils.check_arr_len(counterparty_node_id, 33), channel_value_satoshis, output_script, user_channel_id);
+ public static Event funding_generation_ready(byte[] temporary_channel_id, byte[] counterparty_node_id, long channel_value_satoshis, byte[] output_script, org.ldk.util.UInt128 user_channel_id) {
+ long ret = bindings.Event_funding_generation_ready(InternalUtils.check_arr_len(temporary_channel_id, 32), InternalUtils.check_arr_len(counterparty_node_id, 33), channel_value_satoshis, output_script, user_channel_id.getLEBytes());
Reference.reachabilityFence(temporary_channel_id);
Reference.reachabilityFence(counterparty_node_id);
Reference.reachabilityFence(channel_value_satoshis);
Reference.reachabilityFence(user_channel_id);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
return ret_hu_conv;
}
/**
- * Utility method to constructs a new PaymentReceived-variant Event
+ * Utility method to constructs a new PaymentClaimable-variant Event
*/
- public static Event payment_received(byte[] payment_hash, long amount_msat, PaymentPurpose purpose) {
- long ret = bindings.Event_payment_received(InternalUtils.check_arr_len(payment_hash, 32), amount_msat, purpose.ptr);
+ public static Event payment_claimable(byte[] receiver_node_id, byte[] payment_hash, org.ldk.structs.RecipientOnionFields onion_fields, long amount_msat, long counterparty_skimmed_fee_msat, org.ldk.structs.PaymentPurpose purpose, org.ldk.structs.Option_ThirtyTwoBytesZ via_channel_id, org.ldk.structs.Option_U128Z via_user_channel_id, org.ldk.structs.Option_u32Z claim_deadline) {
+ long ret = bindings.Event_payment_claimable(InternalUtils.check_arr_len(receiver_node_id, 33), InternalUtils.check_arr_len(payment_hash, 32), onion_fields == null ? 0 : onion_fields.ptr, amount_msat, counterparty_skimmed_fee_msat, purpose.ptr, via_channel_id.ptr, via_user_channel_id.ptr, claim_deadline.ptr);
+ Reference.reachabilityFence(receiver_node_id);
Reference.reachabilityFence(payment_hash);
+ Reference.reachabilityFence(onion_fields);
Reference.reachabilityFence(amount_msat);
+ Reference.reachabilityFence(counterparty_skimmed_fee_msat);
Reference.reachabilityFence(purpose);
+ Reference.reachabilityFence(via_channel_id);
+ Reference.reachabilityFence(via_user_channel_id);
+ Reference.reachabilityFence(claim_deadline);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(onion_fields); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(purpose); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(via_channel_id); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(via_user_channel_id); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(claim_deadline); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new PaymentClaimed-variant Event
*/
- public static Event payment_claimed(byte[] payment_hash, long amount_msat, PaymentPurpose purpose) {
- long ret = bindings.Event_payment_claimed(InternalUtils.check_arr_len(payment_hash, 32), amount_msat, purpose.ptr);
+ public static Event payment_claimed(byte[] receiver_node_id, byte[] payment_hash, long amount_msat, org.ldk.structs.PaymentPurpose purpose, ClaimedHTLC[] htlcs, org.ldk.structs.Option_u64Z sender_intended_total_msat) {
+ long ret = bindings.Event_payment_claimed(InternalUtils.check_arr_len(receiver_node_id, 33), InternalUtils.check_arr_len(payment_hash, 32), amount_msat, purpose.ptr, htlcs != null ? Arrays.stream(htlcs).mapToLong(htlcs_conv_13 -> htlcs_conv_13 == null ? 0 : htlcs_conv_13.ptr).toArray() : null, sender_intended_total_msat.ptr);
+ Reference.reachabilityFence(receiver_node_id);
Reference.reachabilityFence(payment_hash);
Reference.reachabilityFence(amount_msat);
Reference.reachabilityFence(purpose);
+ Reference.reachabilityFence(htlcs);
+ Reference.reachabilityFence(sender_intended_total_msat);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(purpose); };
+ for (ClaimedHTLC htlcs_conv_13: htlcs) { if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(htlcs_conv_13); }; };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(sender_intended_total_msat); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * Utility method to constructs a new InvoiceRequestFailed-variant Event
+ */
+ public static Event invoice_request_failed(byte[] payment_id) {
+ long ret = bindings.Event_invoice_request_failed(InternalUtils.check_arr_len(payment_id, 32));
+ Reference.reachabilityFence(payment_id);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new PaymentSent-variant Event
*/
- public static Event payment_sent(byte[] payment_id, byte[] payment_preimage, byte[] payment_hash, Option_u64Z fee_paid_msat) {
- long ret = bindings.Event_payment_sent(InternalUtils.check_arr_len(payment_id, 32), InternalUtils.check_arr_len(payment_preimage, 32), InternalUtils.check_arr_len(payment_hash, 32), fee_paid_msat.ptr);
+ public static Event payment_sent(org.ldk.structs.Option_ThirtyTwoBytesZ payment_id, byte[] payment_preimage, byte[] payment_hash, org.ldk.structs.Option_u64Z fee_paid_msat) {
+ long ret = bindings.Event_payment_sent(payment_id.ptr, InternalUtils.check_arr_len(payment_preimage, 32), InternalUtils.check_arr_len(payment_hash, 32), fee_paid_msat.ptr);
Reference.reachabilityFence(payment_id);
Reference.reachabilityFence(payment_preimage);
Reference.reachabilityFence(payment_hash);
Reference.reachabilityFence(fee_paid_msat);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(payment_id); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(fee_paid_msat); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new PaymentFailed-variant Event
*/
- public static Event payment_failed(byte[] payment_id, byte[] payment_hash) {
- long ret = bindings.Event_payment_failed(InternalUtils.check_arr_len(payment_id, 32), InternalUtils.check_arr_len(payment_hash, 32));
+ public static Event payment_failed(byte[] payment_id, byte[] payment_hash, org.ldk.structs.Option_PaymentFailureReasonZ reason) {
+ long ret = bindings.Event_payment_failed(InternalUtils.check_arr_len(payment_id, 32), InternalUtils.check_arr_len(payment_hash, 32), reason.ptr);
Reference.reachabilityFence(payment_id);
Reference.reachabilityFence(payment_hash);
+ Reference.reachabilityFence(reason);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(reason); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new PaymentPathSuccessful-variant Event
*/
- public static Event payment_path_successful(byte[] payment_id, byte[] payment_hash, RouteHop[] path) {
- long ret = bindings.Event_payment_path_successful(InternalUtils.check_arr_len(payment_id, 32), InternalUtils.check_arr_len(payment_hash, 32), path != null ? Arrays.stream(path).mapToLong(path_conv_10 -> path_conv_10 == null ? 0 : path_conv_10.ptr & ~1).toArray() : null);
+ public static Event payment_path_successful(byte[] payment_id, org.ldk.structs.Option_ThirtyTwoBytesZ payment_hash, org.ldk.structs.Path path) {
+ long ret = bindings.Event_payment_path_successful(InternalUtils.check_arr_len(payment_id, 32), payment_hash.ptr, path == null ? 0 : path.ptr);
Reference.reachabilityFence(payment_id);
Reference.reachabilityFence(payment_hash);
Reference.reachabilityFence(path);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(payment_hash); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(path); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new PaymentPathFailed-variant Event
*/
- public static Event payment_path_failed(byte[] payment_id, byte[] payment_hash, boolean rejected_by_dest, Option_NetworkUpdateZ network_update, boolean all_paths_failed, RouteHop[] path, Option_u64Z short_channel_id, RouteParameters retry) {
- long ret = bindings.Event_payment_path_failed(InternalUtils.check_arr_len(payment_id, 32), InternalUtils.check_arr_len(payment_hash, 32), rejected_by_dest, network_update.ptr, all_paths_failed, path != null ? Arrays.stream(path).mapToLong(path_conv_10 -> path_conv_10 == null ? 0 : path_conv_10.ptr & ~1).toArray() : null, short_channel_id.ptr, retry == null ? 0 : retry.ptr & ~1);
+ public static Event payment_path_failed(org.ldk.structs.Option_ThirtyTwoBytesZ payment_id, byte[] payment_hash, boolean payment_failed_permanently, org.ldk.structs.PathFailure failure, org.ldk.structs.Path path, org.ldk.structs.Option_u64Z short_channel_id) {
+ long ret = bindings.Event_payment_path_failed(payment_id.ptr, InternalUtils.check_arr_len(payment_hash, 32), payment_failed_permanently, failure.ptr, path == null ? 0 : path.ptr, short_channel_id.ptr);
+ Reference.reachabilityFence(payment_id);
+ Reference.reachabilityFence(payment_hash);
+ Reference.reachabilityFence(payment_failed_permanently);
+ Reference.reachabilityFence(failure);
+ Reference.reachabilityFence(path);
+ Reference.reachabilityFence(short_channel_id);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(payment_id); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(failure); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(path); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(short_channel_id); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * Utility method to constructs a new ProbeSuccessful-variant Event
+ */
+ public static Event probe_successful(byte[] payment_id, byte[] payment_hash, org.ldk.structs.Path path) {
+ long ret = bindings.Event_probe_successful(InternalUtils.check_arr_len(payment_id, 32), InternalUtils.check_arr_len(payment_hash, 32), path == null ? 0 : path.ptr);
+ Reference.reachabilityFence(payment_id);
+ Reference.reachabilityFence(payment_hash);
+ Reference.reachabilityFence(path);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(path); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * Utility method to constructs a new ProbeFailed-variant Event
+ */
+ public static Event probe_failed(byte[] payment_id, byte[] payment_hash, org.ldk.structs.Path path, org.ldk.structs.Option_u64Z short_channel_id) {
+ long ret = bindings.Event_probe_failed(InternalUtils.check_arr_len(payment_id, 32), InternalUtils.check_arr_len(payment_hash, 32), path == null ? 0 : path.ptr, short_channel_id.ptr);
Reference.reachabilityFence(payment_id);
Reference.reachabilityFence(payment_hash);
- Reference.reachabilityFence(rejected_by_dest);
- Reference.reachabilityFence(network_update);
- Reference.reachabilityFence(all_paths_failed);
Reference.reachabilityFence(path);
Reference.reachabilityFence(short_channel_id);
- Reference.reachabilityFence(retry);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(path); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(short_channel_id); };
return ret_hu_conv;
}
Reference.reachabilityFence(time_forwardable);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * Utility method to constructs a new HTLCIntercepted-variant Event
+ */
+ public static Event htlcintercepted(byte[] intercept_id, long requested_next_hop_scid, byte[] payment_hash, long inbound_amount_msat, long expected_outbound_amount_msat) {
+ long ret = bindings.Event_htlcintercepted(InternalUtils.check_arr_len(intercept_id, 32), requested_next_hop_scid, InternalUtils.check_arr_len(payment_hash, 32), inbound_amount_msat, expected_outbound_amount_msat);
+ Reference.reachabilityFence(intercept_id);
+ Reference.reachabilityFence(requested_next_hop_scid);
+ Reference.reachabilityFence(payment_hash);
+ Reference.reachabilityFence(inbound_amount_msat);
+ Reference.reachabilityFence(expected_outbound_amount_msat);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new SpendableOutputs-variant Event
*/
- public static Event spendable_outputs(SpendableOutputDescriptor[] outputs) {
- long ret = bindings.Event_spendable_outputs(outputs != null ? Arrays.stream(outputs).mapToLong(outputs_conv_27 -> outputs_conv_27.ptr).toArray() : null);
+ public static Event spendable_outputs(SpendableOutputDescriptor[] outputs, org.ldk.structs.Option_ThirtyTwoBytesZ channel_id) {
+ long ret = bindings.Event_spendable_outputs(outputs != null ? Arrays.stream(outputs).mapToLong(outputs_conv_27 -> outputs_conv_27.ptr).toArray() : null, channel_id.ptr);
Reference.reachabilityFence(outputs);
+ Reference.reachabilityFence(channel_id);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ for (SpendableOutputDescriptor outputs_conv_27: outputs) { if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(outputs_conv_27); }; };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(channel_id); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new PaymentForwarded-variant Event
*/
- public static Event payment_forwarded(byte[] prev_channel_id, byte[] next_channel_id, Option_u64Z fee_earned_msat, boolean claim_from_onchain_tx) {
- long ret = bindings.Event_payment_forwarded(InternalUtils.check_arr_len(prev_channel_id, 32), InternalUtils.check_arr_len(next_channel_id, 32), fee_earned_msat.ptr, claim_from_onchain_tx);
+ public static Event payment_forwarded(org.ldk.structs.Option_ThirtyTwoBytesZ prev_channel_id, org.ldk.structs.Option_ThirtyTwoBytesZ next_channel_id, org.ldk.structs.Option_u64Z fee_earned_msat, boolean claim_from_onchain_tx, org.ldk.structs.Option_u64Z outbound_amount_forwarded_msat) {
+ long ret = bindings.Event_payment_forwarded(prev_channel_id.ptr, next_channel_id.ptr, fee_earned_msat.ptr, claim_from_onchain_tx, outbound_amount_forwarded_msat.ptr);
Reference.reachabilityFence(prev_channel_id);
Reference.reachabilityFence(next_channel_id);
Reference.reachabilityFence(fee_earned_msat);
Reference.reachabilityFence(claim_from_onchain_tx);
+ Reference.reachabilityFence(outbound_amount_forwarded_msat);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(prev_channel_id); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(next_channel_id); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(fee_earned_msat); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(outbound_amount_forwarded_msat); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * Utility method to constructs a new ChannelPending-variant Event
+ */
+ public static Event channel_pending(byte[] channel_id, org.ldk.util.UInt128 user_channel_id, org.ldk.structs.Option_ThirtyTwoBytesZ former_temporary_channel_id, byte[] counterparty_node_id, org.ldk.structs.OutPoint funding_txo) {
+ long ret = bindings.Event_channel_pending(InternalUtils.check_arr_len(channel_id, 32), user_channel_id.getLEBytes(), former_temporary_channel_id.ptr, InternalUtils.check_arr_len(counterparty_node_id, 33), funding_txo == null ? 0 : funding_txo.ptr);
+ Reference.reachabilityFence(channel_id);
+ Reference.reachabilityFence(user_channel_id);
+ Reference.reachabilityFence(former_temporary_channel_id);
+ Reference.reachabilityFence(counterparty_node_id);
+ Reference.reachabilityFence(funding_txo);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(former_temporary_channel_id); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(funding_txo); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * Utility method to constructs a new ChannelReady-variant Event
+ */
+ public static Event channel_ready(byte[] channel_id, org.ldk.util.UInt128 user_channel_id, byte[] counterparty_node_id, org.ldk.structs.ChannelTypeFeatures channel_type) {
+ long ret = bindings.Event_channel_ready(InternalUtils.check_arr_len(channel_id, 32), user_channel_id.getLEBytes(), InternalUtils.check_arr_len(counterparty_node_id, 33), channel_type == null ? 0 : channel_type.ptr);
+ Reference.reachabilityFence(channel_id);
+ Reference.reachabilityFence(user_channel_id);
+ Reference.reachabilityFence(counterparty_node_id);
+ Reference.reachabilityFence(channel_type);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(channel_type); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new ChannelClosed-variant Event
*/
- public static Event channel_closed(byte[] channel_id, long user_channel_id, ClosureReason reason) {
- long ret = bindings.Event_channel_closed(InternalUtils.check_arr_len(channel_id, 32), user_channel_id, reason.ptr);
+ public static Event channel_closed(byte[] channel_id, org.ldk.util.UInt128 user_channel_id, org.ldk.structs.ClosureReason reason, byte[] counterparty_node_id, org.ldk.structs.Option_u64Z channel_capacity_sats) {
+ long ret = bindings.Event_channel_closed(InternalUtils.check_arr_len(channel_id, 32), user_channel_id.getLEBytes(), reason.ptr, InternalUtils.check_arr_len(counterparty_node_id, 33), channel_capacity_sats.ptr);
Reference.reachabilityFence(channel_id);
Reference.reachabilityFence(user_channel_id);
Reference.reachabilityFence(reason);
+ Reference.reachabilityFence(counterparty_node_id);
+ Reference.reachabilityFence(channel_capacity_sats);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(reason); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(channel_capacity_sats); };
return ret_hu_conv;
}
Reference.reachabilityFence(transaction);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
return ret_hu_conv;
}
/**
* Utility method to constructs a new OpenChannelRequest-variant Event
*/
- public static Event open_channel_request(byte[] temporary_channel_id, byte[] counterparty_node_id, long funding_satoshis, long push_msat, ChannelTypeFeatures channel_type) {
- long ret = bindings.Event_open_channel_request(InternalUtils.check_arr_len(temporary_channel_id, 32), InternalUtils.check_arr_len(counterparty_node_id, 33), funding_satoshis, push_msat, channel_type == null ? 0 : channel_type.ptr & ~1);
+ public static Event open_channel_request(byte[] temporary_channel_id, byte[] counterparty_node_id, long funding_satoshis, long push_msat, org.ldk.structs.ChannelTypeFeatures channel_type) {
+ long ret = bindings.Event_open_channel_request(InternalUtils.check_arr_len(temporary_channel_id, 32), InternalUtils.check_arr_len(counterparty_node_id, 33), funding_satoshis, push_msat, channel_type == null ? 0 : channel_type.ptr);
Reference.reachabilityFence(temporary_channel_id);
Reference.reachabilityFence(counterparty_node_id);
Reference.reachabilityFence(funding_satoshis);
Reference.reachabilityFence(channel_type);
if (ret >= 0 && ret <= 4096) { return null; }
org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
- ret_hu_conv.ptrs_to.add(ret_hu_conv);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(channel_type); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * Utility method to constructs a new HTLCHandlingFailed-variant Event
+ */
+ public static Event htlchandling_failed(byte[] prev_channel_id, org.ldk.structs.HTLCDestination failed_next_destination) {
+ long ret = bindings.Event_htlchandling_failed(InternalUtils.check_arr_len(prev_channel_id, 32), failed_next_destination.ptr);
+ Reference.reachabilityFence(prev_channel_id);
+ Reference.reachabilityFence(failed_next_destination);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(failed_next_destination); };
return ret_hu_conv;
}
+ /**
+ * Utility method to constructs a new BumpTransaction-variant Event
+ */
+ public static Event bump_transaction(org.ldk.structs.BumpTransactionEvent a) {
+ long ret = bindings.Event_bump_transaction(a.ptr);
+ Reference.reachabilityFence(a);
+ if (ret >= 0 && ret <= 4096) { return null; }
+ org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+ if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(a); };
+ return ret_hu_conv;
+ }
+
+ /**
+ * Checks if two Events contain equal inner contents.
+ * This ignores pointers and is_owned flags and looks at the values in fields.
+ */
+ public boolean eq(org.ldk.structs.Event b) {
+ boolean ret = bindings.Event_eq(this.ptr, b == null ? 0 : b.ptr);
+ Reference.reachabilityFence(this);
+ Reference.reachabilityFence(b);
+ return ret;
+ }
+
+ @Override public boolean equals(Object o) {
+ if (!(o instanceof Event)) return false;
+ return this.eq((Event)o);
+ }
/**
* Serialize the Event object into a byte array which can be read by Event_read
*/
projects / ldk-java / blobdiff