[Java] Update auto-generated Java bindings
[ldk-java] / src / main / java / org / ldk / structs / RecentPaymentDetails.java
diff --git a/src/main/java/org/ldk/structs/RecentPaymentDetails.java b/src/main/java/org/ldk/structs/RecentPaymentDetails.java
new file mode 100644 (file)
index 0000000..1ccd599
--- /dev/null
@@ -0,0 +1,145 @@
+package org.ldk.structs;
+
+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;
+
+
+/**
+ * Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
+ * These include payments that have yet to find a successful path, or have unresolved HTLCs.
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
+public class RecentPaymentDetails extends CommonBase {
+       private RecentPaymentDetails(Object _dummy, long ptr) { super(ptr); }
+       @Override @SuppressWarnings("deprecation")
+       protected void finalize() throws Throwable {
+               super.finalize();
+               if (ptr != 0) { bindings.RecentPaymentDetails_free(ptr); }
+       }
+       static RecentPaymentDetails constr_from_ptr(long ptr) {
+               bindings.LDKRecentPaymentDetails raw_val = bindings.LDKRecentPaymentDetails_ref_from_ptr(ptr);
+               if (raw_val.getClass() == bindings.LDKRecentPaymentDetails.Pending.class) {
+                       return new Pending(ptr, (bindings.LDKRecentPaymentDetails.Pending)raw_val);
+               }
+               if (raw_val.getClass() == bindings.LDKRecentPaymentDetails.Fulfilled.class) {
+                       return new Fulfilled(ptr, (bindings.LDKRecentPaymentDetails.Fulfilled)raw_val);
+               }
+               if (raw_val.getClass() == bindings.LDKRecentPaymentDetails.Abandoned.class) {
+                       return new Abandoned(ptr, (bindings.LDKRecentPaymentDetails.Abandoned)raw_val);
+               }
+               assert false; return null; // Unreachable without extending the (internal) bindings interface
+       }
+
+       /**
+        * When a payment is still being sent and awaiting successful delivery.
+        */
+       public final static class Pending extends RecentPaymentDetails {
+               /**
+                * Hash of the payment that is currently being sent but has yet to be fulfilled or
+                * abandoned.
+               */
+               public final byte[] payment_hash;
+               /**
+                * Total amount (in msat, excluding fees) across all paths for this payment,
+                * not just the amount currently inflight.
+               */
+               public final long total_msat;
+               private Pending(long ptr, bindings.LDKRecentPaymentDetails.Pending obj) {
+                       super(null, ptr);
+                       this.payment_hash = obj.payment_hash;
+                       this.total_msat = obj.total_msat;
+               }
+       }
+       /**
+        * When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
+        * been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
+        * payment is removed from tracking.
+        */
+       public final static class Fulfilled extends RecentPaymentDetails {
+               /**
+                * Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
+                * made before LDK version 0.0.104.
+                * 
+                * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
+               */
+               @Nullable public final byte[] payment_hash;
+               private Fulfilled(long ptr, bindings.LDKRecentPaymentDetails.Fulfilled obj) {
+                       super(null, ptr);
+                       this.payment_hash = obj.payment_hash;
+               }
+       }
+       /**
+        * After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
+        * abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
+        * pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
+        */
+       public final static class Abandoned extends RecentPaymentDetails {
+               /**
+                * Hash of the payment that we have given up trying to send.
+               */
+               public final byte[] payment_hash;
+               private Abandoned(long ptr, bindings.LDKRecentPaymentDetails.Abandoned obj) {
+                       super(null, ptr);
+                       this.payment_hash = obj.payment_hash;
+               }
+       }
+       long clone_ptr() {
+               long ret = bindings.RecentPaymentDetails_clone_ptr(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * Creates a copy of the RecentPaymentDetails
+        */
+       public RecentPaymentDetails clone() {
+               long ret = bindings.RecentPaymentDetails_clone(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.RecentPaymentDetails ret_hu_conv = org.ldk.structs.RecentPaymentDetails.constr_from_ptr(ret);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new Pending-variant RecentPaymentDetails
+        */
+       public static RecentPaymentDetails pending(byte[] payment_hash, long total_msat) {
+               long ret = bindings.RecentPaymentDetails_pending(InternalUtils.check_arr_len(payment_hash, 32), total_msat);
+               Reference.reachabilityFence(payment_hash);
+               Reference.reachabilityFence(total_msat);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.RecentPaymentDetails ret_hu_conv = org.ldk.structs.RecentPaymentDetails.constr_from_ptr(ret);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new Fulfilled-variant RecentPaymentDetails
+        */
+       public static RecentPaymentDetails fulfilled(byte[] payment_hash) {
+               long ret = bindings.RecentPaymentDetails_fulfilled(InternalUtils.check_arr_len(payment_hash, 32));
+               Reference.reachabilityFence(payment_hash);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.RecentPaymentDetails ret_hu_conv = org.ldk.structs.RecentPaymentDetails.constr_from_ptr(ret);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new Abandoned-variant RecentPaymentDetails
+        */
+       public static RecentPaymentDetails abandoned(byte[] payment_hash) {
+               long ret = bindings.RecentPaymentDetails_abandoned(InternalUtils.check_arr_len(payment_hash, 32));
+               Reference.reachabilityFence(payment_hash);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.RecentPaymentDetails ret_hu_conv = org.ldk.structs.RecentPaymentDetails.constr_from_ptr(ret);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+               return ret_hu_conv;
+       }
+
+}