6 namespace org { namespace ldk { namespace structs {
10 * Represents a syntactically and semantically correct lightning BOLT11 invoice.
12 * There are three ways to construct a `Bolt11Invoice`:
13 * 1. using [`InvoiceBuilder`]
14 * 2. using [`Bolt11Invoice::from_signed`]
15 * 3. using `str::parse::<Bolt11Invoice>(&str)` (see [`Bolt11Invoice::from_str`])
17 * [`Bolt11Invoice::from_str`]: crate::Bolt11Invoice#impl-FromStr
19 public class Bolt11Invoice : CommonBase {
20 internal Bolt11Invoice(object _dummy, long ptr) : base(ptr) { }
22 if (ptr != 0) { bindings.Bolt11Invoice_free(ptr); }
26 * Checks if two Bolt11Invoices contain equal inner contents.
27 * This ignores pointers and is_owned flags and looks at the values in fields.
28 * Two objects with NULL inner values will be considered "equal" here.
30 public bool eq(org.ldk.structs.Bolt11Invoice b) {
31 bool ret = bindings.Bolt11Invoice_eq(this.ptr, b == null ? 0 : b.ptr);
34 if (this != null) { this.ptrs_to.AddLast(b); };
38 public override bool Equals(object o) {
39 if (!(o is Bolt11Invoice)) return false;
40 return this.eq((Bolt11Invoice)o);
42 internal long clone_ptr() {
43 long ret = bindings.Bolt11Invoice_clone_ptr(this.ptr);
49 * Creates a copy of the Bolt11Invoice
51 public Bolt11Invoice clone() {
52 long ret = bindings.Bolt11Invoice_clone(this.ptr);
54 if (ret >= 0 && ret <= 4096) { return null; }
55 org.ldk.structs.Bolt11Invoice ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Bolt11Invoice(null, ret); }
56 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
61 * Generates a non-cryptographic 64-bit hash of the Bolt11Invoice.
64 long ret = bindings.Bolt11Invoice_hash(this.ptr);
69 public override int GetHashCode() {
70 return (int)this.hash();
73 * The hash of the [`RawBolt11Invoice`] that was signed.
75 public byte[] signable_hash() {
76 byte[] ret = bindings.Bolt11Invoice_signable_hash(this.ptr);
82 * Transform the `Bolt11Invoice` into its unchecked version.
84 public SignedRawBolt11Invoice into_signed_raw() {
85 long ret = bindings.Bolt11Invoice_into_signed_raw(this.ptr);
87 if (ret >= 0 && ret <= 4096) { return null; }
88 org.ldk.structs.SignedRawBolt11Invoice ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.SignedRawBolt11Invoice(null, ret); }
89 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
90 if (this != null) { this.ptrs_to.AddLast(this); };
95 * Check that the invoice is signed correctly and that key recovery works
97 public Result_NoneBolt11SemanticErrorZ check_signature() {
98 long ret = bindings.Bolt11Invoice_check_signature(this.ptr);
100 if (ret >= 0 && ret <= 4096) { return null; }
101 Result_NoneBolt11SemanticErrorZ ret_hu_conv = Result_NoneBolt11SemanticErrorZ.constr_from_ptr(ret);
106 * Constructs a `Bolt11Invoice` from a [`SignedRawBolt11Invoice`] by checking all its invariants.
108 * use lightning_invoice::*;
110 * let invoice = \"lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\\
111 * h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\\
112 * 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\\
113 * h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\\
114 * j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\\
115 * ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\\
116 * guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\\
117 * ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\\
118 * p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\\
119 * 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\\
120 * j5r6drg6k6zcqj0fcwg\";
122 * let signed = invoice.parse::<SignedRawBolt11Invoice>().unwrap();
124 * assert!(Bolt11Invoice::from_signed(signed).is_ok());
127 public static Result_Bolt11InvoiceBolt11SemanticErrorZ from_signed(org.ldk.structs.SignedRawBolt11Invoice signed_invoice) {
128 long ret = bindings.Bolt11Invoice_from_signed(signed_invoice == null ? 0 : signed_invoice.ptr);
129 GC.KeepAlive(signed_invoice);
130 if (ret >= 0 && ret <= 4096) { return null; }
131 Result_Bolt11InvoiceBolt11SemanticErrorZ ret_hu_conv = Result_Bolt11InvoiceBolt11SemanticErrorZ.constr_from_ptr(ret);
132 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(signed_invoice); };
137 * Returns the `Bolt11Invoice`'s timestamp (should equal its creation time)
139 public long timestamp() {
140 long ret = bindings.Bolt11Invoice_timestamp(this.ptr);
146 * Returns the `Bolt11Invoice`'s timestamp as a duration since the Unix epoch
148 public long duration_since_epoch() {
149 long ret = bindings.Bolt11Invoice_duration_since_epoch(this.ptr);
155 * Returns the hash to which we will receive the preimage on completion of the payment
157 public byte[] payment_hash() {
158 byte[] ret = bindings.Bolt11Invoice_payment_hash(this.ptr);
164 * Get the payee's public key if one was included in the invoice
166 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
168 public byte[] payee_pub_key() {
169 byte[] ret = bindings.Bolt11Invoice_payee_pub_key(this.ptr);
175 * Get the payment secret if one was included in the invoice
177 public byte[] payment_secret() {
178 byte[] ret = bindings.Bolt11Invoice_payment_secret(this.ptr);
184 * Get the payment metadata blob if one was included in the invoice
186 public Option_CVec_u8ZZ payment_metadata() {
187 long ret = bindings.Bolt11Invoice_payment_metadata(this.ptr);
189 if (ret >= 0 && ret <= 4096) { return null; }
190 org.ldk.structs.Option_CVec_u8ZZ ret_hu_conv = org.ldk.structs.Option_CVec_u8ZZ.constr_from_ptr(ret);
191 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
196 * Get the invoice features if they were included in the invoice
198 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
200 public Bolt11InvoiceFeatures features() {
201 long ret = bindings.Bolt11Invoice_features(this.ptr);
203 if (ret >= 0 && ret <= 4096) { return null; }
204 org.ldk.structs.Bolt11InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Bolt11InvoiceFeatures(null, ret); }
205 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
210 * Recover the payee's public key (only to be used if none was included in the invoice)
212 public byte[] recover_payee_pub_key() {
213 byte[] ret = bindings.Bolt11Invoice_recover_payee_pub_key(this.ptr);
219 * Returns the Duration since the Unix epoch at which the invoice expires.
220 * Returning None if overflow occurred.
222 public Option_DurationZ expires_at() {
223 long ret = bindings.Bolt11Invoice_expires_at(this.ptr);
225 if (ret >= 0 && ret <= 4096) { return null; }
226 org.ldk.structs.Option_DurationZ ret_hu_conv = org.ldk.structs.Option_DurationZ.constr_from_ptr(ret);
227 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
232 * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
234 public long expiry_time() {
235 long ret = bindings.Bolt11Invoice_expiry_time(this.ptr);
241 * Returns whether the invoice has expired.
243 public bool is_expired() {
244 bool ret = bindings.Bolt11Invoice_is_expired(this.ptr);
250 * Returns the Duration remaining until the invoice expires.
252 public long duration_until_expiry() {
253 long ret = bindings.Bolt11Invoice_duration_until_expiry(this.ptr);
259 * Returns the Duration remaining until the invoice expires given the current time.
260 * `time` is the timestamp as a duration since the Unix epoch.
262 public long expiration_remaining_from_epoch(long time) {
263 long ret = bindings.Bolt11Invoice_expiration_remaining_from_epoch(this.ptr, time);
270 * Returns whether the expiry time would pass at the given point in time.
271 * `at_time` is the timestamp as a duration since the Unix epoch.
273 public bool would_expire(long at_time) {
274 bool ret = bindings.Bolt11Invoice_would_expire(this.ptr, at_time);
276 GC.KeepAlive(at_time);
281 * Returns the invoice's `min_final_cltv_expiry_delta` time, if present, otherwise
282 * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA`].
284 public long min_final_cltv_expiry_delta() {
285 long ret = bindings.Bolt11Invoice_min_final_cltv_expiry_delta(this.ptr);
291 * Returns a list of all fallback addresses as [`Address`]es
293 public string[] fallback_addresses() {
294 string[] ret = bindings.Bolt11Invoice_fallback_addresses(this.ptr);
300 * Returns a list of all routes included in the invoice
302 public PrivateRoute[] private_routes() {
303 long[] ret = bindings.Bolt11Invoice_private_routes(this.ptr);
305 int ret_conv_14_len = ret.Length;
306 PrivateRoute[] ret_conv_14_arr = new PrivateRoute[ret_conv_14_len];
307 for (int o = 0; o < ret_conv_14_len; o++) {
308 long ret_conv_14 = ret[o];
309 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); }
310 if (ret_conv_14_hu_conv != null) { ret_conv_14_hu_conv.ptrs_to.AddLast(this); };
311 ret_conv_14_arr[o] = ret_conv_14_hu_conv;
313 return ret_conv_14_arr;
317 * Returns a list of all routes included in the invoice as the underlying hints
319 public RouteHint[] route_hints() {
320 long[] ret = bindings.Bolt11Invoice_route_hints(this.ptr);
322 int ret_conv_11_len = ret.Length;
323 RouteHint[] ret_conv_11_arr = new RouteHint[ret_conv_11_len];
324 for (int l = 0; l < ret_conv_11_len; l++) {
325 long ret_conv_11 = ret[l];
326 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); }
327 if (ret_conv_11_hu_conv != null) { ret_conv_11_hu_conv.ptrs_to.AddLast(this); };
328 ret_conv_11_arr[l] = ret_conv_11_hu_conv;
330 return ret_conv_11_arr;
334 * Returns the currency for which the invoice was issued
336 public Currency currency() {
337 Currency ret = bindings.Bolt11Invoice_currency(this.ptr);
343 * Returns the amount if specified in the invoice as millisatoshis.
345 public Option_u64Z amount_milli_satoshis() {
346 long ret = bindings.Bolt11Invoice_amount_milli_satoshis(this.ptr);
348 if (ret >= 0 && ret <= 4096) { return null; }
349 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
350 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
355 * Read a Bolt11Invoice object from a string
357 public static Result_Bolt11InvoiceParseOrSemanticErrorZ from_str(string s) {
358 long ret = bindings.Bolt11Invoice_from_str(s);
360 if (ret >= 0 && ret <= 4096) { return null; }
361 Result_Bolt11InvoiceParseOrSemanticErrorZ ret_hu_conv = Result_Bolt11InvoiceParseOrSemanticErrorZ.constr_from_ptr(ret);
366 * Get the string representation of a Bolt11Invoice object
368 public string to_str() {
369 string ret = bindings.Bolt11Invoice_to_str(this.ptr);