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 * Features used within an `init` message.
14 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
15 public class InitFeatures extends CommonBase {
16 InitFeatures(Object _dummy, long ptr) { super(ptr); }
17 @Override @SuppressWarnings("deprecation")
18 protected void finalize() throws Throwable {
20 if (ptr != 0) { bindings.InitFeatures_free(ptr); }
24 * Checks if two InitFeaturess contain equal inner contents.
25 * This ignores pointers and is_owned flags and looks at the values in fields.
26 * Two objects with NULL inner values will be considered "equal" here.
28 public boolean eq(org.ldk.structs.InitFeatures b) {
29 boolean ret = bindings.InitFeatures_eq(this.ptr, b == null ? 0 : b.ptr);
30 Reference.reachabilityFence(this);
31 Reference.reachabilityFence(b);
32 if (this != null) { this.ptrs_to.add(b); };
36 @Override public boolean equals(Object o) {
37 if (!(o instanceof InitFeatures)) return false;
38 return this.eq((InitFeatures)o);
41 long ret = bindings.InitFeatures_clone_ptr(this.ptr);
42 Reference.reachabilityFence(this);
47 * Creates a copy of the InitFeatures
49 public InitFeatures clone() {
50 long ret = bindings.InitFeatures_clone(this.ptr);
51 Reference.reachabilityFence(this);
52 if (ret >= 0 && ret <= 4096) { return null; }
53 org.ldk.structs.InitFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InitFeatures(null, ret); }
54 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
59 * Create a blank Features with no features set
61 public static InitFeatures empty() {
62 long ret = bindings.InitFeatures_empty();
63 if (ret >= 0 && ret <= 4096) { return null; }
64 org.ldk.structs.InitFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InitFeatures(null, ret); }
65 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
70 * Returns true if this `Features` object contains required features unknown by `other`.
72 public boolean requires_unknown_bits_from(org.ldk.structs.InitFeatures other) {
73 boolean ret = bindings.InitFeatures_requires_unknown_bits_from(this.ptr, other == null ? 0 : other.ptr);
74 Reference.reachabilityFence(this);
75 Reference.reachabilityFence(other);
76 if (this != null) { this.ptrs_to.add(other); };
81 * Returns true if this `Features` object contains unknown feature flags which are set as
84 public boolean requires_unknown_bits() {
85 boolean ret = bindings.InitFeatures_requires_unknown_bits(this.ptr);
86 Reference.reachabilityFence(this);
91 * Sets a required feature bit. Errors if `bit` is outside the feature range as defined
94 * Note: Required bits are even. If an odd bit is given, then the corresponding even bit will
95 * be set instead (i.e., `bit - 1`).
97 * [BOLT 9]: https://github.com/lightning/bolts/blob/master/09-features.md
99 public Result_NoneNoneZ set_required_feature_bit(long bit) {
100 long ret = bindings.InitFeatures_set_required_feature_bit(this.ptr, bit);
101 Reference.reachabilityFence(this);
102 Reference.reachabilityFence(bit);
103 if (ret >= 0 && ret <= 4096) { return null; }
104 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
109 * Sets an optional feature bit. Errors if `bit` is outside the feature range as defined
112 * Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be
113 * set instead (i.e., `bit + 1`).
115 * [BOLT 9]: https://github.com/lightning/bolts/blob/master/09-features.md
117 public Result_NoneNoneZ set_optional_feature_bit(long bit) {
118 long ret = bindings.InitFeatures_set_optional_feature_bit(this.ptr, bit);
119 Reference.reachabilityFence(this);
120 Reference.reachabilityFence(bit);
121 if (ret >= 0 && ret <= 4096) { return null; }
122 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
127 * Sets a required custom feature bit. Errors if `bit` is outside the custom range as defined
128 * by [bLIP 2] or if it is a known `T` feature.
130 * Note: Required bits are even. If an odd bit is given, then the corresponding even bit will
131 * be set instead (i.e., `bit - 1`).
133 * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
135 public Result_NoneNoneZ set_required_custom_bit(long bit) {
136 long ret = bindings.InitFeatures_set_required_custom_bit(this.ptr, bit);
137 Reference.reachabilityFence(this);
138 Reference.reachabilityFence(bit);
139 if (ret >= 0 && ret <= 4096) { return null; }
140 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
145 * Sets an optional custom feature bit. Errors if `bit` is outside the custom range as defined
146 * by [bLIP 2] or if it is a known `T` feature.
148 * Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be
149 * set instead (i.e., `bit + 1`).
151 * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
153 public Result_NoneNoneZ set_optional_custom_bit(long bit) {
154 long ret = bindings.InitFeatures_set_optional_custom_bit(this.ptr, bit);
155 Reference.reachabilityFence(this);
156 Reference.reachabilityFence(bit);
157 if (ret >= 0 && ret <= 4096) { return null; }
158 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
163 * Serialize the InitFeatures object into a byte array which can be read by InitFeatures_read
165 public byte[] write() {
166 byte[] ret = bindings.InitFeatures_write(this.ptr);
167 Reference.reachabilityFence(this);
172 * Read a InitFeatures from a byte array, created by InitFeatures_write
174 public static Result_InitFeaturesDecodeErrorZ read(byte[] ser) {
175 long ret = bindings.InitFeatures_read(ser);
176 Reference.reachabilityFence(ser);
177 if (ret >= 0 && ret <= 4096) { return null; }
178 Result_InitFeaturesDecodeErrorZ ret_hu_conv = Result_InitFeaturesDecodeErrorZ.constr_from_ptr(ret);
183 * Set this feature as optional.
185 public void set_data_loss_protect_optional() {
186 bindings.InitFeatures_set_data_loss_protect_optional(this.ptr);
187 Reference.reachabilityFence(this);
191 * Set this feature as required.
193 public void set_data_loss_protect_required() {
194 bindings.InitFeatures_set_data_loss_protect_required(this.ptr);
195 Reference.reachabilityFence(this);
199 * Checks if this feature is supported.
201 public boolean supports_data_loss_protect() {
202 boolean ret = bindings.InitFeatures_supports_data_loss_protect(this.ptr);
203 Reference.reachabilityFence(this);
208 * Checks if this feature is required.
210 public boolean requires_data_loss_protect() {
211 boolean ret = bindings.InitFeatures_requires_data_loss_protect(this.ptr);
212 Reference.reachabilityFence(this);
217 * Set this feature as optional.
219 public void set_initial_routing_sync_optional() {
220 bindings.InitFeatures_set_initial_routing_sync_optional(this.ptr);
221 Reference.reachabilityFence(this);
225 * Set this feature as required.
227 public void set_initial_routing_sync_required() {
228 bindings.InitFeatures_set_initial_routing_sync_required(this.ptr);
229 Reference.reachabilityFence(this);
233 * Checks if this feature is supported.
235 public boolean initial_routing_sync() {
236 boolean ret = bindings.InitFeatures_initial_routing_sync(this.ptr);
237 Reference.reachabilityFence(this);
242 * Set this feature as optional.
244 public void set_upfront_shutdown_script_optional() {
245 bindings.InitFeatures_set_upfront_shutdown_script_optional(this.ptr);
246 Reference.reachabilityFence(this);
250 * Set this feature as required.
252 public void set_upfront_shutdown_script_required() {
253 bindings.InitFeatures_set_upfront_shutdown_script_required(this.ptr);
254 Reference.reachabilityFence(this);
258 * Checks if this feature is supported.
260 public boolean supports_upfront_shutdown_script() {
261 boolean ret = bindings.InitFeatures_supports_upfront_shutdown_script(this.ptr);
262 Reference.reachabilityFence(this);
267 * Checks if this feature is required.
269 public boolean requires_upfront_shutdown_script() {
270 boolean ret = bindings.InitFeatures_requires_upfront_shutdown_script(this.ptr);
271 Reference.reachabilityFence(this);
276 * Set this feature as optional.
278 public void set_gossip_queries_optional() {
279 bindings.InitFeatures_set_gossip_queries_optional(this.ptr);
280 Reference.reachabilityFence(this);
284 * Set this feature as required.
286 public void set_gossip_queries_required() {
287 bindings.InitFeatures_set_gossip_queries_required(this.ptr);
288 Reference.reachabilityFence(this);
292 * Checks if this feature is supported.
294 public boolean supports_gossip_queries() {
295 boolean ret = bindings.InitFeatures_supports_gossip_queries(this.ptr);
296 Reference.reachabilityFence(this);
301 * Checks if this feature is required.
303 public boolean requires_gossip_queries() {
304 boolean ret = bindings.InitFeatures_requires_gossip_queries(this.ptr);
305 Reference.reachabilityFence(this);
310 * Set this feature as optional.
312 public void set_variable_length_onion_optional() {
313 bindings.InitFeatures_set_variable_length_onion_optional(this.ptr);
314 Reference.reachabilityFence(this);
318 * Set this feature as required.
320 public void set_variable_length_onion_required() {
321 bindings.InitFeatures_set_variable_length_onion_required(this.ptr);
322 Reference.reachabilityFence(this);
326 * Checks if this feature is supported.
328 public boolean supports_variable_length_onion() {
329 boolean ret = bindings.InitFeatures_supports_variable_length_onion(this.ptr);
330 Reference.reachabilityFence(this);
335 * Checks if this feature is required.
337 public boolean requires_variable_length_onion() {
338 boolean ret = bindings.InitFeatures_requires_variable_length_onion(this.ptr);
339 Reference.reachabilityFence(this);
344 * Set this feature as optional.
346 public void set_static_remote_key_optional() {
347 bindings.InitFeatures_set_static_remote_key_optional(this.ptr);
348 Reference.reachabilityFence(this);
352 * Set this feature as required.
354 public void set_static_remote_key_required() {
355 bindings.InitFeatures_set_static_remote_key_required(this.ptr);
356 Reference.reachabilityFence(this);
360 * Checks if this feature is supported.
362 public boolean supports_static_remote_key() {
363 boolean ret = bindings.InitFeatures_supports_static_remote_key(this.ptr);
364 Reference.reachabilityFence(this);
369 * Checks if this feature is required.
371 public boolean requires_static_remote_key() {
372 boolean ret = bindings.InitFeatures_requires_static_remote_key(this.ptr);
373 Reference.reachabilityFence(this);
378 * Set this feature as optional.
380 public void set_payment_secret_optional() {
381 bindings.InitFeatures_set_payment_secret_optional(this.ptr);
382 Reference.reachabilityFence(this);
386 * Set this feature as required.
388 public void set_payment_secret_required() {
389 bindings.InitFeatures_set_payment_secret_required(this.ptr);
390 Reference.reachabilityFence(this);
394 * Checks if this feature is supported.
396 public boolean supports_payment_secret() {
397 boolean ret = bindings.InitFeatures_supports_payment_secret(this.ptr);
398 Reference.reachabilityFence(this);
403 * Checks if this feature is required.
405 public boolean requires_payment_secret() {
406 boolean ret = bindings.InitFeatures_requires_payment_secret(this.ptr);
407 Reference.reachabilityFence(this);
412 * Set this feature as optional.
414 public void set_basic_mpp_optional() {
415 bindings.InitFeatures_set_basic_mpp_optional(this.ptr);
416 Reference.reachabilityFence(this);
420 * Set this feature as required.
422 public void set_basic_mpp_required() {
423 bindings.InitFeatures_set_basic_mpp_required(this.ptr);
424 Reference.reachabilityFence(this);
428 * Checks if this feature is supported.
430 public boolean supports_basic_mpp() {
431 boolean ret = bindings.InitFeatures_supports_basic_mpp(this.ptr);
432 Reference.reachabilityFence(this);
437 * Checks if this feature is required.
439 public boolean requires_basic_mpp() {
440 boolean ret = bindings.InitFeatures_requires_basic_mpp(this.ptr);
441 Reference.reachabilityFence(this);
446 * Set this feature as optional.
448 public void set_wumbo_optional() {
449 bindings.InitFeatures_set_wumbo_optional(this.ptr);
450 Reference.reachabilityFence(this);
454 * Set this feature as required.
456 public void set_wumbo_required() {
457 bindings.InitFeatures_set_wumbo_required(this.ptr);
458 Reference.reachabilityFence(this);
462 * Checks if this feature is supported.
464 public boolean supports_wumbo() {
465 boolean ret = bindings.InitFeatures_supports_wumbo(this.ptr);
466 Reference.reachabilityFence(this);
471 * Checks if this feature is required.
473 public boolean requires_wumbo() {
474 boolean ret = bindings.InitFeatures_requires_wumbo(this.ptr);
475 Reference.reachabilityFence(this);
480 * Set this feature as optional.
482 public void set_anchors_nonzero_fee_htlc_tx_optional() {
483 bindings.InitFeatures_set_anchors_nonzero_fee_htlc_tx_optional(this.ptr);
484 Reference.reachabilityFence(this);
488 * Set this feature as required.
490 public void set_anchors_nonzero_fee_htlc_tx_required() {
491 bindings.InitFeatures_set_anchors_nonzero_fee_htlc_tx_required(this.ptr);
492 Reference.reachabilityFence(this);
496 * Checks if this feature is supported.
498 public boolean supports_anchors_nonzero_fee_htlc_tx() {
499 boolean ret = bindings.InitFeatures_supports_anchors_nonzero_fee_htlc_tx(this.ptr);
500 Reference.reachabilityFence(this);
505 * Checks if this feature is required.
507 public boolean requires_anchors_nonzero_fee_htlc_tx() {
508 boolean ret = bindings.InitFeatures_requires_anchors_nonzero_fee_htlc_tx(this.ptr);
509 Reference.reachabilityFence(this);
514 * Set this feature as optional.
516 public void set_anchors_zero_fee_htlc_tx_optional() {
517 bindings.InitFeatures_set_anchors_zero_fee_htlc_tx_optional(this.ptr);
518 Reference.reachabilityFence(this);
522 * Set this feature as required.
524 public void set_anchors_zero_fee_htlc_tx_required() {
525 bindings.InitFeatures_set_anchors_zero_fee_htlc_tx_required(this.ptr);
526 Reference.reachabilityFence(this);
530 * Checks if this feature is supported.
532 public boolean supports_anchors_zero_fee_htlc_tx() {
533 boolean ret = bindings.InitFeatures_supports_anchors_zero_fee_htlc_tx(this.ptr);
534 Reference.reachabilityFence(this);
539 * Checks if this feature is required.
541 public boolean requires_anchors_zero_fee_htlc_tx() {
542 boolean ret = bindings.InitFeatures_requires_anchors_zero_fee_htlc_tx(this.ptr);
543 Reference.reachabilityFence(this);
548 * Set this feature as optional.
550 public void set_shutdown_any_segwit_optional() {
551 bindings.InitFeatures_set_shutdown_any_segwit_optional(this.ptr);
552 Reference.reachabilityFence(this);
556 * Set this feature as required.
558 public void set_shutdown_any_segwit_required() {
559 bindings.InitFeatures_set_shutdown_any_segwit_required(this.ptr);
560 Reference.reachabilityFence(this);
564 * Checks if this feature is supported.
566 public boolean supports_shutdown_anysegwit() {
567 boolean ret = bindings.InitFeatures_supports_shutdown_anysegwit(this.ptr);
568 Reference.reachabilityFence(this);
573 * Checks if this feature is required.
575 public boolean requires_shutdown_anysegwit() {
576 boolean ret = bindings.InitFeatures_requires_shutdown_anysegwit(this.ptr);
577 Reference.reachabilityFence(this);
582 * Set this feature as optional.
584 public void set_taproot_optional() {
585 bindings.InitFeatures_set_taproot_optional(this.ptr);
586 Reference.reachabilityFence(this);
590 * Set this feature as required.
592 public void set_taproot_required() {
593 bindings.InitFeatures_set_taproot_required(this.ptr);
594 Reference.reachabilityFence(this);
598 * Checks if this feature is supported.
600 public boolean supports_taproot() {
601 boolean ret = bindings.InitFeatures_supports_taproot(this.ptr);
602 Reference.reachabilityFence(this);
607 * Checks if this feature is required.
609 public boolean requires_taproot() {
610 boolean ret = bindings.InitFeatures_requires_taproot(this.ptr);
611 Reference.reachabilityFence(this);
616 * Set this feature as optional.
618 public void set_onion_messages_optional() {
619 bindings.InitFeatures_set_onion_messages_optional(this.ptr);
620 Reference.reachabilityFence(this);
624 * Set this feature as required.
626 public void set_onion_messages_required() {
627 bindings.InitFeatures_set_onion_messages_required(this.ptr);
628 Reference.reachabilityFence(this);
632 * Checks if this feature is supported.
634 public boolean supports_onion_messages() {
635 boolean ret = bindings.InitFeatures_supports_onion_messages(this.ptr);
636 Reference.reachabilityFence(this);
641 * Checks if this feature is required.
643 public boolean requires_onion_messages() {
644 boolean ret = bindings.InitFeatures_requires_onion_messages(this.ptr);
645 Reference.reachabilityFence(this);
650 * Set this feature as optional.
652 public void set_channel_type_optional() {
653 bindings.InitFeatures_set_channel_type_optional(this.ptr);
654 Reference.reachabilityFence(this);
658 * Set this feature as required.
660 public void set_channel_type_required() {
661 bindings.InitFeatures_set_channel_type_required(this.ptr);
662 Reference.reachabilityFence(this);
666 * Checks if this feature is supported.
668 public boolean supports_channel_type() {
669 boolean ret = bindings.InitFeatures_supports_channel_type(this.ptr);
670 Reference.reachabilityFence(this);
675 * Checks if this feature is required.
677 public boolean requires_channel_type() {
678 boolean ret = bindings.InitFeatures_requires_channel_type(this.ptr);
679 Reference.reachabilityFence(this);
684 * Set this feature as optional.
686 public void set_scid_privacy_optional() {
687 bindings.InitFeatures_set_scid_privacy_optional(this.ptr);
688 Reference.reachabilityFence(this);
692 * Set this feature as required.
694 public void set_scid_privacy_required() {
695 bindings.InitFeatures_set_scid_privacy_required(this.ptr);
696 Reference.reachabilityFence(this);
700 * Checks if this feature is supported.
702 public boolean supports_scid_privacy() {
703 boolean ret = bindings.InitFeatures_supports_scid_privacy(this.ptr);
704 Reference.reachabilityFence(this);
709 * Checks if this feature is required.
711 public boolean requires_scid_privacy() {
712 boolean ret = bindings.InitFeatures_requires_scid_privacy(this.ptr);
713 Reference.reachabilityFence(this);
718 * Set this feature as optional.
720 public void set_zero_conf_optional() {
721 bindings.InitFeatures_set_zero_conf_optional(this.ptr);
722 Reference.reachabilityFence(this);
726 * Set this feature as required.
728 public void set_zero_conf_required() {
729 bindings.InitFeatures_set_zero_conf_required(this.ptr);
730 Reference.reachabilityFence(this);
734 * Checks if this feature is supported.
736 public boolean supports_zero_conf() {
737 boolean ret = bindings.InitFeatures_supports_zero_conf(this.ptr);
738 Reference.reachabilityFence(this);
743 * Checks if this feature is required.
745 public boolean requires_zero_conf() {
746 boolean ret = bindings.InitFeatures_requires_zero_conf(this.ptr);
747 Reference.reachabilityFence(this);