1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * Represents a syntactically and semantically correct lightning BOLT11 invoice.
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)`
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 {
25 if (ptr != 0) { bindings.Invoice_free(ptr); }
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.
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);
41 @Override public boolean equals(Object o) {
42 if (!(o instanceof Invoice)) return false;
43 return this.eq((Invoice)o);
46 long ret = bindings.Invoice_clone_ptr(this.ptr);
47 Reference.reachabilityFence(this);
52 * Creates a copy of the Invoice
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 org.ldk.structs.Invoice ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Invoice(null, ret); }
59 ret_hu_conv.ptrs_to.add(this);
64 * Transform the `Invoice` into it's unchecked version
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 org.ldk.structs.SignedRawInvoice ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.SignedRawInvoice(null, ret); }
71 ret_hu_conv.ptrs_to.add(this);
77 * Check that the invoice is signed correctly and that key recovery works
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);
88 * Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
90 * use lightning_invoice::*;
92 * let invoice = \"lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\\
93 * h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\\
94 * 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\\
95 * h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\\
96 * j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\\
97 * ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\\
98 * guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\\
99 * ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\\
100 * p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\\
101 * 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\\
102 * j5r6drg6k6zcqj0fcwg\";
104 * let signed = invoice.parse::<SignedRawInvoice>().unwrap();
106 * assert!(Invoice::from_signed(signed).is_ok());
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);
118 * Returns the `Invoice`'s timestamp (should equal its creation time)
120 public long timestamp() {
121 long ret = bindings.Invoice_timestamp(this.ptr);
122 Reference.reachabilityFence(this);
127 * Returns the `Invoice`'s timestamp as a duration since the Unix epoch
129 public long duration_since_epoch() {
130 long ret = bindings.Invoice_duration_since_epoch(this.ptr);
131 Reference.reachabilityFence(this);
136 * Returns the hash to which we will receive the preimage on completion of the payment
138 public byte[] payment_hash() {
139 byte[] ret = bindings.Invoice_payment_hash(this.ptr);
140 Reference.reachabilityFence(this);
145 * Get the payee's public key if one was included in the invoice
147 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
150 public byte[] payee_pub_key() {
151 byte[] ret = bindings.Invoice_payee_pub_key(this.ptr);
152 Reference.reachabilityFence(this);
157 * Get the payment secret if one was included in the invoice
159 public byte[] payment_secret() {
160 byte[] ret = bindings.Invoice_payment_secret(this.ptr);
161 Reference.reachabilityFence(this);
166 * Get the invoice features if they were included in the invoice
168 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
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 org.ldk.structs.InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InvoiceFeatures(null, ret); }
176 ret_hu_conv.ptrs_to.add(this);
181 * Recover the payee's public key (only to be used if none was included in the invoice)
183 public byte[] recover_payee_pub_key() {
184 byte[] ret = bindings.Invoice_recover_payee_pub_key(this.ptr);
185 Reference.reachabilityFence(this);
190 * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
192 public long expiry_time() {
193 long ret = bindings.Invoice_expiry_time(this.ptr);
194 Reference.reachabilityFence(this);
199 * Returns whether the invoice has expired.
201 public boolean is_expired() {
202 boolean ret = bindings.Invoice_is_expired(this.ptr);
203 Reference.reachabilityFence(this);
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.
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);
219 * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
220 * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
222 public long min_final_cltv_expiry() {
223 long ret = bindings.Invoice_min_final_cltv_expiry(this.ptr);
224 Reference.reachabilityFence(this);
229 * Returns a list of all routes included in the invoice
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 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); }
239 ret_conv_14_hu_conv.ptrs_to.add(this);
240 ret_conv_14_arr[o] = ret_conv_14_hu_conv;
242 return ret_conv_14_arr;
246 * Returns a list of all routes included in the invoice as the underlying hints
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 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); }
256 ret_conv_11_hu_conv.ptrs_to.add(this);
257 ret_conv_11_arr[l] = ret_conv_11_hu_conv;
259 return ret_conv_11_arr;
263 * Returns the currency for which the invoice was issued
265 public Currency currency() {
266 Currency ret = bindings.Invoice_currency(this.ptr);
267 Reference.reachabilityFence(this);
272 * Returns the amount if specified in the invoice as millisatoshis.
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);
284 * Read a Invoice object from a string
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);
295 * Get the string representation of a Invoice object
297 public String to_str() {
298 String ret = bindings.Invoice_to_str(this.ptr);
299 Reference.reachabilityFence(this);