[Java] Update auto-generated Java bindings to LDK 0.0.121
[ldk-java] / src / main / java / org / ldk / structs / ChannelAnnouncement.java
index 9d36fcdfab168049a98b2e2cac325f8c65caa07b..ffac3ff74c6dafcd18365a972cf04dfa54b21a74 100644 (file)
@@ -2,89 +2,202 @@ package org.ldk.structs;
 
 import org.ldk.impl.bindings;
 import org.ldk.enums.*;
-
+import org.ldk.util.*;
+import java.util.Arrays;
+import java.lang.ref.Reference;
+import javax.annotation.Nullable;
+
+
+/**
+ * A [`channel_announcement`] message to be sent to or received from a peer.
+ * 
+ * [`channel_announcement`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_announcement-message
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChannelAnnouncement extends CommonBase {
        ChannelAnnouncement(Object _dummy, long ptr) { super(ptr); }
        @Override @SuppressWarnings("deprecation")
        protected void finalize() throws Throwable {
                super.finalize();
-               bindings.ChannelAnnouncement_free(ptr);
+               if (ptr != 0) { bindings.ChannelAnnouncement_free(ptr); }
+       }
+
+       /**
+        * Authentication of the announcement by the first public node
+        */
+       public byte[] get_node_signature_1() {
+               byte[] ret = bindings.ChannelAnnouncement_get_node_signature_1(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
        }
 
-       public ChannelAnnouncement(ChannelAnnouncement orig) {
-               super(bindings.ChannelAnnouncement_clone(orig == null ? 0 : orig.ptr & ~1));
-               this.ptrs_to.add(orig);
+       /**
+        * Authentication of the announcement by the first public node
+        */
+       public void set_node_signature_1(byte[] val) {
+               bindings.ChannelAnnouncement_set_node_signature_1(this.ptr, InternalUtils.check_arr_len(val, 64));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
-       public byte[] get_node_signature_1(ChannelAnnouncement this_ptr) {
-               byte[] ret = bindings.ChannelAnnouncement_get_node_signature_1(this_ptr == null ? 0 : this_ptr.ptr & ~1);
-               this.ptrs_to.add(this_ptr);
+       /**
+        * Authentication of the announcement by the second public node
+        */
+       public byte[] get_node_signature_2() {
+               byte[] ret = bindings.ChannelAnnouncement_get_node_signature_2(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
-       public void set_node_signature_1(ChannelAnnouncement this_ptr, byte[] val) {
-               bindings.ChannelAnnouncement_set_node_signature_1(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
-               this.ptrs_to.add(this_ptr);
+       /**
+        * Authentication of the announcement by the second public node
+        */
+       public void set_node_signature_2(byte[] val) {
+               bindings.ChannelAnnouncement_set_node_signature_2(this.ptr, InternalUtils.check_arr_len(val, 64));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
-       public byte[] get_node_signature_2(ChannelAnnouncement this_ptr) {
-               byte[] ret = bindings.ChannelAnnouncement_get_node_signature_2(this_ptr == null ? 0 : this_ptr.ptr & ~1);
-               this.ptrs_to.add(this_ptr);
+       /**
+        * Proof of funding UTXO ownership by the first public node
+        */
+       public byte[] get_bitcoin_signature_1() {
+               byte[] ret = bindings.ChannelAnnouncement_get_bitcoin_signature_1(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
-       public void set_node_signature_2(ChannelAnnouncement this_ptr, byte[] val) {
-               bindings.ChannelAnnouncement_set_node_signature_2(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
-               this.ptrs_to.add(this_ptr);
+       /**
+        * Proof of funding UTXO ownership by the first public node
+        */
+       public void set_bitcoin_signature_1(byte[] val) {
+               bindings.ChannelAnnouncement_set_bitcoin_signature_1(this.ptr, InternalUtils.check_arr_len(val, 64));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
-       public byte[] get_bitcoin_signature_1(ChannelAnnouncement this_ptr) {
-               byte[] ret = bindings.ChannelAnnouncement_get_bitcoin_signature_1(this_ptr == null ? 0 : this_ptr.ptr & ~1);
-               this.ptrs_to.add(this_ptr);
+       /**
+        * Proof of funding UTXO ownership by the second public node
+        */
+       public byte[] get_bitcoin_signature_2() {
+               byte[] ret = bindings.ChannelAnnouncement_get_bitcoin_signature_2(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
-       public void set_bitcoin_signature_1(ChannelAnnouncement this_ptr, byte[] val) {
-               bindings.ChannelAnnouncement_set_bitcoin_signature_1(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
-               this.ptrs_to.add(this_ptr);
+       /**
+        * Proof of funding UTXO ownership by the second public node
+        */
+       public void set_bitcoin_signature_2(byte[] val) {
+               bindings.ChannelAnnouncement_set_bitcoin_signature_2(this.ptr, InternalUtils.check_arr_len(val, 64));
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
        }
 
-       public byte[] get_bitcoin_signature_2(ChannelAnnouncement this_ptr) {
-               byte[] ret = bindings.ChannelAnnouncement_get_bitcoin_signature_2(this_ptr == null ? 0 : this_ptr.ptr & ~1);
-               this.ptrs_to.add(this_ptr);
-               return ret;
+       /**
+        * The actual announcement
+        */
+       public UnsignedChannelAnnouncement get_contents() {
+               long ret = bindings.ChannelAnnouncement_get_contents(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.UnsignedChannelAnnouncement ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.UnsignedChannelAnnouncement(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+               return ret_hu_conv;
+       }
+
+       /**
+        * The actual announcement
+        */
+       public void set_contents(org.ldk.structs.UnsignedChannelAnnouncement val) {
+               bindings.ChannelAnnouncement_set_contents(this.ptr, val == null ? 0 : val.ptr);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(val);
+               if (this != null) { this.ptrs_to.add(val); };
        }
 
-       public void set_bitcoin_signature_2(ChannelAnnouncement this_ptr, byte[] val) {
-               bindings.ChannelAnnouncement_set_bitcoin_signature_2(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
-               this.ptrs_to.add(this_ptr);
+       /**
+        * Constructs a new ChannelAnnouncement given each field
+        */
+       public static ChannelAnnouncement of(byte[] node_signature_1_arg, byte[] node_signature_2_arg, byte[] bitcoin_signature_1_arg, byte[] bitcoin_signature_2_arg, org.ldk.structs.UnsignedChannelAnnouncement contents_arg) {
+               long ret = bindings.ChannelAnnouncement_new(InternalUtils.check_arr_len(node_signature_1_arg, 64), InternalUtils.check_arr_len(node_signature_2_arg, 64), InternalUtils.check_arr_len(bitcoin_signature_1_arg, 64), InternalUtils.check_arr_len(bitcoin_signature_2_arg, 64), contents_arg == null ? 0 : contents_arg.ptr);
+               Reference.reachabilityFence(node_signature_1_arg);
+               Reference.reachabilityFence(node_signature_2_arg);
+               Reference.reachabilityFence(bitcoin_signature_1_arg);
+               Reference.reachabilityFence(bitcoin_signature_2_arg);
+               Reference.reachabilityFence(contents_arg);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.ChannelAnnouncement ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelAnnouncement(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(contents_arg); };
+               return ret_hu_conv;
        }
 
-       public UnsignedChannelAnnouncement get_contents(ChannelAnnouncement this_ptr) {
-               UnsignedChannelAnnouncement ret = new UnsignedChannelAnnouncement(null, bindings.ChannelAnnouncement_get_contents(this_ptr == null ? 0 : this_ptr.ptr & ~1));
-               this.ptrs_to.add(this_ptr);
+       long clone_ptr() {
+               long ret = bindings.ChannelAnnouncement_clone_ptr(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
-       public void set_contents(ChannelAnnouncement this_ptr, UnsignedChannelAnnouncement val) {
-               bindings.ChannelAnnouncement_set_contents(this_ptr == null ? 0 : this_ptr.ptr & ~1, val == null ? 0 : val.ptr & ~1);
-               this.ptrs_to.add(this_ptr);
-               this.ptrs_to.add(val);
+       /**
+        * Creates a copy of the ChannelAnnouncement
+        */
+       public ChannelAnnouncement clone() {
+               long ret = bindings.ChannelAnnouncement_clone(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.ChannelAnnouncement ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelAnnouncement(null, ret); }
+               if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
+               return ret_hu_conv;
        }
 
-       public ChannelAnnouncement(byte[] node_signature_1_arg, byte[] node_signature_2_arg, byte[] bitcoin_signature_1_arg, byte[] bitcoin_signature_2_arg, UnsignedChannelAnnouncement contents_arg) {
-               super(bindings.ChannelAnnouncement_new(node_signature_1_arg, node_signature_2_arg, bitcoin_signature_1_arg, bitcoin_signature_2_arg, contents_arg == null ? 0 : contents_arg.ptr & ~1));
-               this.ptrs_to.add(contents_arg);
+       /**
+        * Generates a non-cryptographic 64-bit hash of the ChannelAnnouncement.
+        */
+       public long hash() {
+               long ret = bindings.ChannelAnnouncement_hash(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       @Override public int hashCode() {
+               return (int)this.hash();
+       }
+       /**
+        * Checks if two ChannelAnnouncements contain equal inner contents.
+        * This ignores pointers and is_owned flags and looks at the values in fields.
+        * Two objects with NULL inner values will be considered "equal" here.
+        */
+       public boolean eq(org.ldk.structs.ChannelAnnouncement b) {
+               boolean ret = bindings.ChannelAnnouncement_eq(this.ptr, b == null ? 0 : b.ptr);
+               Reference.reachabilityFence(this);
+               Reference.reachabilityFence(b);
+               if (this != null) { this.ptrs_to.add(b); };
+               return ret;
        }
 
-       public byte[] write(ChannelAnnouncement obj) {
-               byte[] ret = bindings.ChannelAnnouncement_write(obj == null ? 0 : obj.ptr & ~1);
-               this.ptrs_to.add(obj);
+       @Override public boolean equals(Object o) {
+               if (!(o instanceof ChannelAnnouncement)) return false;
+               return this.eq((ChannelAnnouncement)o);
+       }
+       /**
+        * Serialize the ChannelAnnouncement object into a byte array which can be read by ChannelAnnouncement_read
+        */
+       public byte[] write() {
+               byte[] ret = bindings.ChannelAnnouncement_write(this.ptr);
+               Reference.reachabilityFence(this);
                return ret;
        }
 
-       public ChannelAnnouncement(byte[] ser) {
-               super(bindings.ChannelAnnouncement_read(ser));
+       /**
+        * Read a ChannelAnnouncement from a byte array, created by ChannelAnnouncement_write
+        */
+       public static Result_ChannelAnnouncementDecodeErrorZ read(byte[] ser) {
+               long ret = bindings.ChannelAnnouncement_read(ser);
+               Reference.reachabilityFence(ser);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_ChannelAnnouncementDecodeErrorZ ret_hu_conv = Result_ChannelAnnouncementDecodeErrorZ.constr_from_ptr(ret);
+               return ret_hu_conv;
        }
 
 }