X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FChannelHandshakeLimits.java;h=3b16709b82d0b24827bae556f56da01136096e48;hb=f3e670e9341decac613d33fc52febf19cea32f20;hp=2d6ed0ea7cb0db4df260afa0ebd3721ba5970514;hpb=3d559f3266fde7c6a21248c10d9a7145125b5e69;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/ChannelHandshakeLimits.java b/src/main/java/org/ldk/structs/ChannelHandshakeLimits.java
index 2d6ed0ea..3b16709b 100644
--- a/src/main/java/org/ldk/structs/ChannelHandshakeLimits.java
+++ b/src/main/java/org/ldk/structs/ChannelHandshakeLimits.java
@@ -2,135 +2,257 @@ package org.ldk.structs;
 
 import org.ldk.impl.bindings;
 import org.ldk.enums.*;
+import org.ldk.util.*;
+import java.util.Arrays;
+import javax.annotation.Nullable;
 
+
+/**
+ * Optional channel limits which are applied during channel creation.
+ * 
+ * These limits are only applied to our counterparty's limits, not our own.
+ * 
+ * Use 0/<type>::max_value() as appropriate to skip checking.
+ * 
+ * Provides sane defaults for most configurations.
+ * 
+ * Most additional limits are disabled except those with which specify a default in individual
+ * field documentation. Note that this may result in barely-usable channels, but since they
+ * are applied mostly only to incoming channels that's not much of a problem.
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChannelHandshakeLimits extends CommonBase {
 	ChannelHandshakeLimits(Object _dummy, long ptr) { super(ptr); }
 	@Override @SuppressWarnings("deprecation")
 	protected void finalize() throws Throwable {
-		bindings.ChannelHandshakeLimits_free(ptr); super.finalize();
-	}
-
-	public ChannelHandshakeLimits(ChannelHandshakeLimits orig) {
-		super(bindings.ChannelHandshakeLimits_clone(orig.ptr & ~1));
-		this.ptrs_to.add(orig);
+		super.finalize();
+		if (ptr != 0) { bindings.ChannelHandshakeLimits_free(ptr); }
 	}
 
-	public long get_min_funding_satoshis(ChannelHandshakeLimits this_ptr) {
-		long ret = bindings.ChannelHandshakeLimits_get_min_funding_satoshis(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
+	 * only applies to inbound channels.
+	 * 
+	 * Default value: 0.
+	 */
+	public long get_min_funding_satoshis() {
+		long ret = bindings.ChannelHandshakeLimits_get_min_funding_satoshis(this.ptr);
 		return ret;
 	}
 
