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 a `node_announcement` message.
14 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
15 public class NodeFeatures extends CommonBase {
16 NodeFeatures(Object _dummy, long ptr) { super(ptr); }
17 @Override @SuppressWarnings("deprecation")
18 protected void finalize() throws Throwable {
20 if (ptr != 0) { bindings.NodeFeatures_free(ptr); }
24 * Checks if two NodeFeaturess 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.NodeFeatures b) {
29 boolean ret = bindings.NodeFeatures_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 NodeFeatures)) return false;
38 return this.eq((NodeFeatures)o);
41 long ret = bindings.NodeFeatures_clone_ptr(this.ptr);
42 Reference.reachabilityFence(this);
47 * Creates a copy of the NodeFeatures
49 public NodeFeatures clone() {
50 long ret = bindings.NodeFeatures_clone(this.ptr);
51 Reference.reachabilityFence(this);
52 if (ret >= 0 && ret <= 4096) { return null; }
53 org.ldk.structs.NodeFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.NodeFeatures(null, ret); }
54 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
59 * Generates a non-cryptographic 64-bit hash of the NodeFeatures.
62 long ret = bindings.NodeFeatures_hash(this.ptr);
63 Reference.reachabilityFence(this);
67 @Override public int hashCode() {
68 return (int)this.hash();
71 * Create a blank Features with no features set
73 public static NodeFeatures empty() {
74 long ret = bindings.NodeFeatures_empty();
75 if (ret >= 0 && ret <= 4096) { return null; }
76 org.ldk.structs.NodeFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.NodeFeatures(null, ret); }
77 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
82 * Returns true if this `Features` object contains required features unknown by `other`.
84 public boolean requires_unknown_bits_from(org.ldk.structs.NodeFeatures other) {
85 boolean ret = bindings.NodeFeatures_requires_unknown_bits_from(this.ptr, other == null ? 0 : other.ptr);
86 Reference.reachabilityFence(this);
87 Reference.reachabilityFence(other);
88 if (this != null) { this.ptrs_to.add(other); };
93 * Returns true if this `Features` object contains unknown feature flags which are set as
96 public boolean requires_unknown_bits() {
97 boolean ret = bindings.NodeFeatures_requires_unknown_bits(this.ptr);
98 Reference.reachabilityFence(this);
103 * Sets a required feature bit. Errors if `bit` is outside the feature range as defined
106 * Note: Required bits are even. If an odd bit is given, then the corresponding even bit will
107 * be set instead (i.e., `bit - 1`).
109 * [BOLT 9]: https://github.com/lightning/bolts/blob/master/09-features.md
111 public Result_NoneNoneZ set_required_feature_bit(long bit) {
112 long ret = bindings.NodeFeatures_set_required_feature_bit(this.ptr, bit);
113 Reference.reachabilityFence(this);
114 Reference.reachabilityFence(bit);
115 if (ret >= 0 && ret <= 4096) { return null; }
116 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
121 * Sets an optional feature bit. Errors if `bit` is outside the feature range as defined
124 * Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be
125 * set instead (i.e., `bit + 1`).
127 * [BOLT 9]: https://github.com/lightning/bolts/blob/master/09-features.md
129 public Result_NoneNoneZ set_optional_feature_bit(long bit) {
130 long ret = bindings.NodeFeatures_set_optional_feature_bit(this.ptr, bit);
131 Reference.reachabilityFence(this);
132 Reference.reachabilityFence(bit);
133 if (ret >= 0 && ret <= 4096) { return null; }
134 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
139 * Sets a required custom feature bit. Errors if `bit` is outside the custom range as defined
140 * by [bLIP 2] or if it is a known `T` feature.
142 * Note: Required bits are even. If an odd bit is given, then the corresponding even bit will
143 * be set instead (i.e., `bit - 1`).
145 * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
147 public Result_NoneNoneZ set_required_custom_bit(long bit) {
148 long ret = bindings.NodeFeatures_set_required_custom_bit(this.ptr, bit);
149 Reference.reachabilityFence(this);
150 Reference.reachabilityFence(bit);
151 if (ret >= 0 && ret <= 4096) { return null; }
152 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
157 * Sets an optional custom feature bit. Errors if `bit` is outside the custom range as defined
158 * by [bLIP 2] or if it is a known `T` feature.
160 * Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be
161 * set instead (i.e., `bit + 1`).
163 * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
165 public Result_NoneNoneZ set_optional_custom_bit(long bit) {
166 long ret = bindings.NodeFeatures_set_optional_custom_bit(this.ptr, bit);
167 Reference.reachabilityFence(this);
168 Reference.reachabilityFence(bit);
169 if (ret >= 0 && ret <= 4096) { return null; }
170 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
175 * Serialize the NodeFeatures object into a byte array which can be read by NodeFeatures_read
177 public byte[] write() {
178 byte[] ret = bindings.NodeFeatures_write(this.ptr);
179 Reference.reachabilityFence(this);
184 * Read a NodeFeatures from a byte array, created by NodeFeatures_write
186 public static Result_NodeFeaturesDecodeErrorZ read(byte[] ser) {
187 long ret = bindings.NodeFeatures_read(ser);
188 Reference.reachabilityFence(ser);
189 if (ret >= 0 && ret <= 4096) { return null; }
190 Result_NodeFeaturesDecodeErrorZ ret_hu_conv = Result_NodeFeaturesDecodeErrorZ.constr_from_ptr(ret);
195 * Set this feature as optional.
197 public void set_data_loss_protect_optional() {
198 bindings.NodeFeatures_set_data_loss_protect_optional(this.ptr);
199 Reference.reachabilityFence(this);
203 * Set this feature as required.
205 public void set_data_loss_protect_required() {
206 bindings.NodeFeatures_set_data_loss_protect_required(this.ptr);
207 Reference.reachabilityFence(this);
211 * Checks if this feature is supported.
213 public boolean supports_data_loss_protect() {
214 boolean ret = bindings.NodeFeatures_supports_data_loss_protect(this.ptr);
215 Reference.reachabilityFence(this);
220 * Checks if this feature is required.
222 public boolean requires_data_loss_protect() {
223 boolean ret = bindings.NodeFeatures_requires_data_loss_protect(this.ptr);
224 Reference.reachabilityFence(this);
229 * Set this feature as optional.
231 public void set_upfront_shutdown_script_optional() {
232 bindings.NodeFeatures_set_upfront_shutdown_script_optional(this.ptr);
233 Reference.reachabilityFence(this);
237 * Set this feature as required.
239 public void set_upfront_shutdown_script_required() {
240 bindings.NodeFeatures_set_upfront_shutdown_script_required(this.ptr);
241 Reference.reachabilityFence(this);
245 * Checks if this feature is supported.
247 public boolean supports_upfront_shutdown_script() {
248 boolean ret = bindings.NodeFeatures_supports_upfront_shutdown_script(this.ptr);
249 Reference.reachabilityFence(this);
254 * Checks if this feature is required.
256 public boolean requires_upfront_shutdown_script() {
257 boolean ret = bindings.NodeFeatures_requires_upfront_shutdown_script(this.ptr);
258 Reference.reachabilityFence(this);
263 * Set this feature as optional.
265 public void set_gossip_queries_optional() {
266 bindings.NodeFeatures_set_gossip_queries_optional(this.ptr);
267 Reference.reachabilityFence(this);
271 * Set this feature as required.
273 public void set_gossip_queries_required() {
274 bindings.NodeFeatures_set_gossip_queries_required(this.ptr);
275 Reference.reachabilityFence(this);
279 * Checks if this feature is supported.
281 public boolean supports_gossip_queries() {
282 boolean ret = bindings.NodeFeatures_supports_gossip_queries(this.ptr);
283 Reference.reachabilityFence(this);
288 * Checks if this feature is required.
290 public boolean requires_gossip_queries() {
291 boolean ret = bindings.NodeFeatures_requires_gossip_queries(this.ptr);
292 Reference.reachabilityFence(this);
297 * Set this feature as optional.
299 public void set_variable_length_onion_optional() {
300 bindings.NodeFeatures_set_variable_length_onion_optional(this.ptr);
301 Reference.reachabilityFence(this);
305 * Set this feature as required.
307 public void set_variable_length_onion_required() {
308 bindings.NodeFeatures_set_variable_length_onion_required(this.ptr);
309 Reference.reachabilityFence(this);
313 * Checks if this feature is supported.
315 public boolean supports_variable_length_onion() {
316 boolean ret = bindings.NodeFeatures_supports_variable_length_onion(this.ptr);
317 Reference.reachabilityFence(this);
322 * Checks if this feature is required.
324 public boolean requires_variable_length_onion() {
325 boolean ret = bindings.NodeFeatures_requires_variable_length_onion(this.ptr);
326 Reference.reachabilityFence(this);
331 * Set this feature as optional.
333 public void set_static_remote_key_optional() {
334 bindings.NodeFeatures_set_static_remote_key_optional(this.ptr);
335 Reference.reachabilityFence(this);
339 * Set this feature as required.
341 public void set_static_remote_key_required() {
342 bindings.NodeFeatures_set_static_remote_key_required(this.ptr);
343 Reference.reachabilityFence(this);
347 * Checks if this feature is supported.
349 public boolean supports_static_remote_key() {
350 boolean ret = bindings.NodeFeatures_supports_static_remote_key(this.ptr);
351 Reference.reachabilityFence(this);
356 * Checks if this feature is required.
358 public boolean requires_static_remote_key() {
359 boolean ret = bindings.NodeFeatures_requires_static_remote_key(this.ptr);
360 Reference.reachabilityFence(this);
365 * Set this feature as optional.
367 public void set_payment_secret_optional() {
368 bindings.NodeFeatures_set_payment_secret_optional(this.ptr);
369 Reference.reachabilityFence(this);
373 * Set this feature as required.
375 public void set_payment_secret_required() {
376 bindings.NodeFeatures_set_payment_secret_required(this.ptr);
377 Reference.reachabilityFence(this);
381 * Checks if this feature is supported.
383 public boolean supports_payment_secret() {
384 boolean ret = bindings.NodeFeatures_supports_payment_secret(this.ptr);
385 Reference.reachabilityFence(this);
390 * Checks if this feature is required.
392 public boolean requires_payment_secret() {
393 boolean ret = bindings.NodeFeatures_requires_payment_secret(this.ptr);
394 Reference.reachabilityFence(this);
399 * Set this feature as optional.
401 public void set_basic_mpp_optional() {
402 bindings.NodeFeatures_set_basic_mpp_optional(this.ptr);
403 Reference.reachabilityFence(this);
407 * Set this feature as required.
409 public void set_basic_mpp_required() {
410 bindings.NodeFeatures_set_basic_mpp_required(this.ptr);
411 Reference.reachabilityFence(this);
415 * Checks if this feature is supported.
417 public boolean supports_basic_mpp() {
418 boolean ret = bindings.NodeFeatures_supports_basic_mpp(this.ptr);
419 Reference.reachabilityFence(this);
424 * Checks if this feature is required.
426 public boolean requires_basic_mpp() {
427 boolean ret = bindings.NodeFeatures_requires_basic_mpp(this.ptr);
428 Reference.reachabilityFence(this);
433 * Set this feature as optional.
435 public void set_wumbo_optional() {
436 bindings.NodeFeatures_set_wumbo_optional(this.ptr);
437 Reference.reachabilityFence(this);
441 * Set this feature as required.
443 public void set_wumbo_required() {
444 bindings.NodeFeatures_set_wumbo_required(this.ptr);
445 Reference.reachabilityFence(this);
449 * Checks if this feature is supported.
451 public boolean supports_wumbo() {
452 boolean ret = bindings.NodeFeatures_supports_wumbo(this.ptr);
453 Reference.reachabilityFence(this);
458 * Checks if this feature is required.
460 public boolean requires_wumbo() {
461 boolean ret = bindings.NodeFeatures_requires_wumbo(this.ptr);
462 Reference.reachabilityFence(this);
467 * Set this feature as optional.
469 public void set_anchors_nonzero_fee_htlc_tx_optional() {
470 bindings.NodeFeatures_set_anchors_nonzero_fee_htlc_tx_optional(this.ptr);
471 Reference.reachabilityFence(this);
475 * Set this feature as required.
477 public void set_anchors_nonzero_fee_htlc_tx_required() {
478 bindings.NodeFeatures_set_anchors_nonzero_fee_htlc_tx_required(this.ptr);
479 Reference.reachabilityFence(this);
483 * Checks if this feature is supported.
485 public boolean supports_anchors_nonzero_fee_htlc_tx() {
486 boolean ret = bindings.NodeFeatures_supports_anchors_nonzero_fee_htlc_tx(this.ptr);
487 Reference.reachabilityFence(this);
492 * Checks if this feature is required.
494 public boolean requires_anchors_nonzero_fee_htlc_tx() {
495 boolean ret = bindings.NodeFeatures_requires_anchors_nonzero_fee_htlc_tx(this.ptr);
496 Reference.reachabilityFence(this);
501 * Set this feature as optional.
503 public void set_anchors_zero_fee_htlc_tx_optional() {
504 bindings.NodeFeatures_set_anchors_zero_fee_htlc_tx_optional(this.ptr);
505 Reference.reachabilityFence(this);
509 * Set this feature as required.
511 public void set_anchors_zero_fee_htlc_tx_required() {
512 bindings.NodeFeatures_set_anchors_zero_fee_htlc_tx_required(this.ptr);
513 Reference.reachabilityFence(this);
517 * Checks if this feature is supported.
519 public boolean supports_anchors_zero_fee_htlc_tx() {
520 boolean ret = bindings.NodeFeatures_supports_anchors_zero_fee_htlc_tx(this.ptr);
521 Reference.reachabilityFence(this);
526 * Checks if this feature is required.
528 public boolean requires_anchors_zero_fee_htlc_tx() {
529 boolean ret = bindings.NodeFeatures_requires_anchors_zero_fee_htlc_tx(this.ptr);
530 Reference.reachabilityFence(this);
535 * Set this feature as optional.
537 public void set_route_blinding_optional() {
538 bindings.NodeFeatures_set_route_blinding_optional(this.ptr);
539 Reference.reachabilityFence(this);
543 * Set this feature as required.
545 public void set_route_blinding_required() {
546 bindings.NodeFeatures_set_route_blinding_required(this.ptr);
547 Reference.reachabilityFence(this);
551 * Checks if this feature is supported.
553 public boolean supports_route_blinding() {
554 boolean ret = bindings.NodeFeatures_supports_route_blinding(this.ptr);
555 Reference.reachabilityFence(this);
560 * Checks if this feature is required.
562 public boolean requires_route_blinding() {
563 boolean ret = bindings.NodeFeatures_requires_route_blinding(this.ptr);
564 Reference.reachabilityFence(this);
569 * Set this feature as optional.
571 public void set_shutdown_any_segwit_optional() {
572 bindings.NodeFeatures_set_shutdown_any_segwit_optional(this.ptr);
573 Reference.reachabilityFence(this);
577 * Set this feature as required.
579 public void set_shutdown_any_segwit_required() {
580 bindings.NodeFeatures_set_shutdown_any_segwit_required(this.ptr);
581 Reference.reachabilityFence(this);
585 * Checks if this feature is supported.
587 public boolean supports_shutdown_anysegwit() {
588 boolean ret = bindings.NodeFeatures_supports_shutdown_anysegwit(this.ptr);
589 Reference.reachabilityFence(this);
594 * Checks if this feature is required.
596 public boolean requires_shutdown_anysegwit() {
597 boolean ret = bindings.NodeFeatures_requires_shutdown_anysegwit(this.ptr);
598 Reference.reachabilityFence(this);
603 * Set this feature as optional.
605 public void set_taproot_optional() {
606 bindings.NodeFeatures_set_taproot_optional(this.ptr);
607 Reference.reachabilityFence(this);
611 * Set this feature as required.
613 public void set_taproot_required() {
614 bindings.NodeFeatures_set_taproot_required(this.ptr);
615 Reference.reachabilityFence(this);
619 * Checks if this feature is supported.
621 public boolean supports_taproot() {
622 boolean ret = bindings.NodeFeatures_supports_taproot(this.ptr);
623 Reference.reachabilityFence(this);
628 * Checks if this feature is required.
630 public boolean requires_taproot() {
631 boolean ret = bindings.NodeFeatures_requires_taproot(this.ptr);
632 Reference.reachabilityFence(this);
637 * Set this feature as optional.
639 public void set_onion_messages_optional() {
640 bindings.NodeFeatures_set_onion_messages_optional(this.ptr);
641 Reference.reachabilityFence(this);
645 * Set this feature as required.
647 public void set_onion_messages_required() {
648 bindings.NodeFeatures_set_onion_messages_required(this.ptr);
649 Reference.reachabilityFence(this);
653 * Checks if this feature is supported.
655 public boolean supports_onion_messages() {
656 boolean ret = bindings.NodeFeatures_supports_onion_messages(this.ptr);
657 Reference.reachabilityFence(this);
662 * Checks if this feature is required.
664 public boolean requires_onion_messages() {
665 boolean ret = bindings.NodeFeatures_requires_onion_messages(this.ptr);
666 Reference.reachabilityFence(this);
671 * Set this feature as optional.
673 public void set_channel_type_optional() {
674 bindings.NodeFeatures_set_channel_type_optional(this.ptr);
675 Reference.reachabilityFence(this);
679 * Set this feature as required.
681 public void set_channel_type_required() {
682 bindings.NodeFeatures_set_channel_type_required(this.ptr);
683 Reference.reachabilityFence(this);
687 * Checks if this feature is supported.
689 public boolean supports_channel_type() {
690 boolean ret = bindings.NodeFeatures_supports_channel_type(this.ptr);
691 Reference.reachabilityFence(this);
696 * Checks if this feature is required.
698 public boolean requires_channel_type() {
699 boolean ret = bindings.NodeFeatures_requires_channel_type(this.ptr);
700 Reference.reachabilityFence(this);
705 * Set this feature as optional.
707 public void set_scid_privacy_optional() {
708 bindings.NodeFeatures_set_scid_privacy_optional(this.ptr);
709 Reference.reachabilityFence(this);
713 * Set this feature as required.
715 public void set_scid_privacy_required() {
716 bindings.NodeFeatures_set_scid_privacy_required(this.ptr);
717 Reference.reachabilityFence(this);
721 * Checks if this feature is supported.
723 public boolean supports_scid_privacy() {
724 boolean ret = bindings.NodeFeatures_supports_scid_privacy(this.ptr);
725 Reference.reachabilityFence(this);
730 * Checks if this feature is required.
732 public boolean requires_scid_privacy() {
733 boolean ret = bindings.NodeFeatures_requires_scid_privacy(this.ptr);
734 Reference.reachabilityFence(this);
739 * Set this feature as optional.
741 public void set_zero_conf_optional() {
742 bindings.NodeFeatures_set_zero_conf_optional(this.ptr);
743 Reference.reachabilityFence(this);
747 * Set this feature as required.
749 public void set_zero_conf_required() {
750 bindings.NodeFeatures_set_zero_conf_required(this.ptr);
751 Reference.reachabilityFence(this);
755 * Checks if this feature is supported.
757 public boolean supports_zero_conf() {
758 boolean ret = bindings.NodeFeatures_supports_zero_conf(this.ptr);
759 Reference.reachabilityFence(this);
764 * Checks if this feature is required.
766 public boolean requires_zero_conf() {
767 boolean ret = bindings.NodeFeatures_requires_zero_conf(this.ptr);
768 Reference.reachabilityFence(this);
773 * Set this feature as optional.
775 public void set_keysend_optional() {
776 bindings.NodeFeatures_set_keysend_optional(this.ptr);
777 Reference.reachabilityFence(this);
781 * Set this feature as required.
783 public void set_keysend_required() {
784 bindings.NodeFeatures_set_keysend_required(this.ptr);
785 Reference.reachabilityFence(this);
789 * Checks if this feature is supported.
791 public boolean supports_keysend() {
792 boolean ret = bindings.NodeFeatures_supports_keysend(this.ptr);
793 Reference.reachabilityFence(this);
798 * Checks if this feature is required.
800 public boolean requires_keysend() {
801 boolean ret = bindings.NodeFeatures_requires_keysend(this.ptr);
802 Reference.reachabilityFence(this);