Add handling for signed int64 type
[ldk-java] / src / main / java / org / ldk / structs / Invoice.java
index e162d340d5d467490b3e9a402c805286c0a56ac2..cbcad6bd78db4d6cc3e28ba52a0f45418214a5a1 100644 (file)
@@ -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;
 
 
@@ -11,9 +12,11 @@ import javax.annotation.Nullable;
  * Represents a syntactically and semantically correct lightning BOLT11 invoice.
  * 
  * There are three ways to construct an `Invoice`:
- * 1. using `InvoiceBuilder`
- * 2. using `Invoice::from_signed(SignedRawInvoice)`
- * 3. using `str::parse::<Invoice>(&str)`
+ * 1. using [`InvoiceBuilder`]
+ * 2. using [`Invoice::from_signed`]
+ * 3. using `str::parse::<Invoice>(&str)` (see [`Invoice::from_str`])
+ * 
+ * [`Invoice::from_str`]: crate::Invoice#impl-FromStr
  */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class Invoice extends CommonBase {
@@ -29,9 +32,21 @@ public class Invoice extends CommonBase {
         * This ignores pointers and is_owned flags and looks at the values in fields.
         * Two objects with NULL inner values will be considered "equal" here.
         */
-       public boolean eq(Invoice b) {
-               boolean ret = bindings.Invoice_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
-               this.ptrs_to.add(b);
+       public boolean eq(org.ldk.structs.Invoice b) {
+               boolean ret = bindings.Invoice_eq(this.ptr, b == null ? 0 : b.ptr);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(b);
+               if (this != null) { this.ptrs_to.add(b); };
+               return ret;
+       }
+
+       @Override public boolean equals(Object o) {
+               if (!(o instanceof Invoice)) return false;
+               return this.eq((Invoice)o);
+       }
+       long clone_ptr() {
+               long ret = bindings.Invoice_clone_ptr(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
@@ -40,21 +55,44 @@ public class Invoice extends CommonBase {
         */
        public Invoice clone() {
                long ret = bindings.Invoice_clone(this.ptr);
-               if (ret < 1024) { return null; }
-               Invoice ret_hu_conv = new Invoice(null, ret);
-               ret_hu_conv.ptrs_to.add(this);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.Invoice ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Invoice(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
+       /**
+        * Generates a non-cryptographic 64-bit hash of the Invoice.
+        */
+       public long hash() {
+               long ret = bindings.Invoice_hash(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       @Override public int hashCode() {
+               return (int)this.hash();
+       }
+       /**
+        * The hash of the [`RawInvoice`] that was signed.
+        */
+       public byte[] signable_hash() {
+               byte[] ret = bindings.Invoice_signable_hash(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
        /**
         * Transform the `Invoice` into it's unchecked version
         */
        public SignedRawInvoice into_signed_raw() {
                long ret = bindings.Invoice_into_signed_raw(this.ptr);
-               if (ret < 1024) { return null; }
-               SignedRawInvoice ret_hu_conv = new SignedRawInvoice(null, ret);
-               ret_hu_conv.ptrs_to.add(this);
-               this.ptrs_to.add(this);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.SignedRawInvoice ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.SignedRawInvoice(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+               if (this != null) { this.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
@@ -63,13 +101,14 @@ public class Invoice extends CommonBase {
         */
        public Result_NoneSemanticErrorZ check_signature() {
                long ret = bindings.Invoice_check_signature(this.ptr);
-               if (ret < 1024) { return null; }
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_NoneSemanticErrorZ ret_hu_conv = Result_NoneSemanticErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }
 
        /**
-        * Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
+        * Constructs an `Invoice` from a [`SignedRawInvoice`] by checking all its invariants.
         * ```
         * use lightning_invoice::*;
         * 
@@ -90,19 +129,30 @@ public class Invoice extends CommonBase {
         * assert!(Invoice::from_signed(signed).is_ok());
         * ```
         */
-       public static Result_InvoiceSemanticErrorZ from_signed(SignedRawInvoice signed_invoice) {
-               long ret = bindings.Invoice_from_signed(signed_invoice == null ? 0 : signed_invoice.ptr & ~1);
-               if (ret < 1024) { return null; }
+       public static Result_InvoiceSemanticErrorZ from_signed(org.ldk.structs.SignedRawInvoice signed_invoice) {
+               long ret = bindings.Invoice_from_signed(signed_invoice == null ? 0 : signed_invoice.ptr);
+               Reference.reachabilityFence(signed_invoice);
+               if (ret >= 0 && ret <= 4096) { return null; }
                Result_InvoiceSemanticErrorZ ret_hu_conv = Result_InvoiceSemanticErrorZ.constr_from_ptr(ret);
-               ret_hu_conv.ptrs_to.add(signed_invoice);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(signed_invoice); };
                return ret_hu_conv;
        }
 
        /**
-        * Returns the `Invoice`'s timestamp (should equal it's creation time)
+        * Returns the `Invoice`'s timestamp (should equal its creation time)
         */
        public long timestamp() {
                long ret = bindings.Invoice_timestamp(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * Returns the `Invoice`'s timestamp as a duration since the Unix epoch
+        */
+       public long duration_since_epoch() {
+               long ret = bindings.Invoice_duration_since_epoch(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
@@ -111,6 +161,7 @@ public class Invoice extends CommonBase {
         */
        public byte[] payment_hash() {
                byte[] ret = bindings.Invoice_payment_hash(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
@@ -122,6 +173,7 @@ public class Invoice extends CommonBase {
        @Nullable
        public byte[] payee_pub_key() {
                byte[] ret = bindings.Invoice_payee_pub_key(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
@@ -130,9 +182,22 @@ public class Invoice extends CommonBase {
         */
        public byte[] payment_secret() {
                byte[] ret = bindings.Invoice_payment_secret(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * Get the payment metadata blob if one was included in the invoice
+        */
+       public Option_CVec_u8ZZ payment_metadata() {
+               long ret = bindings.Invoice_payment_metadata(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.Option_CVec_u8ZZ ret_hu_conv = org.ldk.structs.Option_CVec_u8ZZ.constr_from_ptr(ret);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+               return ret_hu_conv;
+       }
+
        /**
         * Get the invoice features if they were included in the invoice
         * 
@@ -141,9 +206,10 @@ public class Invoice extends CommonBase {
        @Nullable
        public InvoiceFeatures features() {
                long ret = bindings.Invoice_features(this.ptr);
-               if (ret < 1024) { return null; }
-               InvoiceFeatures ret_hu_conv = new InvoiceFeatures(null, ret);
-               ret_hu_conv.ptrs_to.add(this);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InvoiceFeatures(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
@@ -152,23 +218,88 @@ public class Invoice extends CommonBase {
         */
        public byte[] recover_payee_pub_key() {
                byte[] ret = bindings.Invoice_recover_payee_pub_key(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
+       /**
+        * Returns the Duration since the Unix epoch at which the invoice expires.
+        * Returning None if overflow occurred.
+        */
+       public Option_DurationZ expires_at() {
+               long ret = bindings.Invoice_expires_at(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.Option_DurationZ ret_hu_conv = org.ldk.structs.Option_DurationZ.constr_from_ptr(ret);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+               return ret_hu_conv;
+       }
+
        /**
         * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
         */
        public long expiry_time() {
                long ret = bindings.Invoice_expiry_time(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * Returns whether the invoice has expired.
+        */
+       public boolean is_expired() {
+               boolean ret = bindings.Invoice_is_expired(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * Returns the Duration remaining until the invoice expires.
+        */
+       public long duration_until_expiry() {
+               long ret = bindings.Invoice_duration_until_expiry(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * Returns the Duration remaining until the invoice expires given the current time.
+        * `time` is the timestamp as a duration since the Unix epoch.
+        */
+       public long expiration_remaining_from_epoch(long time) {
+               long ret = bindings.Invoice_expiration_remaining_from_epoch(this.ptr, time);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(time);
+               return ret;
+       }
+
+       /**
+        * Returns whether the expiry time would pass at the given point in time.
+        * `at_time` is the timestamp as a duration since the Unix epoch.
+        */
+       public boolean would_expire(long at_time) {
+               boolean ret = bindings.Invoice_would_expire(this.ptr, at_time);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(at_time);
+               return ret;
+       }
+
+       /**
+        * Returns the invoice's `min_final_cltv_expiry_delta` time, if present, otherwise
+        * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA`].
+        */
+       public long min_final_cltv_expiry_delta() {
+               long ret = bindings.Invoice_min_final_cltv_expiry_delta(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
        /**
-        * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
-        * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
+        * Returns a list of all fallback addresses as [`Address`]es
         */
-       public long min_final_cltv_expiry() {
-               long ret = bindings.Invoice_min_final_cltv_expiry(this.ptr);
+       public String[] fallback_addresses() {
+               String[] ret = bindings.Invoice_fallback_addresses(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
@@ -177,11 +308,13 @@ public class Invoice extends CommonBase {
         */
        public PrivateRoute[] private_routes() {
                long[] ret = bindings.Invoice_private_routes(this.ptr);
-               PrivateRoute[] ret_conv_14_arr = new PrivateRoute[ret.length];
-               for (int o = 0; o < ret.length; o++) {
+               Reference.reachabilityFence(this);
+               int ret_conv_14_len = ret.length;
+               PrivateRoute[] ret_conv_14_arr = new PrivateRoute[ret_conv_14_len];
+               for (int o = 0; o < ret_conv_14_len; o++) {
                        long ret_conv_14 = ret[o];
-                       PrivateRoute ret_conv_14_hu_conv = new PrivateRoute(null, ret_conv_14);
-                       ret_conv_14_hu_conv.ptrs_to.add(this);
+                       org.ldk.structs.PrivateRoute ret_conv_14_hu_conv = null; if (ret_conv_14 < 0 || ret_conv_14 > 4096) { ret_conv_14_hu_conv = new org.ldk.structs.PrivateRoute(null, ret_conv_14); }
+                       if (ret_conv_14_hu_conv != null) { ret_conv_14_hu_conv.ptrs_to.add(this); };
                        ret_conv_14_arr[o] = ret_conv_14_hu_conv;
                }
                return ret_conv_14_arr;
@@ -192,11 +325,13 @@ public class Invoice extends CommonBase {
         */
        public RouteHint[] route_hints() {
                long[] ret = bindings.Invoice_route_hints(this.ptr);
-               RouteHint[] ret_conv_11_arr = new RouteHint[ret.length];
-               for (int l = 0; l < ret.length; l++) {
+               Reference.reachabilityFence(this);
+               int ret_conv_11_len = ret.length;
+               RouteHint[] ret_conv_11_arr = new RouteHint[ret_conv_11_len];
+               for (int l = 0; l < ret_conv_11_len; l++) {
                        long ret_conv_11 = ret[l];
-                       RouteHint ret_conv_11_hu_conv = new RouteHint(null, ret_conv_11);
-                       ret_conv_11_hu_conv.ptrs_to.add(this);
+                       org.ldk.structs.RouteHint ret_conv_11_hu_conv = null; if (ret_conv_11 < 0 || ret_conv_11 > 4096) { ret_conv_11_hu_conv = new org.ldk.structs.RouteHint(null, ret_conv_11); }
+                       if (ret_conv_11_hu_conv != null) { ret_conv_11_hu_conv.ptrs_to.add(this); };
                        ret_conv_11_arr[l] = ret_conv_11_hu_conv;
                }
                return ret_conv_11_arr;
@@ -207,27 +342,30 @@ public class Invoice extends CommonBase {
         */
        public Currency currency() {
                Currency ret = bindings.Invoice_currency(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
        /**
-        * Returns the amount if specified in the invoice as pico <currency>.
+        * Returns the amount if specified in the invoice as millisatoshis.
         */
-       public Option_u64Z amount_pico_btc() {
-               long ret = bindings.Invoice_amount_pico_btc(this.ptr);
-               if (ret < 1024) { return null; }
-               Option_u64Z ret_hu_conv = Option_u64Z.constr_from_ptr(ret);
-               ret_hu_conv.ptrs_to.add(this);
+       public Option_u64Z amount_milli_satoshis() {
+               long ret = bindings.Invoice_amount_milli_satoshis(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
        /**
         * Read a Invoice object from a string
         */
-       public static Result_InvoiceNoneZ from_str(java.lang.String s) {
+       public static Result_InvoiceParseOrSemanticErrorZ from_str(java.lang.String s) {
                long ret = bindings.Invoice_from_str(s);
-               if (ret < 1024) { return null; }
-               Result_InvoiceNoneZ ret_hu_conv = Result_InvoiceNoneZ.constr_from_ptr(ret);
+               Reference.reachabilityFence(s);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_InvoiceParseOrSemanticErrorZ ret_hu_conv = Result_InvoiceParseOrSemanticErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
        }
 
@@ -236,6 +374,7 @@ public class Invoice extends CommonBase {
         */
        public String to_str() {
                String ret = bindings.Invoice_to_str(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }