1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * An Event which you should probably take some action in response to.
14 * Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
15 * them directly as they don't round-trip exactly (for example FundingGenerationReady is never
16 * written as it makes no sense to respond to it after reconnecting to peers).
18 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
19 public class Event extends CommonBase {
20 private Event(Object _dummy, long ptr) { super(ptr); }
21 @Override @SuppressWarnings("deprecation")
22 protected void finalize() throws Throwable {
24 if (ptr != 0) { bindings.Event_free(ptr); }
26 static Event constr_from_ptr(long ptr) {
27 bindings.LDKEvent raw_val = bindings.LDKEvent_ref_from_ptr(ptr);
28 if (raw_val.getClass() == bindings.LDKEvent.FundingGenerationReady.class) {
29 return new FundingGenerationReady(ptr, (bindings.LDKEvent.FundingGenerationReady)raw_val);
31 if (raw_val.getClass() == bindings.LDKEvent.PaymentReceived.class) {
32 return new PaymentReceived(ptr, (bindings.LDKEvent.PaymentReceived)raw_val);
34 if (raw_val.getClass() == bindings.LDKEvent.PaymentSent.class) {
35 return new PaymentSent(ptr, (bindings.LDKEvent.PaymentSent)raw_val);
37 if (raw_val.getClass() == bindings.LDKEvent.PaymentPathFailed.class) {
38 return new PaymentPathFailed(ptr, (bindings.LDKEvent.PaymentPathFailed)raw_val);
40 if (raw_val.getClass() == bindings.LDKEvent.PaymentFailed.class) {
41 return new PaymentFailed(ptr, (bindings.LDKEvent.PaymentFailed)raw_val);
43 if (raw_val.getClass() == bindings.LDKEvent.PendingHTLCsForwardable.class) {
44 return new PendingHTLCsForwardable(ptr, (bindings.LDKEvent.PendingHTLCsForwardable)raw_val);
46 if (raw_val.getClass() == bindings.LDKEvent.SpendableOutputs.class) {
47 return new SpendableOutputs(ptr, (bindings.LDKEvent.SpendableOutputs)raw_val);
49 if (raw_val.getClass() == bindings.LDKEvent.PaymentForwarded.class) {
50 return new PaymentForwarded(ptr, (bindings.LDKEvent.PaymentForwarded)raw_val);
52 if (raw_val.getClass() == bindings.LDKEvent.ChannelClosed.class) {
53 return new ChannelClosed(ptr, (bindings.LDKEvent.ChannelClosed)raw_val);
55 if (raw_val.getClass() == bindings.LDKEvent.DiscardFunding.class) {
56 return new DiscardFunding(ptr, (bindings.LDKEvent.DiscardFunding)raw_val);
58 if (raw_val.getClass() == bindings.LDKEvent.PaymentPathSuccessful.class) {
59 return new PaymentPathSuccessful(ptr, (bindings.LDKEvent.PaymentPathSuccessful)raw_val);
61 if (raw_val.getClass() == bindings.LDKEvent.OpenChannelRequest.class) {
62 return new OpenChannelRequest(ptr, (bindings.LDKEvent.OpenChannelRequest)raw_val);
64 assert false; return null; // Unreachable without extending the (internal) bindings interface
68 * Used to indicate that the client should generate a funding transaction with the given
69 * parameters and then call [`ChannelManager::funding_transaction_generated`].
70 * Generated in [`ChannelManager`] message handling.
71 * Note that *all inputs* in the funding transaction must spend SegWit outputs or your
72 * counterparty can steal your funds!
74 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
75 * [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
77 public final static class FundingGenerationReady extends Event {
79 * The random channel_id we picked which you'll need to pass into
80 * ChannelManager::funding_transaction_generated.
82 public final byte[] temporary_channel_id;
84 * The value, in satoshis, that the output should have.
86 public final long channel_value_satoshis;
88 * The script which should be used in the transaction output.
90 public final byte[] output_script;
92 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
95 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
97 public final long user_channel_id;
98 private FundingGenerationReady(long ptr, bindings.LDKEvent.FundingGenerationReady obj) {
100 this.temporary_channel_id = obj.temporary_channel_id;
101 this.channel_value_satoshis = obj.channel_value_satoshis;
102 this.output_script = obj.output_script;
103 this.user_channel_id = obj.user_channel_id;
107 * Indicates we've received money! Just gotta dig out that payment preimage and feed it to
108 * [`ChannelManager::claim_funds`] to get it....
109 * Note that if the preimage is not known, you should call
110 * [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
111 * network congestion.
112 * If you fail to call either [`ChannelManager::claim_funds`] or
113 * [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
114 * automatically failed.
117 * LDK will not stop an inbound payment from being paid multiple times, so multiple
118 * `PaymentReceived` events may be generated for the same payment.
120 * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
121 * [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
123 public final static class PaymentReceived extends Event {
125 * The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
126 * not stop you from registering duplicate payment hashes for inbound payments.
128 public final byte[] payment_hash;
130 * The value, in thousandths of a satoshi, that this payment is for.
132 public final long amt;
134 * Information for claiming this received payment, based on whether the purpose of the
135 * payment is to pay an invoice or to send a spontaneous payment.
137 public final org.ldk.structs.PaymentPurpose purpose;
138 private PaymentReceived(long ptr, bindings.LDKEvent.PaymentReceived obj) {
140 this.payment_hash = obj.payment_hash;
142 long purpose = obj.purpose;
143 org.ldk.structs.PaymentPurpose purpose_hu_conv = org.ldk.structs.PaymentPurpose.constr_from_ptr(purpose);
144 purpose_hu_conv.ptrs_to.add(this);
145 this.purpose = purpose_hu_conv;
149 * Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
150 * and we got back the payment preimage for it).
152 * Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
153 * event. In this situation, you SHOULD treat this payment as having succeeded.
155 public final static class PaymentSent extends Event {
157 * The id returned by [`ChannelManager::send_payment`] and used with
158 * [`ChannelManager::retry_payment`].
160 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
161 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
163 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
165 @Nullable public final byte[] payment_id;
167 * The preimage to the hash given to ChannelManager::send_payment.
168 * Note that this serves as a payment receipt, if you wish to have such a thing, you must
171 public final byte[] payment_preimage;
173 * The hash that was given to [`ChannelManager::send_payment`].
175 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
177 public final byte[] payment_hash;
179 * The total fee which was spent at intermediate hops in this payment, across all paths.
181 * Note that, like [`Route::get_total_fees`] this does *not* include any potential
182 * overpayment to the recipient node.
184 * If the recipient or an intermediate node misbehaves and gives us free money, this may
185 * overstate the amount paid, though this is unlikely.
187 * [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
189 public final org.ldk.structs.Option_u64Z fee_paid_msat;
190 private PaymentSent(long ptr, bindings.LDKEvent.PaymentSent obj) {
192 this.payment_id = obj.payment_id;
193 this.payment_preimage = obj.payment_preimage;
194 this.payment_hash = obj.payment_hash;
195 long fee_paid_msat = obj.fee_paid_msat;
196 org.ldk.structs.Option_u64Z fee_paid_msat_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(fee_paid_msat);
197 fee_paid_msat_hu_conv.ptrs_to.add(this);
198 this.fee_paid_msat = fee_paid_msat_hu_conv;
202 * Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
203 * something. You may wish to retry with a different route.
205 * Note that this does *not* indicate that all paths for an MPP payment have failed, see
206 * [`Event::PaymentFailed`] and [`all_paths_failed`].
208 * [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
210 public final static class PaymentPathFailed extends Event {
212 * The id returned by [`ChannelManager::send_payment`] and used with
213 * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
215 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
216 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
217 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
219 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
221 @Nullable public final byte[] payment_id;
223 * The hash that was given to [`ChannelManager::send_payment`].
225 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
227 public final byte[] payment_hash;
229 * Indicates the payment was rejected for some reason by the recipient. This implies that
230 * the payment has failed, not just the route in question. If this is not set, you may
231 * retry the payment via a different route.
233 public final boolean rejected_by_dest;
235 * Any failure information conveyed via the Onion return packet by a node along the failed
238 * Should be applied to the [`NetworkGraph`] so that routing decisions can take into
239 * account the update. [`NetGraphMsgHandler`] is capable of doing this.
241 * [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
242 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
244 public final org.ldk.structs.Option_NetworkUpdateZ network_update;
246 * For both single-path and multi-path payments, this is set if all paths of the payment have
247 * failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
248 * larger MPP payment were still in flight when this event was generated.
250 * Note that if you are retrying individual MPP parts, using this value to determine if a
251 * payment has fully failed is race-y. Because multiple failures can happen prior to events
252 * being processed, you may retry in response to a first failure, with a second failure
253 * (with `all_paths_failed` set) still pending. Then, when the second failure is processed
254 * you will see `all_paths_failed` set even though the retry of the first failure still
255 * has an associated in-flight HTLC. See (1) for an example of such a failure.
257 * If you wish to retry individual MPP parts and learn when a payment has failed, you must
258 * call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
260 * (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
262 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
264 public final boolean all_paths_failed;
266 * The payment path that failed.
268 public final RouteHop[] path;
270 * The channel responsible for the failed payment path.
272 * If this is `Some`, then the corresponding channel should be avoided when the payment is
273 * retried. May be `None` for older [`Event`] serializations.
275 public final org.ldk.structs.Option_u64Z short_channel_id;
277 * Parameters needed to compute a new [`Route`] when retrying the failed payment path.
279 * See [`find_route`] for details.
281 * [`Route`]: crate::routing::router::Route
282 * [`find_route`]: crate::routing::router::find_route
284 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
286 @Nullable public final org.ldk.structs.RouteParameters retry;
287 private PaymentPathFailed(long ptr, bindings.LDKEvent.PaymentPathFailed obj) {
289 this.payment_id = obj.payment_id;
290 this.payment_hash = obj.payment_hash;
291 this.rejected_by_dest = obj.rejected_by_dest;
292 long network_update = obj.network_update;
293 org.ldk.structs.Option_NetworkUpdateZ network_update_hu_conv = org.ldk.structs.Option_NetworkUpdateZ.constr_from_ptr(network_update);
294 network_update_hu_conv.ptrs_to.add(this);
295 this.network_update = network_update_hu_conv;
296 this.all_paths_failed = obj.all_paths_failed;
297 long[] path = obj.path;
298 int path_conv_10_len = path.length;
299 RouteHop[] path_conv_10_arr = new RouteHop[path_conv_10_len];
300 for (int k = 0; k < path_conv_10_len; k++) {
301 long path_conv_10 = path[k];
302 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); }
303 path_conv_10_hu_conv.ptrs_to.add(this);
304 path_conv_10_arr[k] = path_conv_10_hu_conv;
306 this.path = path_conv_10_arr;
307 long short_channel_id = obj.short_channel_id;
308 org.ldk.structs.Option_u64Z short_channel_id_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(short_channel_id);
309 short_channel_id_hu_conv.ptrs_to.add(this);
310 this.short_channel_id = short_channel_id_hu_conv;
311 long retry = obj.retry;
312 RouteParameters retry_hu_conv = null; if (retry < 0 || retry > 4096) { retry_hu_conv = new RouteParameters(null, retry); }
313 retry_hu_conv.ptrs_to.add(this);
314 this.retry = retry_hu_conv;
318 * Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
319 * provide failure information for each MPP part in the payment.
321 * This event is provided once there are no further pending HTLCs for the payment and the
322 * payment is no longer retryable, either due to a several-block timeout or because
323 * [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
325 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
327 public final static class PaymentFailed extends Event {
329 * The id returned by [`ChannelManager::send_payment`] and used with
330 * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
332 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
333 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
334 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
336 public final byte[] payment_id;
338 * The hash that was given to [`ChannelManager::send_payment`].
340 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
342 public final byte[] payment_hash;
343 private PaymentFailed(long ptr, bindings.LDKEvent.PaymentFailed obj) {
345 this.payment_id = obj.payment_id;
346 this.payment_hash = obj.payment_hash;
350 * Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
351 * a time in the future.
353 * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
355 public final static class PendingHTLCsForwardable extends Event {
357 * The minimum amount of time that should be waited prior to calling
358 * process_pending_htlc_forwards. To increase the effort required to correlate payments,
359 * you should wait a random amount of time in roughly the range (now + time_forwardable,
360 * now + 5*time_forwardable).
362 public final long time_forwardable;
363 private PendingHTLCsForwardable(long ptr, bindings.LDKEvent.PendingHTLCsForwardable obj) {
365 this.time_forwardable = obj.time_forwardable;
369 * Used to indicate that an output which you should know how to spend was confirmed on chain
370 * and is now spendable.
371 * Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
372 * counterparty spending them due to some kind of timeout. Thus, you need to store them
373 * somewhere and spend them when you create on-chain transactions.
375 public final static class SpendableOutputs extends Event {
377 * The outputs which you should store as spendable by you.
379 public final SpendableOutputDescriptor[] outputs;
380 private SpendableOutputs(long ptr, bindings.LDKEvent.SpendableOutputs obj) {
382 long[] outputs = obj.outputs;
383 int outputs_conv_27_len = outputs.length;
384 SpendableOutputDescriptor[] outputs_conv_27_arr = new SpendableOutputDescriptor[outputs_conv_27_len];
385 for (int b = 0; b < outputs_conv_27_len; b++) {
386 long outputs_conv_27 = outputs[b];
387 org.ldk.structs.SpendableOutputDescriptor outputs_conv_27_hu_conv = org.ldk.structs.SpendableOutputDescriptor.constr_from_ptr(outputs_conv_27);
388 outputs_conv_27_hu_conv.ptrs_to.add(this);
389 outputs_conv_27_arr[b] = outputs_conv_27_hu_conv;
391 this.outputs = outputs_conv_27_arr;
395 * This event is generated when a payment has been successfully forwarded through us and a
396 * forwarding fee earned.
398 public final static class PaymentForwarded extends Event {
400 * The fee, in milli-satoshis, which was earned as a result of the payment.
402 * Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
403 * was pending, the amount the next hop claimed will have been rounded down to the nearest
404 * whole satoshi. Thus, the fee calculated here may be higher than expected as we still
405 * claimed the full value in millisatoshis from the source. In this case,
406 * `claim_from_onchain_tx` will be set.
408 * If the channel which sent us the payment has been force-closed, we will claim the funds
409 * via an on-chain transaction. In that case we do not yet know the on-chain transaction
410 * fees which we will spend and will instead set this to `None`. It is possible duplicate
411 * `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
414 public final org.ldk.structs.Option_u64Z fee_earned_msat;
416 * If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
419 public final boolean claim_from_onchain_tx;
420 private PaymentForwarded(long ptr, bindings.LDKEvent.PaymentForwarded obj) {
422 long fee_earned_msat = obj.fee_earned_msat;
423 org.ldk.structs.Option_u64Z fee_earned_msat_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(fee_earned_msat);
424 fee_earned_msat_hu_conv.ptrs_to.add(this);
425 this.fee_earned_msat = fee_earned_msat_hu_conv;
426 this.claim_from_onchain_tx = obj.claim_from_onchain_tx;
430 * Used to indicate that a channel with the given `channel_id` is in the process of closure.
432 public final static class ChannelClosed extends Event {
434 * The channel_id of the channel which has been closed. Note that on-chain transactions
435 * resolving the channel are likely still awaiting confirmation.
437 public final byte[] channel_id;
439 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
440 * channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
441 * [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
442 * `user_channel_id` will be 0 for an inbound channel.
443 * This will always be zero for objects serialized with LDK versions prior to 0.0.102.
445 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
446 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
447 * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
449 public final long user_channel_id;
451 * The reason the channel was closed.
453 public final org.ldk.structs.ClosureReason reason;
454 private ChannelClosed(long ptr, bindings.LDKEvent.ChannelClosed obj) {
456 this.channel_id = obj.channel_id;
457 this.user_channel_id = obj.user_channel_id;
458 long reason = obj.reason;
459 org.ldk.structs.ClosureReason reason_hu_conv = org.ldk.structs.ClosureReason.constr_from_ptr(reason);
460 reason_hu_conv.ptrs_to.add(this);
461 this.reason = reason_hu_conv;
465 * Used to indicate to the user that they can abandon the funding transaction and recycle the
466 * inputs for another purpose.
468 public final static class DiscardFunding extends Event {
470 * The channel_id of the channel which has been closed.
472 public final byte[] channel_id;
474 * The full transaction received from the user
476 public final byte[] transaction;
477 private DiscardFunding(long ptr, bindings.LDKEvent.DiscardFunding obj) {
479 this.channel_id = obj.channel_id;
480 this.transaction = obj.transaction;
484 * Indicates that a path for an outbound payment was successful.
486 * Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
487 * [`Event::PaymentSent`] for obtaining the payment preimage.
489 public final static class PaymentPathSuccessful extends Event {
491 * The id returned by [`ChannelManager::send_payment`] and used with
492 * [`ChannelManager::retry_payment`].
494 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
495 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
497 public final byte[] payment_id;
499 * The hash that was given to [`ChannelManager::send_payment`].
501 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
503 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
505 @Nullable public final byte[] payment_hash;
507 * The payment path that was successful.
509 * May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
511 public final RouteHop[] path;
512 private PaymentPathSuccessful(long ptr, bindings.LDKEvent.PaymentPathSuccessful obj) {
514 this.payment_id = obj.payment_id;
515 this.payment_hash = obj.payment_hash;
516 long[] path = obj.path;
517 int path_conv_10_len = path.length;
518 RouteHop[] path_conv_10_arr = new RouteHop[path_conv_10_len];
519 for (int k = 0; k < path_conv_10_len; k++) {
520 long path_conv_10 = path[k];
521 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); }
522 path_conv_10_hu_conv.ptrs_to.add(this);
523 path_conv_10_arr[k] = path_conv_10_hu_conv;
525 this.path = path_conv_10_arr;
529 * Indicates a request to open a new channel by a peer.
531 * To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
532 * request, call [`ChannelManager::force_close_channel`].
534 * The event is only triggered when a new open channel request is received and the
535 * [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
537 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
538 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
539 * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
541 public final static class OpenChannelRequest extends Event {
543 * The temporary channel ID of the channel requested to be opened.
545 * When responding to the request, the `temporary_channel_id` should be passed
546 * back to the ChannelManager with [`ChannelManager::accept_inbound_channel`] to accept,
547 * or to [`ChannelManager::force_close_channel`] to reject.
549 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
550 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
552 public final byte[] temporary_channel_id;
554 * The node_id of the counterparty requesting to open the channel.
556 public final byte[] counterparty_node_id;
558 * The channel value of the requested channel.
560 public final long funding_satoshis;
562 * Our starting balance in the channel if the request is accepted, in milli-satoshi.
564 public final long push_msat;
566 * The features that this channel will operate with. If you reject the channel, a
567 * well-behaved counterparty may automatically re-attempt the channel with a new set of
570 * Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
571 * the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
574 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
576 public final org.ldk.structs.ChannelTypeFeatures channel_type;
577 private OpenChannelRequest(long ptr, bindings.LDKEvent.OpenChannelRequest obj) {
579 this.temporary_channel_id = obj.temporary_channel_id;
580 this.counterparty_node_id = obj.counterparty_node_id;
581 this.funding_satoshis = obj.funding_satoshis;
582 this.push_msat = obj.push_msat;
583 long channel_type = obj.channel_type;
584 ChannelTypeFeatures channel_type_hu_conv = null; if (channel_type < 0 || channel_type > 4096) { channel_type_hu_conv = new ChannelTypeFeatures(null, channel_type); }
585 channel_type_hu_conv.ptrs_to.add(this);
586 this.channel_type = channel_type_hu_conv;
590 long ret = bindings.Event_clone_ptr(this.ptr);
591 Reference.reachabilityFence(this);
596 * Creates a copy of the Event
598 public Event clone() {
599 long ret = bindings.Event_clone(this.ptr);
600 Reference.reachabilityFence(this);
601 if (ret >= 0 && ret <= 4096) { return null; }
602 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
603 ret_hu_conv.ptrs_to.add(this);
608 * Utility method to constructs a new FundingGenerationReady-variant Event
610 public static Event funding_generation_ready(byte[] temporary_channel_id, long channel_value_satoshis, byte[] output_script, long user_channel_id) {
611 long ret = bindings.Event_funding_generation_ready(InternalUtils.check_arr_len(temporary_channel_id, 32), channel_value_satoshis, output_script, user_channel_id);
612 Reference.reachabilityFence(temporary_channel_id);
613 Reference.reachabilityFence(channel_value_satoshis);
614 Reference.reachabilityFence(output_script);
615 Reference.reachabilityFence(user_channel_id);
616 if (ret >= 0 && ret <= 4096) { return null; }
617 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
618 ret_hu_conv.ptrs_to.add(ret_hu_conv);
623 * Utility method to constructs a new PaymentReceived-variant Event
625 public static Event payment_received(byte[] payment_hash, long amt, PaymentPurpose purpose) {
626 long ret = bindings.Event_payment_received(InternalUtils.check_arr_len(payment_hash, 32), amt, purpose.ptr);
627 Reference.reachabilityFence(payment_hash);
628 Reference.reachabilityFence(amt);
629 Reference.reachabilityFence(purpose);
630 if (ret >= 0 && ret <= 4096) { return null; }
631 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
632 ret_hu_conv.ptrs_to.add(ret_hu_conv);
637 * Utility method to constructs a new PaymentSent-variant Event
639 public static Event payment_sent(byte[] payment_id, byte[] payment_preimage, byte[] payment_hash, Option_u64Z fee_paid_msat) {
640 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);
641 Reference.reachabilityFence(payment_id);
642 Reference.reachabilityFence(payment_preimage);
643 Reference.reachabilityFence(payment_hash);
644 Reference.reachabilityFence(fee_paid_msat);
645 if (ret >= 0 && ret <= 4096) { return null; }
646 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
647 ret_hu_conv.ptrs_to.add(ret_hu_conv);
652 * Utility method to constructs a new PaymentPathFailed-variant Event
654 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) {
655 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);
656 Reference.reachabilityFence(payment_id);
657 Reference.reachabilityFence(payment_hash);
658 Reference.reachabilityFence(rejected_by_dest);
659 Reference.reachabilityFence(network_update);
660 Reference.reachabilityFence(all_paths_failed);
661 Reference.reachabilityFence(path);
662 Reference.reachabilityFence(short_channel_id);
663 Reference.reachabilityFence(retry);
664 if (ret >= 0 && ret <= 4096) { return null; }
665 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
666 ret_hu_conv.ptrs_to.add(ret_hu_conv);
671 * Utility method to constructs a new PaymentFailed-variant Event
673 public static Event payment_failed(byte[] payment_id, byte[] payment_hash) {
674 long ret = bindings.Event_payment_failed(InternalUtils.check_arr_len(payment_id, 32), InternalUtils.check_arr_len(payment_hash, 32));
675 Reference.reachabilityFence(payment_id);
676 Reference.reachabilityFence(payment_hash);
677 if (ret >= 0 && ret <= 4096) { return null; }
678 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
679 ret_hu_conv.ptrs_to.add(ret_hu_conv);
684 * Utility method to constructs a new PendingHTLCsForwardable-variant Event
686 public static Event pending_htlcs_forwardable(long time_forwardable) {
687 long ret = bindings.Event_pending_htlcs_forwardable(time_forwardable);
688 Reference.reachabilityFence(time_forwardable);
689 if (ret >= 0 && ret <= 4096) { return null; }
690 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
691 ret_hu_conv.ptrs_to.add(ret_hu_conv);
696 * Utility method to constructs a new SpendableOutputs-variant Event
698 public static Event spendable_outputs(SpendableOutputDescriptor[] outputs) {
699 long ret = bindings.Event_spendable_outputs(outputs != null ? Arrays.stream(outputs).mapToLong(outputs_conv_27 -> outputs_conv_27.ptr).toArray() : null);
700 Reference.reachabilityFence(outputs);
701 if (ret >= 0 && ret <= 4096) { return null; }
702 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
703 ret_hu_conv.ptrs_to.add(ret_hu_conv);
708 * Utility method to constructs a new PaymentForwarded-variant Event
710 public static Event payment_forwarded(Option_u64Z fee_earned_msat, boolean claim_from_onchain_tx) {
711 long ret = bindings.Event_payment_forwarded(fee_earned_msat.ptr, claim_from_onchain_tx);
712 Reference.reachabilityFence(fee_earned_msat);
713 Reference.reachabilityFence(claim_from_onchain_tx);
714 if (ret >= 0 && ret <= 4096) { return null; }
715 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
716 ret_hu_conv.ptrs_to.add(ret_hu_conv);
721 * Utility method to constructs a new ChannelClosed-variant Event
723 public static Event channel_closed(byte[] channel_id, long user_channel_id, ClosureReason reason) {
724 long ret = bindings.Event_channel_closed(InternalUtils.check_arr_len(channel_id, 32), user_channel_id, reason.ptr);
725 Reference.reachabilityFence(channel_id);
726 Reference.reachabilityFence(user_channel_id);
727 Reference.reachabilityFence(reason);
728 if (ret >= 0 && ret <= 4096) { return null; }
729 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
730 ret_hu_conv.ptrs_to.add(ret_hu_conv);
735 * Utility method to constructs a new DiscardFunding-variant Event
737 public static Event discard_funding(byte[] channel_id, byte[] transaction) {
738 long ret = bindings.Event_discard_funding(InternalUtils.check_arr_len(channel_id, 32), transaction);
739 Reference.reachabilityFence(channel_id);
740 Reference.reachabilityFence(transaction);
741 if (ret >= 0 && ret <= 4096) { return null; }
742 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
743 ret_hu_conv.ptrs_to.add(ret_hu_conv);
748 * Utility method to constructs a new PaymentPathSuccessful-variant Event
750 public static Event payment_path_successful(byte[] payment_id, byte[] payment_hash, RouteHop[] path) {
751 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);
752 Reference.reachabilityFence(payment_id);
753 Reference.reachabilityFence(payment_hash);
754 Reference.reachabilityFence(path);
755 if (ret >= 0 && ret <= 4096) { return null; }
756 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
757 ret_hu_conv.ptrs_to.add(ret_hu_conv);
762 * Utility method to constructs a new OpenChannelRequest-variant Event
764 public static Event open_channel_request(byte[] temporary_channel_id, byte[] counterparty_node_id, long funding_satoshis, long push_msat, ChannelTypeFeatures channel_type) {
765 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);
766 Reference.reachabilityFence(temporary_channel_id);
767 Reference.reachabilityFence(counterparty_node_id);
768 Reference.reachabilityFence(funding_satoshis);
769 Reference.reachabilityFence(push_msat);
770 Reference.reachabilityFence(channel_type);
771 if (ret >= 0 && ret <= 4096) { return null; }
772 org.ldk.structs.Event ret_hu_conv = org.ldk.structs.Event.constr_from_ptr(ret);
773 ret_hu_conv.ptrs_to.add(ret_hu_conv);
778 * Serialize the Event object into a byte array which can be read by Event_read
780 public byte[] write() {
781 byte[] ret = bindings.Event_write(this.ptr);
782 Reference.reachabilityFence(this);