Update auto-generated files

[ldk-java] / src / main / java / org / ldk / structs / PaymentPurpose.java

diff --git a/src/main/java/org/ldk/structs/PaymentPurpose.java b/src/main/java/org/ldk/structs/PaymentPurpose.java
new file mode 100644 (file)
index 0000000..e2654da
--- /dev/null
+++ b/src/main/java/org/ldk/structs/PaymentPurpose.java
@@ -0,0 +1,116 @@
+package org.ldk.structs;
+
+import org.ldk.impl.bindings;
+import org.ldk.enums.*;
+import org.ldk.util.*;
+import java.util.Arrays;
+import javax.annotation.Nullable;
+
+
+/**
+ * Some information provided on receipt of payment depends on whether the payment received is a
+ * spontaneous payment or a \"conventional\" lightning payment that's paying an invoice.
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
+public class PaymentPurpose extends CommonBase {
+       private PaymentPurpose(Object _dummy, long ptr) { super(ptr); }
+       @Override @SuppressWarnings("deprecation")
+       protected void finalize() throws Throwable {
+               super.finalize();
+               if (ptr != 0) { bindings.PaymentPurpose_free(ptr); }
+       }
+       static PaymentPurpose constr_from_ptr(long ptr) {
+               bindings.LDKPaymentPurpose raw_val = bindings.LDKPaymentPurpose_ref_from_ptr(ptr);
+               if (raw_val.getClass() == bindings.LDKPaymentPurpose.InvoicePayment.class) {
+                       return new InvoicePayment(ptr, (bindings.LDKPaymentPurpose.InvoicePayment)raw_val);
+               }
+               if (raw_val.getClass() == bindings.LDKPaymentPurpose.SpontaneousPayment.class) {
+                       return new SpontaneousPayment(ptr, (bindings.LDKPaymentPurpose.SpontaneousPayment)raw_val);
+               }
+               assert false; return null; // Unreachable without extending the (internal) bindings interface
+       }
+
+       public final static class InvoicePayment extends PaymentPurpose {
+               /**
+                * 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;
+               /**
+                * 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
+               */
+               public final long user_payment_id;
+               private InvoicePayment(long ptr, bindings.LDKPaymentPurpose.InvoicePayment obj) {
+                       super(null, ptr);
+                       this.payment_preimage = obj.payment_preimage;
+                       this.payment_secret = obj.payment_secret;
+                       this.user_payment_id = obj.user_payment_id;
+               }
+       }
+       public final static class SpontaneousPayment extends PaymentPurpose {
+               public final byte[] spontaneous_payment;
+               private SpontaneousPayment(long ptr, bindings.LDKPaymentPurpose.SpontaneousPayment obj) {
+                       super(null, ptr);
+                       this.spontaneous_payment = obj.spontaneous_payment;
+               }
+       }
+       /**
+        * Creates a copy of the PaymentPurpose
+        */
+       public PaymentPurpose clone() {
+               long ret = bindings.PaymentPurpose_clone(this.ptr);
+               if (ret < 1024) { return null; }
+               PaymentPurpose ret_hu_conv = PaymentPurpose.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(this);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new InvoicePayment-variant PaymentPurpose
+        */
+       public static PaymentPurpose invoice_payment(byte[] payment_preimage, byte[] payment_secret, long user_payment_id) {
+               long ret = bindings.PaymentPurpose_invoice_payment(payment_preimage, payment_secret, user_payment_id);
+               if (ret < 1024) { return null; }
+               PaymentPurpose ret_hu_conv = PaymentPurpose.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new SpontaneousPayment-variant PaymentPurpose
+        */
+       public static PaymentPurpose spontaneous_payment(byte[] a) {
+               long ret = bindings.PaymentPurpose_spontaneous_payment(a);
+               if (ret < 1024) { return null; }
+               PaymentPurpose ret_hu_conv = PaymentPurpose.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
+}