X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FEvent.java;h=df53a51150bddd493bc816974f32af70924a7f29;hb=d87886bb194886ef86d3597a5cdc142b6ccc89e9;hp=d3f85fed9e8df907eea826de13b43fd18d0268ef;hpb=c6bac88847b7c09560af81f00ba8dd3c2ebe3a19;p=ldk-java diff --git a/src/main/java/org/ldk/structs/Event.java b/src/main/java/org/ldk/structs/Event.java index d3f85fed..df53a511 100644 --- a/src/main/java/org/ldk/structs/Event.java +++ b/src/main/java/org/ldk/structs/Event.java @@ -4,6 +4,7 @@ import org.ldk.impl.bindings; import org.ldk.enums.*; import org.ldk.util.*; import java.util.Arrays; +import java.lang.ref.Reference; import javax.annotation.Nullable; @@ -36,6 +37,9 @@ public class Event extends CommonBase { 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.PendingHTLCsForwardable.class) { return new PendingHTLCsForwardable(ptr, (bindings.LDKEvent.PendingHTLCsForwardable)raw_val); } @@ -51,9 +55,22 @@ 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); + } assert false; return null; // Unreachable without extending the (internal) bindings interface } + /** + * Used to indicate that the client should generate a funding transaction with the given + * parameters and then call [`ChannelManager::funding_transaction_generated`]. + * Generated in [`ChannelManager`] message handling. + * Note that *all inputs* in the funding transaction must spend SegWit outputs or your + * counterparty can steal your funds! + * + * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager + * [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated + */ public final static class FundingGenerationReady extends Event { /** * The random channel_id we picked which you'll need to pass into @@ -83,9 +100,27 @@ public class Event extends CommonBase { 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.... + * 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. + * + * # Note + * LDK will not stop an inbound payment from being paid multiple times, so multiple + * `PaymentReceived` events may be generated for the same payment. + * + * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds + * [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards + */ public final static class PaymentReceived extends Event { /** - * The hash for which the preimage should be handed to the ChannelManager. + * 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; /** @@ -107,6 +142,13 @@ public class Event extends CommonBase { this.purpose = purpose_hu_conv; } } + /** + * Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target + * and we got back the payment preimage for it). + * + * Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed` + * event. In this situation, you SHOULD treat this payment as having succeeded. + */ public final static class PaymentSent extends Event { /** * The id returned by [`ChannelManager::send_payment`] and used with @@ -125,7 +167,7 @@ public class Event extends CommonBase { */ public final byte[] payment_preimage; /** - * The hash which was given to [`ChannelManager::send_payment`]. + * The hash that was given to [`ChannelManager::send_payment`]. * * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment */ @@ -153,19 +195,31 @@ public class Event extends CommonBase { this.fee_paid_msat = fee_paid_msat_hu_conv; } } + /** + * Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped + * something. You may wish to retry with a different route. + * + * 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 + */ public final static class PaymentPathFailed extends Event { /** * The id returned by [`ChannelManager::send_payment`] and used with - * [`ChannelManager::retry_payment`]. + * [`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 * * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None */ @Nullable public final byte[] payment_id; /** - * The hash which was given to ChannelManager::send_payment. + * The hash that was given to [`ChannelManager::send_payment`]. + * + * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment */ public final byte[] payment_hash; /** @@ -189,6 +243,20 @@ public class Event extends CommonBase { * 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) + * + * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment */ public final boolean all_paths_failed; /** @@ -224,8 +292,9 @@ public class Event extends CommonBase { this.network_update = network_update_hu_conv; this.all_paths_failed = obj.all_paths_failed; long[] path = obj.path; - RouteHop[] path_conv_10_arr = new RouteHop[path.length]; - for (int k = 0; k < path.length; k++) { + 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); @@ -242,6 +311,44 @@ public class Event extends CommonBase { 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. + * + * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards + */ public final static class PendingHTLCsForwardable extends Event { /** * The minimum amount of time that should be waited prior to calling @@ -255,6 +362,13 @@ public class Event extends CommonBase { this.time_forwardable = obj.time_forwardable; } } + /** + * Used to indicate that an output which you should know how to spend was confirmed on chain + * and is now spendable. + * Such an output will *not* ever be spent by rust-lightning, and are not at risk of your + * counterparty spending them due to some kind of timeout. Thus, you need to store them + * somewhere and spend them when you create on-chain transactions. + */ public final static class SpendableOutputs extends Event { /** * The outputs which you should store as spendable by you. @@ -263,8 +377,9 @@ public class Event extends CommonBase { private SpendableOutputs(long ptr, bindings.LDKEvent.SpendableOutputs obj) { super(null, ptr); long[] outputs = obj.outputs; - SpendableOutputDescriptor[] outputs_conv_27_arr = new SpendableOutputDescriptor[outputs.length]; - for (int b = 0; b < outputs.length; b++) { + int outputs_conv_27_len = outputs.length; + 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); outputs_conv_27_hu_conv.ptrs_to.add(this); @@ -273,6 +388,10 @@ public class Event extends CommonBase { this.outputs = outputs_conv_27_arr; } } + /** + * This event is generated when a payment has been successfully forwarded through us and a + * forwarding fee earned. + */ public final static class PaymentForwarded extends Event { /** * The fee, in milli-satoshis, which was earned as a result of the payment. @@ -304,6 +423,9 @@ public class Event extends CommonBase { 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. + */ public final static class ChannelClosed extends Event { /** * The channel_id of the channel which has been closed. Note that on-chain transactions @@ -332,6 +454,10 @@ public class Event extends CommonBase { this.reason = reason_hu_conv; } } + /** + * Used to indicate to the user that they can abandon the funding transaction and recycle the + * inputs for another purpose. + */ public final static class DiscardFunding extends Event { /** * The channel_id of the channel which has been closed. @@ -347,11 +473,63 @@ public class Event extends CommonBase { this.transaction = obj.transaction; } } + /** + * 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]; + 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; + } + } + long clone_ptr() { + long ret = bindings.Event_clone_ptr(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + /** * Creates a copy of the Event */ public Event clone() { 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); ret_hu_conv.ptrs_to.add(this); @@ -362,7 +540,11 @@ 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(temporary_channel_id, channel_value_satoshis, output_script, 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); + Reference.reachabilityFence(temporary_channel_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); ret_hu_conv.ptrs_to.add(ret_hu_conv); @@ -373,7 +555,10 @@ 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(payment_hash, amt, purpose.ptr); + long ret = bindings.Event_payment_received(InternalUtils.check_arr_len(payment_hash, 32), amt, purpose.ptr); + Reference.reachabilityFence(payment_hash); + Reference.reachabilityFence(amt); + Reference.reachabilityFence(purpose); if (ret >= 0 && ret <= 4096) { return null; } Event ret_hu_conv = Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); @@ -384,7 +569,11 @@ public class Event extends CommonBase { * 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(payment_id, payment_preimage, payment_hash, fee_paid_msat.ptr); + 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); + Reference.reachabilityFence(payment_id); + Reference.reachabilityFence(payment_preimage); + 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); ret_hu_conv.ptrs_to.add(ret_hu_conv); @@ -395,7 +584,28 @@ public class Event extends CommonBase { * 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(payment_id, payment_hash, 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); + 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); + ret_hu_conv.ptrs_to.add(ret_hu_conv); + 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)); + Reference.reachabilityFence(payment_id); + Reference.reachabilityFence(payment_hash); if (ret >= 0 && ret <= 4096) { return null; } Event ret_hu_conv = Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); @@ -407,6 +617,7 @@ public class Event extends CommonBase { */ public static Event pending_htlcs_forwardable(long time_forwardable) { 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); ret_hu_conv.ptrs_to.add(ret_hu_conv); @@ -418,6 +629,7 @@ public class Event extends CommonBase { */ 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); + Reference.reachabilityFence(outputs); if (ret >= 0 && ret <= 4096) { return null; } Event ret_hu_conv = Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); @@ -429,6 +641,8 @@ public class Event extends CommonBase { */ 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); + 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); ret_hu_conv.ptrs_to.add(ret_hu_conv); @@ -439,7 +653,10 @@ public class Event extends CommonBase { * 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(channel_id, user_channel_id, reason.ptr); + long ret = bindings.Event_channel_closed(InternalUtils.check_arr_len(channel_id, 32), user_channel_id, reason.ptr); + Reference.reachabilityFence(channel_id); + Reference.reachabilityFence(user_channel_id); + Reference.reachabilityFence(reason); if (ret >= 0 && ret <= 4096) { return null; } Event ret_hu_conv = Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); @@ -450,7 +667,23 @@ public class Event extends CommonBase { * Utility method to constructs a new DiscardFunding-variant Event */ public static Event discard_funding(byte[] channel_id, byte[] transaction) { - long ret = bindings.Event_discard_funding(channel_id, transaction); + long ret = bindings.Event_discard_funding(InternalUtils.check_arr_len(channel_id, 32), transaction); + Reference.reachabilityFence(channel_id); + Reference.reachabilityFence(transaction); + if (ret >= 0 && ret <= 4096) { return null; } + Event ret_hu_conv = 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(path); if (ret >= 0 && ret <= 4096) { return null; } Event ret_hu_conv = Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(ret_hu_conv); @@ -462,6 +695,7 @@ public class Event extends CommonBase { */ public byte[] write() { byte[] ret = bindings.Event_write(this.ptr); + Reference.reachabilityFence(this); return ret; }