_ 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
   8
   9 /**
  10  * Represents a syntactically and semantically correct lightning BOLT11 invoice.
  11  *
  12  * There are three ways to construct an `Invoice`:
  13  * 1. using `InvoiceBuilder`
  14  * 2. using `Invoice::from_signed(SignedRawInvoice)`
  15  * 3. using `str::parse::<Invoice>(&str)`
  16  */
  17 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  18 public class Invoice extends CommonBase {
  19         Invoice(Object _dummy, long ptr) { super(ptr); }
  20         @Override @SuppressWarnings("deprecation")
  21         protected void finalize() throws Throwable {
  22                 super.finalize();
  23                 if (ptr != 0) { bindings.Invoice_free(ptr); }
  24         }
  25
  26         /**
  27          * Checks if two Invoices contain equal inner contents.
  28          * This ignores pointers and is_owned flags and looks at the values in fields.
  29          * Two objects with NULL inner values will be considered "equal" here.
  30          */
  31         public boolean eq(Invoice b) {
  32                 boolean ret = bindings.Invoice_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
  33                 this.ptrs_to.add(b);
  34                 return ret;
  35         }
  36
  37         /**
  38          * Creates a copy of the Invoice
  39          */
  40         public Invoice clone() {
  41                 long ret = bindings.Invoice_clone(this.ptr);
  42                 Invoice ret_hu_conv = new Invoice(null, ret);
  43                 ret_hu_conv.ptrs_to.add(this);
  44                 return ret_hu_conv;
  45         }
  46
  47         /**
  48          * Transform the `Invoice` into it's unchecked version
  49          */
  50         public SignedRawInvoice into_signed_raw() {
  51                 long ret = bindings.Invoice_into_signed_raw(this.ptr);
  52                 SignedRawInvoice ret_hu_conv = new SignedRawInvoice(null, ret);
  53                 ret_hu_conv.ptrs_to.add(this);
  54                 this.ptrs_to.add(this);
  55                 return ret_hu_conv;
  56         }
  57
  58         /**
  59          * Check that the invoice is signed correctly and that key recovery works
  60          */
  61         public Result_NoneSemanticErrorZ check_signature() {
  62                 long ret = bindings.Invoice_check_signature(this.ptr);
  63                 Result_NoneSemanticErrorZ ret_hu_conv = Result_NoneSemanticErrorZ.constr_from_ptr(ret);
  64                 return ret_hu_conv;
  65         }
  66
  67         /**
  68          * Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
  69          * ```
  70          * use lightning_invoice::*;
  71          *
  72          * let invoice = \"lnbc1pvjluezpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdp\\
  73          * \tl2pkx2ctnv5sxxmmwwd5kgetjypeh2ursdae8g6twvus8g6rfwvs8qun0dfjkxaq8rkx3yf5tcsyz3d7\\
  74          * \t3gafnh3cax9rn449d9p5uxz9ezhhypd0elx87sjle52x86fux2ypatgddc6k63n7erqz25le42c4u4ec\\
  75          * \tky03ylcqca784w\";
  76          *
  77          * let signed = invoice.parse::<SignedRawInvoice>().unwrap();
  78          *
  79          * assert!(Invoice::from_signed(signed).is_ok());
  80          * ```
  81          */
  82         public static Result_InvoiceSemanticErrorZ from_signed(SignedRawInvoice signed_invoice) {
  83                 long ret = bindings.Invoice_from_signed(signed_invoice == null ? 0 : signed_invoice.ptr & ~1);
  84                 Result_InvoiceSemanticErrorZ ret_hu_conv = Result_InvoiceSemanticErrorZ.constr_from_ptr(ret);
  85                 ret_hu_conv.ptrs_to.add(signed_invoice);
  86                 return ret_hu_conv;
  87         }
  88
  89         /**
  90          * Returns the `Invoice`'s timestamp (should equal it's creation time)
  91          */
  92         public long timestamp() {
  93                 long ret = bindings.Invoice_timestamp(this.ptr);
  94                 return ret;
  95         }
  96
  97         /**
  98          * Returns the hash to which we will receive the preimage on completion of the payment
  99          */
 100         public byte[] payment_hash() {
 101                 byte[] ret = bindings.Invoice_payment_hash(this.ptr);
 102                 return ret;
 103         }
 104
 105         /**
 106          * Get the payee's public key if one was included in the invoice
 107          */
 108         public byte[] payee_pub_key() {
 109                 byte[] ret = bindings.Invoice_payee_pub_key(this.ptr);
 110                 return ret;
 111         }
 112
 113         /**
 114          * Get the payment secret if one was included in the invoice
 115          */
 116         public byte[] payment_secret() {
 117                 byte[] ret = bindings.Invoice_payment_secret(this.ptr);
 118                 return ret;
 119         }
 120
 121         /**
 122          * Get the invoice features if they were included in the invoice
 123          */
 124         public InvoiceFeatures features() {
 125                 long ret = bindings.Invoice_features(this.ptr);
 126                 InvoiceFeatures ret_hu_conv = new InvoiceFeatures(null, ret);
 127                 ret_hu_conv.ptrs_to.add(this);
 128                 return ret_hu_conv;
 129         }
 130
 131         /**
 132          * Recover the payee's public key (only to be used if none was included in the invoice)
 133          */
 134         public byte[] recover_payee_pub_key() {
 135                 byte[] ret = bindings.Invoice_recover_payee_pub_key(this.ptr);
 136                 return ret;
 137         }
 138
 139         /**
 140          * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
 141          */
 142         public long expiry_time() {
 143                 long ret = bindings.Invoice_expiry_time(this.ptr);
 144                 return ret;
 145         }
 146
 147         /**
 148          * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
 149          * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
 150          */
 151         public long min_final_cltv_expiry() {
 152                 long ret = bindings.Invoice_min_final_cltv_expiry(this.ptr);
 153                 return ret;
 154         }
 155
 156         /**
 157          * Returns a list of all routes included in the invoice
 158          */
 159         public PrivateRoute[] private_routes() {
 160                 long[] ret = bindings.Invoice_private_routes(this.ptr);
 161                 PrivateRoute[] ret_conv_14_arr = new PrivateRoute[ret.length];
 162                 for (int o = 0; o < ret.length; o++) {
 163                         long ret_conv_14 = ret[o];
 164                         PrivateRoute ret_conv_14_hu_conv = new PrivateRoute(null, ret_conv_14);
 165                         ret_conv_14_hu_conv.ptrs_to.add(this);
 166                         ret_conv_14_arr[o] = ret_conv_14_hu_conv;
 167                 }
 168                 return ret_conv_14_arr;
 169         }
 170
 171         /**
 172          * Returns a list of all routes included in the invoice as the underlying hints
 173          */
 174         public RouteHint[] route_hints() {
 175                 long[] ret = bindings.Invoice_route_hints(this.ptr);
 176                 RouteHint[] ret_conv_11_arr = new RouteHint[ret.length];
 177                 for (int l = 0; l < ret.length; l++) {
 178                         long ret_conv_11 = ret[l];
 179                         RouteHint ret_conv_11_hu_conv = new RouteHint(null, ret_conv_11);
 180                         ret_conv_11_hu_conv.ptrs_to.add(this);
 181                         ret_conv_11_arr[l] = ret_conv_11_hu_conv;
 182                 }
 183                 return ret_conv_11_arr;
 184         }
 185
 186         /**
 187          * Returns the currency for which the invoice was issued
 188          */
 189         public Currency currency() {
 190                 Currency ret = bindings.Invoice_currency(this.ptr);
 191                 return ret;
 192         }
 193
 194         /**
 195          * Returns the amount if specified in the invoice as pico <currency>.
 196          */
 197         public Option_u64Z amount_pico_btc() {
 198                 long ret = bindings.Invoice_amount_pico_btc(this.ptr);
 199                 Option_u64Z ret_hu_conv = Option_u64Z.constr_from_ptr(ret);
 200                 ret_hu_conv.ptrs_to.add(this);
 201                 return ret_hu_conv;
 202         }
 203
 204         /**
 205          * Read a Invoice object from a string
 206          */
 207         public static Result_InvoiceNoneZ from_str(String s) {
 208                 long ret = bindings.Invoice_from_str(s);
 209                 Result_InvoiceNoneZ ret_hu_conv = Result_InvoiceNoneZ.constr_from_ptr(ret);
 210                 return ret_hu_conv;
 211         }
 212
 213         /**
 214          * Get the string representation of a Invoice object
 215          */
 216         public String to_str() {
 217                 String ret = bindings.Invoice_to_str(this.ptr);
 218                 return ret;
 219         }
 220
 221 }