X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-java;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FShutdown.java;h=b57589739e4312bad91230f56743c1022ba964d7;hp=ec11fcc00363c6f48f1a798dcd4b75377f025392;hb=17113550a5fefab21f39f27fbfe02646b8db53ae;hpb=d69a40d071871d3c0e4160744202c6e85941a4cc

diff --git a/src/main/java/org/ldk/structs/Shutdown.java b/src/main/java/org/ldk/structs/Shutdown.java
index ec11fcc0..b5758973 100644
--- a/src/main/java/org/ldk/structs/Shutdown.java
+++ b/src/main/java/org/ldk/structs/Shutdown.java
@@ -5,6 +5,10 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * 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,24 +18,41 @@ public class Shutdown extends CommonBase {
 		if (ptr != 0) { bindings.Shutdown_free(ptr); }
 	}
 
+	/**
+	 * 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);
 	}
 
+	/**
+	 * Constructs a new Shutdown given each field
+	 */
 	public static Shutdown constructor_new(byte[] channel_id_arg, byte[] scriptpubkey_arg) {
 		long ret = bindings.Shutdown_new(channel_id_arg, scriptpubkey_arg);
 		Shutdown ret_hu_conv = new Shutdown(null, ret);
@@ -39,6 +60,9 @@ public class Shutdown extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a copy of the Shutdown
+	 */
 	public Shutdown clone() {
 		long ret = bindings.Shutdown_clone(this.ptr);
 		Shutdown ret_hu_conv = new Shutdown(null, ret);
@@ -46,11 +70,17 @@ public class Shutdown extends CommonBase {
 		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;
 	}
 
+	/**
+	 * Read a Shutdown from a byte array, created by Shutdown_write
+	 */
 	public static Result_ShutdownDecodeErrorZ constructor_read(byte[] ser) {
 		long ret = bindings.Shutdown_read(ser);
 		Result_ShutdownDecodeErrorZ ret_hu_conv = Result_ShutdownDecodeErrorZ.constr_from_ptr(ret);