X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FEvent.java;h=3a9d799e6382268de68946928a4ae66834f46f68;hb=2a8741cb87eb2b82381a6220a98f80f741147837;hp=df53a51150bddd493bc816974f32af70924a7f29;hpb=d87886bb194886ef86d3597a5cdc142b6ccc89e9;p=ldk-java diff --git a/src/main/java/org/ldk/structs/Event.java b/src/main/java/org/ldk/structs/Event.java index df53a511..3a9d799e 100644 --- a/src/main/java/org/ldk/structs/Event.java +++ b/src/main/java/org/ldk/structs/Event.java @@ -31,15 +31,21 @@ public class Event extends CommonBase { if (raw_val.getClass() == bindings.LDKEvent.PaymentReceived.class) { return new PaymentReceived(ptr, (bindings.LDKEvent.PaymentReceived)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.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.PaymentFailed.class) { return new PaymentFailed(ptr, (bindings.LDKEvent.PaymentFailed)raw_val); } + if (raw_val.getClass() == bindings.LDKEvent.PaymentPathSuccessful.class) { + return new PaymentPathSuccessful(ptr, (bindings.LDKEvent.PaymentPathSuccessful)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.PendingHTLCsForwardable.class) { return new PendingHTLCsForwardable(ptr, (bindings.LDKEvent.PendingHTLCsForwardable)raw_val); } @@ -55,8 +61,8 @@ public class Event extends CommonBase { if (raw_val.getClass() == bindings.LDKEvent.DiscardFunding.class) { return new DiscardFunding(ptr, (bindings.LDKEvent.DiscardFunding)raw_val); } - if (raw_val.getClass() == bindings.LDKEvent.PaymentPathSuccessful.class) { - return new PaymentPathSuccessful(ptr, (bindings.LDKEvent.PaymentPathSuccessful)raw_val); + if (raw_val.getClass() == bindings.LDKEvent.OpenChannelRequest.class) { + return new OpenChannelRequest(ptr, (bindings.LDKEvent.OpenChannelRequest)raw_val); } assert false; return null; // Unreachable without extending the (internal) bindings interface } @@ -74,9 +80,18 @@ public class Event extends CommonBase { public final static class FundingGenerationReady extends Event { /** * The random channel_id we picked which you'll need to pass into - * ChannelManager::funding_transaction_generated. + * [`ChannelManager::funding_transaction_generated`]. + * + * [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated */ public final byte[] temporary_channel_id; + /** + * The counterparty's node_id, which you'll need to pass back into + * [`ChannelManager::funding_transaction_generated`]. + * + * [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated + */ + public final byte[] counterparty_node_id; /** * The value, in satoshis, that the output should have. */ @@ -95,14 +110,16 @@ public class Event extends CommonBase { 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; } } /** - * Indicates we've received money! Just gotta dig out that payment preimage and feed it to - * [`ChannelManager::claim_funds`] to get it.... + * 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.... + * * 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. @@ -126,18 +143,59 @@ public class Event extends CommonBase { /** * The value, in thousandths of a satoshi, that this payment is for. */ - public final long amt; + public final long amount_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 PaymentPurpose purpose; + public final org.ldk.structs.PaymentPurpose purpose; private PaymentReceived(long ptr, bindings.LDKEvent.PaymentReceived obj) { super(null, ptr); this.payment_hash = obj.payment_hash; - this.amt = obj.amt; + 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); + this.purpose = purpose_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 + * [`ChannelManager::claim_funds`] call you may see this event without a corresponding + * [`Event::PaymentReceived`] 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 + * multiple `PaymentClaimed` events. + * + * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds + */ + public final static class PaymentClaimed extends Event { + /** + * 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. + */ + public final long amount_msat; + /** + * The purpose of this claimed payment, i.e. whether the payment was for an invoice or a + * spontaneous payment. + */ + public final org.ldk.structs.PaymentPurpose purpose; + private PaymentClaimed(long ptr, bindings.LDKEvent.PaymentClaimed obj) { + super(null, ptr); + this.payment_hash = obj.payment_hash; + this.amount_msat = obj.amount_msat; long purpose = obj.purpose; - PaymentPurpose purpose_hu_conv = PaymentPurpose.constr_from_ptr(purpose); + org.ldk.structs.PaymentPurpose purpose_hu_conv = org.ldk.structs.PaymentPurpose.constr_from_ptr(purpose); purpose_hu_conv.ptrs_to.add(this); this.purpose = purpose_hu_conv; } @@ -183,18 +241,95 @@ public class Event extends CommonBase { * * [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees */ - public final Option_u64Z fee_paid_msat; + 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; this.payment_preimage = obj.payment_preimage; this.payment_hash = obj.payment_hash; long fee_paid_msat = obj.fee_paid_msat; - Option_u64Z fee_paid_msat_hu_conv = Option_u64Z.constr_from_ptr(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); 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. + * + * 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. + * + * [`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`]. + * + * [`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; + /** + * The hash that was given to [`ChannelManager::send_payment`]. + * + * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment + */ + public final byte[] payment_hash; + private PaymentFailed(long ptr, bindings.LDKEvent.PaymentFailed obj) { + super(null, ptr); + this.payment_id = obj.payment_id; + this.payment_hash = obj.payment_hash; + } + } + /** + * 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. + */ + public final static class PaymentPathSuccessful extends Event { + /** + * 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 + */ + public final byte[] payment_id; + /** + * 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 + */ + @Nullable public final byte[] 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; + 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; + } + } /** * Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped * something. You may wish to retry with a different route. @@ -202,7 +337,7 @@ public class Event extends CommonBase { * Note that this does *not* indicate that all paths for an MPP payment have failed, see * [`Event::PaymentFailed`] and [`all_paths_failed`]. * - * [`all_paths_failed`]: Self::all_paths_failed + * [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed */ public final static class PaymentPathFailed extends Event { /** @@ -233,12 +368,11 @@ public class Event extends CommonBase { * payment route. * * Should be applied to the [`NetworkGraph`] so that routing decisions can take into - * account the update. [`NetGraphMsgHandler`] is capable of doing this. + * account the update. * - * [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph - * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler + * [`NetworkGraph`]: crate::routing::gossip::NetworkGraph */ - public final Option_NetworkUpdateZ network_update; + 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 @@ -266,10 +400,14 @@ public class Event extends CommonBase { /** * The channel responsible for the failed payment path. * + * 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. + * * If this is `Some`, then the corresponding channel should be avoided when the payment is * retried. May be `None` for older [`Event`] serializations. */ - public final Option_u64Z short_channel_id; + public final org.ldk.structs.Option_u64Z short_channel_id; /** * Parameters needed to compute a new [`Route`] when retrying the failed payment path. * @@ -280,14 +418,14 @@ public class Event extends CommonBase { * * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None */ - @Nullable public final RouteParameters retry; + @Nullable public final org.ldk.structs.RouteParameters retry; private PaymentPathFailed(long ptr, bindings.LDKEvent.PaymentPathFailed 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; - Option_NetworkUpdateZ network_update_hu_conv = Option_NetworkUpdateZ.constr_from_ptr(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; @@ -296,53 +434,21 @@ public class Event extends CommonBase { 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]; - RouteHop path_conv_10_hu_conv = null; if (path_conv_10 < 0 || path_conv_10 > 4096) { path_conv_10_hu_conv = new RouteHop(null, path_conv_10); } + 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 short_channel_id = obj.short_channel_id; - Option_u64Z short_channel_id_hu_conv = Option_u64Z.constr_from_ptr(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); this.short_channel_id = short_channel_id_hu_conv; long retry = obj.retry; - RouteParameters retry_hu_conv = null; if (retry < 0 || retry > 4096) { retry_hu_conv = new RouteParameters(null, 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; } } - /** - * Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events - * provide failure information for each MPP part in the payment. - * - * 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. - * - * [`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`]. - * - * [`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; - /** - * The hash that was given to [`ChannelManager::send_payment`]. - * - * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment - */ - public final byte[] payment_hash; - private PaymentFailed(long ptr, bindings.LDKEvent.PaymentFailed obj) { - super(null, ptr); - this.payment_id = obj.payment_id; - this.payment_hash = obj.payment_hash; - } - } /** * Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at * a time in the future. @@ -381,7 +487,7 @@ public class Event extends CommonBase { SpendableOutputDescriptor[] outputs_conv_27_arr = new SpendableOutputDescriptor[outputs_conv_27_len]; for (int b = 0; b < outputs_conv_27_len; b++) { long outputs_conv_27 = outputs[b]; - SpendableOutputDescriptor outputs_conv_27_hu_conv = SpendableOutputDescriptor.constr_from_ptr(outputs_conv_27); + 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); outputs_conv_27_arr[b] = outputs_conv_27_hu_conv; } @@ -393,6 +499,20 @@ public class Event extends CommonBase { * forwarding fee earned. */ public final static class PaymentForwarded extends Event { + /** + * 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; + /** + * 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; /** * The fee, in milli-satoshis, which was earned as a result of the payment. * @@ -408,7 +528,7 @@ public class Event extends CommonBase { * `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is * `None`. */ - public final Option_u64Z fee_earned_msat; + public final org.ldk.structs.Option_u64Z fee_earned_msat; /** * If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain * transaction. @@ -416,15 +536,18 @@ public class Event extends CommonBase { public final boolean claim_from_onchain_tx; 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 fee_earned_msat = obj.fee_earned_msat; - Option_u64Z fee_earned_msat_hu_conv = Option_u64Z.constr_from_ptr(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); this.fee_earned_msat = fee_earned_msat_hu_conv; this.claim_from_onchain_tx = obj.claim_from_onchain_tx; } } /** - * Used to indicate that a channel with the given `channel_id` is in the process of closure. + * Used to indicate that a previously opened channel with the given `channel_id` is in the + * process of closure. */ public final static class ChannelClosed extends Event { /** @@ -433,23 +556,27 @@ public class Event extends CommonBase { */ public final byte[] channel_id; /** - * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for - * an inbound channel. This will always be zero for objects serialized with LDK versions - * prior to 0.0.102. + * 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. * * [`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; /** * The reason the channel was closed. */ - public final ClosureReason reason; + public final org.ldk.structs.ClosureReason reason; 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; long reason = obj.reason; - ClosureReason reason_hu_conv = ClosureReason.constr_from_ptr(reason); + org.ldk.structs.ClosureReason reason_hu_conv = org.ldk.structs.ClosureReason.constr_from_ptr(reason); reason_hu_conv.ptrs_to.add(this); this.reason = reason_hu_conv; } @@ -474,48 +601,78 @@ public class Event extends CommonBase { } } /** - * Indicates that a path for an outbound payment was successful. + * Indicates a request to open a new channel by a peer. * - * Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See - * [`Event::PaymentSent`] for obtaining the payment preimage. + * To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the + * request, call [`ChannelManager::force_close_channel`]. + * + * 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 + * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels */ - public final static class PaymentPathSuccessful extends Event { + public final static class OpenChannelRequest extends Event { /** - * The id returned by [`ChannelManager::send_payment`] and used with - * [`ChannelManager::retry_payment`]. + * The temporary channel ID of the channel requested to be opened. * - * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment - * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment + * 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. + * + * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel + * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel */ - public final byte[] payment_id; + public final byte[] temporary_channel_id; /** - * The hash that was given to [`ChannelManager::send_payment`]. + * The node_id of the counterparty requesting to open the channel. * - * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment + * 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 + * request. * - * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None + * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel + * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel */ - @Nullable public final byte[] payment_hash; + public final byte[] counterparty_node_id; /** - * The payment path that was successful. + * The channel value of the requested channel. + */ + public final long funding_satoshis; + /** + * Our starting balance in the channel if the request is accepted, in milli-satoshi. + */ + public final long push_msat; + /** + * The features that this channel will operate with. If you reject the channel, a + * well-behaved counterparty may automatically re-attempt the channel with a new set of + * feature flags. * - * May contain a closed channel if the HTLC sent along the path was fulfilled on chain. + * Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type, + * the resulting [`ChannelManager`] will not be readable by versions of LDK prior to + * 0.0.106. + * + * Furthermore, note that if [`ChannelTypeFeatures::supports_zero_conf`] returns true on this type, + * the resulting [`ChannelManager`] will not be readable by versions of LDK prior to + * 0.0.107. Channels setting this type also need to get manually accepted via + * [`crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`], + * or will be rejected otherwise. + * + * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager */ - public final RouteHop[] path; - private PaymentPathSuccessful(long ptr, bindings.LDKEvent.PaymentPathSuccessful obj) { + public final org.ldk.structs.ChannelTypeFeatures channel_type; + private OpenChannelRequest(long ptr, bindings.LDKEvent.OpenChannelRequest 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]; - RouteHop path_conv_10_hu_conv = null; if (path_conv_10 < 0 || path_conv_10 > 4096) { path_conv_10_hu_conv = new 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; + this.temporary_channel_id = obj.temporary_channel_id; + this.counterparty_node_id = obj.counterparty_node_id; + this.funding_satoshis = obj.funding_satoshis; + 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); + this.channel_type = channel_type_hu_conv; } } long clone_ptr() { @@ -531,7 +688,7 @@ public class Event extends CommonBase { long ret = bindings.Event_clone(this.ptr); Reference.reachabilityFence(this); if (ret >= 0 && ret <= 4096) { return null; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(this); return ret_hu_conv; } @@ -539,14 +696,15 @@ public class Event extends CommonBase { /** * Utility method to constructs a new FundingGenerationReady-variant Event */ - public static Event funding_generation_ready(byte[] temporary_channel_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), 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, 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); Reference.reachabilityFence(temporary_channel_id); + Reference.reachabilityFence(counterparty_node_id); Reference.reachabilityFence(channel_value_satoshis); Reference.reachabilityFence(output_script); Reference.reachabilityFence(user_channel_id); if (ret >= 0 && ret <= 4096) { return null; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; } @@ -554,13 +712,27 @@ public class Event extends CommonBase { /** * Utility method to constructs a new PaymentReceived-variant Event */ - public static Event payment_received(byte[] payment_hash, long amt, PaymentPurpose purpose) { - long ret = bindings.Event_payment_received(InternalUtils.check_arr_len(payment_hash, 32), amt, purpose.ptr); + 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); Reference.reachabilityFence(payment_hash); - Reference.reachabilityFence(amt); + Reference.reachabilityFence(amount_msat); Reference.reachabilityFence(purpose); if (ret >= 0 && ret <= 4096) { return null; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); + ret_hu_conv.ptrs_to.add(ret_hu_conv); + 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); + Reference.reachabilityFence(payment_hash); + Reference.reachabilityFence(amount_msat); + Reference.reachabilityFence(purpose); + 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); return ret_hu_conv; } @@ -575,39 +747,53 @@ public class Event extends CommonBase { Reference.reachabilityFence(payment_hash); Reference.reachabilityFence(fee_paid_msat); if (ret >= 0 && ret <= 4096) { return null; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; } /** - * Utility method to constructs a new PaymentPathFailed-variant Event + * Utility method to constructs a new PaymentFailed-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_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)); + Reference.reachabilityFence(payment_id); + Reference.reachabilityFence(payment_hash); + 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); + 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); 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; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; } /** - * Utility method to constructs a new PaymentFailed-variant Event + * Utility method to constructs a new PaymentPathFailed-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_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); 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; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; } @@ -619,7 +805,7 @@ public class Event extends CommonBase { long ret = bindings.Event_pending_htlcs_forwardable(time_forwardable); Reference.reachabilityFence(time_forwardable); if (ret >= 0 && ret <= 4096) { return null; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; } @@ -631,7 +817,7 @@ public class Event extends CommonBase { long ret = bindings.Event_spendable_outputs(outputs != null ? Arrays.stream(outputs).mapToLong(outputs_conv_27 -> outputs_conv_27.ptr).toArray() : null); Reference.reachabilityFence(outputs); if (ret >= 0 && ret <= 4096) { return null; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; } @@ -639,12 +825,14 @@ public class Event extends CommonBase { /** * Utility method to constructs a new PaymentForwarded-variant Event */ - public static Event payment_forwarded(Option_u64Z fee_earned_msat, boolean claim_from_onchain_tx) { - long ret = bindings.Event_payment_forwarded(fee_earned_msat.ptr, claim_from_onchain_tx); + 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); + Reference.reachabilityFence(prev_channel_id); + Reference.reachabilityFence(next_channel_id); Reference.reachabilityFence(fee_earned_msat); Reference.reachabilityFence(claim_from_onchain_tx); if (ret >= 0 && ret <= 4096) { return null; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; } @@ -658,7 +846,7 @@ public class Event extends CommonBase { Reference.reachabilityFence(user_channel_id); Reference.reachabilityFence(reason); if (ret >= 0 && ret <= 4096) { return null; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; } @@ -671,21 +859,23 @@ public class Event extends CommonBase { Reference.reachabilityFence(channel_id); Reference.reachabilityFence(transaction); if (ret >= 0 && ret <= 4096) { return null; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; } /** - * Utility method to constructs a new PaymentPathSuccessful-variant Event + * Utility method to constructs a new OpenChannelRequest-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); - Reference.reachabilityFence(payment_id); - Reference.reachabilityFence(payment_hash); - Reference.reachabilityFence(path); + 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); + Reference.reachabilityFence(temporary_channel_id); + Reference.reachabilityFence(counterparty_node_id); + Reference.reachabilityFence(funding_satoshis); + Reference.reachabilityFence(push_msat); + Reference.reachabilityFence(channel_type); if (ret >= 0 && ret <= 4096) { return null; } - Event ret_hu_conv = Event.constr_from_ptr(ret); + org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; }