X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FEvent.java;h=d3f85fed9e8df907eea826de13b43fd18d0268ef;hb=c6bac88847b7c09560af81f00ba8dd3c2ebe3a19;hp=4bd1fad4408225d0cad607fbc413038b376d2680;hpb=db1a11032b4164540a2d3403696be12bbca70e94;p=ldk-java diff --git a/src/main/java/org/ldk/structs/Event.java b/src/main/java/org/ldk/structs/Event.java index 4bd1fad4..d3f85fed 100644 --- a/src/main/java/org/ldk/structs/Event.java +++ b/src/main/java/org/ldk/structs/Event.java @@ -33,8 +33,8 @@ public class Event extends CommonBase { if (raw_val.getClass() == bindings.LDKEvent.PaymentSent.class) { return new PaymentSent(ptr, (bindings.LDKEvent.PaymentSent)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.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); @@ -42,6 +42,15 @@ public class Event extends CommonBase { if (raw_val.getClass() == bindings.LDKEvent.SpendableOutputs.class) { return new SpendableOutputs(ptr, (bindings.LDKEvent.SpendableOutputs)raw_val); } + if (raw_val.getClass() == bindings.LDKEvent.PaymentForwarded.class) { + return new PaymentForwarded(ptr, (bindings.LDKEvent.PaymentForwarded)raw_val); + } + if (raw_val.getClass() == bindings.LDKEvent.ChannelClosed.class) { + return new ChannelClosed(ptr, (bindings.LDKEvent.ChannelClosed)raw_val); + } + if (raw_val.getClass() == bindings.LDKEvent.DiscardFunding.class) { + return new DiscardFunding(ptr, (bindings.LDKEvent.DiscardFunding)raw_val); + } assert false; return null; // Unreachable without extending the (internal) bindings interface } @@ -60,7 +69,10 @@ public class Event extends CommonBase { */ public final byte[] output_script; /** - * The value passed in to ChannelManager::create_channel + * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for + * an inbound channel. + * + * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel */ public final long user_channel_id; private FundingGenerationReady(long ptr, bindings.LDKEvent.FundingGenerationReady obj) { @@ -77,68 +89,81 @@ public class Event extends CommonBase { */ public final byte[] payment_hash; /** - * The preimage to the payment_hash, if the payment hash (and secret) were fetched via - * [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to - * [`ChannelManager::claim_funds`]. - * - * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment - * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds - * - * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None - */ - @Nullable public final byte[] payment_preimage; - /** - * The \"payment secret\". This authenticates the sender to the recipient, preventing a - * number of deanonymization attacks during the routing process. - * It is provided here for your reference, however its accuracy is enforced directly by - * [`ChannelManager`] using the values you previously provided to - * [`ChannelManager::create_inbound_payment`] or - * [`ChannelManager::create_inbound_payment_for_hash`]. - * - * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager - * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment - * [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash - */ - public final byte[] payment_secret; - /** - * The value, in thousandths of a satoshi, that this payment is for. Note that you must - * compare this to the expected value before accepting the payment (as otherwise you are - * providing proof-of-payment for less than the value you expected!). + * The value, in thousandths of a satoshi, that this payment is for. */ public final long amt; /** - * This is the `user_payment_id` which was provided to - * [`ChannelManager::create_inbound_payment_for_hash`] or - * [`ChannelManager::create_inbound_payment`]. It has no meaning inside of LDK and is - * simply copied here. It may be used to correlate PaymentReceived events with invoice - * metadata stored elsewhere. - * - * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment - * [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash + * 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 long user_payment_id; + public final PaymentPurpose purpose; private PaymentReceived(long ptr, bindings.LDKEvent.PaymentReceived obj) { super(null, ptr); this.payment_hash = obj.payment_hash; - this.payment_preimage = obj.payment_preimage; - this.payment_secret = obj.payment_secret; this.amt = obj.amt; - this.user_payment_id = obj.user_payment_id; + long purpose = obj.purpose; + PaymentPurpose purpose_hu_conv = PaymentPurpose.constr_from_ptr(purpose); + purpose_hu_conv.ptrs_to.add(this); + this.purpose = purpose_hu_conv; } } public final static class PaymentSent 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 + * + * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None + */ + @Nullable public final byte[] payment_id; /** * The preimage to the hash given to ChannelManager::send_payment. * Note that this serves as a payment receipt, if you wish to have such a thing, you must * store it somehow! */ public final byte[] payment_preimage; + /** + * The hash which was given to [`ChannelManager::send_payment`]. + * + * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment + */ + public final byte[] payment_hash; + /** + * The total fee which was spent at intermediate hops in this payment, across all paths. + * + * Note that, like [`Route::get_total_fees`] this does *not* include any potential + * overpayment to the recipient node. + * + * If the recipient or an intermediate node misbehaves and gives us free money, this may + * overstate the amount paid, though this is unlikely. + * + * [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees + */ + public final 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); + fee_paid_msat_hu_conv.ptrs_to.add(this); + this.fee_paid_msat = fee_paid_msat_hu_conv; } } - public final static class PaymentFailed extends Event { + public final static class PaymentPathFailed 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 + * + * 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. */ @@ -149,10 +174,72 @@ public class Event extends CommonBase { * retry the payment via a different route. */ public final boolean rejected_by_dest; - private PaymentFailed(long ptr, bindings.LDKEvent.PaymentFailed obj) { + /** + * Any failure information conveyed via the Onion return packet by a node along the failed + * payment route. + * + * Should be applied to the [`NetworkGraph`] so that routing decisions can take into + * account the update. [`NetGraphMsgHandler`] is capable of doing this. + * + * [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph + * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler + */ + public final Option_NetworkUpdateZ network_update; + /** + * For both single-path and multi-path payments, this is set if all paths of the payment have + * failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the + * larger MPP payment were still in flight when this event was generated. + */ + public final boolean all_paths_failed; + /** + * The payment path that failed. + */ + public final RouteHop[] path; + /** + * The channel responsible for the failed payment path. + * + * 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; + /** + * Parameters needed to compute a new [`Route`] when retrying the failed payment path. + * + * See [`find_route`] for details. + * + * [`Route`]: crate::routing::router::Route + * [`find_route`]: crate::routing::router::find_route + * + * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None + */ + @Nullable public final 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); + network_update_hu_conv.ptrs_to.add(this); + this.network_update = network_update_hu_conv; + this.all_paths_failed = obj.all_paths_failed; + long[] path = obj.path; + RouteHop[] path_conv_10_arr = new RouteHop[path.length]; + for (int k = 0; k < path.length; 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 short_channel_id = obj.short_channel_id; + Option_u64Z short_channel_id_hu_conv = 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); } + retry_hu_conv.ptrs_to.add(this); + this.retry = retry_hu_conv; } } public final static class PendingHTLCsForwardable extends Event { @@ -186,12 +273,86 @@ public class Event extends CommonBase { this.outputs = outputs_conv_27_arr; } } + public final static class PaymentForwarded extends Event { + /** + * The fee, in milli-satoshis, which was earned as a result of the payment. + * + * Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC + * was pending, the amount the next hop claimed will have been rounded down to the nearest + * whole satoshi. Thus, the fee calculated here may be higher than expected as we still + * claimed the full value in millisatoshis from the source. In this case, + * `claim_from_onchain_tx` will be set. + * + * If the channel which sent us the payment has been force-closed, we will claim the funds + * via an on-chain transaction. In that case we do not yet know the on-chain transaction + * fees which we will spend and will instead set this to `None`. It is possible duplicate + * `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is + * `None`. + */ + public final Option_u64Z fee_earned_msat; + /** + * If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain + * transaction. + */ + public final boolean claim_from_onchain_tx; + private PaymentForwarded(long ptr, bindings.LDKEvent.PaymentForwarded obj) { + super(null, ptr); + long fee_earned_msat = obj.fee_earned_msat; + Option_u64Z fee_earned_msat_hu_conv = 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; + } + } + public final static class ChannelClosed extends Event { + /** + * The channel_id of the channel which has been closed. Note that on-chain transactions + * resolving the channel are likely still awaiting confirmation. + */ + public final byte[] channel_id; + /** + * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 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 + */ + public final long user_channel_id; + /** + * The reason the channel was closed. + */ + public final 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); + reason_hu_conv.ptrs_to.add(this); + this.reason = reason_hu_conv; + } + } + public final static class DiscardFunding extends Event { + /** + * The channel_id of the channel which has been closed. + */ + public final byte[] channel_id; + /** + * The full transaction received from the user + */ + public final byte[] transaction; + private DiscardFunding(long ptr, bindings.LDKEvent.DiscardFunding obj) { + super(null, ptr); + this.channel_id = obj.channel_id; + this.transaction = obj.transaction; + } + } /** * Creates a copy of the Event */ public Event clone() { long ret = bindings.Event_clone(this.ptr); - if (ret < 1024) { return null; } + if (ret >= 0 && ret <= 4096) { return null; } Event ret_hu_conv = Event.constr_from_ptr(ret); ret_hu_conv.ptrs_to.add(this); return ret_hu_conv; @@ -202,7 +363,7 @@ public class Event extends CommonBase { */ 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); - if (ret < 1024) { return null; } + 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; @@ -211,9 +372,9 @@ public class Event extends CommonBase { /** * Utility method to constructs a new PaymentReceived-variant Event */ - public static Event payment_received(byte[] payment_hash, byte[] payment_preimage, byte[] payment_secret, long amt, long user_payment_id) { - long ret = bindings.Event_payment_received(payment_hash, payment_preimage, payment_secret, amt, user_payment_id); - if (ret < 1024) { return null; } + public static Event payment_received(byte[] payment_hash, long amt, PaymentPurpose purpose) { + long ret = bindings.Event_payment_received(payment_hash, amt, purpose.ptr); + 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; @@ -222,20 +383,20 @@ public class Event extends CommonBase { /** * Utility method to constructs a new PaymentSent-variant Event */ - public static Event payment_sent(byte[] payment_preimage) { - long ret = bindings.Event_payment_sent(payment_preimage); - if (ret < 1024) { return null; } + 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); + 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 + * Utility method to constructs a new PaymentPathFailed-variant Event */ - public static Event payment_failed(byte[] payment_hash, boolean rejected_by_dest) { - long ret = bindings.Event_payment_failed(payment_hash, rejected_by_dest); - if (ret < 1024) { return null; } + 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); + 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; @@ -246,7 +407,7 @@ public class Event extends CommonBase { */ public static Event pending_htlcs_forwardable(long time_forwardable) { long ret = bindings.Event_pending_htlcs_forwardable(time_forwardable); - if (ret < 1024) { return null; } + 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; @@ -257,10 +418,42 @@ 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); - if (ret < 1024) { return null; } + 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 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); + 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 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); + 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 DiscardFunding-variant Event + */ + public static Event discard_funding(byte[] channel_id, byte[] transaction) { + long ret = bindings.Event_discard_funding(channel_id, 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); - /* TODO 2 SpendableOutputDescriptor */; return ret_hu_conv; }