9c2d9e13dc778ab49378418d27a4203c8357ba2b
[ldk-java] / c_sharp / src / org / ldk / structs / InitFeatures.cs
1 using org.ldk.impl;
2 using org.ldk.enums;
3 using org.ldk.util;
4 using System;
5
6 namespace org { namespace ldk { namespace structs {
7
8
9 /**
10  * Features used within an `init` message.
11  */
12 public class InitFeatures : CommonBase {
13         internal InitFeatures(object _dummy, long ptr) : base(ptr) { }
14         ~InitFeatures() {
15                 if (ptr != 0) { bindings.InitFeatures_free(ptr); }
16         }
17
18         /**
19          * Checks if two InitFeaturess contain equal inner contents.
20          * This ignores pointers and is_owned flags and looks at the values in fields.
21          * Two objects with NULL inner values will be considered "equal" here.
22          */
23         public bool eq(org.ldk.structs.InitFeatures b) {
24                 bool ret = bindings.InitFeatures_eq(this.ptr, b == null ? 0 : b.ptr);
25                 GC.KeepAlive(this);
26                 GC.KeepAlive(b);
27                 if (this != null) { this.ptrs_to.AddLast(b); };
28                 return ret;
29         }
30
31         public override bool Equals(object o) {
32                 if (!(o is InitFeatures)) return false;
33                 return this.eq((InitFeatures)o);
34         }
35         internal long clone_ptr() {
36                 long ret = bindings.InitFeatures_clone_ptr(this.ptr);
37                 GC.KeepAlive(this);
38                 return ret;
39         }
40
41         /**
42          * Creates a copy of the InitFeatures
43          */
44         public InitFeatures clone() {
45                 long ret = bindings.InitFeatures_clone(this.ptr);
46                 GC.KeepAlive(this);
47                 if (ret >= 0 && ret <= 4096) { return null; }
48                 org.ldk.structs.InitFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InitFeatures(null, ret); }
49                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
50                 return ret_hu_conv;
51         }
52
53         /**
54          * Create a blank Features with no features set
55          */
56         public static InitFeatures empty() {
57                 long ret = bindings.InitFeatures_empty();
58                 if (ret >= 0 && ret <= 4096) { return null; }
59                 org.ldk.structs.InitFeatures ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.InitFeatures(null, ret); }
60                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
61                 return ret_hu_conv;
62         }
63
64         /**
65          * Returns true if this `Features` object contains required features unknown by `other`.
66          */
67         public bool requires_unknown_bits_from(org.ldk.structs.InitFeatures other) {
68                 bool ret = bindings.InitFeatures_requires_unknown_bits_from(this.ptr, other == null ? 0 : other.ptr);
69                 GC.KeepAlive(this);
70                 GC.KeepAlive(other);
71                 if (this != null) { this.ptrs_to.AddLast(other); };
72                 return ret;
73         }
74
75         /**
76          * Returns true if this `Features` object contains unknown feature flags which are set as
77          * \"required\".
78          */
79         public bool requires_unknown_bits() {
80                 bool ret = bindings.InitFeatures_requires_unknown_bits(this.ptr);
81                 GC.KeepAlive(this);
82                 return ret;
83         }
84
85         /**
86          * Sets a required custom feature bit. Errors if `bit` is outside the custom range as defined
87          * by [bLIP 2] or if it is a known `T` feature.
88          * 
89          * Note: Required bits are even. If an odd bit is given, then the corresponding even bit will
90          * be set instead (i.e., `bit - 1`).
91          * 
92          * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
93          */
94         public Result_NoneNoneZ set_required_custom_bit(long bit) {
95                 long ret = bindings.InitFeatures_set_required_custom_bit(this.ptr, bit);
96                 GC.KeepAlive(this);
97                 GC.KeepAlive(bit);
98                 if (ret >= 0 && ret <= 4096) { return null; }
99                 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
100                 return ret_hu_conv;
101         }
102
103         /**
104          * Sets an optional custom feature bit. Errors if `bit` is outside the custom range as defined
105          * by [bLIP 2] or if it is a known `T` feature.
106          * 
107          * Note: Optional bits are odd. If an even bit is given, then the corresponding odd bit will be
108          * set instead (i.e., `bit + 1`).
109          * 
110          * [bLIP 2]: https://github.com/lightning/blips/blob/master/blip-0002.md#feature-bits
111          */
112         public Result_NoneNoneZ set_optional_custom_bit(long bit) {
113                 long ret = bindings.InitFeatures_set_optional_custom_bit(this.ptr, bit);
114                 GC.KeepAlive(this);
115                 GC.KeepAlive(bit);
116                 if (ret >= 0 && ret <= 4096) { return null; }
117                 Result_NoneNoneZ ret_hu_conv = Result_NoneNoneZ.constr_from_ptr(ret);
118                 return ret_hu_conv;
119         }
120
121         /**
122          * Serialize the InitFeatures object into a byte array which can be read by InitFeatures_read
123          */
124         public byte[] write() {
125                 byte[] ret = bindings.InitFeatures_write(this.ptr);
126                 GC.KeepAlive(this);
127                 return ret;
128         }
129
130         /**
131          * Read a InitFeatures from a byte array, created by InitFeatures_write
132          */
133         public static Result_InitFeaturesDecodeErrorZ read(byte[] ser) {
134                 long ret = bindings.InitFeatures_read(ser);
135                 GC.KeepAlive(ser);
136                 if (ret >= 0 && ret <= 4096) { return null; }
137                 Result_InitFeaturesDecodeErrorZ ret_hu_conv = Result_InitFeaturesDecodeErrorZ.constr_from_ptr(ret);
138                 return ret_hu_conv;
139         }
140
141         /**
142          * Set this feature as optional.
143          */
144         public void set_data_loss_protect_optional() {
145                 bindings.InitFeatures_set_data_loss_protect_optional(this.ptr);
146                 GC.KeepAlive(this);
147         }
148
149         /**
150          * Set this feature as required.
151          */
152         public void set_data_loss_protect_required() {
153                 bindings.InitFeatures_set_data_loss_protect_required(this.ptr);
154                 GC.KeepAlive(this);
155         }
156
157         /**
158          * Checks if this feature is supported.
159          */
160         public bool supports_data_loss_protect() {
161                 bool ret = bindings.InitFeatures_supports_data_loss_protect(this.ptr);
162                 GC.KeepAlive(this);
163                 return ret;
164         }
165
166         /**
167          * Checks if this feature is required.
168          */
169         public bool requires_data_loss_protect() {
170                 bool ret = bindings.InitFeatures_requires_data_loss_protect(this.ptr);
171                 GC.KeepAlive(this);
172                 return ret;
173         }
174
175         /**
176          * Set this feature as optional.
177          */
178         public void set_initial_routing_sync_optional() {
179                 bindings.InitFeatures_set_initial_routing_sync_optional(this.ptr);
180                 GC.KeepAlive(this);
181         }
182
183         /**
184          * Set this feature as required.
185          */
186         public void set_initial_routing_sync_required() {
187                 bindings.InitFeatures_set_initial_routing_sync_required(this.ptr);
188                 GC.KeepAlive(this);
189         }
190
191         /**
192          * Checks if this feature is supported.
193          */
194         public bool initial_routing_sync() {
195                 bool ret = bindings.InitFeatures_initial_routing_sync(this.ptr);
196                 GC.KeepAlive(this);
197                 return ret;
198         }
199
200         /**
201          * Set this feature as optional.
202          */
203         public void set_upfront_shutdown_script_optional() {
204                 bindings.InitFeatures_set_upfront_shutdown_script_optional(this.ptr);
205                 GC.KeepAlive(this);
206         }
207
208         /**
209          * Set this feature as required.
210          */
211         public void set_upfront_shutdown_script_required() {
212                 bindings.InitFeatures_set_upfront_shutdown_script_required(this.ptr);
213                 GC.KeepAlive(this);
214         }
215
216         /**
217          * Checks if this feature is supported.
218          */
219         public bool supports_upfront_shutdown_script() {
220                 bool ret = bindings.InitFeatures_supports_upfront_shutdown_script(this.ptr);
221                 GC.KeepAlive(this);
222                 return ret;
223         }
224
225         /**
226          * Checks if this feature is required.
227          */
228         public bool requires_upfront_shutdown_script() {
229                 bool ret = bindings.InitFeatures_requires_upfront_shutdown_script(this.ptr);
230                 GC.KeepAlive(this);
231                 return ret;
232         }
233
234         /**
235          * Set this feature as optional.
236          */
237         public void set_gossip_queries_optional() {
238                 bindings.InitFeatures_set_gossip_queries_optional(this.ptr);
239                 GC.KeepAlive(this);
240         }
241
242         /**
243          * Set this feature as required.
244          */
245         public void set_gossip_queries_required() {
246                 bindings.InitFeatures_set_gossip_queries_required(this.ptr);
247                 GC.KeepAlive(this);
248         }
249
250         /**
251          * Checks if this feature is supported.
252          */
253         public bool supports_gossip_queries() {
254                 bool ret = bindings.InitFeatures_supports_gossip_queries(this.ptr);
255                 GC.KeepAlive(this);
256                 return ret;
257         }
258
259         /**
260          * Checks if this feature is required.
261          */
262         public bool requires_gossip_queries() {
263                 bool ret = bindings.InitFeatures_requires_gossip_queries(this.ptr);
264                 GC.KeepAlive(this);
265                 return ret;
266         }
267
268         /**
269          * Set this feature as optional.
270          */
271         public void set_variable_length_onion_optional() {
272                 bindings.InitFeatures_set_variable_length_onion_optional(this.ptr);
273                 GC.KeepAlive(this);
274         }
275
276         /**
277          * Set this feature as required.
278          */
279         public void set_variable_length_onion_required() {
280                 bindings.InitFeatures_set_variable_length_onion_required(this.ptr);
281                 GC.KeepAlive(this);
282         }
283
284         /**
285          * Checks if this feature is supported.
286          */
287         public bool supports_variable_length_onion() {
288                 bool ret = bindings.InitFeatures_supports_variable_length_onion(this.ptr);
289                 GC.KeepAlive(this);
290                 return ret;
291         }
292
293         /**
294          * Checks if this feature is required.
295          */
296         public bool requires_variable_length_onion() {
297                 bool ret = bindings.InitFeatures_requires_variable_length_onion(this.ptr);
298                 GC.KeepAlive(this);
299                 return ret;
300         }
301
302         /**
303          * Set this feature as optional.
304          */
305         public void set_static_remote_key_optional() {
306                 bindings.InitFeatures_set_static_remote_key_optional(this.ptr);
307                 GC.KeepAlive(this);
308         }
309
310         /**
311          * Set this feature as required.
312          */
313         public void set_static_remote_key_required() {
314                 bindings.InitFeatures_set_static_remote_key_required(this.ptr);
315                 GC.KeepAlive(this);
316         }
317
318         /**
319          * Checks if this feature is supported.
320          */
321         public bool supports_static_remote_key() {
322                 bool ret = bindings.InitFeatures_supports_static_remote_key(this.ptr);
323                 GC.KeepAlive(this);
324                 return ret;
325         }
326
327         /**
328          * Checks if this feature is required.
329          */
330         public bool requires_static_remote_key() {
331                 bool ret = bindings.InitFeatures_requires_static_remote_key(this.ptr);
332                 GC.KeepAlive(this);
333                 return ret;
334         }
335
336         /**
337          * Set this feature as optional.
338          */
339         public void set_payment_secret_optional() {
340                 bindings.InitFeatures_set_payment_secret_optional(this.ptr);
341                 GC.KeepAlive(this);
342         }
343
344         /**
345          * Set this feature as required.
346          */
347         public void set_payment_secret_required() {
348                 bindings.InitFeatures_set_payment_secret_required(this.ptr);
349                 GC.KeepAlive(this);
350         }
351
352         /**
353          * Checks if this feature is supported.
354          */
355         public bool supports_payment_secret() {
356                 bool ret = bindings.InitFeatures_supports_payment_secret(this.ptr);
357                 GC.KeepAlive(this);
358                 return ret;
359         }
360
361         /**
362          * Checks if this feature is required.
363          */
364         public bool requires_payment_secret() {
365                 bool ret = bindings.InitFeatures_requires_payment_secret(this.ptr);
366                 GC.KeepAlive(this);
367                 return ret;
368         }
369
370         /**
371          * Set this feature as optional.
372          */
373         public void set_basic_mpp_optional() {
374                 bindings.InitFeatures_set_basic_mpp_optional(this.ptr);
375                 GC.KeepAlive(this);
376         }
377
378         /**
379          * Set this feature as required.
380          */
381         public void set_basic_mpp_required() {
382                 bindings.InitFeatures_set_basic_mpp_required(this.ptr);
383                 GC.KeepAlive(this);
384         }
385
386         /**
387          * Checks if this feature is supported.
388          */
389         public bool supports_basic_mpp() {
390                 bool ret = bindings.InitFeatures_supports_basic_mpp(this.ptr);
391                 GC.KeepAlive(this);
392                 return ret;
393         }
394
395         /**
396          * Checks if this feature is required.
397          */
398         public bool requires_basic_mpp() {
399                 bool ret = bindings.InitFeatures_requires_basic_mpp(this.ptr);
400                 GC.KeepAlive(this);
401                 return ret;
402         }
403
404         /**
405          * Set this feature as optional.
406          */
407         public void set_wumbo_optional() {
408                 bindings.InitFeatures_set_wumbo_optional(this.ptr);
409                 GC.KeepAlive(this);
410         }
411
412         /**
413          * Set this feature as required.
414          */
415         public void set_wumbo_required() {
416                 bindings.InitFeatures_set_wumbo_required(this.ptr);
417                 GC.KeepAlive(this);
418         }
419
420         /**
421          * Checks if this feature is supported.
422          */
423         public bool supports_wumbo() {
424                 bool ret = bindings.InitFeatures_supports_wumbo(this.ptr);
425                 GC.KeepAlive(this);
426                 return ret;
427         }
428
429         /**
430          * Checks if this feature is required.
431          */
432         public bool requires_wumbo() {
433                 bool ret = bindings.InitFeatures_requires_wumbo(this.ptr);
434                 GC.KeepAlive(this);
435                 return ret;
436         }
437
438         /**
439          * Set this feature as optional.
440          */
441         public void set_anchors_nonzero_fee_htlc_tx_optional() {
442                 bindings.InitFeatures_set_anchors_nonzero_fee_htlc_tx_optional(this.ptr);
443                 GC.KeepAlive(this);
444         }
445
446         /**
447          * Set this feature as required.
448          */
449         public void set_anchors_nonzero_fee_htlc_tx_required() {
450                 bindings.InitFeatures_set_anchors_nonzero_fee_htlc_tx_required(this.ptr);
451                 GC.KeepAlive(this);
452         }
453
454         /**
455          * Checks if this feature is supported.
456          */
457         public bool supports_anchors_nonzero_fee_htlc_tx() {
458                 bool ret = bindings.InitFeatures_supports_anchors_nonzero_fee_htlc_tx(this.ptr);
459                 GC.KeepAlive(this);
460                 return ret;
461         }
462
463         /**
464          * Checks if this feature is required.
465          */
466         public bool requires_anchors_nonzero_fee_htlc_tx() {
467                 bool ret = bindings.InitFeatures_requires_anchors_nonzero_fee_htlc_tx(this.ptr);
468                 GC.KeepAlive(this);
469                 return ret;
470         }
471
472         /**
473          * Set this feature as optional.
474          */
475         public void set_anchors_zero_fee_htlc_tx_optional() {
476                 bindings.InitFeatures_set_anchors_zero_fee_htlc_tx_optional(this.ptr);
477                 GC.KeepAlive(this);
478         }
479
480         /**
481          * Set this feature as required.
482          */
483         public void set_anchors_zero_fee_htlc_tx_required() {
484                 bindings.InitFeatures_set_anchors_zero_fee_htlc_tx_required(this.ptr);
485                 GC.KeepAlive(this);
486         }
487
488         /**
489          * Checks if this feature is supported.
490          */
491         public bool supports_anchors_zero_fee_htlc_tx() {
492                 bool ret = bindings.InitFeatures_supports_anchors_zero_fee_htlc_tx(this.ptr);
493                 GC.KeepAlive(this);
494                 return ret;
495         }
496
497         /**
498          * Checks if this feature is required.
499          */
500         public bool requires_anchors_zero_fee_htlc_tx() {
501                 bool ret = bindings.InitFeatures_requires_anchors_zero_fee_htlc_tx(this.ptr);
502                 GC.KeepAlive(this);
503                 return ret;
504         }
505
506         /**
507          * Set this feature as optional.
508          */
509         public void set_shutdown_any_segwit_optional() {
510                 bindings.InitFeatures_set_shutdown_any_segwit_optional(this.ptr);
511                 GC.KeepAlive(this);
512         }
513
514         /**
515          * Set this feature as required.
516          */
517         public void set_shutdown_any_segwit_required() {
518                 bindings.InitFeatures_set_shutdown_any_segwit_required(this.ptr);
519                 GC.KeepAlive(this);
520         }
521
522         /**
523          * Checks if this feature is supported.
524          */
525         public bool supports_shutdown_anysegwit() {
526                 bool ret = bindings.InitFeatures_supports_shutdown_anysegwit(this.ptr);
527                 GC.KeepAlive(this);
528                 return ret;
529         }
530
531         /**
532          * Checks if this feature is required.
533          */
534         public bool requires_shutdown_anysegwit() {
535                 bool ret = bindings.InitFeatures_requires_shutdown_anysegwit(this.ptr);
536                 GC.KeepAlive(this);
537                 return ret;
538         }
539
540         /**
541          * Set this feature as optional.
542          */
543         public void set_onion_messages_optional() {
544                 bindings.InitFeatures_set_onion_messages_optional(this.ptr);
545                 GC.KeepAlive(this);
546         }
547
548         /**
549          * Set this feature as required.
550          */
551         public void set_onion_messages_required() {
552                 bindings.InitFeatures_set_onion_messages_required(this.ptr);
553                 GC.KeepAlive(this);
554         }
555
556         /**
557          * Checks if this feature is supported.
558          */
559         public bool supports_onion_messages() {
560                 bool ret = bindings.InitFeatures_supports_onion_messages(this.ptr);
561                 GC.KeepAlive(this);
562                 return ret;
563         }
564
565         /**
566          * Checks if this feature is required.
567          */
568         public bool requires_onion_messages() {
569                 bool ret = bindings.InitFeatures_requires_onion_messages(this.ptr);
570                 GC.KeepAlive(this);
571                 return ret;
572         }
573
574         /**
575          * Set this feature as optional.
576          */
577         public void set_channel_type_optional() {
578                 bindings.InitFeatures_set_channel_type_optional(this.ptr);
579                 GC.KeepAlive(this);
580         }
581
582         /**
583          * Set this feature as required.
584          */
585         public void set_channel_type_required() {
586                 bindings.InitFeatures_set_channel_type_required(this.ptr);
587                 GC.KeepAlive(this);
588         }
589
590         /**
591          * Checks if this feature is supported.
592          */
593         public bool supports_channel_type() {
594                 bool ret = bindings.InitFeatures_supports_channel_type(this.ptr);
595                 GC.KeepAlive(this);
596                 return ret;
597         }
598
599         /**
600          * Checks if this feature is required.
601          */
602         public bool requires_channel_type() {
603                 bool ret = bindings.InitFeatures_requires_channel_type(this.ptr);
604                 GC.KeepAlive(this);
605                 return ret;
606         }
607
608         /**
609          * Set this feature as optional.
610          */
611         public void set_scid_privacy_optional() {
612                 bindings.InitFeatures_set_scid_privacy_optional(this.ptr);
613                 GC.KeepAlive(this);
614         }
615
616         /**
617          * Set this feature as required.
618          */
619         public void set_scid_privacy_required() {
620                 bindings.InitFeatures_set_scid_privacy_required(this.ptr);
621                 GC.KeepAlive(this);
622         }
623
624         /**
625          * Checks if this feature is supported.
626          */
627         public bool supports_scid_privacy() {
628                 bool ret = bindings.InitFeatures_supports_scid_privacy(this.ptr);
629                 GC.KeepAlive(this);
630                 return ret;
631         }
632
633         /**
634          * Checks if this feature is required.
635          */
636         public bool requires_scid_privacy() {
637                 bool ret = bindings.InitFeatures_requires_scid_privacy(this.ptr);
638                 GC.KeepAlive(this);
639                 return ret;
640         }
641
642         /**
643          * Set this feature as optional.
644          */
645         public void set_zero_conf_optional() {
646                 bindings.InitFeatures_set_zero_conf_optional(this.ptr);
647                 GC.KeepAlive(this);
648         }
649
650         /**
651          * Set this feature as required.
652          */
653         public void set_zero_conf_required() {
654                 bindings.InitFeatures_set_zero_conf_required(this.ptr);
655                 GC.KeepAlive(this);
656         }
657
658         /**
659          * Checks if this feature is supported.
660          */
661         public bool supports_zero_conf() {
662                 bool ret = bindings.InitFeatures_supports_zero_conf(this.ptr);
663                 GC.KeepAlive(this);
664                 return ret;
665         }
666
667         /**
668          * Checks if this feature is required.
669          */
670         public bool requires_zero_conf() {
671                 bool ret = bindings.InitFeatures_requires_zero_conf(this.ptr);
672                 GC.KeepAlive(this);
673                 return ret;
674         }
675
676 }
677 } } }