1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * The recipient of a payment.
14 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
15 public class PaymentParameters extends CommonBase {
16 PaymentParameters(Object _dummy, long ptr) { super(ptr); }
17 @Override @SuppressWarnings("deprecation")
18 protected void finalize() throws Throwable {
20 if (ptr != 0) { bindings.PaymentParameters_free(ptr); }
24 * The node id of the payee.
26 public byte[] get_payee_pubkey() {
27 byte[] ret = bindings.PaymentParameters_get_payee_pubkey(this.ptr);
28 Reference.reachabilityFence(this);
33 * The node id of the payee.
35 public void set_payee_pubkey(byte[] val) {
36 bindings.PaymentParameters_set_payee_pubkey(this.ptr, InternalUtils.check_arr_len(val, 33));
37 Reference.reachabilityFence(this);
38 Reference.reachabilityFence(val);
42 * Features supported by the payee.
44 * May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
45 * does not contain any features.
47 * [`for_keysend`]: Self::for_keysend
49 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
52 public InvoiceFeatures get_features() {
53 long ret = bindings.PaymentParameters_get_features(this.ptr);
54 Reference.reachabilityFence(this);
55 if (ret >= 0 && ret <= 4096) { return null; }
56 org.ldk.structs.InvoiceFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InvoiceFeatures(null, ret); }
57 ret_hu_conv.ptrs_to.add(this);
62 * Features supported by the payee.
64 * May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
65 * does not contain any features.
67 * [`for_keysend`]: Self::for_keysend
69 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
71 public void set_features(@Nullable InvoiceFeatures val) {
72 bindings.PaymentParameters_set_features(this.ptr, val == null ? 0 : val.ptr & ~1);
73 Reference.reachabilityFence(this);
74 Reference.reachabilityFence(val);
78 * Hints for routing to the payee, containing channels connecting the payee to public nodes.
80 public RouteHint[] get_route_hints() {
81 long[] ret = bindings.PaymentParameters_get_route_hints(this.ptr);
82 Reference.reachabilityFence(this);
83 int ret_conv_11_len = ret.length;
84 RouteHint[] ret_conv_11_arr = new RouteHint[ret_conv_11_len];
85 for (int l = 0; l < ret_conv_11_len; l++) {
86 long ret_conv_11 = ret[l];
87 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); }
88 ret_conv_11_hu_conv.ptrs_to.add(this);
89 ret_conv_11_arr[l] = ret_conv_11_hu_conv;
91 return ret_conv_11_arr;
95 * Hints for routing to the payee, containing channels connecting the payee to public nodes.
97 public void set_route_hints(RouteHint[] val) {
98 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);
99 Reference.reachabilityFence(this);
100 Reference.reachabilityFence(val);
104 * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
106 public Option_u64Z get_expiry_time() {
107 long ret = bindings.PaymentParameters_get_expiry_time(this.ptr);
108 Reference.reachabilityFence(this);
109 if (ret >= 0 && ret <= 4096) { return null; }
110 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
111 ret_hu_conv.ptrs_to.add(this);
116 * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
118 public void set_expiry_time(Option_u64Z val) {
119 bindings.PaymentParameters_set_expiry_time(this.ptr, val.ptr);
120 Reference.reachabilityFence(this);
121 Reference.reachabilityFence(val);
125 * The maximum total CLTV delta we accept for the route.
126 * Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
128 public int get_max_total_cltv_expiry_delta() {
129 int ret = bindings.PaymentParameters_get_max_total_cltv_expiry_delta(this.ptr);
130 Reference.reachabilityFence(this);
135 * The maximum total CLTV delta we accept for the route.
136 * Defaults to [`DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA`].
138 public void set_max_total_cltv_expiry_delta(int val) {
139 bindings.PaymentParameters_set_max_total_cltv_expiry_delta(this.ptr, val);
140 Reference.reachabilityFence(this);
141 Reference.reachabilityFence(val);
145 * The maximum number of paths that may be used by (MPP) payments.
146 * Defaults to [`DEFAULT_MAX_PATH_COUNT`].
148 public byte get_max_path_count() {
149 byte ret = bindings.PaymentParameters_get_max_path_count(this.ptr);
150 Reference.reachabilityFence(this);
155 * The maximum number of paths that may be used by (MPP) payments.
156 * Defaults to [`DEFAULT_MAX_PATH_COUNT`].
158 public void set_max_path_count(byte val) {
159 bindings.PaymentParameters_set_max_path_count(this.ptr, val);
160 Reference.reachabilityFence(this);
161 Reference.reachabilityFence(val);
165 * Selects the maximum share of a channel's total capacity which will be sent over a channel,
166 * as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
167 * a lower value prefers to send larger MPP parts, potentially saturating channels and
168 * increasing failure probability for those paths.
170 * Note that this restriction will be relaxed during pathfinding after paths which meet this
171 * restriction have been found. While paths which meet this criteria will be searched for, it
172 * is ultimately up to the scorer to select them over other paths.
174 * A value of 0 will allow payments up to and including a channel's total announced usable
175 * capacity, a value of one will only use up to half its capacity, two 1/4, etc.
179 public byte get_max_channel_saturation_power_of_half() {
180 byte ret = bindings.PaymentParameters_get_max_channel_saturation_power_of_half(this.ptr);
181 Reference.reachabilityFence(this);
186 * Selects the maximum share of a channel's total capacity which will be sent over a channel,
187 * as a power of 1/2. A higher value prefers to send the payment using more MPP parts whereas
188 * a lower value prefers to send larger MPP parts, potentially saturating channels and
189 * increasing failure probability for those paths.
191 * Note that this restriction will be relaxed during pathfinding after paths which meet this
192 * restriction have been found. While paths which meet this criteria will be searched for, it
193 * is ultimately up to the scorer to select them over other paths.
195 * A value of 0 will allow payments up to and including a channel's total announced usable
196 * capacity, a value of one will only use up to half its capacity, two 1/4, etc.
200 public void set_max_channel_saturation_power_of_half(byte val) {
201 bindings.PaymentParameters_set_max_channel_saturation_power_of_half(this.ptr, val);
202 Reference.reachabilityFence(this);
203 Reference.reachabilityFence(val);
207 * A list of SCIDs which this payment was previously attempted over and which caused the
208 * payment to fail. Future attempts for the same payment shouldn't be relayed through any of
211 * Returns a copy of the field.
213 public long[] get_previously_failed_channels() {
214 long[] ret = bindings.PaymentParameters_get_previously_failed_channels(this.ptr);
215 Reference.reachabilityFence(this);
220 * A list of SCIDs which this payment was previously attempted over and which caused the
221 * payment to fail. Future attempts for the same payment shouldn't be relayed through any of
224 public void set_previously_failed_channels(long[] val) {
225 bindings.PaymentParameters_set_previously_failed_channels(this.ptr, val);
226 Reference.reachabilityFence(this);
227 Reference.reachabilityFence(val);
231 * Constructs a new PaymentParameters given each field
233 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, byte max_path_count_arg, byte max_channel_saturation_power_of_half_arg, long[] previously_failed_channels_arg) {
234 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, max_path_count_arg, max_channel_saturation_power_of_half_arg, previously_failed_channels_arg);
235 Reference.reachabilityFence(payee_pubkey_arg);
236 Reference.reachabilityFence(features_arg);
237 Reference.reachabilityFence(route_hints_arg);
238 Reference.reachabilityFence(expiry_time_arg);
239 Reference.reachabilityFence(max_total_cltv_expiry_delta_arg);
240 Reference.reachabilityFence(max_path_count_arg);
241 Reference.reachabilityFence(max_channel_saturation_power_of_half_arg);
242 Reference.reachabilityFence(previously_failed_channels_arg);
243 if (ret >= 0 && ret <= 4096) { return null; }
244 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
245 ret_hu_conv.ptrs_to.add(ret_hu_conv);
250 long ret = bindings.PaymentParameters_clone_ptr(this.ptr);
251 Reference.reachabilityFence(this);
256 * Creates a copy of the PaymentParameters
258 public PaymentParameters clone() {
259 long ret = bindings.PaymentParameters_clone(this.ptr);
260 Reference.reachabilityFence(this);
261 if (ret >= 0 && ret <= 4096) { return null; }
262 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
263 ret_hu_conv.ptrs_to.add(this);
268 * Checks if two PaymentParameterss contain equal inner contents.
271 long ret = bindings.PaymentParameters_hash(this.ptr);
272 Reference.reachabilityFence(this);
276 @Override public int hashCode() {
277 return (int)this.hash();
280 * Checks if two PaymentParameterss contain equal inner contents.
281 * This ignores pointers and is_owned flags and looks at the values in fields.
282 * Two objects with NULL inner values will be considered "equal" here.
284 public boolean eq(PaymentParameters b) {
285 boolean ret = bindings.PaymentParameters_eq(this.ptr, b == null ? 0 : b.ptr & ~1);
286 Reference.reachabilityFence(this);
287 Reference.reachabilityFence(b);
292 @Override public boolean equals(Object o) {
293 if (!(o instanceof PaymentParameters)) return false;
294 return this.eq((PaymentParameters)o);
297 * Serialize the PaymentParameters object into a byte array which can be read by PaymentParameters_read
299 public byte[] write() {
300 byte[] ret = bindings.PaymentParameters_write(this.ptr);
301 Reference.reachabilityFence(this);
306 * Read a PaymentParameters from a byte array, created by PaymentParameters_write
308 public static Result_PaymentParametersDecodeErrorZ read(byte[] ser) {
309 long ret = bindings.PaymentParameters_read(ser);
310 Reference.reachabilityFence(ser);
311 if (ret >= 0 && ret <= 4096) { return null; }
312 Result_PaymentParametersDecodeErrorZ ret_hu_conv = Result_PaymentParametersDecodeErrorZ.constr_from_ptr(ret);
317 * Creates a payee with the node id of the given `pubkey`.
319 public static PaymentParameters from_node_id(byte[] payee_pubkey) {
320 long ret = bindings.PaymentParameters_from_node_id(InternalUtils.check_arr_len(payee_pubkey, 33));
321 Reference.reachabilityFence(payee_pubkey);
322 if (ret >= 0 && ret <= 4096) { return null; }
323 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
324 ret_hu_conv.ptrs_to.add(ret_hu_conv);
329 * Creates a payee with the node id of the given `pubkey` to use for keysend payments.
331 public static PaymentParameters for_keysend(byte[] payee_pubkey) {
332 long ret = bindings.PaymentParameters_for_keysend(InternalUtils.check_arr_len(payee_pubkey, 33));
333 Reference.reachabilityFence(payee_pubkey);
334 if (ret >= 0 && ret <= 4096) { return null; }
335 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
336 ret_hu_conv.ptrs_to.add(ret_hu_conv);