_ Git - ldk-java/blob - src/main/java/org/ldk/structs/Invoice.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7 import java.lang.ref.Reference;
   8 import javax.annotation.Nullable;
   9
  10
  11 /**
  12  * Represents a syntactically and semantically correct lightning BOLT11 invoice.
  13  *
  14  * There are three ways to construct an `Invoice`:
  15  * 1. using `InvoiceBuilder`
  16  * 2. using `Invoice::from_signed(SignedRawInvoice)`
  17  * 3. using `str::parse::<Invoice>(&str)`
  18  */
  19 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  20 public class Invoice extends CommonBase {
  21         Invoice(Object _dummy, long ptr) { super(ptr); }
  22         @Override @SuppressWarnings("deprecation")
  23         protected void finalize() throws Throwable {
  24                 super.finalize();
  25                 if (ptr != 0) { bindings.Invoice_free(ptr); }
  26         }
  27
  28         /**
  29          * Checks if two Invoices contain equal inner contents.
  30          * This ignores pointers and is_owned flags and looks at the values in fields.
  31          * Two objects with NULL inner values will be considered "equal" here.
  32          */
  33         public boolean eq(Invoice b) {
  34                 boolean ret = bindings.Invoice_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
  35                 Reference.reachabilityFence(this);
  36                 Reference.reachabilityFence(b);
  37                 this.ptrs_to.add(b);
  38                 return ret;
  39         }
  40
  41         @Override public boolean equals(Object o) {
  42                 if (!(o instanceof Invoice)) return false;
  43                 return this.eq((Invoice)o);
  44         }
  45         long clone_ptr() {
  46                 long ret = bindings.Invoice_clone_ptr(this.ptr);
  47                 Reference.reachabilityFence(this);
  48                 return ret;
  49         }
  50
  51         /**
  52          * Creates a copy of the Invoice
  53          */
  54         public Invoice clone() {
  55                 long ret = bindings.Invoice_clone(this.ptr);
  56                 Reference.reachabilityFence(this);
  57                 if (ret >= 0 && ret <= 4096) { return null; }
  58                 Invoice ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Invoice(null, ret); }
  59                 ret_hu_conv.ptrs_to.add(this);
  60                 return ret_hu_conv;
  61         }
  62
  63         /**
  64          * Transform the `Invoice` into it's unchecked version
  65          */
  66         public SignedRawInvoice into_signed_raw() {
  67                 long ret = bindings.Invoice_into_signed_raw(this.ptr);
  68                 Reference.reachabilityFence(this);
  69                 if (ret >= 0 && ret <= 4096) { return null; }
  70                 SignedRawInvoice ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new SignedRawInvoice(null, ret); }
  71                 ret_hu_conv.ptrs_to.add(this);
  72                 ;
  73                 return ret_hu_conv;
  74         }
  75
  76         /**
  77          * Check that the invoice is signed correctly and that key recovery works
  78          */
  79         public Result_NoneSemanticErrorZ check_signature() {
  80                 long ret = bindings.Invoice_check_signature(this.ptr);
  81                 Reference.reachabilityFence(this);
  82                 if (ret >= 0 && ret <= 4096) { return null; }
  83                 Result_NoneSemanticErrorZ ret_hu_conv = Result_NoneSemanticErrorZ.constr_from_ptr(ret);
  84                 return ret_hu_conv;
  85         }
  86
  87         /**
  88          * Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
  89          * ```
  90          * use lightning_invoice::*;
  91          *
  92          * let invoice = \"lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\\
  93          * h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\\
  94          * 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\\
  95          * h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\\
  96          * j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\\
  97          * ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\\
  98          * guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\\
  99          * ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\\
 100          * p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\\
 101          * 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\\
 102          * j5r6drg6k6zcqj0fcwg\";
 103          *
 104          * let signed = invoice.parse::<SignedRawInvoice>().unwrap();
 105          *
 106          * assert!(Invoice::from_signed(signed).is_ok());
 107          * ```
 108          */
 109         public static Result_InvoiceSemanticErrorZ from_signed(SignedRawInvoice signed_invoice) {
 110                 long ret = bindings.Invoice_from_signed(signed_invoice == null ? 0 : signed_invoice.ptr & ~1);
 111                 Reference.reachabilityFence(signed_invoice);
 112                 if (ret >= 0 && ret <= 4096) { return null; }
 113                 Result_InvoiceSemanticErrorZ ret_hu_conv = Result_InvoiceSemanticErrorZ.constr_from_ptr(ret);
 114                 return ret_hu_conv;
 115         }
 116
 117         /**
 118          * Returns the `Invoice`'s timestamp (should equal its creation time)
 119          */
 120         public long timestamp() {
 121                 long ret = bindings.Invoice_timestamp(this.ptr);
 122                 Reference.reachabilityFence(this);
 123                 return ret;
 124         }
 125
 126         /**
 127          * Returns the `Invoice`'s timestamp as a duration since the Unix epoch
 128          */
 129         public long duration_since_epoch() {
 130                 long ret = bindings.Invoice_duration_since_epoch(this.ptr);
 131                 Reference.reachabilityFence(this);
 132                 return ret;
 133         }
 134
 135         /**
 136          * Returns the hash to which we will receive the preimage on completion of the payment
 137          */
 138         public byte[] payment_hash() {
 139                 byte[] ret = bindings.Invoice_payment_hash(this.ptr);
 140                 Reference.reachabilityFence(this);
 141                 return ret;
 142         }
 143
 144         /**
 145          * Get the payee's public key if one was included in the invoice
 146          *
 147          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 148          */
 149         @Nullable
 150         public byte[] payee_pub_key() {
 151                 byte[] ret = bindings.Invoice_payee_pub_key(this.ptr);
 152                 Reference.reachabilityFence(this);
 153                 return ret;
 154         }
 155
 156         /**
 157          * Get the payment secret if one was included in the invoice
 158          */
 159         public byte[] payment_secret() {
 160                 byte[] ret = bindings.Invoice_payment_secret(this.ptr);
 161                 Reference.reachabilityFence(this);
 162                 return ret;
 163         }
 164
 165         /**
 166          * Get the invoice features if they were included in the invoice
 167          *
 168          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 169          */
 170         @Nullable
 171         public InvoiceFeatures features() {
 172                 long ret = bindings.Invoice_features(this.ptr);
 173                 Reference.reachabilityFence(this);
 174                 if (ret >= 0 && ret <= 4096) { return null; }
 175                 InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new InvoiceFeatures(null, ret); }
 176                 ret_hu_conv.ptrs_to.add(this);
 177                 return ret_hu_conv;
 178         }
 179
 180         /**
 181          * Recover the payee's public key (only to be used if none was included in the invoice)
 182          */
 183         public byte[] recover_payee_pub_key() {
 184                 byte[] ret = bindings.Invoice_recover_payee_pub_key(this.ptr);
 185                 Reference.reachabilityFence(this);
 186                 return ret;
 187         }
 188
 189         /**
 190          * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
 191          */
 192         public long expiry_time() {
 193                 long ret = bindings.Invoice_expiry_time(this.ptr);
 194                 Reference.reachabilityFence(this);
 195                 return ret;
 196         }
 197
 198         /**
 199          * Returns whether the invoice has expired.
 200          */
 201         public boolean is_expired() {
 202                 boolean ret = bindings.Invoice_is_expired(this.ptr);
 203                 Reference.reachabilityFence(this);
 204                 return ret;
 205         }
 206
 207         /**
 208          * Returns whether the expiry time would pass at the given point in time.
 209          * `at_time` is the timestamp as a duration since the Unix epoch.
 210          */
 211         public boolean would_expire(long at_time) {
 212                 boolean ret = bindings.Invoice_would_expire(this.ptr, at_time);
 213                 Reference.reachabilityFence(this);
 214                 Reference.reachabilityFence(at_time);
 215                 return ret;
 216         }
 217
 218         /**
 219          * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
 220          * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
 221          */
 222         public long min_final_cltv_expiry() {
 223                 long ret = bindings.Invoice_min_final_cltv_expiry(this.ptr);
 224                 Reference.reachabilityFence(this);
 225                 return ret;
 226         }
 227
 228         /**
 229          * Returns a list of all routes included in the invoice
 230          */
 231         public PrivateRoute[] private_routes() {
 232                 long[] ret = bindings.Invoice_private_routes(this.ptr);
 233                 Reference.reachabilityFence(this);
 234                 int ret_conv_14_len = ret.length;
 235                 PrivateRoute[] ret_conv_14_arr = new PrivateRoute[ret_conv_14_len];
 236                 for (int o = 0; o < ret_conv_14_len; o++) {
 237                         long ret_conv_14 = ret[o];
 238                         PrivateRoute ret_conv_14_hu_conv = null; if (ret_conv_14 < 0 || ret_conv_14 > 4096) { ret_conv_14_hu_conv = new PrivateRoute(null, ret_conv_14); }
 239                         ret_conv_14_hu_conv.ptrs_to.add(this);
 240                         ret_conv_14_arr[o] = ret_conv_14_hu_conv;
 241                 }
 242                 return ret_conv_14_arr;
 243         }
 244
 245         /**
 246          * Returns a list of all routes included in the invoice as the underlying hints
 247          */
 248         public RouteHint[] route_hints() {
 249                 long[] ret = bindings.Invoice_route_hints(this.ptr);
 250                 Reference.reachabilityFence(this);
 251                 int ret_conv_11_len = ret.length;
 252                 RouteHint[] ret_conv_11_arr = new RouteHint[ret_conv_11_len];
 253                 for (int l = 0; l < ret_conv_11_len; l++) {
 254                         long ret_conv_11 = ret[l];
 255                         RouteHint ret_conv_11_hu_conv = null; if (ret_conv_11 < 0 || ret_conv_11 > 4096) { ret_conv_11_hu_conv = new RouteHint(null, ret_conv_11); }
 256                         ret_conv_11_hu_conv.ptrs_to.add(this);
 257                         ret_conv_11_arr[l] = ret_conv_11_hu_conv;
 258                 }
 259                 return ret_conv_11_arr;
 260         }
 261
 262         /**
 263          * Returns the currency for which the invoice was issued
 264          */
 265         public Currency currency() {
 266                 Currency ret = bindings.Invoice_currency(this.ptr);
 267                 Reference.reachabilityFence(this);
 268                 return ret;
 269         }
 270
 271         /**
 272          * Returns the amount if specified in the invoice as millisatoshis.
 273          */
 274         public Option_u64Z amount_milli_satoshis() {
 275                 long ret = bindings.Invoice_amount_milli_satoshis(this.ptr);
 276                 Reference.reachabilityFence(this);
 277                 if (ret >= 0 && ret <= 4096) { return null; }
 278                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
 279                 ret_hu_conv.ptrs_to.add(this);
 280                 return ret_hu_conv;
 281         }
 282
 283         /**
 284          * Read a Invoice object from a string
 285          */
 286         public static Result_InvoiceParseOrSemanticErrorZ from_str(java.lang.String s) {
 287                 long ret = bindings.Invoice_from_str(s);
 288                 Reference.reachabilityFence(s);
 289                 if (ret >= 0 && ret <= 4096) { return null; }
 290                 Result_InvoiceParseOrSemanticErrorZ ret_hu_conv = Result_InvoiceParseOrSemanticErrorZ.constr_from_ptr(ret);
 291                 return ret_hu_conv;
 292         }
 293
 294         /**
 295          * Get the string representation of a Invoice object
 296          */
 297         public String to_str() {
 298                 String ret = bindings.Invoice_to_str(this.ptr);
 299                 Reference.reachabilityFence(this);
 300                 return ret;
 301         }
 302
 303 }