Update auto-generated bindings
[ldk-java] / src / main / java / org / ldk / structs / NetAddress.java
index 646489eba079debf0fdb35a3860ef4ca38e2add5..242e169a35d64570e086c56e86eabf13dc665c22 100644 (file)
@@ -4,6 +4,7 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import javax.annotation.Nullable;
 
 
 /**
@@ -34,8 +35,17 @@ public class NetAddress extends CommonBase {
                assert false; return null; // Unreachable without extending the (internal) bindings interface
        }
 
+       /**
+        * An IPv4 address/port on which the peer is listening.
+        */
        public final static class IPv4 extends NetAddress {
+               /**
+                * The 4-byte IPv4 address
+               */
                public final byte[] addr;
+               /**
+                * The port on which the node is listening
+               */
                public final short port;
                private IPv4(long ptr, bindings.LDKNetAddress.IPv4 obj) {
                        super(null, ptr);
@@ -43,8 +53,17 @@ public class NetAddress extends CommonBase {
                        this.port = obj.port;
                }
        }
+       /**
+        * An IPv6 address/port on which the peer is listening.
+        */
        public final static class IPv6 extends NetAddress {
+               /**
+                * The 16-byte IPv6 address
+               */
                public final byte[] addr;
+               /**
+                * The port on which the node is listening
+               */
                public final short port;
                private IPv6(long ptr, bindings.LDKNetAddress.IPv6 obj) {
                        super(null, ptr);
@@ -52,8 +71,17 @@ public class NetAddress extends CommonBase {
                        this.port = obj.port;
                }
        }
+       /**
+        * An old-style Tor onion address/port on which the peer is listening.
+        */
        public final static class OnionV2 extends NetAddress {
+               /**
+                * The bytes (usually encoded in base32 with \".onion\" appended)
+               */
                public final byte[] addr;
+               /**
+                * The port on which the node is listening
+               */
                public final short port;
                private OnionV2(long ptr, bindings.LDKNetAddress.OnionV2 obj) {
                        super(null, ptr);
@@ -61,10 +89,27 @@ public class NetAddress extends CommonBase {
                        this.port = obj.port;
                }
        }
+       /**
+        * A new-style Tor onion address/port on which the peer is listening.
+        * To create the human-readable \"hostname\", concatenate ed25519_pubkey, checksum, and version,
+        * wrap as base32 and append \".onion\".
+        */
        public final static class OnionV3 extends NetAddress {
+               /**
+                * The ed25519 long-term public key of the peer
+               */
                public final byte[] ed25519_pubkey;
+               /**
+                * The checksum of the pubkey and version, as included in the onion address
+               */
                public final short checksum;
+               /**
+                * The version byte, as defined by the Tor Onion v3 spec.
+               */
                public final byte version;
+               /**
+                * The port on which the node is listening
+               */
                public final short port;
                private OnionV3(long ptr, bindings.LDKNetAddress.OnionV3 obj) {
                        super(null, ptr);
@@ -74,16 +119,66 @@ public class NetAddress extends CommonBase {
                        this.port = obj.port;
                }
        }
+       long clone_ptr() {
+               long ret = bindings.NetAddress_clone_ptr(this.ptr);
+               return ret;
+       }
+
        /**
         * Creates a copy of the NetAddress
         */
        public NetAddress clone() {
                long ret = bindings.NetAddress_clone(this.ptr);
+               if (ret >= 0 && ret <= 4096) { return null; }
                NetAddress ret_hu_conv = NetAddress.constr_from_ptr(ret);
                ret_hu_conv.ptrs_to.add(this);
                return ret_hu_conv;
        }
 
+       /**
+        * Utility method to constructs a new IPv4-variant NetAddress
+        */
+       public static NetAddress ipv4(byte[] addr, short port) {
+               long ret = bindings.NetAddress_ipv4(InternalUtils.check_arr_len(addr, 4), port);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               NetAddress ret_hu_conv = NetAddress.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new IPv6-variant NetAddress
+        */
+       public static NetAddress ipv6(byte[] addr, short port) {
+               long ret = bindings.NetAddress_ipv6(InternalUtils.check_arr_len(addr, 16), port);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               NetAddress ret_hu_conv = NetAddress.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new OnionV2-variant NetAddress
+        */
+       public static NetAddress onion_v2(byte[] addr, short port) {
+               long ret = bindings.NetAddress_onion_v2(InternalUtils.check_arr_len(addr, 10), port);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               NetAddress ret_hu_conv = NetAddress.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new OnionV3-variant NetAddress
+        */
+       public static NetAddress onion_v3(byte[] ed25519_pubkey, short checksum, byte version, short port) {
+               long ret = bindings.NetAddress_onion_v3(InternalUtils.check_arr_len(ed25519_pubkey, 32), checksum, version, port);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               NetAddress ret_hu_conv = NetAddress.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
        /**
         * Serialize the NetAddress object into a byte array which can be read by NetAddress_read
         */
@@ -92,4 +187,14 @@ public class NetAddress extends CommonBase {
                return ret;
        }
 
+       /**
+        * Read a NetAddress from a byte array, created by NetAddress_write
+        */
+       public static Result_NetAddressDecodeErrorZ read(byte[] ser) {
+               long ret = bindings.NetAddress_read(ser);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_NetAddressDecodeErrorZ ret_hu_conv = Result_NetAddressDecodeErrorZ.constr_from_ptr(ret);
+               return ret_hu_conv;
+       }
+
 }