1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import javax.annotation.Nullable;
11 * Represents a syntactically and semantically correct lightning BOLT11 invoice.
13 * There are three ways to construct an `Invoice`:
14 * 1. using `InvoiceBuilder`
15 * 2. using `Invoice::from_signed(SignedRawInvoice)`
16 * 3. using `str::parse::<Invoice>(&str)`
18 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
19 public class Invoice extends CommonBase {
20 Invoice(Object _dummy, long ptr) { super(ptr); }
21 @Override @SuppressWarnings("deprecation")
22 protected void finalize() throws Throwable {
24 if (ptr != 0) { bindings.Invoice_free(ptr); }
28 * Checks if two Invoices contain equal inner contents.
29 * This ignores pointers and is_owned flags and looks at the values in fields.
30 * Two objects with NULL inner values will be considered "equal" here.
32 public boolean eq(Invoice b) {
33 boolean ret = bindings.Invoice_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
39 * Creates a copy of the Invoice
41 public Invoice clone() {
42 long ret = bindings.Invoice_clone(this.ptr);
43 if (ret >= 0 && ret <= 4096) { return null; }
44 Invoice ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new Invoice(null, ret); }
45 ret_hu_conv.ptrs_to.add(this);
50 * Transform the `Invoice` into it's unchecked version
52 public SignedRawInvoice into_signed_raw() {
53 long ret = bindings.Invoice_into_signed_raw(this.ptr);
54 if (ret >= 0 && ret <= 4096) { return null; }
55 SignedRawInvoice ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new SignedRawInvoice(null, ret); }
56 ret_hu_conv.ptrs_to.add(this);
62 * Check that the invoice is signed correctly and that key recovery works
64 public Result_NoneSemanticErrorZ check_signature() {
65 long ret = bindings.Invoice_check_signature(this.ptr);
66 if (ret >= 0 && ret <= 4096) { return null; }
67 Result_NoneSemanticErrorZ ret_hu_conv = Result_NoneSemanticErrorZ.constr_from_ptr(ret);
72 * Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
74 * use lightning_invoice::*;
76 * let invoice = \"lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\\
77 * h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\\
78 * 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\\
79 * h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\\
80 * j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\\
81 * ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\\
82 * guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\\
83 * ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\\
84 * p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\\
85 * 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\\
86 * j5r6drg6k6zcqj0fcwg\";
88 * let signed = invoice.parse::<SignedRawInvoice>().unwrap();
90 * assert!(Invoice::from_signed(signed).is_ok());
93 public static Result_InvoiceSemanticErrorZ from_signed(SignedRawInvoice signed_invoice) {
94 long ret = bindings.Invoice_from_signed(signed_invoice == null ? 0 : signed_invoice.ptr & ~1);
95 if (ret >= 0 && ret <= 4096) { return null; }
96 Result_InvoiceSemanticErrorZ ret_hu_conv = Result_InvoiceSemanticErrorZ.constr_from_ptr(ret);
101 * Returns the `Invoice`'s timestamp (should equal it's creation time)
103 public long timestamp() {
104 long ret = bindings.Invoice_timestamp(this.ptr);
109 * Returns the hash to which we will receive the preimage on completion of the payment
111 public byte[] payment_hash() {
112 byte[] ret = bindings.Invoice_payment_hash(this.ptr);
117 * Get the payee's public key if one was included in the invoice
119 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
122 public byte[] payee_pub_key() {
123 byte[] ret = bindings.Invoice_payee_pub_key(this.ptr);
128 * Get the payment secret if one was included in the invoice
130 public byte[] payment_secret() {
131 byte[] ret = bindings.Invoice_payment_secret(this.ptr);
136 * Get the invoice features if they were included in the invoice
138 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
141 public InvoiceFeatures features() {
142 long ret = bindings.Invoice_features(this.ptr);
143 if (ret >= 0 && ret <= 4096) { return null; }
144 InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new InvoiceFeatures(null, ret); }
145 ret_hu_conv.ptrs_to.add(this);
150 * Recover the payee's public key (only to be used if none was included in the invoice)
152 public byte[] recover_payee_pub_key() {
153 byte[] ret = bindings.Invoice_recover_payee_pub_key(this.ptr);
158 * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
160 public long expiry_time() {
161 long ret = bindings.Invoice_expiry_time(this.ptr);
166 * Returns whether the invoice has expired.
168 public boolean is_expired() {
169 boolean ret = bindings.Invoice_is_expired(this.ptr);
174 * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
175 * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
177 public long min_final_cltv_expiry() {
178 long ret = bindings.Invoice_min_final_cltv_expiry(this.ptr);
183 * Returns a list of all routes included in the invoice
185 public PrivateRoute[] private_routes() {
186 long[] ret = bindings.Invoice_private_routes(this.ptr);
187 PrivateRoute[] ret_conv_14_arr = new PrivateRoute[ret.length];
188 for (int o = 0; o < ret.length; o++) {
189 long ret_conv_14 = ret[o];
190 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); }
191 ret_conv_14_hu_conv.ptrs_to.add(this);
192 ret_conv_14_arr[o] = ret_conv_14_hu_conv;
194 return ret_conv_14_arr;
198 * Returns a list of all routes included in the invoice as the underlying hints
200 public RouteHint[] route_hints() {
201 long[] ret = bindings.Invoice_route_hints(this.ptr);
202 RouteHint[] ret_conv_11_arr = new RouteHint[ret.length];
203 for (int l = 0; l < ret.length; l++) {
204 long ret_conv_11 = ret[l];
205 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); }
206 ret_conv_11_hu_conv.ptrs_to.add(this);
207 ret_conv_11_arr[l] = ret_conv_11_hu_conv;
209 return ret_conv_11_arr;
213 * Returns the currency for which the invoice was issued
215 public Currency currency() {
216 Currency ret = bindings.Invoice_currency(this.ptr);
221 * Returns the amount if specified in the invoice as millisatoshis.
223 public Option_u64Z amount_milli_satoshis() {
224 long ret = bindings.Invoice_amount_milli_satoshis(this.ptr);
225 if (ret >= 0 && ret <= 4096) { return null; }
226 Option_u64Z ret_hu_conv = Option_u64Z.constr_from_ptr(ret);
227 ret_hu_conv.ptrs_to.add(this);
232 * Read a Invoice object from a string
234 public static Result_InvoiceNoneZ from_str(java.lang.String s) {
235 long ret = bindings.Invoice_from_str(s);
236 if (ret >= 0 && ret <= 4096) { return null; }
237 Result_InvoiceNoneZ ret_hu_conv = Result_InvoiceNoneZ.constr_from_ptr(ret);
242 * Get the string representation of a Invoice object
244 public String to_str() {
245 String ret = bindings.Invoice_to_str(this.ptr);