X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FShutdown.java;h=187027b436a832014bd7dfeb2b54a91b974ddd5a;hb=32692e00046b7ec16b6a2e20bd54800b2b48d4c0;hp=491939cd70e2db356a66f17f7454d7803d6d9e05;hpb=fed2245c60159f6c074c9ed5c0f3ce273ad9841b;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/Shutdown.java b/src/main/java/org/ldk/structs/Shutdown.java
index 491939cd..187027b4 100644
--- a/src/main/java/org/ldk/structs/Shutdown.java
+++ b/src/main/java/org/ldk/structs/Shutdown.java
@@ -4,7 +4,12 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import javax.annotation.Nullable;
 
+
+/**
+ * A shutdown message to be sent or received from a peer
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class Shutdown extends CommonBase {
 	Shutdown(Object _dummy, long ptr) { super(ptr); }
@@ -14,47 +19,75 @@ public class Shutdown extends CommonBase {
 		if (ptr != 0) { bindings.Shutdown_free(ptr); }
 	}
 
-	public Shutdown clone() {
-		long ret = bindings.Shutdown_clone(this.ptr);
-		Shutdown ret_hu_conv = new Shutdown(null, ret);
-		ret_hu_conv.ptrs_to.add(this);
-		return ret_hu_conv;
-	}
-
+	/**
+	 * The channel ID
+	 */
 	public byte[] get_channel_id() {
 		byte[] ret = bindings.Shutdown_get_channel_id(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The channel ID
+	 */
 	public void set_channel_id(byte[] val) {
 		bindings.Shutdown_set_channel_id(this.ptr, val);
 	}
 
+	/**
+	 * The destination of this peer's funds on closing.
+	 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
+	 */
 	public byte[] get_scriptpubkey() {
 		byte[] ret = bindings.Shutdown_get_scriptpubkey(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The destination of this peer's funds on closing.
+	 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
+	 */
 	public void set_scriptpubkey(byte[] val) {
 		bindings.Shutdown_set_scriptpubkey(this.ptr, val);
 	}
 
-	public static Shutdown constructor_new(byte[] channel_id_arg, byte[] scriptpubkey_arg) {
+	/**
+	 * Constructs a new Shutdown given each field
+	 */
+	public static Shutdown of(byte[] channel_id_arg, byte[] scriptpubkey_arg) {
 		long ret = bindings.Shutdown_new(channel_id_arg, scriptpubkey_arg);
+		if (ret >= 0 && ret < 1024) { return null; }
 		Shutdown ret_hu_conv = new Shutdown(null, ret);
 		ret_hu_conv.ptrs_to.add(ret_hu_conv);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a copy of the Shutdown
+	 */
+	public Shutdown clone() {
+		long ret = bindings.Shutdown_clone(this.ptr);
+		if (ret >= 0 && ret < 1024) { return null; }
+		Shutdown ret_hu_conv = new Shutdown(null, ret);
+		ret_hu_conv.ptrs_to.add(this);
+		return ret_hu_conv;
+	}
+
+	/**
+	 * Serialize the Shutdown object into a byte array which can be read by Shutdown_read
+	 */
 	public byte[] write() {
 		byte[] ret = bindings.Shutdown_write(this.ptr);
 		return ret;
 	}
 
-	public static Shutdown constructor_read(byte[] ser) {
+	/**
+	 * Read a Shutdown from a byte array, created by Shutdown_write
+	 */
+	public static Result_ShutdownDecodeErrorZ read(byte[] ser) {
 		long ret = bindings.Shutdown_read(ser);
-		Shutdown ret_hu_conv = new Shutdown(null, ret);
-		ret_hu_conv.ptrs_to.add(ret_hu_conv);
+		if (ret >= 0 && ret < 1024) { return null; }
+		Result_ShutdownDecodeErrorZ ret_hu_conv = Result_ShutdownDecodeErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}