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 * Create a blank Features with no features set
61 public static NodeFeatures empty() {
62 long ret = bindings.NodeFeatures_empty();
63 if (ret >= 0 && ret <= 4096) { return null; }
64 org.ldk.structs.NodeFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.NodeFeatures(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.NodeFeatures other) {
73 boolean ret = bindings.NodeFeatures_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.NodeFeatures_requires_unknown_bits(this.ptr);
86 Reference.reachabilityFence(this);
91 * Sets a required custom feature bit. Errors if `bit` is outside the custom range as defined
92 * by [bLIP 2] or if it is a known `T` feature.
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 * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
99 public Result_NoneNoneZ set_required_custom_bit(long bit) {
100 long ret = bindings.NodeFeatures_set_required_custom_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 custom feature bit. Errors if `bit` is outside the custom range as defined
110 * by [bLIP 2] or if it is a known `T` feature.
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 * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
117 public Result_NoneNoneZ set_optional_custom_bit(long bit) {
118 long ret = bindings.NodeFeatures_set_optional_custom_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 * Serialize the NodeFeatures object into a byte array which can be read by NodeFeatures_read
129 public byte[] write() {
130 byte[] ret = bindings.NodeFeatures_write(this.ptr);
131 Reference.reachabilityFence(this);
136 * Read a NodeFeatures from a byte array, created by NodeFeatures_write
138 public static Result_NodeFeaturesDecodeErrorZ read(byte[] ser) {
139 long ret = bindings.NodeFeatures_read(ser);
140 Reference.reachabilityFence(ser);
141 if (ret >= 0 && ret <= 4096) { return null; }
142 Result_NodeFeaturesDecodeErrorZ ret_hu_conv = Result_NodeFeaturesDecodeErrorZ.constr_from_ptr(ret);
147 * Set this feature as optional.
149 public void set_data_loss_protect_optional() {
150 bindings.NodeFeatures_set_data_loss_protect_optional(this.ptr);
151 Reference.reachabilityFence(this);
155 * Set this feature as required.
157 public void set_data_loss_protect_required() {
158 bindings.NodeFeatures_set_data_loss_protect_required(this.ptr);
159 Reference.reachabilityFence(this);
163 * Checks if this feature is supported.
165 public boolean supports_data_loss_protect() {
166 boolean ret = bindings.NodeFeatures_supports_data_loss_protect(this.ptr);
167 Reference.reachabilityFence(this);
172 * Checks if this feature is required.
174 public boolean requires_data_loss_protect() {
175 boolean ret = bindings.NodeFeatures_requires_data_loss_protect(this.ptr);
176 Reference.reachabilityFence(this);
181 * Set this feature as optional.
183 public void set_upfront_shutdown_script_optional() {
184 bindings.NodeFeatures_set_upfront_shutdown_script_optional(this.ptr);
185 Reference.reachabilityFence(this);
189 * Set this feature as required.
191 public void set_upfront_shutdown_script_required() {
192 bindings.NodeFeatures_set_upfront_shutdown_script_required(this.ptr);
193 Reference.reachabilityFence(this);
197 * Checks if this feature is supported.
199 public boolean supports_upfront_shutdown_script() {
200 boolean ret = bindings.NodeFeatures_supports_upfront_shutdown_script(this.ptr);
201 Reference.reachabilityFence(this);
206 * Checks if this feature is required.
208 public boolean requires_upfront_shutdown_script() {
209 boolean ret = bindings.NodeFeatures_requires_upfront_shutdown_script(this.ptr);
210 Reference.reachabilityFence(this);
215 * Set this feature as optional.
217 public void set_gossip_queries_optional() {
218 bindings.NodeFeatures_set_gossip_queries_optional(this.ptr);
219 Reference.reachabilityFence(this);
223 * Set this feature as required.
225 public void set_gossip_queries_required() {
226 bindings.NodeFeatures_set_gossip_queries_required(this.ptr);
227 Reference.reachabilityFence(this);
231 * Checks if this feature is supported.
233 public boolean supports_gossip_queries() {
234 boolean ret = bindings.NodeFeatures_supports_gossip_queries(this.ptr);
235 Reference.reachabilityFence(this);
240 * Checks if this feature is required.
242 public boolean requires_gossip_queries() {
243 boolean ret = bindings.NodeFeatures_requires_gossip_queries(this.ptr);
244 Reference.reachabilityFence(this);
249 * Set this feature as optional.
251 public void set_variable_length_onion_optional() {
252 bindings.NodeFeatures_set_variable_length_onion_optional(this.ptr);
253 Reference.reachabilityFence(this);
257 * Set this feature as required.
259 public void set_variable_length_onion_required() {
260 bindings.NodeFeatures_set_variable_length_onion_required(this.ptr);
261 Reference.reachabilityFence(this);
265 * Checks if this feature is supported.
267 public boolean supports_variable_length_onion() {
268 boolean ret = bindings.NodeFeatures_supports_variable_length_onion(this.ptr);
269 Reference.reachabilityFence(this);
274 * Checks if this feature is required.
276 public boolean requires_variable_length_onion() {
277 boolean ret = bindings.NodeFeatures_requires_variable_length_onion(this.ptr);
278 Reference.reachabilityFence(this);
283 * Set this feature as optional.
285 public void set_static_remote_key_optional() {
286 bindings.NodeFeatures_set_static_remote_key_optional(this.ptr);
287 Reference.reachabilityFence(this);
291 * Set this feature as required.
293 public void set_static_remote_key_required() {
294 bindings.NodeFeatures_set_static_remote_key_required(this.ptr);
295 Reference.reachabilityFence(this);
299 * Checks if this feature is supported.
301 public boolean supports_static_remote_key() {
302 boolean ret = bindings.NodeFeatures_supports_static_remote_key(this.ptr);
303 Reference.reachabilityFence(this);
308 * Checks if this feature is required.
310 public boolean requires_static_remote_key() {
311 boolean ret = bindings.NodeFeatures_requires_static_remote_key(this.ptr);
312 Reference.reachabilityFence(this);
317 * Set this feature as optional.
319 public void set_payment_secret_optional() {
320 bindings.NodeFeatures_set_payment_secret_optional(this.ptr);
321 Reference.reachabilityFence(this);
325 * Set this feature as required.
327 public void set_payment_secret_required() {
328 bindings.NodeFeatures_set_payment_secret_required(this.ptr);
329 Reference.reachabilityFence(this);
333 * Checks if this feature is supported.
335 public boolean supports_payment_secret() {
336 boolean ret = bindings.NodeFeatures_supports_payment_secret(this.ptr);
337 Reference.reachabilityFence(this);
342 * Checks if this feature is required.
344 public boolean requires_payment_secret() {
345 boolean ret = bindings.NodeFeatures_requires_payment_secret(this.ptr);
346 Reference.reachabilityFence(this);
351 * Set this feature as optional.
353 public void set_basic_mpp_optional() {
354 bindings.NodeFeatures_set_basic_mpp_optional(this.ptr);
355 Reference.reachabilityFence(this);
359 * Set this feature as required.
361 public void set_basic_mpp_required() {
362 bindings.NodeFeatures_set_basic_mpp_required(this.ptr);
363 Reference.reachabilityFence(this);
367 * Checks if this feature is supported.
369 public boolean supports_basic_mpp() {
370 boolean ret = bindings.NodeFeatures_supports_basic_mpp(this.ptr);
371 Reference.reachabilityFence(this);
376 * Checks if this feature is required.
378 public boolean requires_basic_mpp() {
379 boolean ret = bindings.NodeFeatures_requires_basic_mpp(this.ptr);
380 Reference.reachabilityFence(this);
385 * Set this feature as optional.
387 public void set_wumbo_optional() {
388 bindings.NodeFeatures_set_wumbo_optional(this.ptr);
389 Reference.reachabilityFence(this);
393 * Set this feature as required.
395 public void set_wumbo_required() {
396 bindings.NodeFeatures_set_wumbo_required(this.ptr);
397 Reference.reachabilityFence(this);
401 * Checks if this feature is supported.
403 public boolean supports_wumbo() {
404 boolean ret = bindings.NodeFeatures_supports_wumbo(this.ptr);
405 Reference.reachabilityFence(this);
410 * Checks if this feature is required.
412 public boolean requires_wumbo() {
413 boolean ret = bindings.NodeFeatures_requires_wumbo(this.ptr);
414 Reference.reachabilityFence(this);
419 * Set this feature as optional.
421 public void set_anchors_nonzero_fee_htlc_tx_optional() {
422 bindings.NodeFeatures_set_anchors_nonzero_fee_htlc_tx_optional(this.ptr);
423 Reference.reachabilityFence(this);
427 * Set this feature as required.
429 public void set_anchors_nonzero_fee_htlc_tx_required() {
430 bindings.NodeFeatures_set_anchors_nonzero_fee_htlc_tx_required(this.ptr);
431 Reference.reachabilityFence(this);
435 * Checks if this feature is supported.
437 public boolean supports_anchors_nonzero_fee_htlc_tx() {
438 boolean ret = bindings.NodeFeatures_supports_anchors_nonzero_fee_htlc_tx(this.ptr);
439 Reference.reachabilityFence(this);
444 * Checks if this feature is required.
446 public boolean requires_anchors_nonzero_fee_htlc_tx() {
447 boolean ret = bindings.NodeFeatures_requires_anchors_nonzero_fee_htlc_tx(this.ptr);
448 Reference.reachabilityFence(this);
453 * Set this feature as optional.
455 public void set_anchors_zero_fee_htlc_tx_optional() {
456 bindings.NodeFeatures_set_anchors_zero_fee_htlc_tx_optional(this.ptr);
457 Reference.reachabilityFence(this);
461 * Set this feature as required.
463 public void set_anchors_zero_fee_htlc_tx_required() {
464 bindings.NodeFeatures_set_anchors_zero_fee_htlc_tx_required(this.ptr);
465 Reference.reachabilityFence(this);
469 * Checks if this feature is supported.
471 public boolean supports_anchors_zero_fee_htlc_tx() {
472 boolean ret = bindings.NodeFeatures_supports_anchors_zero_fee_htlc_tx(this.ptr);
473 Reference.reachabilityFence(this);
478 * Checks if this feature is required.
480 public boolean requires_anchors_zero_fee_htlc_tx() {
481 boolean ret = bindings.NodeFeatures_requires_anchors_zero_fee_htlc_tx(this.ptr);
482 Reference.reachabilityFence(this);
487 * Set this feature as optional.
489 public void set_shutdown_any_segwit_optional() {
490 bindings.NodeFeatures_set_shutdown_any_segwit_optional(this.ptr);
491 Reference.reachabilityFence(this);
495 * Set this feature as required.
497 public void set_shutdown_any_segwit_required() {
498 bindings.NodeFeatures_set_shutdown_any_segwit_required(this.ptr);
499 Reference.reachabilityFence(this);
503 * Checks if this feature is supported.
505 public boolean supports_shutdown_anysegwit() {
506 boolean ret = bindings.NodeFeatures_supports_shutdown_anysegwit(this.ptr);
507 Reference.reachabilityFence(this);
512 * Checks if this feature is required.
514 public boolean requires_shutdown_anysegwit() {
515 boolean ret = bindings.NodeFeatures_requires_shutdown_anysegwit(this.ptr);
516 Reference.reachabilityFence(this);
521 * Set this feature as optional.
523 public void set_onion_messages_optional() {
524 bindings.NodeFeatures_set_onion_messages_optional(this.ptr);
525 Reference.reachabilityFence(this);
529 * Set this feature as required.
531 public void set_onion_messages_required() {
532 bindings.NodeFeatures_set_onion_messages_required(this.ptr);
533 Reference.reachabilityFence(this);
537 * Checks if this feature is supported.
539 public boolean supports_onion_messages() {
540 boolean ret = bindings.NodeFeatures_supports_onion_messages(this.ptr);
541 Reference.reachabilityFence(this);
546 * Checks if this feature is required.
548 public boolean requires_onion_messages() {
549 boolean ret = bindings.NodeFeatures_requires_onion_messages(this.ptr);
550 Reference.reachabilityFence(this);
555 * Set this feature as optional.
557 public void set_channel_type_optional() {
558 bindings.NodeFeatures_set_channel_type_optional(this.ptr);
559 Reference.reachabilityFence(this);
563 * Set this feature as required.
565 public void set_channel_type_required() {
566 bindings.NodeFeatures_set_channel_type_required(this.ptr);
567 Reference.reachabilityFence(this);
571 * Checks if this feature is supported.
573 public boolean supports_channel_type() {
574 boolean ret = bindings.NodeFeatures_supports_channel_type(this.ptr);
575 Reference.reachabilityFence(this);
580 * Checks if this feature is required.
582 public boolean requires_channel_type() {
583 boolean ret = bindings.NodeFeatures_requires_channel_type(this.ptr);
584 Reference.reachabilityFence(this);
589 * Set this feature as optional.
591 public void set_scid_privacy_optional() {
592 bindings.NodeFeatures_set_scid_privacy_optional(this.ptr);
593 Reference.reachabilityFence(this);
597 * Set this feature as required.
599 public void set_scid_privacy_required() {
600 bindings.NodeFeatures_set_scid_privacy_required(this.ptr);
601 Reference.reachabilityFence(this);
605 * Checks if this feature is supported.
607 public boolean supports_scid_privacy() {
608 boolean ret = bindings.NodeFeatures_supports_scid_privacy(this.ptr);
609 Reference.reachabilityFence(this);
614 * Checks if this feature is required.
616 public boolean requires_scid_privacy() {
617 boolean ret = bindings.NodeFeatures_requires_scid_privacy(this.ptr);
618 Reference.reachabilityFence(this);
623 * Set this feature as optional.
625 public void set_zero_conf_optional() {
626 bindings.NodeFeatures_set_zero_conf_optional(this.ptr);
627 Reference.reachabilityFence(this);
631 * Set this feature as required.
633 public void set_zero_conf_required() {
634 bindings.NodeFeatures_set_zero_conf_required(this.ptr);
635 Reference.reachabilityFence(this);
639 * Checks if this feature is supported.
641 public boolean supports_zero_conf() {
642 boolean ret = bindings.NodeFeatures_supports_zero_conf(this.ptr);
643 Reference.reachabilityFence(this);
648 * Checks if this feature is required.
650 public boolean requires_zero_conf() {
651 boolean ret = bindings.NodeFeatures_requires_zero_conf(this.ptr);
652 Reference.reachabilityFence(this);
657 * Set this feature as optional.
659 public void set_keysend_optional() {
660 bindings.NodeFeatures_set_keysend_optional(this.ptr);
661 Reference.reachabilityFence(this);
665 * Set this feature as required.
667 public void set_keysend_required() {
668 bindings.NodeFeatures_set_keysend_required(this.ptr);
669 Reference.reachabilityFence(this);
673 * Checks if this feature is supported.
675 public boolean supports_keysend() {
676 boolean ret = bindings.NodeFeatures_supports_keysend(this.ptr);
677 Reference.reachabilityFence(this);
682 * Checks if this feature is required.
684 public boolean requires_keysend() {
685 boolean ret = bindings.NodeFeatures_requires_keysend(this.ptr);
686 Reference.reachabilityFence(this);