X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FChannelHandshakeConfig.java;h=414c760689508b073b9f82eba123efede7d95818;hb=b6cc0960eaee5a5bbc7fde79a56152d6dcd649d8;hp=730d50adb2618cd4932ad8ab51c166fa574003d1;hpb=9e8763c71cd61d55be7c869d973524f75209a3f3;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/ChannelHandshakeConfig.java b/src/main/java/org/ldk/structs/ChannelHandshakeConfig.java
index 730d50ad..414c7606 100644
--- a/src/main/java/org/ldk/structs/ChannelHandshakeConfig.java
+++ b/src/main/java/org/ldk/structs/ChannelHandshakeConfig.java
@@ -5,6 +5,12 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * Configuration we set when applicable.
+ * 
+ * Default::default() provides sane defaults.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChannelHandshakeConfig extends CommonBase {
 	ChannelHandshakeConfig(Object _dummy, long ptr) { super(ptr); }
@@ -14,40 +20,112 @@ public class ChannelHandshakeConfig extends CommonBase {
 		if (ptr != 0) { bindings.ChannelHandshakeConfig_free(ptr); }
 	}
 
+	/**
+	 * Confirmations we will wait for before considering the channel locked in.
+	 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
+	 * equivalent limit applied to outbound channels).
+	 * 
+	 * Default value: 6.
+	 */
 	public int get_minimum_depth() {
 		int ret = bindings.ChannelHandshakeConfig_get_minimum_depth(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Confirmations we will wait for before considering the channel locked in.
+	 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
+	 * equivalent limit applied to outbound channels).
+	 * 
+	 * Default value: 6.
+	 */
 	public void set_minimum_depth(int val) {
 		bindings.ChannelHandshakeConfig_set_minimum_depth(this.ptr, val);
 	}
 
+	/**
+	 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
+	 * the number of blocks we have to punish our counterparty if they broadcast a revoked
+	 * transaction).
+	 * 
+	 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
+	 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
+	 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
+	 * possibly with time in between to RBF the spending transaction).
+	 * 
+	 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
+	 * case of an honest unilateral channel close, which implicitly decrease the economic value of
+	 * our channel.
+	 * 
+	 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
+	 * can tweak config to ask for more security, not less.
+	 */
 	public short get_our_to_self_delay() {
 		short ret = bindings.ChannelHandshakeConfig_get_our_to_self_delay(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
+	 * the number of blocks we have to punish our counterparty if they broadcast a revoked
+	 * transaction).
+	 * 
+	 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
+	 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
+	 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
+	 * possibly with time in between to RBF the spending transaction).
+	 * 
+	 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
+	 * case of an honest unilateral channel close, which implicitly decrease the economic value of
+	 * our channel.
+	 * 
+	 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
+	 * can tweak config to ask for more security, not less.
+	 */
 	public void set_our_to_self_delay(short val) {
 		bindings.ChannelHandshakeConfig_set_our_to_self_delay(this.ptr, val);
 	}
 
+	/**
+	 * Set to the smallest value HTLC we will accept to process.
+	 * 
+	 * This value is sent to our counterparty on channel-open and we close the channel any time
+	 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
+	 * 
+	 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
+	 * by the protocol.
+	 */
 	public long get_our_htlc_minimum_msat() {
 		long ret = bindings.ChannelHandshakeConfig_get_our_htlc_minimum_msat(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * Set to the smallest value HTLC we will accept to process.
+	 * 
+	 * This value is sent to our counterparty on channel-open and we close the channel any time
+	 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
+	 * 
+	 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
+	 * by the protocol.
+	 */
 	public void set_our_htlc_minimum_msat(long val) {
 		bindings.ChannelHandshakeConfig_set_our_htlc_minimum_msat(this.ptr, val);
 	}
 
-	public static ChannelHandshakeConfig constructor_new(int minimum_depth_arg, short our_to_self_delay_arg, long our_htlc_minimum_msat_arg) {
+	/**
+	 * Constructs a new ChannelHandshakeConfig given each field
+	 */
+	public static ChannelHandshakeConfig of(int minimum_depth_arg, short our_to_self_delay_arg, long our_htlc_minimum_msat_arg) {
 		long ret = bindings.ChannelHandshakeConfig_new(minimum_depth_arg, our_to_self_delay_arg, our_htlc_minimum_msat_arg);
 		ChannelHandshakeConfig ret_hu_conv = new ChannelHandshakeConfig(null, ret);
 		ret_hu_conv.ptrs_to.add(ret_hu_conv);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a copy of the ChannelHandshakeConfig
+	 */
 	public ChannelHandshakeConfig clone() {
 		long ret = bindings.ChannelHandshakeConfig_clone(this.ptr);
 		ChannelHandshakeConfig ret_hu_conv = new ChannelHandshakeConfig(null, ret);
@@ -55,7 +133,10 @@ public class ChannelHandshakeConfig extends CommonBase {
 		return ret_hu_conv;
 	}
 
-	public static ChannelHandshakeConfig constructor_default() {
+	/**
+	 * Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used.
+	 */
+	public static ChannelHandshakeConfig with_default() {
 		long ret = bindings.ChannelHandshakeConfig_default();
 		ChannelHandshakeConfig ret_hu_conv = new ChannelHandshakeConfig(null, ret);
 		ret_hu_conv.ptrs_to.add(ret_hu_conv);