[Java] Update auto-generated Java bindings for 0.0.116
[ldk-java] / src / main / java / org / ldk / structs / ChannelDetails.java
1 package org.ldk.structs;
2
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
5 import org.ldk.util.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
9
10
11 /**
12  * Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
13  */
14 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
15 public class ChannelDetails extends CommonBase {
16         ChannelDetails(Object _dummy, long ptr) { super(ptr); }
17         @Override @SuppressWarnings("deprecation")
18         protected void finalize() throws Throwable {
19                 super.finalize();
20                 if (ptr != 0) { bindings.ChannelDetails_free(ptr); }
21         }
22
23         /**
24          * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
25          * thereafter this is the txid of the funding transaction xor the funding transaction output).
26          * Note that this means this value is *not* persistent - it can change once during the
27          * lifetime of the channel.
28          */
29         public byte[] get_channel_id() {
30                 byte[] ret = bindings.ChannelDetails_get_channel_id(this.ptr);
31                 Reference.reachabilityFence(this);
32                 return ret;
33         }
34
35         /**
36          * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
37          * thereafter this is the txid of the funding transaction xor the funding transaction output).
38          * Note that this means this value is *not* persistent - it can change once during the
39          * lifetime of the channel.
40          */
41         public void set_channel_id(byte[] val) {
42                 bindings.ChannelDetails_set_channel_id(this.ptr, InternalUtils.check_arr_len(val, 32));
43                 Reference.reachabilityFence(this);
44                 Reference.reachabilityFence(val);
45         }
46
47         /**
48          * Parameters which apply to our counterparty. See individual fields for more information.
49          */
50         public ChannelCounterparty get_counterparty() {
51                 long ret = bindings.ChannelDetails_get_counterparty(this.ptr);
52                 Reference.reachabilityFence(this);
53                 if (ret >= 0 && ret <= 4096) { return null; }
54                 org.ldk.structs.ChannelCounterparty ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelCounterparty(null, ret); }
55                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
56                 return ret_hu_conv;
57         }
58
59         /**
60          * Parameters which apply to our counterparty. See individual fields for more information.
61          */
62         public void set_counterparty(org.ldk.structs.ChannelCounterparty val) {
63                 bindings.ChannelDetails_set_counterparty(this.ptr, val == null ? 0 : val.ptr);
64                 Reference.reachabilityFence(this);
65                 Reference.reachabilityFence(val);
66                 if (this != null) { this.ptrs_to.add(val); };
67         }
68
69         /**
70          * The Channel's funding transaction output, if we've negotiated the funding transaction with
71          * our counterparty already.
72          * 
73          * Note that, if this has been set, `channel_id` will be equivalent to
74          * `funding_txo.unwrap().to_channel_id()`.
75          * 
76          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
77          */
78         @Nullable
79         public OutPoint get_funding_txo() {
80                 long ret = bindings.ChannelDetails_get_funding_txo(this.ptr);
81                 Reference.reachabilityFence(this);
82                 if (ret >= 0 && ret <= 4096) { return null; }
83                 org.ldk.structs.OutPoint ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.OutPoint(null, ret); }
84                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
85                 return ret_hu_conv;
86         }
87
88         /**
89          * The Channel's funding transaction output, if we've negotiated the funding transaction with
90          * our counterparty already.
91          * 
92          * Note that, if this has been set, `channel_id` will be equivalent to
93          * `funding_txo.unwrap().to_channel_id()`.
94          * 
95          * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
96          */
97         public void set_funding_txo(@Nullable org.ldk.structs.OutPoint val) {
98                 bindings.ChannelDetails_set_funding_txo(this.ptr, val == null ? 0 : val.ptr);
99                 Reference.reachabilityFence(this);
100                 Reference.reachabilityFence(val);
101                 if (this != null) { this.ptrs_to.add(val); };
102         }
103
104         /**
105          * The features which this channel operates with. See individual features for more info.
106          * 
107          * `None` until negotiation completes and the channel type is finalized.
108          * 
109          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
110          */
111         @Nullable
112         public ChannelTypeFeatures get_channel_type() {
113                 long ret = bindings.ChannelDetails_get_channel_type(this.ptr);
114                 Reference.reachabilityFence(this);
115                 if (ret >= 0 && ret <= 4096) { return null; }
116                 org.ldk.structs.ChannelTypeFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelTypeFeatures(null, ret); }
117                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
118                 return ret_hu_conv;
119         }
120
121         /**
122          * The features which this channel operates with. See individual features for more info.
123          * 
124          * `None` until negotiation completes and the channel type is finalized.
125          * 
126          * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
127          */
128         public void set_channel_type(@Nullable org.ldk.structs.ChannelTypeFeatures val) {
129                 bindings.ChannelDetails_set_channel_type(this.ptr, val == null ? 0 : val.ptr);
130                 Reference.reachabilityFence(this);
131                 Reference.reachabilityFence(val);
132                 if (this != null) { this.ptrs_to.add(val); };
133         }
134
135         /**
136          * The position of the funding transaction in the chain. None if the funding transaction has
137          * not yet been confirmed and the channel fully opened.
138          * 
139          * Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
140          * payments instead of this. See [`get_inbound_payment_scid`].
141          * 
142          * For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
143          * be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
144          * 
145          * [`inbound_scid_alias`]: Self::inbound_scid_alias
146          * [`outbound_scid_alias`]: Self::outbound_scid_alias
147          * [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
148          * [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
149          * [`confirmations_required`]: Self::confirmations_required
150          */
151         public Option_u64Z get_short_channel_id() {
152                 long ret = bindings.ChannelDetails_get_short_channel_id(this.ptr);
153                 Reference.reachabilityFence(this);
154                 if (ret >= 0 && ret <= 4096) { return null; }
155                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
156                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
157                 return ret_hu_conv;
158         }
159
160         /**
161          * The position of the funding transaction in the chain. None if the funding transaction has
162          * not yet been confirmed and the channel fully opened.
163          * 
164          * Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
165          * payments instead of this. See [`get_inbound_payment_scid`].
166          * 
167          * For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
168          * be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
169          * 
170          * [`inbound_scid_alias`]: Self::inbound_scid_alias
171          * [`outbound_scid_alias`]: Self::outbound_scid_alias
172          * [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
173          * [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
174          * [`confirmations_required`]: Self::confirmations_required
175          */
176         public void set_short_channel_id(org.ldk.structs.Option_u64Z val) {
177                 bindings.ChannelDetails_set_short_channel_id(this.ptr, val.ptr);
178                 Reference.reachabilityFence(this);
179                 Reference.reachabilityFence(val);
180                 if (this != null) { this.ptrs_to.add(val); };
181         }
182
183         /**
184          * An optional [`short_channel_id`] alias for this channel, randomly generated by us and
185          * usable in place of [`short_channel_id`] to reference the channel in outbound routes when
186          * the channel has not yet been confirmed (as long as [`confirmations_required`] is
187          * `Some(0)`).
188          * 
189          * This will be `None` as long as the channel is not available for routing outbound payments.
190          * 
191          * [`short_channel_id`]: Self::short_channel_id
192          * [`confirmations_required`]: Self::confirmations_required
193          */
194         public Option_u64Z get_outbound_scid_alias() {
195                 long ret = bindings.ChannelDetails_get_outbound_scid_alias(this.ptr);
196                 Reference.reachabilityFence(this);
197                 if (ret >= 0 && ret <= 4096) { return null; }
198                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
199                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
200                 return ret_hu_conv;
201         }
202
203         /**
204          * An optional [`short_channel_id`] alias for this channel, randomly generated by us and
205          * usable in place of [`short_channel_id`] to reference the channel in outbound routes when
206          * the channel has not yet been confirmed (as long as [`confirmations_required`] is
207          * `Some(0)`).
208          * 
209          * This will be `None` as long as the channel is not available for routing outbound payments.
210          * 
211          * [`short_channel_id`]: Self::short_channel_id
212          * [`confirmations_required`]: Self::confirmations_required
213          */
214         public void set_outbound_scid_alias(org.ldk.structs.Option_u64Z val) {
215                 bindings.ChannelDetails_set_outbound_scid_alias(this.ptr, val.ptr);
216                 Reference.reachabilityFence(this);
217                 Reference.reachabilityFence(val);
218                 if (this != null) { this.ptrs_to.add(val); };
219         }
220
221         /**
222          * An optional [`short_channel_id`] alias for this channel, randomly generated by our
223          * counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
224          * counterparty will recognize the alias provided here in place of the [`short_channel_id`]
225          * when they see a payment to be routed to us.
226          * 
227          * Our counterparty may choose to rotate this value at any time, though will always recognize
228          * previous values for inbound payment forwarding.
229          * 
230          * [`short_channel_id`]: Self::short_channel_id
231          */
232         public Option_u64Z get_inbound_scid_alias() {
233                 long ret = bindings.ChannelDetails_get_inbound_scid_alias(this.ptr);
234                 Reference.reachabilityFence(this);
235                 if (ret >= 0 && ret <= 4096) { return null; }
236                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
237                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
238                 return ret_hu_conv;
239         }
240
241         /**
242          * An optional [`short_channel_id`] alias for this channel, randomly generated by our
243          * counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
244          * counterparty will recognize the alias provided here in place of the [`short_channel_id`]
245          * when they see a payment to be routed to us.
246          * 
247          * Our counterparty may choose to rotate this value at any time, though will always recognize
248          * previous values for inbound payment forwarding.
249          * 
250          * [`short_channel_id`]: Self::short_channel_id
251          */
252         public void set_inbound_scid_alias(org.ldk.structs.Option_u64Z val) {
253                 bindings.ChannelDetails_set_inbound_scid_alias(this.ptr, val.ptr);
254                 Reference.reachabilityFence(this);
255                 Reference.reachabilityFence(val);
256                 if (this != null) { this.ptrs_to.add(val); };
257         }
258
259         /**
260          * The value, in satoshis, of this channel as appears in the funding output
261          */
262         public long get_channel_value_satoshis() {
263                 long ret = bindings.ChannelDetails_get_channel_value_satoshis(this.ptr);
264                 Reference.reachabilityFence(this);
265                 return ret;
266         }
267
268         /**
269          * The value, in satoshis, of this channel as appears in the funding output
270          */
271         public void set_channel_value_satoshis(long val) {
272                 bindings.ChannelDetails_set_channel_value_satoshis(this.ptr, val);
273                 Reference.reachabilityFence(this);
274                 Reference.reachabilityFence(val);
275         }
276
277         /**
278          * The value, in satoshis, that must always be held in the channel for us. This value ensures
279          * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
280          * this value on chain.
281          * 
282          * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
283          * 
284          * This value will be `None` for outbound channels until the counterparty accepts the channel.
285          * 
286          * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
287          */
288         public Option_u64Z get_unspendable_punishment_reserve() {
289                 long ret = bindings.ChannelDetails_get_unspendable_punishment_reserve(this.ptr);
290                 Reference.reachabilityFence(this);
291                 if (ret >= 0 && ret <= 4096) { return null; }
292                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
293                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
294                 return ret_hu_conv;
295         }
296
297         /**
298          * The value, in satoshis, that must always be held in the channel for us. This value ensures
299          * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
300          * this value on chain.
301          * 
302          * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
303          * 
304          * This value will be `None` for outbound channels until the counterparty accepts the channel.
305          * 
306          * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
307          */
308         public void set_unspendable_punishment_reserve(org.ldk.structs.Option_u64Z val) {
309                 bindings.ChannelDetails_set_unspendable_punishment_reserve(this.ptr, val.ptr);
310                 Reference.reachabilityFence(this);
311                 Reference.reachabilityFence(val);
312                 if (this != null) { this.ptrs_to.add(val); };
313         }
314
315         /**
316          * The `user_channel_id` passed in to create_channel, or a random value if the channel was
317          * inbound. This may be zero for inbound channels serialized with LDK versions prior to
318          * 0.0.113.
319          */
320         public UInt128 get_user_channel_id() {
321                 byte[] ret = bindings.ChannelDetails_get_user_channel_id(this.ptr);
322                 Reference.reachabilityFence(this);
323                 org.ldk.util.UInt128 ret_conv = new org.ldk.util.UInt128(ret);
324                 return ret_conv;
325         }
326
327         /**
328          * The `user_channel_id` passed in to create_channel, or a random value if the channel was
329          * inbound. This may be zero for inbound channels serialized with LDK versions prior to
330          * 0.0.113.
331          */
332         public void set_user_channel_id(org.ldk.util.UInt128 val) {
333                 bindings.ChannelDetails_set_user_channel_id(this.ptr, val.getLEBytes());
334                 Reference.reachabilityFence(this);
335                 Reference.reachabilityFence(val);
336         }
337
338         /**
339          * The currently negotiated fee rate denominated in satoshi per 1000 weight units,
340          * which is applied to commitment and HTLC transactions.
341          * 
342          * This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
343          */
344         public Option_u32Z get_feerate_sat_per_1000_weight() {
345                 long ret = bindings.ChannelDetails_get_feerate_sat_per_1000_weight(this.ptr);
346                 Reference.reachabilityFence(this);
347                 if (ret >= 0 && ret <= 4096) { return null; }
348                 org.ldk.structs.Option_u32Z ret_hu_conv = org.ldk.structs.Option_u32Z.constr_from_ptr(ret);
349                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
350                 return ret_hu_conv;
351         }
352
353         /**
354          * The currently negotiated fee rate denominated in satoshi per 1000 weight units,
355          * which is applied to commitment and HTLC transactions.
356          * 
357          * This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
358          */
359         public void set_feerate_sat_per_1000_weight(org.ldk.structs.Option_u32Z val) {
360                 bindings.ChannelDetails_set_feerate_sat_per_1000_weight(this.ptr, val.ptr);
361                 Reference.reachabilityFence(this);
362                 Reference.reachabilityFence(val);
363                 if (this != null) { this.ptrs_to.add(val); };
364         }
365
366         /**
367          * Our total balance.  This is the amount we would get if we close the channel.
368          * This value is not exact. Due to various in-flight changes and feerate changes, exactly this
369          * amount is not likely to be recoverable on close.
370          * 
371          * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
372          * balance is not available for inclusion in new outbound HTLCs). This further does not include
373          * any pending outgoing HTLCs which are awaiting some other resolution to be sent.
374          * This does not consider any on-chain fees.
375          * 
376          * See also [`ChannelDetails::outbound_capacity_msat`]
377          */
378         public long get_balance_msat() {
379                 long ret = bindings.ChannelDetails_get_balance_msat(this.ptr);
380                 Reference.reachabilityFence(this);
381                 return ret;
382         }
383
384         /**
385          * Our total balance.  This is the amount we would get if we close the channel.
386          * This value is not exact. Due to various in-flight changes and feerate changes, exactly this
387          * amount is not likely to be recoverable on close.
388          * 
389          * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
390          * balance is not available for inclusion in new outbound HTLCs). This further does not include
391          * any pending outgoing HTLCs which are awaiting some other resolution to be sent.
392          * This does not consider any on-chain fees.
393          * 
394          * See also [`ChannelDetails::outbound_capacity_msat`]
395          */
396         public void set_balance_msat(long val) {
397                 bindings.ChannelDetails_set_balance_msat(this.ptr, val);
398                 Reference.reachabilityFence(this);
399                 Reference.reachabilityFence(val);
400         }
401
402         /**
403          * The available outbound capacity for sending HTLCs to the remote peer. This does not include
404          * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
405          * available for inclusion in new outbound HTLCs). This further does not include any pending
406          * outgoing HTLCs which are awaiting some other resolution to be sent.
407          * 
408          * See also [`ChannelDetails::balance_msat`]
409          * 
410          * This value is not exact. Due to various in-flight changes, feerate changes, and our
411          * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
412          * should be able to spend nearly this amount.
413          */
414         public long get_outbound_capacity_msat() {
415                 long ret = bindings.ChannelDetails_get_outbound_capacity_msat(this.ptr);
416                 Reference.reachabilityFence(this);
417                 return ret;
418         }
419
420         /**
421          * The available outbound capacity for sending HTLCs to the remote peer. This does not include
422          * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
423          * available for inclusion in new outbound HTLCs). This further does not include any pending
424          * outgoing HTLCs which are awaiting some other resolution to be sent.
425          * 
426          * See also [`ChannelDetails::balance_msat`]
427          * 
428          * This value is not exact. Due to various in-flight changes, feerate changes, and our
429          * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
430          * should be able to spend nearly this amount.
431          */
432         public void set_outbound_capacity_msat(long val) {
433                 bindings.ChannelDetails_set_outbound_capacity_msat(this.ptr, val);
434                 Reference.reachabilityFence(this);
435                 Reference.reachabilityFence(val);
436         }
437
438         /**
439          * The available outbound capacity for sending a single HTLC to the remote peer. This is
440          * similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
441          * the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
442          * to use a limit as close as possible to the HTLC limit we can currently send.
443          * 
444          * See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
445          * [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
446          */
447         public long get_next_outbound_htlc_limit_msat() {
448                 long ret = bindings.ChannelDetails_get_next_outbound_htlc_limit_msat(this.ptr);
449                 Reference.reachabilityFence(this);
450                 return ret;
451         }
452
453         /**
454          * The available outbound capacity for sending a single HTLC to the remote peer. This is
455          * similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
456          * the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
457          * to use a limit as close as possible to the HTLC limit we can currently send.
458          * 
459          * See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
460          * [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
461          */
462         public void set_next_outbound_htlc_limit_msat(long val) {
463                 bindings.ChannelDetails_set_next_outbound_htlc_limit_msat(this.ptr, val);
464                 Reference.reachabilityFence(this);
465                 Reference.reachabilityFence(val);
466         }
467
468         /**
469          * The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
470          * [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
471          * an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
472          * route which is valid.
473          */
474         public long get_next_outbound_htlc_minimum_msat() {
475                 long ret = bindings.ChannelDetails_get_next_outbound_htlc_minimum_msat(this.ptr);
476                 Reference.reachabilityFence(this);
477                 return ret;
478         }
479
480         /**
481          * The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
482          * [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
483          * an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
484          * route which is valid.
485          */
486         public void set_next_outbound_htlc_minimum_msat(long val) {
487                 bindings.ChannelDetails_set_next_outbound_htlc_minimum_msat(this.ptr, val);
488                 Reference.reachabilityFence(this);
489                 Reference.reachabilityFence(val);
490         }
491
492         /**
493          * The available inbound capacity for the remote peer to send HTLCs to us. This does not
494          * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
495          * available for inclusion in new inbound HTLCs).
496          * Note that there are some corner cases not fully handled here, so the actual available
497          * inbound capacity may be slightly higher than this.
498          * 
499          * This value is not exact. Due to various in-flight changes, feerate changes, and our
500          * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
501          * However, our counterparty should be able to spend nearly this amount.
502          */
503         public long get_inbound_capacity_msat() {
504                 long ret = bindings.ChannelDetails_get_inbound_capacity_msat(this.ptr);
505                 Reference.reachabilityFence(this);
506                 return ret;
507         }
508
509         /**
510          * The available inbound capacity for the remote peer to send HTLCs to us. This does not
511          * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
512          * available for inclusion in new inbound HTLCs).
513          * Note that there are some corner cases not fully handled here, so the actual available
514          * inbound capacity may be slightly higher than this.
515          * 
516          * This value is not exact. Due to various in-flight changes, feerate changes, and our
517          * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
518          * However, our counterparty should be able to spend nearly this amount.
519          */
520         public void set_inbound_capacity_msat(long val) {
521                 bindings.ChannelDetails_set_inbound_capacity_msat(this.ptr, val);
522                 Reference.reachabilityFence(this);
523                 Reference.reachabilityFence(val);
524         }
525
526         /**
527          * The number of required confirmations on the funding transaction before the funding will be
528          * considered \"locked\". This number is selected by the channel fundee (i.e. us if
529          * [`is_outbound`] is *not* set), and can be selected for inbound channels with
530          * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
531          * [`ChannelHandshakeLimits::max_minimum_depth`].
532          * 
533          * This value will be `None` for outbound channels until the counterparty accepts the channel.
534          * 
535          * [`is_outbound`]: ChannelDetails::is_outbound
536          * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
537          * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
538          */
539         public Option_u32Z get_confirmations_required() {
540                 long ret = bindings.ChannelDetails_get_confirmations_required(this.ptr);
541                 Reference.reachabilityFence(this);
542                 if (ret >= 0 && ret <= 4096) { return null; }
543                 org.ldk.structs.Option_u32Z ret_hu_conv = org.ldk.structs.Option_u32Z.constr_from_ptr(ret);
544                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
545                 return ret_hu_conv;
546         }
547
548         /**
549          * The number of required confirmations on the funding transaction before the funding will be
550          * considered \"locked\". This number is selected by the channel fundee (i.e. us if
551          * [`is_outbound`] is *not* set), and can be selected for inbound channels with
552          * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
553          * [`ChannelHandshakeLimits::max_minimum_depth`].
554          * 
555          * This value will be `None` for outbound channels until the counterparty accepts the channel.
556          * 
557          * [`is_outbound`]: ChannelDetails::is_outbound
558          * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
559          * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
560          */
561         public void set_confirmations_required(org.ldk.structs.Option_u32Z val) {
562                 bindings.ChannelDetails_set_confirmations_required(this.ptr, val.ptr);
563                 Reference.reachabilityFence(this);
564                 Reference.reachabilityFence(val);
565                 if (this != null) { this.ptrs_to.add(val); };
566         }
567
568         /**
569          * The current number of confirmations on the funding transaction.
570          * 
571          * This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
572          */
573         public Option_u32Z get_confirmations() {
574                 long ret = bindings.ChannelDetails_get_confirmations(this.ptr);
575                 Reference.reachabilityFence(this);
576                 if (ret >= 0 && ret <= 4096) { return null; }
577                 org.ldk.structs.Option_u32Z ret_hu_conv = org.ldk.structs.Option_u32Z.constr_from_ptr(ret);
578                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
579                 return ret_hu_conv;
580         }
581
582         /**
583          * The current number of confirmations on the funding transaction.
584          * 
585          * This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
586          */
587         public void set_confirmations(org.ldk.structs.Option_u32Z val) {
588                 bindings.ChannelDetails_set_confirmations(this.ptr, val.ptr);
589                 Reference.reachabilityFence(this);
590                 Reference.reachabilityFence(val);
591                 if (this != null) { this.ptrs_to.add(val); };
592         }
593
594         /**
595          * The number of blocks (after our commitment transaction confirms) that we will need to wait
596          * until we can claim our funds after we force-close the channel. During this time our
597          * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
598          * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
599          * time to claim our non-HTLC-encumbered funds.
600          * 
601          * This value will be `None` for outbound channels until the counterparty accepts the channel.
602          */
603         public Option_u16Z get_force_close_spend_delay() {
604                 long ret = bindings.ChannelDetails_get_force_close_spend_delay(this.ptr);
605                 Reference.reachabilityFence(this);
606                 if (ret >= 0 && ret <= 4096) { return null; }
607                 org.ldk.structs.Option_u16Z ret_hu_conv = org.ldk.structs.Option_u16Z.constr_from_ptr(ret);
608                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
609                 return ret_hu_conv;
610         }
611
612         /**
613          * The number of blocks (after our commitment transaction confirms) that we will need to wait
614          * until we can claim our funds after we force-close the channel. During this time our
615          * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
616          * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
617          * time to claim our non-HTLC-encumbered funds.
618          * 
619          * This value will be `None` for outbound channels until the counterparty accepts the channel.
620          */
621         public void set_force_close_spend_delay(org.ldk.structs.Option_u16Z val) {
622                 bindings.ChannelDetails_set_force_close_spend_delay(this.ptr, val.ptr);
623                 Reference.reachabilityFence(this);
624                 Reference.reachabilityFence(val);
625                 if (this != null) { this.ptrs_to.add(val); };
626         }
627
628         /**
629          * True if the channel was initiated (and thus funded) by us.
630          */
631         public boolean get_is_outbound() {
632                 boolean ret = bindings.ChannelDetails_get_is_outbound(this.ptr);
633                 Reference.reachabilityFence(this);
634                 return ret;
635         }
636
637         /**
638          * True if the channel was initiated (and thus funded) by us.
639          */
640         public void set_is_outbound(boolean val) {
641                 bindings.ChannelDetails_set_is_outbound(this.ptr, val);
642                 Reference.reachabilityFence(this);
643                 Reference.reachabilityFence(val);
644         }
645
646         /**
647          * True if the channel is confirmed, channel_ready messages have been exchanged, and the
648          * channel is not currently being shut down. `channel_ready` message exchange implies the
649          * required confirmation count has been reached (and we were connected to the peer at some
650          * point after the funding transaction received enough confirmations). The required
651          * confirmation count is provided in [`confirmations_required`].
652          * 
653          * [`confirmations_required`]: ChannelDetails::confirmations_required
654          */
655         public boolean get_is_channel_ready() {
656                 boolean ret = bindings.ChannelDetails_get_is_channel_ready(this.ptr);
657                 Reference.reachabilityFence(this);
658                 return ret;
659         }
660
661         /**
662          * True if the channel is confirmed, channel_ready messages have been exchanged, and the
663          * channel is not currently being shut down. `channel_ready` message exchange implies the
664          * required confirmation count has been reached (and we were connected to the peer at some
665          * point after the funding transaction received enough confirmations). The required
666          * confirmation count is provided in [`confirmations_required`].
667          * 
668          * [`confirmations_required`]: ChannelDetails::confirmations_required
669          */
670         public void set_is_channel_ready(boolean val) {
671                 bindings.ChannelDetails_set_is_channel_ready(this.ptr, val);
672                 Reference.reachabilityFence(this);
673                 Reference.reachabilityFence(val);
674         }
675
676         /**
677          * The stage of the channel's shutdown.
678          * `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
679          * 
680          * Returns a copy of the field.
681          */
682         public Option_ChannelShutdownStateZ get_channel_shutdown_state() {
683                 long ret = bindings.ChannelDetails_get_channel_shutdown_state(this.ptr);
684                 Reference.reachabilityFence(this);
685                 if (ret >= 0 && ret <= 4096) { return null; }
686                 org.ldk.structs.Option_ChannelShutdownStateZ ret_hu_conv = org.ldk.structs.Option_ChannelShutdownStateZ.constr_from_ptr(ret);
687                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
688                 return ret_hu_conv;
689         }
690
691         /**
692          * The stage of the channel's shutdown.
693          * `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
694          */
695         public void set_channel_shutdown_state(org.ldk.structs.Option_ChannelShutdownStateZ val) {
696                 bindings.ChannelDetails_set_channel_shutdown_state(this.ptr, val.ptr);
697                 Reference.reachabilityFence(this);
698                 Reference.reachabilityFence(val);
699                 if (this != null) { this.ptrs_to.add(val); };
700         }
701
702         /**
703          * True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
704          * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
705          * 
706          * This is a strict superset of `is_channel_ready`.
707          */
708         public boolean get_is_usable() {
709                 boolean ret = bindings.ChannelDetails_get_is_usable(this.ptr);
710                 Reference.reachabilityFence(this);
711                 return ret;
712         }
713
714         /**
715          * True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
716          * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
717          * 
718          * This is a strict superset of `is_channel_ready`.
719          */
720         public void set_is_usable(boolean val) {
721                 bindings.ChannelDetails_set_is_usable(this.ptr, val);
722                 Reference.reachabilityFence(this);
723                 Reference.reachabilityFence(val);
724         }
725
726         /**
727          * True if this channel is (or will be) publicly-announced.
728          */
729         public boolean get_is_public() {
730                 boolean ret = bindings.ChannelDetails_get_is_public(this.ptr);
731                 Reference.reachabilityFence(this);
732                 return ret;
733         }
734
735         /**
736          * True if this channel is (or will be) publicly-announced.
737          */
738         public void set_is_public(boolean val) {
739                 bindings.ChannelDetails_set_is_public(this.ptr, val);
740                 Reference.reachabilityFence(this);
741                 Reference.reachabilityFence(val);
742         }
743
744         /**
745          * The smallest value HTLC (in msat) we will accept, for this channel. This field
746          * is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
747          */
748         public Option_u64Z get_inbound_htlc_minimum_msat() {
749                 long ret = bindings.ChannelDetails_get_inbound_htlc_minimum_msat(this.ptr);
750                 Reference.reachabilityFence(this);
751                 if (ret >= 0 && ret <= 4096) { return null; }
752                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
753                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
754                 return ret_hu_conv;
755         }
756
757         /**
758          * The smallest value HTLC (in msat) we will accept, for this channel. This field
759          * is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
760          */
761         public void set_inbound_htlc_minimum_msat(org.ldk.structs.Option_u64Z val) {
762                 bindings.ChannelDetails_set_inbound_htlc_minimum_msat(this.ptr, val.ptr);
763                 Reference.reachabilityFence(this);
764                 Reference.reachabilityFence(val);
765                 if (this != null) { this.ptrs_to.add(val); };
766         }
767
768         /**
769          * The largest value HTLC (in msat) we currently will accept, for this channel.
770          */
771         public Option_u64Z get_inbound_htlc_maximum_msat() {
772                 long ret = bindings.ChannelDetails_get_inbound_htlc_maximum_msat(this.ptr);
773                 Reference.reachabilityFence(this);
774                 if (ret >= 0 && ret <= 4096) { return null; }
775                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
776                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
777                 return ret_hu_conv;
778         }
779
780         /**
781          * The largest value HTLC (in msat) we currently will accept, for this channel.
782          */
783         public void set_inbound_htlc_maximum_msat(org.ldk.structs.Option_u64Z val) {
784                 bindings.ChannelDetails_set_inbound_htlc_maximum_msat(this.ptr, val.ptr);
785                 Reference.reachabilityFence(this);
786                 Reference.reachabilityFence(val);
787                 if (this != null) { this.ptrs_to.add(val); };
788         }
789
790         /**
791          * Set of configurable parameters that affect channel operation.
792          * 
793          * This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
794          * 
795          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
796          */
797         @Nullable
798         public ChannelConfig get_config() {
799                 long ret = bindings.ChannelDetails_get_config(this.ptr);
800                 Reference.reachabilityFence(this);
801                 if (ret >= 0 && ret <= 4096) { return null; }
802                 org.ldk.structs.ChannelConfig ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelConfig(null, ret); }
803                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
804                 return ret_hu_conv;
805         }
806
807         /**
808          * Set of configurable parameters that affect channel operation.
809          * 
810          * This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
811          * 
812          * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
813          */
814         public void set_config(@Nullable org.ldk.structs.ChannelConfig val) {
815                 bindings.ChannelDetails_set_config(this.ptr, val == null ? 0 : val.ptr);
816                 Reference.reachabilityFence(this);
817                 Reference.reachabilityFence(val);
818                 if (this != null) { this.ptrs_to.add(val); };
819         }
820
821         /**
822          * Constructs a new ChannelDetails given each field
823          */
824         public static ChannelDetails of(byte[] channel_id_arg, org.ldk.structs.ChannelCounterparty counterparty_arg, org.ldk.structs.OutPoint funding_txo_arg, org.ldk.structs.ChannelTypeFeatures channel_type_arg, org.ldk.structs.Option_u64Z short_channel_id_arg, org.ldk.structs.Option_u64Z outbound_scid_alias_arg, org.ldk.structs.Option_u64Z inbound_scid_alias_arg, long channel_value_satoshis_arg, org.ldk.structs.Option_u64Z unspendable_punishment_reserve_arg, org.ldk.util.UInt128 user_channel_id_arg, org.ldk.structs.Option_u32Z feerate_sat_per_1000_weight_arg, long balance_msat_arg, long outbound_capacity_msat_arg, long next_outbound_htlc_limit_msat_arg, long next_outbound_htlc_minimum_msat_arg, long inbound_capacity_msat_arg, org.ldk.structs.Option_u32Z confirmations_required_arg, org.ldk.structs.Option_u32Z confirmations_arg, org.ldk.structs.Option_u16Z force_close_spend_delay_arg, boolean is_outbound_arg, boolean is_channel_ready_arg, org.ldk.structs.Option_ChannelShutdownStateZ channel_shutdown_state_arg, boolean is_usable_arg, boolean is_public_arg, org.ldk.structs.Option_u64Z inbound_htlc_minimum_msat_arg, org.ldk.structs.Option_u64Z inbound_htlc_maximum_msat_arg, org.ldk.structs.ChannelConfig config_arg) {
825                 long ret = bindings.ChannelDetails_new(InternalUtils.check_arr_len(channel_id_arg, 32), counterparty_arg == null ? 0 : counterparty_arg.ptr, funding_txo_arg == null ? 0 : funding_txo_arg.ptr, channel_type_arg == null ? 0 : channel_type_arg.ptr, short_channel_id_arg.ptr, outbound_scid_alias_arg.ptr, inbound_scid_alias_arg.ptr, channel_value_satoshis_arg, unspendable_punishment_reserve_arg.ptr, user_channel_id_arg.getLEBytes(), feerate_sat_per_1000_weight_arg.ptr, balance_msat_arg, outbound_capacity_msat_arg, next_outbound_htlc_limit_msat_arg, next_outbound_htlc_minimum_msat_arg, inbound_capacity_msat_arg, confirmations_required_arg.ptr, confirmations_arg.ptr, force_close_spend_delay_arg.ptr, is_outbound_arg, is_channel_ready_arg, channel_shutdown_state_arg.ptr, is_usable_arg, is_public_arg, inbound_htlc_minimum_msat_arg.ptr, inbound_htlc_maximum_msat_arg.ptr, config_arg == null ? 0 : config_arg.ptr);
826                 Reference.reachabilityFence(channel_id_arg);
827                 Reference.reachabilityFence(counterparty_arg);
828                 Reference.reachabilityFence(funding_txo_arg);
829                 Reference.reachabilityFence(channel_type_arg);
830                 Reference.reachabilityFence(short_channel_id_arg);
831                 Reference.reachabilityFence(outbound_scid_alias_arg);
832                 Reference.reachabilityFence(inbound_scid_alias_arg);
833                 Reference.reachabilityFence(channel_value_satoshis_arg);
834                 Reference.reachabilityFence(unspendable_punishment_reserve_arg);
835                 Reference.reachabilityFence(user_channel_id_arg);
836                 Reference.reachabilityFence(feerate_sat_per_1000_weight_arg);
837                 Reference.reachabilityFence(balance_msat_arg);
838                 Reference.reachabilityFence(outbound_capacity_msat_arg);
839                 Reference.reachabilityFence(next_outbound_htlc_limit_msat_arg);
840                 Reference.reachabilityFence(next_outbound_htlc_minimum_msat_arg);
841                 Reference.reachabilityFence(inbound_capacity_msat_arg);
842                 Reference.reachabilityFence(confirmations_required_arg);
843                 Reference.reachabilityFence(confirmations_arg);
844                 Reference.reachabilityFence(force_close_spend_delay_arg);
845                 Reference.reachabilityFence(is_outbound_arg);
846                 Reference.reachabilityFence(is_channel_ready_arg);
847                 Reference.reachabilityFence(channel_shutdown_state_arg);
848                 Reference.reachabilityFence(is_usable_arg);
849                 Reference.reachabilityFence(is_public_arg);
850                 Reference.reachabilityFence(inbound_htlc_minimum_msat_arg);
851                 Reference.reachabilityFence(inbound_htlc_maximum_msat_arg);
852                 Reference.reachabilityFence(config_arg);
853                 if (ret >= 0 && ret <= 4096) { return null; }
854                 org.ldk.structs.ChannelDetails ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelDetails(null, ret); }
855                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
856                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(counterparty_arg); };
857                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(funding_txo_arg); };
858                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(channel_type_arg); };
859                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(short_channel_id_arg); };
860                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(outbound_scid_alias_arg); };
861                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(inbound_scid_alias_arg); };
862                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(unspendable_punishment_reserve_arg); };
863                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(feerate_sat_per_1000_weight_arg); };
864                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(confirmations_required_arg); };
865                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(confirmations_arg); };
866                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(force_close_spend_delay_arg); };
867                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(channel_shutdown_state_arg); };
868                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(inbound_htlc_minimum_msat_arg); };
869                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(inbound_htlc_maximum_msat_arg); };
870                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(config_arg); };
871                 return ret_hu_conv;
872         }
873
874         long clone_ptr() {
875                 long ret = bindings.ChannelDetails_clone_ptr(this.ptr);
876                 Reference.reachabilityFence(this);
877                 return ret;
878         }
879
880         /**
881          * Creates a copy of the ChannelDetails
882          */
883         public ChannelDetails clone() {
884                 long ret = bindings.ChannelDetails_clone(this.ptr);
885                 Reference.reachabilityFence(this);
886                 if (ret >= 0 && ret <= 4096) { return null; }
887                 org.ldk.structs.ChannelDetails ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelDetails(null, ret); }
888                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
889                 return ret_hu_conv;
890         }
891
892         /**
893          * Gets the current SCID which should be used to identify this channel for inbound payments.
894          * This should be used for providing invoice hints or in any other context where our
895          * counterparty will forward a payment to us.
896          * 
897          * This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
898          * [`ChannelDetails::short_channel_id`]. See those for more information.
899          */
900         public Option_u64Z get_inbound_payment_scid() {
901                 long ret = bindings.ChannelDetails_get_inbound_payment_scid(this.ptr);
902                 Reference.reachabilityFence(this);
903                 if (ret >= 0 && ret <= 4096) { return null; }
904                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
905                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
906                 return ret_hu_conv;
907         }
908
909         /**
910          * Gets the current SCID which should be used to identify this channel for outbound payments.
911          * This should be used in [`Route`]s to describe the first hop or in other contexts where
912          * we're sending or forwarding a payment outbound over this channel.
913          * 
914          * This is either the [`ChannelDetails::short_channel_id`], if set, or the
915          * [`ChannelDetails::outbound_scid_alias`]. See those for more information.
916          */
917         public Option_u64Z get_outbound_payment_scid() {
918                 long ret = bindings.ChannelDetails_get_outbound_payment_scid(this.ptr);
919                 Reference.reachabilityFence(this);
920                 if (ret >= 0 && ret <= 4096) { return null; }
921                 org.ldk.structs.Option_u64Z ret_hu_conv = org.ldk.structs.Option_u64Z.constr_from_ptr(ret);
922                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
923                 return ret_hu_conv;
924         }
925
926         /**
927          * Serialize the ChannelDetails object into a byte array which can be read by ChannelDetails_read
928          */
929         public byte[] write() {
930                 byte[] ret = bindings.ChannelDetails_write(this.ptr);
931                 Reference.reachabilityFence(this);
932                 return ret;
933         }
934
935         /**
936          * Read a ChannelDetails from a byte array, created by ChannelDetails_write
937          */
938         public static Result_ChannelDetailsDecodeErrorZ read(byte[] ser) {
939                 long ret = bindings.ChannelDetails_read(ser);
940                 Reference.reachabilityFence(ser);
941                 if (ret >= 0 && ret <= 4096) { return null; }
942                 Result_ChannelDetailsDecodeErrorZ ret_hu_conv = Result_ChannelDetailsDecodeErrorZ.constr_from_ptr(ret);
943                 return ret_hu_conv;
944         }
945
946 }