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

diff --git a/src/main/java/org/ldk/structs/ChannelAnnouncement.java b/src/main/java/org/ldk/structs/ChannelAnnouncement.java
index 52c88eac..447b9bf0 100644
--- a/src/main/java/org/ldk/structs/ChannelAnnouncement.java
+++ b/src/main/java/org/ldk/structs/ChannelAnnouncement.java
@@ -5,6 +5,10 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * A channel_announcement message to be sent or received from a peer
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChannelAnnouncement extends CommonBase {
 	ChannelAnnouncement(Object _dummy, long ptr) { super(ptr); }
@@ -14,42 +18,69 @@ public class ChannelAnnouncement extends CommonBase {
 		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);
 		return ret;
 	}
 
+	/**
+	 * 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, val);
 	}
 
+	/**
+	 * 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);
 		return ret;
 	}
 
+	/**
+	 * 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, val);
 	}
 
+	/**
+	 * 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);
 		return ret;
 	}
 
+	/**
+	 * 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, val);
 	}
 
+	/**
+	 * 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);
 		return ret;
 	}
 
+	/**
+	 * 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, val);
 	}
 
+	/**
+	 * The actual announcement
+	 */
 	public UnsignedChannelAnnouncement get_contents() {
 		long ret = bindings.ChannelAnnouncement_get_contents(this.ptr);
 		UnsignedChannelAnnouncement ret_hu_conv = new UnsignedChannelAnnouncement(null, ret);
@@ -57,11 +88,17 @@ public class ChannelAnnouncement extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * The actual announcement
+	 */
 	public void set_contents(UnsignedChannelAnnouncement val) {
 		bindings.ChannelAnnouncement_set_contents(this.ptr, val == null ? 0 : val.ptr & ~1);
 		this.ptrs_to.add(val);
 	}
 
+	/**
+	 * Constructs a new ChannelAnnouncement given each field
+	 */
 	public static ChannelAnnouncement constructor_new(byte[] node_signature_1_arg, byte[] node_signature_2_arg, byte[] bitcoin_signature_1_arg, byte[] bitcoin_signature_2_arg, UnsignedChannelAnnouncement contents_arg) {
 		long ret = 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);
 		ChannelAnnouncement ret_hu_conv = new ChannelAnnouncement(null, ret);
@@ -70,6 +107,9 @@ public class ChannelAnnouncement extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a copy of the ChannelAnnouncement
+	 */
 	public ChannelAnnouncement clone() {
 		long ret = bindings.ChannelAnnouncement_clone(this.ptr);
 		ChannelAnnouncement ret_hu_conv = new ChannelAnnouncement(null, ret);
@@ -77,11 +117,17 @@ public class ChannelAnnouncement extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * 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);
 		return ret;
 	}
 
+	/**
+	 * Read a ChannelAnnouncement from a byte array, created by ChannelAnnouncement_write
+	 */
 	public static Result_ChannelAnnouncementDecodeErrorZ constructor_read(byte[] ser) {
 		long ret = bindings.ChannelAnnouncement_read(ser);
 		Result_ChannelAnnouncementDecodeErrorZ ret_hu_conv = Result_ChannelAnnouncementDecodeErrorZ.constr_from_ptr(ret);