-	public void set_min_funding_satoshis(ChannelHandshakeLimits this_ptr, long val) {
-		bindings.ChannelHandshakeLimits_set_min_funding_satoshis(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
+	 * only applies to inbound channels.
+	 * 
+	 * Default value: 0.
+	 */
+	public void set_min_funding_satoshis(long val) {
+		bindings.ChannelHandshakeLimits_set_min_funding_satoshis(this.ptr, val);
 	}
 
-	public long get_max_htlc_minimum_msat(ChannelHandshakeLimits this_ptr) {
-		long ret = bindings.ChannelHandshakeLimits_get_max_htlc_minimum_msat(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
+	 * you to limit the maximum minimum-size they can require.
+	 * 
+	 * Default value: u64::max_value.
+	 */
+	public long get_max_htlc_minimum_msat() {
+		long ret = bindings.ChannelHandshakeLimits_get_max_htlc_minimum_msat(this.ptr);
 		return ret;
 	}
 
-	public void set_max_htlc_minimum_msat(ChannelHandshakeLimits this_ptr, long val) {
-		bindings.ChannelHandshakeLimits_set_max_htlc_minimum_msat(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
+	 * you to limit the maximum minimum-size they can require.
+	 * 
+	 * Default value: u64::max_value.
+	 */
+	public void set_max_htlc_minimum_msat(long val) {
+		bindings.ChannelHandshakeLimits_set_max_htlc_minimum_msat(this.ptr, val);
 	}
 
-	public long get_min_max_htlc_value_in_flight_msat(ChannelHandshakeLimits this_ptr) {
-		long ret = bindings.ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
+	 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
+	 * 
+	 * Default value: 0.
+	 */
+	public long get_min_max_htlc_value_in_flight_msat() {
+		long ret = bindings.ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(this.ptr);
 		return ret;
 	}
 
-	public void set_min_max_htlc_value_in_flight_msat(ChannelHandshakeLimits this_ptr, long val) {
-		bindings.ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
+	 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
+	 * 
+	 * Default value: 0.
+	 */
+	public void set_min_max_htlc_value_in_flight_msat(long val) {
+		bindings.ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(this.ptr, val);
 	}
 
-	public long get_max_channel_reserve_satoshis(ChannelHandshakeLimits this_ptr) {
-		long ret = bindings.ChannelHandshakeLimits_get_max_channel_reserve_satoshis(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The remote node will require we keep a certain amount in direct payment to ourselves at all
+	 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
+	 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
+	 * 
+	 * Default value: u64::max_value.
+	 */
+	public long get_max_channel_reserve_satoshis() {
+		long ret = bindings.ChannelHandshakeLimits_get_max_channel_reserve_satoshis(this.ptr);
 		return ret;
 	}
 
-	public void set_max_channel_reserve_satoshis(ChannelHandshakeLimits this_ptr, long val) {
-		bindings.ChannelHandshakeLimits_set_max_channel_reserve_satoshis(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The remote node will require we keep a certain amount in direct payment to ourselves at all
+	 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
+	 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
+	 * 
+	 * Default value: u64::max_value.
+	 */
+	public void set_max_channel_reserve_satoshis(long val) {
+		bindings.ChannelHandshakeLimits_set_max_channel_reserve_satoshis(this.ptr, val);
 	}
 
-	public short get_min_max_accepted_htlcs(ChannelHandshakeLimits this_ptr) {
-		short ret = bindings.ChannelHandshakeLimits_get_min_max_accepted_htlcs(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
+	 * time. This allows you to set a minimum such value.
+	 * 
+	 * Default value: 0.
+	 */
+	public short get_min_max_accepted_htlcs() {
+		short ret = bindings.ChannelHandshakeLimits_get_min_max_accepted_htlcs(this.ptr);
 		return ret;
 	}
 
-	public void set_min_max_accepted_htlcs(ChannelHandshakeLimits this_ptr, short val) {
-		bindings.ChannelHandshakeLimits_set_min_max_accepted_htlcs(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
+	 * time. This allows you to set a minimum such value.
+	 * 
+	 * Default value: 0.
+	 */
+	public void set_min_max_accepted_htlcs(short val) {
+		bindings.ChannelHandshakeLimits_set_min_max_accepted_htlcs(this.ptr, val);
 	}
 
-	public long get_min_dust_limit_satoshis(ChannelHandshakeLimits this_ptr) {
-		long ret = bindings.ChannelHandshakeLimits_get_min_dust_limit_satoshis(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * Before a channel is usable the funding transaction will need to be confirmed by at least a
+	 * certain number of blocks, specified by the node which is not the funder (as the funder can
+	 * assume they aren't going to double-spend themselves).
+	 * This config allows you to set a limit on the maximum amount of time to wait.
+	 * 
+	 * Default value: 144, or roughly one day and only applies to outbound channels.
+	 */
+	public int get_max_minimum_depth() {
+		int ret = bindings.ChannelHandshakeLimits_get_max_minimum_depth(this.ptr);
 		return ret;
 	}
 
-	public void set_min_dust_limit_satoshis(ChannelHandshakeLimits this_ptr, long val) {
-		bindings.ChannelHandshakeLimits_set_min_dust_limit_satoshis(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * Before a channel is usable the funding transaction will need to be confirmed by at least a
+	 * certain number of blocks, specified by the node which is not the funder (as the funder can
+	 * assume they aren't going to double-spend themselves).
+	 * This config allows you to set a limit on the maximum amount of time to wait.
+	 * 
+	 * Default value: 144, or roughly one day and only applies to outbound channels.
+	 */
+	public void set_max_minimum_depth(int val) {
+		bindings.ChannelHandshakeLimits_set_max_minimum_depth(this.ptr, val);
 	}
 
-	public long get_max_dust_limit_satoshis(ChannelHandshakeLimits this_ptr) {
-		long ret = bindings.ChannelHandshakeLimits_get_max_dust_limit_satoshis(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * Set to force an incoming channel to match our announced channel preference in
+	 * [`ChannelConfig::announced_channel`].
+	 * 
+	 * For a node which is not online reliably, this should be set to true and
+	 * [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
+	 * channels will ever be opened.
+	 * 
+	 * Default value: true.
+	 */
+	public boolean get_force_announced_channel_preference() {
+		boolean ret = bindings.ChannelHandshakeLimits_get_force_announced_channel_preference(this.ptr);
 		return ret;
 	}
 
-	public void set_max_dust_limit_satoshis(ChannelHandshakeLimits this_ptr, long val) {
-		bindings.ChannelHandshakeLimits_set_max_dust_limit_satoshis(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * Set to force an incoming channel to match our announced channel preference in
+	 * [`ChannelConfig::announced_channel`].
+	 * 
+	 * For a node which is not online reliably, this should be set to true and
+	 * [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
+	 * channels will ever be opened.
+	 * 
+	 * Default value: true.
+	 */
+	public void set_force_announced_channel_preference(boolean val) {
+		bindings.ChannelHandshakeLimits_set_force_announced_channel_preference(this.ptr, val);
 	}
 
-	public int get_max_minimum_depth(ChannelHandshakeLimits this_ptr) {
-		int ret = bindings.ChannelHandshakeLimits_get_max_minimum_depth(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * Set to the amount of time we're willing to wait to claim money back to us.
+	 * 
+	 * Not checking this value would be a security issue, as our peer would be able to set it to
+	 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
+	 * 
+	 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
+	 * reduce the loss of having useless locked funds (if your peer accepts)
+	 */
+	public short get_their_to_self_delay() {
+		short ret = bindings.ChannelHandshakeLimits_get_their_to_self_delay(this.ptr);
 		return ret;
 	}
 
-	public void set_max_minimum_depth(ChannelHandshakeLimits this_ptr, int val) {
-		bindings.ChannelHandshakeLimits_set_max_minimum_depth(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
-	}
-
-	public boolean get_force_announced_channel_preference(ChannelHandshakeLimits this_ptr) {
-		boolean ret = bindings.ChannelHandshakeLimits_get_force_announced_channel_preference(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
-		return ret;
+	/**
+	 * Set to the amount of time we're willing to wait to claim money back to us.
+	 * 
+	 * Not checking this value would be a security issue, as our peer would be able to set it to
+	 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
+	 * 
+	 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
+	 * reduce the loss of having useless locked funds (if your peer accepts)
+	 */
+	public void set_their_to_self_delay(short val) {
+		bindings.ChannelHandshakeLimits_set_their_to_self_delay(this.ptr, val);
 	}
 
-	public void set_force_announced_channel_preference(ChannelHandshakeLimits this_ptr, boolean val) {
-		bindings.ChannelHandshakeLimits_set_force_announced_channel_preference(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
+	/**
+	 * Constructs a new ChannelHandshakeLimits given each field
+	 */
+	public static ChannelHandshakeLimits of(long min_funding_satoshis_arg, long max_htlc_minimum_msat_arg, long min_max_htlc_value_in_flight_msat_arg, long max_channel_reserve_satoshis_arg, short min_max_accepted_htlcs_arg, int max_minimum_depth_arg, boolean force_announced_channel_preference_arg, short their_to_self_delay_arg) {
+		long ret = bindings.ChannelHandshakeLimits_new(min_funding_satoshis_arg, max_htlc_minimum_msat_arg, min_max_htlc_value_in_flight_msat_arg, max_channel_reserve_satoshis_arg, min_max_accepted_htlcs_arg, max_minimum_depth_arg, force_announced_channel_preference_arg, their_to_self_delay_arg);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		ChannelHandshakeLimits ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ChannelHandshakeLimits(null, ret); }
+		ret_hu_conv.ptrs_to.add(ret_hu_conv);
+		return ret_hu_conv;
 	}
 
-	public short get_their_to_self_delay(ChannelHandshakeLimits this_ptr) {
-		short ret = bindings.ChannelHandshakeLimits_get_their_to_self_delay(this_ptr.ptr & ~1);
-		this.ptrs_to.add(this_ptr);
+	long clone_ptr() {
+		long ret = bindings.ChannelHandshakeLimits_clone_ptr(this.ptr);
 		return ret;
 	}
 
-	public void set_their_to_self_delay(ChannelHandshakeLimits this_ptr, short val) {
-		bindings.ChannelHandshakeLimits_set_their_to_self_delay(this_ptr.ptr & ~1, val);
-		this.ptrs_to.add(this_ptr);
-	}
-
-	public ChannelHandshakeLimits(long min_funding_satoshis_arg, long max_htlc_minimum_msat_arg, long min_max_htlc_value_in_flight_msat_arg, long max_channel_reserve_satoshis_arg, short min_max_accepted_htlcs_arg, long min_dust_limit_satoshis_arg, long max_dust_limit_satoshis_arg, int max_minimum_depth_arg, boolean force_announced_channel_preference_arg, short their_to_self_delay_arg) {
-		super(bindings.ChannelHandshakeLimits_new(min_funding_satoshis_arg, max_htlc_minimum_msat_arg, min_max_htlc_value_in_flight_msat_arg, max_channel_reserve_satoshis_arg, min_max_accepted_htlcs_arg, min_dust_limit_satoshis_arg, max_dust_limit_satoshis_arg, max_minimum_depth_arg, force_announced_channel_preference_arg, their_to_self_delay_arg));
+	/**
+	 * Creates a copy of the ChannelHandshakeLimits
+	 */
+	public ChannelHandshakeLimits clone() {
+		long ret = bindings.ChannelHandshakeLimits_clone(this.ptr);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		ChannelHandshakeLimits ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ChannelHandshakeLimits(null, ret); }
+		ret_hu_conv.ptrs_to.add(this);
+		return ret_hu_conv;
 	}
 
-	public ChannelHandshakeLimits() {
-		super(bindings.ChannelHandshakeLimits_default());
+	/**
+	 * Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used.
+	 */
+	public static ChannelHandshakeLimits with_default() {
+		long ret = bindings.ChannelHandshakeLimits_default();
+		if (ret >= 0 && ret <= 4096) { return null; }
+		ChannelHandshakeLimits ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ChannelHandshakeLimits(null, ret); }
+		ret_hu_conv.ptrs_to.add(ret_hu_conv);
+		return ret_hu_conv;
 	}
 
 }