X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FNodeInfo.java;fp=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FNodeInfo.java;h=420323749d80c55c7e7944ba13baf3cc203b2247;hb=1b870a3ffab1c0024411e30102bc6d198300f095;hp=8b9837398d36a2f49bbfb685bf011357ebe09321;hpb=246459dcbc3be28c38b4951140a5933f4b3aa024;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/NodeInfo.java b/src/main/java/org/ldk/structs/NodeInfo.java
index 8b983739..42032374 100644
--- a/src/main/java/org/ldk/structs/NodeInfo.java
+++ b/src/main/java/org/ldk/structs/NodeInfo.java
@@ -5,6 +5,10 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * Details about a node in the network, known from the network announcement.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class NodeInfo extends CommonBase {
 	NodeInfo(Object _dummy, long ptr) { super(ptr); }
@@ -14,10 +18,18 @@ public class NodeInfo extends CommonBase {
 		if (ptr != 0) { bindings.NodeInfo_free(ptr); }
 	}
 
+	/**
+	 * All valid channels a node has announced
+	 */
 	public void set_channels(long[] val) {
 		bindings.NodeInfo_set_channels(this.ptr, val);
 	}
 
+	/**
+	 * Lowest fees enabling routing via any of the enabled, known channels to a node.
+	 * The two fields (flat and proportional fee) are independent,
+	 * meaning they don't have to refer to the same channel.
+	 */
 	public RoutingFees get_lowest_inbound_channel_fees() {
 		long ret = bindings.NodeInfo_get_lowest_inbound_channel_fees(this.ptr);
 		RoutingFees ret_hu_conv = new RoutingFees(null, ret);
@@ -25,11 +37,21 @@ public class NodeInfo extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Lowest fees enabling routing via any of the enabled, known channels to a node.
+	 * The two fields (flat and proportional fee) are independent,
+	 * meaning they don't have to refer to the same channel.
+	 */
 	public void set_lowest_inbound_channel_fees(RoutingFees val) {
 		bindings.NodeInfo_set_lowest_inbound_channel_fees(this.ptr, val == null ? 0 : val.ptr & ~1);
 		this.ptrs_to.add(val);
 	}
 
+	/**
+	 * More information about a node from node_announcement.
+	 * Optional because we store a Node entry after learning about it from
+	 * a channel announcement, but before receiving a node announcement.
+	 */
 	public NodeAnnouncementInfo get_announcement_info() {
 		long ret = bindings.NodeInfo_get_announcement_info(this.ptr);
 		NodeAnnouncementInfo ret_hu_conv = new NodeAnnouncementInfo(null, ret);
@@ -37,11 +59,19 @@ public class NodeInfo extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * More information about a node from node_announcement.
+	 * Optional because we store a Node entry after learning about it from
+	 * a channel announcement, but before receiving a node announcement.
+	 */
 	public void set_announcement_info(NodeAnnouncementInfo val) {
 		bindings.NodeInfo_set_announcement_info(this.ptr, val == null ? 0 : val.ptr & ~1);
 		this.ptrs_to.add(val);
 	}
 
+	/**
+	 * Constructs a new NodeInfo given each field
+	 */
 	public static NodeInfo constructor_new(long[] channels_arg, RoutingFees lowest_inbound_channel_fees_arg, NodeAnnouncementInfo announcement_info_arg) {
 		long ret = bindings.NodeInfo_new(channels_arg, lowest_inbound_channel_fees_arg == null ? 0 : lowest_inbound_channel_fees_arg.ptr & ~1, announcement_info_arg == null ? 0 : announcement_info_arg.ptr & ~1);
 		NodeInfo ret_hu_conv = new NodeInfo(null, ret);
@@ -51,6 +81,9 @@ public class NodeInfo extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a copy of the NodeInfo
+	 */
 	public NodeInfo clone() {
 		long ret = bindings.NodeInfo_clone(this.ptr);
 		NodeInfo ret_hu_conv = new NodeInfo(null, ret);
@@ -58,11 +91,17 @@ public class NodeInfo extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Serialize the NodeInfo object into a byte array which can be read by NodeInfo_read
+	 */
 	public byte[] write() {
 		byte[] ret = bindings.NodeInfo_write(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Read a NodeInfo from a byte array, created by NodeInfo_write
+	 */
 	public static Result_NodeInfoDecodeErrorZ constructor_read(byte[] ser) {
 		long ret = bindings.NodeInfo_read(ser);
 		Result_NodeInfoDecodeErrorZ ret_hu_conv = Result_NodeInfoDecodeErrorZ.constr_from_ptr(ret);