_ Git - ldk-java/blob - c_sharp/src/org/ldk/structs/PaymentParameters.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  * Information used to route a payment.
  11  */
  12 public class PaymentParameters : CommonBase {
  13         internal PaymentParameters(object _dummy, long ptr) : base(ptr) { }
  14         ~PaymentParameters() {
  15                 if (ptr != 0) { bindings.PaymentParameters_free(ptr); }
  16         }
  17
  18         /**
  19          * Information about the payee, such as their features and route hints for their channels.
  20          */
  21         public Payee get_payee() {
  22                 long ret = bindings.PaymentParameters_get_payee(this.ptr);
  23                 GC.KeepAlive(this);
  24                 if (ret >= 0 && ret <= 4096) { return null; }
  25                 org.ldk.structs.Payee ret_hu_conv = org.ldk.structs.Payee.constr_from_ptr(ret);
  26                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
  27                 return ret_hu_conv;
  28         }
  29
  30         /**
  31          * Information about the payee, such as their features and route hints for their channels.
  32          */
  33         public void set_payee(org.ldk.structs.Payee val) {
  34                 bindings.PaymentParameters_set_payee(this.ptr, val.ptr);
  35                 GC.KeepAlive(this);
  36                 GC.KeepAlive(val);
  37                 if (this != null) { this.ptrs_to.AddLast(val); };
  38         }
  39
  40         /**
  41          * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
  42          */
  43         public Option_u64Z get_expiry_time() {
  44                 long ret = bindings.PaymentParameters_get_expiry_time(this.ptr);
  45                 GC.KeepAlive(this);
  46                 if (ret >= 0 && ret <= 4096) { return null; }
  47                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
  48                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
  49                 return ret_hu_conv;
  50         }
  51
  52         /**
  53          * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
  54          */
  55         public void set_expiry_time(org.ldk.structs.Option_u64Z val) {
  56                 bindings.PaymentParameters_set_expiry_time(this.ptr, val.ptr);
  57                 GC.KeepAlive(this);
  58                 GC.KeepAlive(val);
  59                 if (this != null) { this.ptrs_to.AddLast(val); };
  60         }
  61
  62         /**
  63          * The maximum total CLTV delta we accept for the route.
  64          * Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
  65          */
  66         public int get_max_total_cltv_expiry_delta() {
  67                 int ret = bindings.PaymentParameters_get_max_total_cltv_expiry_delta(this.ptr);
  68                 GC.KeepAlive(this);
  69                 return ret;
  70         }
  71
  72         /**
  73          * The maximum total CLTV delta we accept for the route.
  74          * Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
  75          */
  76         public void set_max_total_cltv_expiry_delta(int val) {
  77                 bindings.PaymentParameters_set_max_total_cltv_expiry_delta(this.ptr, val);
  78                 GC.KeepAlive(this);
  79                 GC.KeepAlive(val);
  80         }
  81
  82         /**
  83          * The maximum number of paths that may be used by (MPP) payments.
  84          * Defaults to [`DEFAULT_MAX_PATH_COUNT`].
  85          */
  86         public byte get_max_path_count() {
  87                 byte ret = bindings.PaymentParameters_get_max_path_count(this.ptr);
  88                 GC.KeepAlive(this);
  89                 return ret;
  90         }
  91
  92         /**
  93          * The maximum number of paths that may be used by (MPP) payments.
  94          * Defaults to [`DEFAULT_MAX_PATH_COUNT`].
  95          */
  96         public void set_max_path_count(byte val) {
  97                 bindings.PaymentParameters_set_max_path_count(this.ptr, val);
  98                 GC.KeepAlive(this);
  99                 GC.KeepAlive(val);
 100         }
 101
 102         /**
 103          * Selects the maximum share of a channel's total capacity which will be sent over a channel,
 104          * as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
 105          * a lower value prefers to send larger MPP parts, potentially saturating channels and
 106          * increasing failure probability for those paths.
 107          *
 108          * Note that this restriction will be relaxed during pathfinding after paths which meet this
 109          * restriction have been found. While paths which meet this criteria will be searched for, it
 110          * is ultimately up to the scorer to select them over other paths.
 111          *
 112          * A value of 0 will allow payments up to and including a channel's total announced usable
 113          * capacity, a value of one will only use up to half its capacity, two 1/4, etc.
 114          *
 115          * Default value: 2
 116          */
 117         public byte get_max_channel_saturation_power_of_half() {
 118                 byte ret = bindings.PaymentParameters_get_max_channel_saturation_power_of_half(this.ptr);
 119                 GC.KeepAlive(this);
 120                 return ret;
 121         }
 122
 123         /**
 124          * Selects the maximum share of a channel's total capacity which will be sent over a channel,
 125          * as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
 126          * a lower value prefers to send larger MPP parts, potentially saturating channels and
 127          * increasing failure probability for those paths.
 128          *
 129          * Note that this restriction will be relaxed during pathfinding after paths which meet this
 130          * restriction have been found. While paths which meet this criteria will be searched for, it
 131          * is ultimately up to the scorer to select them over other paths.
 132          *
 133          * A value of 0 will allow payments up to and including a channel's total announced usable
 134          * capacity, a value of one will only use up to half its capacity, two 1/4, etc.
 135          *
 136          * Default value: 2
 137          */
 138         public void set_max_channel_saturation_power_of_half(byte val) {
 139                 bindings.PaymentParameters_set_max_channel_saturation_power_of_half(this.ptr, val);
 140                 GC.KeepAlive(this);
 141                 GC.KeepAlive(val);
 142         }
 143
 144         /**
 145          * A list of SCIDs which this payment was previously attempted over and which caused the
 146          * payment to fail. Future attempts for the same payment shouldn't be relayed through any of
 147          * these SCIDs.
 148          *
 149          * Returns a copy of the field.
 150          */
 151         public long[] get_previously_failed_channels() {
 152                 long[] ret = bindings.PaymentParameters_get_previously_failed_channels(this.ptr);
 153                 GC.KeepAlive(this);
 154                 return ret;
 155         }
 156
 157         /**
 158          * A list of SCIDs which this payment was previously attempted over and which caused the
 159          * payment to fail. Future attempts for the same payment shouldn't be relayed through any of
 160          * these SCIDs.
 161          */
 162         public void set_previously_failed_channels(long[] val) {
 163                 bindings.PaymentParameters_set_previously_failed_channels(this.ptr, val);
 164                 GC.KeepAlive(this);
 165                 GC.KeepAlive(val);
 166         }
 167
 168         /**
 169          * Constructs a new PaymentParameters given each field
 170          */
 171         public static PaymentParameters of(org.ldk.structs.Payee payee_arg, org.ldk.structs.Option_u64Z expiry_time_arg, int max_total_cltv_expiry_delta_arg, byte max_path_count_arg, byte max_channel_saturation_power_of_half_arg, long[] previously_failed_channels_arg) {
 172                 long ret = bindings.PaymentParameters_new(payee_arg.ptr, expiry_time_arg.ptr, max_total_cltv_expiry_delta_arg, max_path_count_arg, max_channel_saturation_power_of_half_arg, previously_failed_channels_arg);
 173                 GC.KeepAlive(payee_arg);
 174                 GC.KeepAlive(expiry_time_arg);
 175                 GC.KeepAlive(max_total_cltv_expiry_delta_arg);
 176                 GC.KeepAlive(max_path_count_arg);
 177                 GC.KeepAlive(max_channel_saturation_power_of_half_arg);
 178                 GC.KeepAlive(previously_failed_channels_arg);
 179                 if (ret >= 0 && ret <= 4096) { return null; }
 180                 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
 181                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
 182                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(payee_arg); };
 183                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(expiry_time_arg); };
 184                 return ret_hu_conv;
 185         }
 186
 187         internal long clone_ptr() {
 188                 long ret = bindings.PaymentParameters_clone_ptr(this.ptr);
 189                 GC.KeepAlive(this);
 190                 return ret;
 191         }
 192
 193         /**
 194          * Creates a copy of the PaymentParameters
 195          */
 196         public PaymentParameters clone() {
 197                 long ret = bindings.PaymentParameters_clone(this.ptr);
 198                 GC.KeepAlive(this);
 199                 if (ret >= 0 && ret <= 4096) { return null; }
 200                 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
 201                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
 202                 return ret_hu_conv;
 203         }
 204
 205         /**
 206          * Generates a non-cryptographic 64-bit hash of the PaymentParameters.
 207          */
 208         public long hash() {
 209                 long ret = bindings.PaymentParameters_hash(this.ptr);
 210                 GC.KeepAlive(this);
 211                 return ret;
 212         }
 213
 214         public override int GetHashCode() {
 215                 return (int)this.hash();
 216         }
 217         /**
 218          * Checks if two PaymentParameterss contain equal inner contents.
 219          * This ignores pointers and is_owned flags and looks at the values in fields.
 220          * Two objects with NULL inner values will be considered "equal" here.
 221          */
 222         public bool eq(org.ldk.structs.PaymentParameters b) {
 223                 bool ret = bindings.PaymentParameters_eq(this.ptr, b == null ? 0 : b.ptr);
 224                 GC.KeepAlive(this);
 225                 GC.KeepAlive(b);
 226                 if (this != null) { this.ptrs_to.AddLast(b); };
 227                 return ret;
 228         }
 229
 230         public override bool Equals(object o) {
 231                 if (!(o is PaymentParameters)) return false;
 232                 return this.eq((PaymentParameters)o);
 233         }
 234         /**
 235          * Serialize the PaymentParameters object into a byte array which can be read by PaymentParameters_read
 236          */
 237         public byte[] write() {
 238                 byte[] ret = bindings.PaymentParameters_write(this.ptr);
 239                 GC.KeepAlive(this);
 240                 return ret;
 241         }
 242
 243         /**
 244          * Read a PaymentParameters from a byte array, created by PaymentParameters_write
 245          */
 246         public static Result_PaymentParametersDecodeErrorZ read(byte[] ser, int arg) {
 247                 long ret = bindings.PaymentParameters_read(ser, arg);
 248                 GC.KeepAlive(ser);
 249                 GC.KeepAlive(arg);
 250                 if (ret >= 0 && ret <= 4096) { return null; }
 251                 Result_PaymentParametersDecodeErrorZ ret_hu_conv = Result_PaymentParametersDecodeErrorZ.constr_from_ptr(ret);
 252                 return ret_hu_conv;
 253         }
 254
 255         /**
 256          * Creates a payee with the node id of the given `pubkey`.
 257          *
 258          * The `final_cltv_expiry_delta` should match the expected final CLTV delta the recipient has
 259          * provided.
 260          */
 261         public static PaymentParameters from_node_id(byte[] payee_pubkey, int final_cltv_expiry_delta) {
 262                 long ret = bindings.PaymentParameters_from_node_id(InternalUtils.check_arr_len(payee_pubkey, 33), final_cltv_expiry_delta);
 263                 GC.KeepAlive(payee_pubkey);
 264                 GC.KeepAlive(final_cltv_expiry_delta);
 265                 if (ret >= 0 && ret <= 4096) { return null; }
 266                 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
 267                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
 268                 return ret_hu_conv;
 269         }
 270
 271         /**
 272          * Creates a payee with the node id of the given `pubkey` to use for keysend payments.
 273          *
 274          * The `final_cltv_expiry_delta` should match the expected final CLTV delta the recipient has
 275          * provided.
 276          *
 277          * Note that MPP keysend is not widely supported yet. The `allow_mpp` lets you choose
 278          * whether your router will be allowed to find a multi-part route for this payment. If you
 279          * set `allow_mpp` to true, you should ensure a payment secret is set on send, likely via
 280          * [`RecipientOnionFields::secret_only`].
 281          *
 282          * [`RecipientOnionFields::secret_only`]: crate::ln::channelmanager::RecipientOnionFields::secret_only
 283          */
 284         public static PaymentParameters for_keysend(byte[] payee_pubkey, int final_cltv_expiry_delta, bool allow_mpp) {
 285                 long ret = bindings.PaymentParameters_for_keysend(InternalUtils.check_arr_len(payee_pubkey, 33), final_cltv_expiry_delta, allow_mpp);
 286                 GC.KeepAlive(payee_pubkey);
 287                 GC.KeepAlive(final_cltv_expiry_delta);
 288                 GC.KeepAlive(allow_mpp);
 289                 if (ret >= 0 && ret <= 4096) { return null; }
 290                 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
 291                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
 292                 return ret_hu_conv;
 293         }
 294
 295         /**
 296          * Creates parameters for paying to a blinded payee from the provided invoice. Sets
 297          * [`Payee::Blinded::route_hints`], [`Payee::Blinded::features`], and
 298          * [`PaymentParameters::expiry_time`].
 299          */
 300         public static PaymentParameters from_bolt12_invoice(org.ldk.structs.Bolt12Invoice invoice) {
 301                 long ret = bindings.PaymentParameters_from_bolt12_invoice(invoice == null ? 0 : invoice.ptr);
 302                 GC.KeepAlive(invoice);
 303                 if (ret >= 0 && ret <= 4096) { return null; }
 304                 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
 305                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
 306                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(invoice); };
 307                 return ret_hu_conv;
 308         }
 309
 310 }
 311 } } }