_ Git - ldk-java/blob - c_sharp/src/org/ldk/structs/Refund.cs

   1 using org.ldk.impl;
   2 using org.ldk.enums;
   3 using org.ldk.util;
   4 using System;
   5
   6 namespace org { namespace ldk { namespace structs {
   7
   8
   9 /**
  10  * A `Refund` is a request to send an [`Bolt12Invoice`] without a preceding [`Offer`].
  11  *
  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
  14  * bitcoin ATM.
  15  *
  16  * [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
  17  * [`Offer`]: crate::offers::offer::Offer
  18  */
  19 public class Refund : CommonBase {
  20         internal Refund(object _dummy, long ptr) : base(ptr) { }
  21         ~Refund() {
  22                 if (ptr != 0) { bindings.Refund_free(ptr); }
  23         }
  24
  25         internal long clone_ptr() {
  26                 long ret = bindings.Refund_clone_ptr(this.ptr);
  27                 GC.KeepAlive(this);
  28                 return ret;
  29         }
  30
  31         /**
  32          * Creates a copy of the Refund
  33          */
  34         public Refund clone() {
  35                 long ret = bindings.Refund_clone(this.ptr);
  36                 GC.KeepAlive(this);
  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); };
  40                 return ret_hu_conv;
  41         }
  42
  43         /**
  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.
  46          */
  47         public PrintableString description() {
  48                 long ret = bindings.Refund_description(this.ptr);
  49                 GC.KeepAlive(this);
  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); };
  53                 return ret_hu_conv;
  54         }
  55
  56         /**
  57          * Duration since the Unix epoch when an invoice should no longer be sent.
  58          *
  59          * If `None`, the refund does not expire.
  60          */
  61         public Option_DurationZ absolute_expiry() {
  62                 long ret = bindings.Refund_absolute_expiry(this.ptr);
  63                 GC.KeepAlive(this);
  64                 if (ret >= 0 && ret <= 4096) { return null; }
  65                 org.ldk.structs.Option_DurationZ ret_hu_conv = org.ldk.structs.Option_DurationZ.constr_from_ptr(ret);
  66                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
  67                 return ret_hu_conv;
  68         }
  69
  70         /**
  71          * Whether the refund has expired.
  72          */
  73         public bool is_expired() {
  74                 bool ret = bindings.Refund_is_expired(this.ptr);
  75                 GC.KeepAlive(this);
  76                 return ret;
  77         }
  78
  79         /**
  80          * The issuer of the refund, possibly beginning with `user@domain` or `domain`. Intended to be
  81          * displayed to the user but with the caveat that it has not been verified in any way.
  82          *
  83          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
  84          */
  85         public PrintableString issuer() {
  86                 long ret = bindings.Refund_issuer(this.ptr);
  87                 GC.KeepAlive(this);
  88                 if (ret >= 0 && ret <= 4096) { return null; }
  89                 org.ldk.structs.PrintableString ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PrintableString(null, ret); }
  90                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
  91                 return ret_hu_conv;
  92         }
  93
  94         /**
  95          * Paths to the sender originating from publicly reachable nodes. Blinded paths provide sender
  96          * privacy by obfuscating its node id.
  97          */
  98         public BlindedPath[] paths() {
  99                 long[] ret = bindings.Refund_paths(this.ptr);
 100                 GC.KeepAlive(this);
 101                 int ret_conv_13_len = ret.Length;
 102                 BlindedPath[] ret_conv_13_arr = new BlindedPath[ret_conv_13_len];
 103                 for (int n = 0; n < ret_conv_13_len; n++) {
 104                         long ret_conv_13 = ret[n];
 105                         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); }
 106                         if (ret_conv_13_hu_conv != null) { ret_conv_13_hu_conv.ptrs_to.AddLast(this); };
 107                         ret_conv_13_arr[n] = ret_conv_13_hu_conv;
 108                 }
 109                 return ret_conv_13_arr;
 110         }
 111
 112         /**
 113          * An unpredictable series of bytes, typically containing information about the derivation of
 114          * [`payer_id`].
 115          *
 116          * [`payer_id`]: Self::payer_id
 117          */
 118         public byte[] metadata() {
 119                 byte[] ret = bindings.Refund_metadata(this.ptr);
 120                 GC.KeepAlive(this);
 121                 return ret;
 122         }
 123
 124         /**
 125          * A chain that the refund is valid for.
 126          */
 127         public byte[] chain() {
 128                 byte[] ret = bindings.Refund_chain(this.ptr);
 129                 GC.KeepAlive(this);
 130                 return ret;
 131         }
 132
 133         /**
 134          * The amount to refund in msats (i.e., the minimum lightning-payable unit for [`chain`]).
 135          *
 136          * [`chain`]: Self::chain
 137          */
 138         public long amount_msats() {
 139                 long ret = bindings.Refund_amount_msats(this.ptr);
 140                 GC.KeepAlive(this);
 141                 return ret;
 142         }
 143
 144         /**
 145          * Features pertaining to requesting an invoice.
 146          */
 147         public InvoiceRequestFeatures features() {
 148                 long ret = bindings.Refund_features(this.ptr);
 149                 GC.KeepAlive(this);
 150                 if (ret >= 0 && ret <= 4096) { return null; }
 151                 org.ldk.structs.InvoiceRequestFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InvoiceRequestFeatures(null, ret); }
 152                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
 153                 return ret_hu_conv;
 154         }
 155
 156         /**
 157          * The quantity of an item that refund is for.
 158          */
 159         public Option_u64Z quantity() {
 160                 long ret = bindings.Refund_quantity(this.ptr);
 161                 GC.KeepAlive(this);
 162                 if (ret >= 0 && ret <= 4096) { return null; }
 163                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
 164                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
 165                 return ret_hu_conv;
 166         }
 167
 168         /**
 169          * A public node id to send to in the case where there are no [`paths`]. Otherwise, a possibly
 170          * transient pubkey.
 171          *
 172          * [`paths`]: Self::paths
 173          */
 174         public byte[] payer_id() {
 175                 byte[] ret = bindings.Refund_payer_id(this.ptr);
 176                 GC.KeepAlive(this);
 177                 return ret;
 178         }
 179
 180         /**
 181          * Payer provided note to include in the invoice.
 182          *
 183          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 184          */
 185         public PrintableString payer_note() {
 186                 long ret = bindings.Refund_payer_note(this.ptr);
 187                 GC.KeepAlive(this);
 188                 if (ret >= 0 && ret <= 4096) { return null; }
 189                 org.ldk.structs.PrintableString ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PrintableString(null, ret); }
 190                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
 191                 return ret_hu_conv;
 192         }
 193
 194         /**
 195          * Serialize the Refund object into a byte array which can be read by Refund_read
 196          */
 197         public byte[] write() {
 198                 byte[] ret = bindings.Refund_write(this.ptr);
 199                 GC.KeepAlive(this);
 200                 return ret;
 201         }
 202
 203         /**
 204          * Read a Refund object from a string
 205          */
 206         public static Result_RefundBolt12ParseErrorZ from_str(string s) {
 207                 long ret = bindings.Refund_from_str(s);
 208                 GC.KeepAlive(s);
 209                 if (ret >= 0 && ret <= 4096) { return null; }
 210                 Result_RefundBolt12ParseErrorZ ret_hu_conv = Result_RefundBolt12ParseErrorZ.constr_from_ptr(ret);
 211                 return ret_hu_conv;
 212         }
 213
 214 }
 215 } } }