[Java] Update auto-generated bindings to 0.0.115
[ldk-java] / src / main / java / org / ldk / structs / PaymentParameters.java
index 7baa07cea7dee2a3e964e88f09920ac9b42451ff..d341d248099da924e3adf57fdc4d37648dab2093 100644 (file)
@@ -53,8 +53,8 @@ public class PaymentParameters extends CommonBase {
                long ret = bindings.PaymentParameters_get_features(this.ptr);
                Reference.reachabilityFence(this);
                if (ret >= 0 && ret <= 4096) { return null; }
-               InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new InvoiceFeatures(null, ret); }
-               ret_hu_conv.ptrs_to.add(this);
+               org.ldk.structs.InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InvoiceFeatures(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
@@ -68,36 +68,33 @@ public class PaymentParameters extends CommonBase {
         * 
         * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
         */
-       public void set_features(@Nullable InvoiceFeatures val) {
-               bindings.PaymentParameters_set_features(this.ptr, val == null ? 0 : val.ptr & ~1);
+       public void set_features(@Nullable org.ldk.structs.InvoiceFeatures val) {
+               bindings.PaymentParameters_set_features(this.ptr, val == null ? 0 : val.ptr);
                Reference.reachabilityFence(this);
                Reference.reachabilityFence(val);
+               if (this != null) { this.ptrs_to.add(val); };
        }
 
        /**
         * Hints for routing to the payee, containing channels connecting the payee to public nodes.
         */
-       public RouteHint[] get_route_hints() {
-               long[] ret = bindings.PaymentParameters_get_route_hints(this.ptr);
+       public Hints get_route_hints() {
+               long ret = bindings.PaymentParameters_get_route_hints(this.ptr);
                Reference.reachabilityFence(this);
-               int ret_conv_11_len = ret.length;
-               RouteHint[] ret_conv_11_arr = new RouteHint[ret_conv_11_len];
-               for (int l = 0; l < ret_conv_11_len; l++) {
-                       long ret_conv_11 = ret[l];
-                       RouteHint ret_conv_11_hu_conv = null; if (ret_conv_11 < 0 || ret_conv_11 > 4096) { ret_conv_11_hu_conv = new RouteHint(null, ret_conv_11); }
-                       ret_conv_11_hu_conv.ptrs_to.add(this);
-                       ret_conv_11_arr[l] = ret_conv_11_hu_conv;
-               }
-               return ret_conv_11_arr;
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.Hints ret_hu_conv = org.ldk.structs.Hints.constr_from_ptr(ret);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+               return ret_hu_conv;
        }
 
        /**
         * Hints for routing to the payee, containing channels connecting the payee to public nodes.
         */
-       public void set_route_hints(RouteHint[] val) {
-               bindings.PaymentParameters_set_route_hints(this.ptr, val != null ? Arrays.stream(val).mapToLong(val_conv_11 -> val_conv_11 == null ? 0 : val_conv_11.ptr & ~1).toArray() : null);
+       public void set_route_hints(org.ldk.structs.Hints val) {
+               bindings.PaymentParameters_set_route_hints(this.ptr, val.ptr);
                Reference.reachabilityFence(this);
                Reference.reachabilityFence(val);
+               if (this != null) { this.ptrs_to.add(val); };
        }
 
        /**
@@ -108,21 +105,23 @@ public class PaymentParameters extends CommonBase {
                Reference.reachabilityFence(this);
                if (ret >= 0 && ret <= 4096) { return null; }
                org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
-               ret_hu_conv.ptrs_to.add(this);
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
        /**
         * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
         */
-       public void set_expiry_time(Option_u64Z val) {
+       public void set_expiry_time(org.ldk.structs.Option_u64Z val) {
                bindings.PaymentParameters_set_expiry_time(this.ptr, val.ptr);
                Reference.reachabilityFence(this);
                Reference.reachabilityFence(val);
+               if (this != null) { this.ptrs_to.add(val); };
        }
 
        /**
         * The maximum total CLTV delta we accept for the route.
+        * Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
         */
        public int get_max_total_cltv_expiry_delta() {
                int ret = bindings.PaymentParameters_get_max_total_cltv_expiry_delta(this.ptr);
@@ -132,6 +131,7 @@ public class PaymentParameters extends CommonBase {
 
        /**
         * The maximum total CLTV delta we accept for the route.
+        * Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
         */
        public void set_max_total_cltv_expiry_delta(int val) {
                bindings.PaymentParameters_set_max_total_cltv_expiry_delta(this.ptr, val);
@@ -139,19 +139,130 @@ public class PaymentParameters extends CommonBase {
                Reference.reachabilityFence(val);
        }
 
+       /**
+        * The maximum number of paths that may be used by (MPP) payments.
+        * Defaults to [`DEFAULT_MAX_PATH_COUNT`].
+        */
+       public byte get_max_path_count() {
+               byte ret = bindings.PaymentParameters_get_max_path_count(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * The maximum number of paths that may be used by (MPP) payments.
+        * Defaults to [`DEFAULT_MAX_PATH_COUNT`].
+        */
+       public void set_max_path_count(byte val) {
+               bindings.PaymentParameters_set_max_path_count(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
+       }
+
+       /**
+        * Selects the maximum share of a channel's total capacity which will be sent over a channel,
+        * as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
+        * a lower value prefers to send larger MPP parts, potentially saturating channels and
+        * increasing failure probability for those paths.
+        * 
+        * Note that this restriction will be relaxed during pathfinding after paths which meet this
+        * restriction have been found. While paths which meet this criteria will be searched for, it
+        * is ultimately up to the scorer to select them over other paths.
+        * 
+        * A value of 0 will allow payments up to and including a channel's total announced usable
+        * capacity, a value of one will only use up to half its capacity, two 1/4, etc.
+        * 
+        * Default value: 2
+        */
+       public byte get_max_channel_saturation_power_of_half() {
+               byte ret = bindings.PaymentParameters_get_max_channel_saturation_power_of_half(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * Selects the maximum share of a channel's total capacity which will be sent over a channel,
+        * as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
+        * a lower value prefers to send larger MPP parts, potentially saturating channels and
+        * increasing failure probability for those paths.
+        * 
+        * Note that this restriction will be relaxed during pathfinding after paths which meet this
+        * restriction have been found. While paths which meet this criteria will be searched for, it
+        * is ultimately up to the scorer to select them over other paths.
+        * 
+        * A value of 0 will allow payments up to and including a channel's total announced usable
+        * capacity, a value of one will only use up to half its capacity, two 1/4, etc.
+        * 
+        * Default value: 2
+        */
+       public void set_max_channel_saturation_power_of_half(byte val) {
+               bindings.PaymentParameters_set_max_channel_saturation_power_of_half(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
+       }
+
+       /**
+        * A list of SCIDs which this payment was previously attempted over and which caused the
+        * payment to fail. Future attempts for the same payment shouldn't be relayed through any of
+        * these SCIDs.
+        * 
+        * Returns a copy of the field.
+        */
+       public long[] get_previously_failed_channels() {
+               long[] ret = bindings.PaymentParameters_get_previously_failed_channels(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * A list of SCIDs which this payment was previously attempted over and which caused the
+        * payment to fail. Future attempts for the same payment shouldn't be relayed through any of
+        * these SCIDs.
+        */
+       public void set_previously_failed_channels(long[] val) {
+               bindings.PaymentParameters_set_previously_failed_channels(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
+       }
+
+       /**
+        * The minimum CLTV delta at the end of the route. This value must not be zero.
+        */
+       public int get_final_cltv_expiry_delta() {
+               int ret = bindings.PaymentParameters_get_final_cltv_expiry_delta(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * The minimum CLTV delta at the end of the route. This value must not be zero.
+        */
+       public void set_final_cltv_expiry_delta(int val) {
+               bindings.PaymentParameters_set_final_cltv_expiry_delta(this.ptr, val);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
+       }
+
        /**
         * Constructs a new PaymentParameters given each field
         */
-       public static PaymentParameters of(byte[] payee_pubkey_arg, InvoiceFeatures features_arg, RouteHint[] route_hints_arg, Option_u64Z expiry_time_arg, int max_total_cltv_expiry_delta_arg) {
-               long ret = bindings.PaymentParameters_new(InternalUtils.check_arr_len(payee_pubkey_arg, 33), features_arg == null ? 0 : features_arg.ptr & ~1, route_hints_arg != null ? Arrays.stream(route_hints_arg).mapToLong(route_hints_arg_conv_11 -> route_hints_arg_conv_11 == null ? 0 : route_hints_arg_conv_11.ptr & ~1).toArray() : null, expiry_time_arg.ptr, max_total_cltv_expiry_delta_arg);
+       public static PaymentParameters of(byte[] payee_pubkey_arg, org.ldk.structs.InvoiceFeatures features_arg, org.ldk.structs.Hints route_hints_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, int final_cltv_expiry_delta_arg) {
+               long ret = bindings.PaymentParameters_new(InternalUtils.check_arr_len(payee_pubkey_arg, 33), features_arg == null ? 0 : features_arg.ptr, route_hints_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, final_cltv_expiry_delta_arg);
                Reference.reachabilityFence(payee_pubkey_arg);
                Reference.reachabilityFence(features_arg);
                Reference.reachabilityFence(route_hints_arg);
                Reference.reachabilityFence(expiry_time_arg);
                Reference.reachabilityFence(max_total_cltv_expiry_delta_arg);
+               Reference.reachabilityFence(max_path_count_arg);
+               Reference.reachabilityFence(max_channel_saturation_power_of_half_arg);
+               Reference.reachabilityFence(previously_failed_channels_arg);
+               Reference.reachabilityFence(final_cltv_expiry_delta_arg);
                if (ret >= 0 && ret <= 4096) { return null; }
-               PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new PaymentParameters(null, ret); }
-               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(features_arg); };
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(route_hints_arg); };
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(expiry_time_arg); };
                return ret_hu_conv;
        }
 
@@ -168,13 +279,13 @@ public class PaymentParameters extends CommonBase {
                long ret = bindings.PaymentParameters_clone(this.ptr);
                Reference.reachabilityFence(this);
                if (ret >= 0 && ret <= 4096) { return null; }
-               PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new PaymentParameters(null, ret); }
-               ret_hu_conv.ptrs_to.add(this);
+               org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
                return ret_hu_conv;
        }
 
        /**
-        * Checks if two PaymentParameterss contain equal inner contents.
+        * Generates a non-cryptographic 64-bit hash of the PaymentParameters.
         */
        public long hash() {
                long ret = bindings.PaymentParameters_hash(this.ptr);
@@ -190,11 +301,11 @@ public class PaymentParameters extends CommonBase {
         * This ignores pointers and is_owned flags and looks at the values in fields.
         * Two objects with NULL inner values will be considered "equal" here.
         */
-       public boolean eq(PaymentParameters b) {
-               boolean ret = bindings.PaymentParameters_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
+       public boolean eq(org.ldk.structs.PaymentParameters b) {
+               boolean ret = bindings.PaymentParameters_eq(this.ptr, b == null ? 0 : b.ptr);
                Reference.reachabilityFence(this);
                Reference.reachabilityFence(b);
-               this.ptrs_to.add(b);
+               if (this != null) { this.ptrs_to.add(b); };
                return ret;
        }
 
@@ -214,9 +325,10 @@ public class PaymentParameters extends CommonBase {
        /**
         * Read a PaymentParameters from a byte array, created by PaymentParameters_write
         */
-       public static Result_PaymentParametersDecodeErrorZ read(byte[] ser) {
-               long ret = bindings.PaymentParameters_read(ser);
+       public static Result_PaymentParametersDecodeErrorZ read(byte[] ser, int arg) {
+               long ret = bindings.PaymentParameters_read(ser, arg);
                Reference.reachabilityFence(ser);
+               Reference.reachabilityFence(arg);
                if (ret >= 0 && ret <= 4096) { return null; }
                Result_PaymentParametersDecodeErrorZ ret_hu_conv = Result_PaymentParametersDecodeErrorZ.constr_from_ptr(ret);
                return ret_hu_conv;
@@ -224,25 +336,33 @@ public class PaymentParameters extends CommonBase {
 
        /**
         * Creates a payee with the node id of the given `pubkey`.
+        * 
+        * The `final_cltv_expiry_delta` should match the expected final CLTV delta the recipient has
+        * provided.
         */
-       public static PaymentParameters from_node_id(byte[] payee_pubkey) {
-               long ret = bindings.PaymentParameters_from_node_id(InternalUtils.check_arr_len(payee_pubkey, 33));
+       public static PaymentParameters from_node_id(byte[] payee_pubkey, int final_cltv_expiry_delta) {
+               long ret = bindings.PaymentParameters_from_node_id(InternalUtils.check_arr_len(payee_pubkey, 33), final_cltv_expiry_delta);
                Reference.reachabilityFence(payee_pubkey);
+               Reference.reachabilityFence(final_cltv_expiry_delta);
                if (ret >= 0 && ret <= 4096) { return null; }
-               PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new PaymentParameters(null, ret); }
-               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
                return ret_hu_conv;
        }
 
        /**
         * Creates a payee with the node id of the given `pubkey` to use for keysend payments.
+        * 
+        * The `final_cltv_expiry_delta` should match the expected final CLTV delta the recipient has
+        * provided.
         */
-       public static PaymentParameters for_keysend(byte[] payee_pubkey) {
-               long ret = bindings.PaymentParameters_for_keysend(InternalUtils.check_arr_len(payee_pubkey, 33));
+       public static PaymentParameters for_keysend(byte[] payee_pubkey, int final_cltv_expiry_delta) {
+               long ret = bindings.PaymentParameters_for_keysend(InternalUtils.check_arr_len(payee_pubkey, 33), final_cltv_expiry_delta);
                Reference.reachabilityFence(payee_pubkey);
+               Reference.reachabilityFence(final_cltv_expiry_delta);
                if (ret >= 0 && ret <= 4096) { return null; }
-               PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new PaymentParameters(null, ret); }
-               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
                return ret_hu_conv;
        }