6 namespace org { namespace ldk { namespace structs {
10 * A `Refund` is a request to send an [`Bolt12Invoice`] without a preceding [`Offer`].
12 * Typically, after an invoice is paid, the recipient may publish a refund allowing the sender to
13 * recoup their funds. A refund may be used more generally as an \"offer for money\", such as with a
16 * [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
17 * [`Offer`]: crate::offers::offer::Offer
19 public class Refund : CommonBase {
20 internal Refund(object _dummy, long ptr) : base(ptr) { }
22 if (ptr != 0) { bindings.Refund_free(ptr); }
25 internal long clone_ptr() {
26 long ret = bindings.Refund_clone_ptr(this.ptr);
32 * Creates a copy of the Refund
34 public Refund clone() {
35 long ret = bindings.Refund_clone(this.ptr);
37 if (ret >= 0 && ret <= 4096) { return null; }
38 org.ldk.structs.Refund ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Refund(null, ret); }
39 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
44 * A complete description of the purpose of the refund. Intended to be displayed to the user
45 * but with the caveat that it has not been verified in any way.
47 public PrintableString description() {
48 long ret = bindings.Refund_description(this.ptr);
50 if (ret >= 0 && ret <= 4096) { return null; }
51 org.ldk.structs.PrintableString ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PrintableString(null, ret); }
52 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
57 * Duration since the Unix epoch when an invoice should no longer be sent.
59 * If `None`, the refund does not expire.
61 public Option_u64Z absolute_expiry() {
62 long ret = bindings.Refund_absolute_expiry(this.ptr);
64 if (ret >= 0 && ret <= 4096) { return null; }
65 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
66 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
71 * Whether the refund has expired.
73 public bool is_expired() {
74 bool ret = bindings.Refund_is_expired(this.ptr);
80 * Whether the refund has expired given the duration since the Unix epoch.
82 public bool is_expired_no_std(long duration_since_epoch) {
83 bool ret = bindings.Refund_is_expired_no_std(this.ptr, duration_since_epoch);
85 GC.KeepAlive(duration_since_epoch);
90 * The issuer of the refund, possibly beginning with `user@domain` or `domain`. Intended to be
91 * displayed to the user but with the caveat that it has not been verified in any way.
93 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
95 public PrintableString issuer() {
96 long ret = bindings.Refund_issuer(this.ptr);
98 if (ret >= 0 && ret <= 4096) { return null; }
99 org.ldk.structs.PrintableString ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PrintableString(null, ret); }
100 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
105 * Paths to the sender originating from publicly reachable nodes. Blinded paths provide sender
106 * privacy by obfuscating its node id.
108 public BlindedPath[] paths() {
109 long ret = bindings.Refund_paths(this.ptr);
111 if (ret >= 0 && ret <= 4096) { return null; }
112 int ret_conv_13_len = InternalUtils.getArrayLength(ret);
113 BlindedPath[] ret_conv_13_arr = new BlindedPath[ret_conv_13_len];
114 for (int n = 0; n < ret_conv_13_len; n++) {
115 long ret_conv_13 = InternalUtils.getU64ArrayElem(ret, n);
116 org.ldk.structs.BlindedPath ret_conv_13_hu_conv = null; if (ret_conv_13 < 0 || ret_conv_13 > 4096) { ret_conv_13_hu_conv = new org.ldk.structs.BlindedPath(null, ret_conv_13); }
117 if (ret_conv_13_hu_conv != null) { ret_conv_13_hu_conv.ptrs_to.AddLast(this); };
118 ret_conv_13_arr[n] = ret_conv_13_hu_conv;
120 bindings.free_buffer(ret);
121 return ret_conv_13_arr;
125 * An unpredictable series of bytes, typically containing information about the derivation of
128 * [`payer_id`]: Self::payer_id
130 public byte[] payer_metadata() {
131 long ret = bindings.Refund_payer_metadata(this.ptr);
133 if (ret >= 0 && ret <= 4096) { return null; }
134 byte[] ret_conv = InternalUtils.decodeUint8Array(ret);
139 * A chain that the refund is valid for.
141 public byte[] chain() {
142 long ret = bindings.Refund_chain(this.ptr);
144 if (ret >= 0 && ret <= 4096) { return null; }
145 byte[] ret_conv = InternalUtils.decodeUint8Array(ret);
150 * The amount to refund in msats (i.e., the minimum lightning-payable unit for [`chain`]).
152 * [`chain`]: Self::chain
154 public long amount_msats() {
155 long ret = bindings.Refund_amount_msats(this.ptr);
161 * Features pertaining to requesting an invoice.
163 public InvoiceRequestFeatures features() {
164 long ret = bindings.Refund_features(this.ptr);
166 if (ret >= 0 && ret <= 4096) { return null; }
167 org.ldk.structs.InvoiceRequestFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InvoiceRequestFeatures(null, ret); }
168 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
173 * The quantity of an item that refund is for.
175 public Option_u64Z quantity() {
176 long ret = bindings.Refund_quantity(this.ptr);
178 if (ret >= 0 && ret <= 4096) { return null; }
179 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
180 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
185 * A public node id to send to in the case where there are no [`paths`]. Otherwise, a possibly
188 * [`paths`]: Self::paths
190 public byte[] payer_id() {
191 long ret = bindings.Refund_payer_id(this.ptr);
193 if (ret >= 0 && ret <= 4096) { return null; }
194 byte[] ret_conv = InternalUtils.decodeUint8Array(ret);
199 * Payer provided note to include in the invoice.
201 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
203 public PrintableString payer_note() {
204 long ret = bindings.Refund_payer_note(this.ptr);
206 if (ret >= 0 && ret <= 4096) { return null; }
207 org.ldk.structs.PrintableString ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PrintableString(null, ret); }
208 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
213 * Generates a non-cryptographic 64-bit hash of the Refund.
216 long ret = bindings.Refund_hash(this.ptr);
221 public override int GetHashCode() {
222 return (int)this.hash();
225 * Serialize the Refund object into a byte array which can be read by Refund_read
227 public byte[] write() {
228 long ret = bindings.Refund_write(this.ptr);
230 if (ret >= 0 && ret <= 4096) { return null; }
231 byte[] ret_conv = InternalUtils.decodeUint8Array(ret);
236 * Read a Refund object from a string
238 public static Result_RefundBolt12ParseErrorZ from_str(string s) {
239 long ret = bindings.Refund_from_str(InternalUtils.encodeString(s));
241 if (ret >= 0 && ret <= 4096) { return null; }
242 Result_RefundBolt12ParseErrorZ ret_hu_conv = Result_RefundBolt12ParseErrorZ.constr_from_ptr(ret);
247 * Get the string representation of a Refund object
249 public string to_str() {
250 long ret = bindings.Refund_to_str(this.ptr);
252 if (ret >= 0 && ret <= 4096) { return null; }
253 string ret_conv = InternalUtils.decodeString(ret);