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

diff --git a/src/main/java/org/ldk/structs/ChainParameters.java b/src/main/java/org/ldk/structs/ChainParameters.java
index 06e56937..f1cafe33 100644
--- a/src/main/java/org/ldk/structs/ChainParameters.java
+++ b/src/main/java/org/ldk/structs/ChainParameters.java
@@ -5,6 +5,14 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * Chain-related parameters used to construct a new `ChannelManager`.
+ * 
+ * Typically, the block-specific parameters are derived from the best block hash for the network,
+ * as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
+ * are not needed when deserializing a previously constructed `ChannelManager`.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChainParameters extends CommonBase {
 	ChainParameters(Object _dummy, long ptr) { super(ptr); }
@@ -14,33 +22,58 @@ public class ChainParameters extends CommonBase {
 		if (ptr != 0) { bindings.ChainParameters_free(ptr); }
 	}
 
+	/**
+	 * The network for determining the `chain_hash` in Lightning messages.
+	 */
 	public LDKNetwork get_network() {
 		LDKNetwork ret = bindings.ChainParameters_get_network(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The network for determining the `chain_hash` in Lightning messages.
+	 */
 	public void set_network(LDKNetwork val) {
 		bindings.ChainParameters_set_network(this.ptr, val);
 	}
 
+	/**
+	 * The hash of the latest block successfully connected.
+	 */
 	public byte[] get_latest_hash() {
 		byte[] ret = bindings.ChainParameters_get_latest_hash(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The hash of the latest block successfully connected.
+	 */
 	public void set_latest_hash(byte[] val) {
 		bindings.ChainParameters_set_latest_hash(this.ptr, val);
 	}
 
+	/**
+	 * The height of the latest block successfully connected.
+	 * 
+	 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
+	 */
 	public long get_latest_height() {
 		long ret = bindings.ChainParameters_get_latest_height(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The height of the latest block successfully connected.
+	 * 
+	 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
+	 */
 	public void set_latest_height(long val) {
 		bindings.ChainParameters_set_latest_height(this.ptr, val);
 	}
 
+	/**
+	 * Constructs a new ChainParameters given each field
+	 */
 	public static ChainParameters constructor_new(LDKNetwork network_arg, byte[] latest_hash_arg, long latest_height_arg) {
 		long ret = bindings.ChainParameters_new(network_arg, latest_hash_arg, latest_height_arg);
 		ChainParameters ret_hu_conv = new ChainParameters(null, ret);