Update auto-generated bindings to 0.0.103
[ldk-java] / src / main / java / org / ldk / structs / Event.java
index 1bbfed0151b1f16536ce13973e24e42e858f2316..d3f85fed9e8df907eea826de13b43fd18d0268ef 100644 (file)
@@ -48,6 +48,9 @@ public class Event extends CommonBase {
                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
        }
 
@@ -66,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) {
@@ -83,9 +89,7 @@ public class Event extends CommonBase {
                */
                public final byte[] payment_hash;
                /**
-                * 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;
                /**
@@ -104,18 +108,62 @@ public class Event extends CommonBase {
                }
        }
        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 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.
                */
@@ -147,8 +195,27 @@ public class Event extends CommonBase {
                 * 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;
@@ -160,11 +227,19 @@ public class Event extends CommonBase {
                        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 = new RouteHop(null, path_conv_10);
+                               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 {
@@ -235,6 +310,14 @@ public class Event extends CommonBase {
                 * 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.
                */
@@ -242,18 +325,34 @@ public class Event extends CommonBase {
                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;
@@ -264,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;
@@ -275,7 +374,7 @@ public class Event extends CommonBase {
         */
        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 < 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;
@@ -284,9 +383,9 @@ 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;
@@ -295,12 +394,11 @@ public class Event extends CommonBase {
        /**
         * Utility method to constructs a new PaymentPathFailed-variant Event
         */
-       public static Event payment_path_failed(byte[] payment_hash, boolean rejected_by_dest, Option_NetworkUpdateZ network_update, boolean all_paths_failed, RouteHop[] path) {
-               long ret = bindings.Event_payment_path_failed(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);
-               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);
-               for (RouteHop path_conv_10: path) { ret_hu_conv.ptrs_to.add(path_conv_10); };
                return ret_hu_conv;
        }
 
@@ -309,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;
@@ -320,7 +418,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);
-               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;
@@ -331,7 +429,7 @@ 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);
-               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;
@@ -340,9 +438,20 @@ public class Event extends CommonBase {
        /**
         * Utility method to constructs a new ChannelClosed-variant Event
         */
-       public static Event channel_closed(byte[] channel_id, ClosureReason reason) {
-               long ret = bindings.Event_channel_closed(channel_id, reason.ptr);
-               if (ret < 1024) { return null; }
+       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);
                return ret_hu_conv;