X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FChannelConfig.java;h=e1c95b64b001cf4f96069eabd485bdfd3c90d4f9;hb=f3e670e9341decac613d33fc52febf19cea32f20;hp=7f5f6d2e63bd1e8e469b6d850fa2c0d927bdf3ac;hpb=d9af3c7d5fbc87035335d96b855bb9f1000a31a5;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/ChannelConfig.java b/src/main/java/org/ldk/structs/ChannelConfig.java
index 7f5f6d2e..e1c95b64 100644
--- a/src/main/java/org/ldk/structs/ChannelConfig.java
+++ b/src/main/java/org/ldk/structs/ChannelConfig.java
@@ -4,6 +4,7 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import javax.annotation.Nullable;
 
 
 /**
@@ -20,26 +21,65 @@ public class ChannelConfig extends CommonBase {
 	}
 
 	/**
-	 * Amount (in millionths of a satoshi) the channel will charge per transferred satoshi.
+	 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
+	 * over the channel.
 	 * This may be allowed to change at runtime in a later update, however doing so must result in
 	 * update messages sent to notify all nodes of our updated relay fee.
 	 * 
 	 * Default value: 0.
 	 */
-	public int get_fee_proportional_millionths() {
-		int ret = bindings.ChannelConfig_get_fee_proportional_millionths(this.ptr);
+	public int get_forwarding_fee_proportional_millionths() {
+		int ret = bindings.ChannelConfig_get_forwarding_fee_proportional_millionths(this.ptr);
 		return ret;
 	}
 
 	/**
-	 * Amount (in millionths of a satoshi) the channel will charge per transferred satoshi.
+	 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
+	 * over the channel.
 	 * This may be allowed to change at runtime in a later update, however doing so must result in
 	 * update messages sent to notify all nodes of our updated relay fee.
 	 * 
 	 * Default value: 0.
 	 */
-	public void set_fee_proportional_millionths(int val) {
-		bindings.ChannelConfig_set_fee_proportional_millionths(this.ptr, val);
+	public void set_forwarding_fee_proportional_millionths(int val) {
+		bindings.ChannelConfig_set_forwarding_fee_proportional_millionths(this.ptr, val);
+	}
+
+	/**
+	 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
+	 * excess of [`forwarding_fee_proportional_millionths`].
+	 * This may be allowed to change at runtime in a later update, however doing so must result in
+	 * update messages sent to notify all nodes of our updated relay fee.
+	 * 
+	 * The default value of a single satoshi roughly matches the market rate on many routing nodes
+	 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
+	 * this node.
+	 * 
+	 * Default value: 1000.
+	 * 
+	 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
+	 */
+	public int get_forwarding_fee_base_msat() {
+		int ret = bindings.ChannelConfig_get_forwarding_fee_base_msat(this.ptr);
+		return ret;
+	}
+
+	/**
+	 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
+	 * excess of [`forwarding_fee_proportional_millionths`].
+	 * This may be allowed to change at runtime in a later update, however doing so must result in
+	 * update messages sent to notify all nodes of our updated relay fee.
+	 * 
+	 * The default value of a single satoshi roughly matches the market rate on many routing nodes
+	 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
+	 * this node.
+	 * 
+	 * Default value: 1000.
+	 * 
+	 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
+	 */
+	public void set_forwarding_fee_base_msat(int val) {
+		bindings.ChannelConfig_set_forwarding_fee_base_msat(this.ptr, val);
 	}
 
 	/**
@@ -100,7 +140,7 @@ public class ChannelConfig extends CommonBase {
 	 * This should only be set to true for nodes which expect to be online reliably.
 	 * 
 	 * As the node which funds a channel picks this value this will only apply for new outbound
-	 * channels unless ChannelHandshakeLimits::force_announced_channel_preferences is set.
+	 * channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
 	 * 
 	 * This cannot be changed after the initial channel handshake.
 	 * 
@@ -118,7 +158,7 @@ public class ChannelConfig extends CommonBase {
 	 * This should only be set to true for nodes which expect to be online reliably.
 	 * 
 	 * As the node which funds a channel picks this value this will only apply for new outbound
-	 * channels unless ChannelHandshakeLimits::force_announced_channel_preferences is set.
+	 * channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
 	 * 
 	 * This cannot be changed after the initial channel handshake.
 	 * 
@@ -163,22 +203,129 @@ public class ChannelConfig extends CommonBase {
 		bindings.ChannelConfig_set_commit_upfront_shutdown_pubkey(this.ptr, val);
 	}
 
+	/**
+	 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
+	 * small to claim on-chain.
+	 * 
+	 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
+	 * not be claimable on-chain, instead being turned into additional miner fees if either
+	 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
+	 * to such payments may be sustantial if there are many dust HTLCs present when the
+	 * channel is force-closed.
+	 * 
+	 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
+	 * exposure across all three types per-channel. Setting this too low may prevent the
+	 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
+	 * important to prevent stealing of dust HTLCs by miners.
+	 * 
+	 * Default value: 5_000_000 msat.
+	 */
+	public long get_max_dust_htlc_exposure_msat() {
+		long ret = bindings.ChannelConfig_get_max_dust_htlc_exposure_msat(this.ptr);
+		return ret;
+	}
+
+	/**
+	 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
+	 * small to claim on-chain.
+	 * 
+	 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
+	 * not be claimable on-chain, instead being turned into additional miner fees if either
+	 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
+	 * to such payments may be sustantial if there are many dust HTLCs present when the
+	 * channel is force-closed.
+	 * 
+	 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
+	 * exposure across all three types per-channel. Setting this too low may prevent the
+	 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
+	 * important to prevent stealing of dust HTLCs by miners.
+	 * 
+	 * Default value: 5_000_000 msat.
+	 */
+	public void set_max_dust_htlc_exposure_msat(long val) {
+		bindings.ChannelConfig_set_max_dust_htlc_exposure_msat(this.ptr, val);
+	}
+
+	/**
+	 * The additional fee we're willing to pay to avoid waiting for the counterparty's
+	 * `to_self_delay` to reclaim funds.
+	 * 
+	 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
+	 * closing transaction which both sides find acceptable, ultimately paid by the channel
+	 * funder/initiator.
+	 * 
+	 * When we are the funder, because we have to pay the channel closing fee, we bound the
+	 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
+	 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
+	 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
+	 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
+	 * funds.
+	 * 
+	 * When we are not the funder, we require the closing transaction fee pay at least our
+	 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
+	 * Thus, this value is ignored when we are not the funder.
+	 * 
+	 * Default value: 1000 satoshis.
+	 * 
+	 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
+	 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
+	 */
+	public long get_force_close_avoidance_max_fee_satoshis() {
+		long ret = bindings.ChannelConfig_get_force_close_avoidance_max_fee_satoshis(this.ptr);
+		return ret;
+	}
+
+	/**
+	 * The additional fee we're willing to pay to avoid waiting for the counterparty's
+	 * `to_self_delay` to reclaim funds.
+	 * 
+	 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
+	 * closing transaction which both sides find acceptable, ultimately paid by the channel
+	 * funder/initiator.
+	 * 
+	 * When we are the funder, because we have to pay the channel closing fee, we bound the
+	 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
+	 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
+	 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
+	 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
+	 * funds.
+	 * 
+	 * When we are not the funder, we require the closing transaction fee pay at least our
+	 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
+	 * Thus, this value is ignored when we are not the funder.
+	 * 
+	 * Default value: 1000 satoshis.
+	 * 
+	 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
+	 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
+	 */
+	public void set_force_close_avoidance_max_fee_satoshis(long val) {
+		bindings.ChannelConfig_set_force_close_avoidance_max_fee_satoshis(this.ptr, val);
+	}
+
 	/**
 	 * Constructs a new ChannelConfig given each field
 	 */
-	public static ChannelConfig constructor_new(int fee_proportional_millionths_arg, short cltv_expiry_delta_arg, boolean announced_channel_arg, boolean commit_upfront_shutdown_pubkey_arg) {
-		long ret = bindings.ChannelConfig_new(fee_proportional_millionths_arg, cltv_expiry_delta_arg, announced_channel_arg, commit_upfront_shutdown_pubkey_arg);
-		ChannelConfig ret_hu_conv = new ChannelConfig(null, ret);
+	public static ChannelConfig of(int forwarding_fee_proportional_millionths_arg, int forwarding_fee_base_msat_arg, short cltv_expiry_delta_arg, boolean announced_channel_arg, boolean commit_upfront_shutdown_pubkey_arg, long max_dust_htlc_exposure_msat_arg, long force_close_avoidance_max_fee_satoshis_arg) {
+		long ret = bindings.ChannelConfig_new(forwarding_fee_proportional_millionths_arg, forwarding_fee_base_msat_arg, cltv_expiry_delta_arg, announced_channel_arg, commit_upfront_shutdown_pubkey_arg, max_dust_htlc_exposure_msat_arg, force_close_avoidance_max_fee_satoshis_arg);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		ChannelConfig ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ChannelConfig(null, ret); }
 		ret_hu_conv.ptrs_to.add(ret_hu_conv);
 		return ret_hu_conv;
 	}
 
+	long clone_ptr() {
+		long ret = bindings.ChannelConfig_clone_ptr(this.ptr);
+		return ret;
+	}
+
 	/**
 	 * Creates a copy of the ChannelConfig
 	 */
 	public ChannelConfig clone() {
 		long ret = bindings.ChannelConfig_clone(this.ptr);
-		ChannelConfig ret_hu_conv = new ChannelConfig(null, ret);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		ChannelConfig ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ChannelConfig(null, ret); }
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;
 	}
@@ -186,9 +333,10 @@ public class ChannelConfig extends CommonBase {
 	/**
 	 * Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
 	 */
-	public static ChannelConfig constructor_default() {
+	public static ChannelConfig with_default() {
 		long ret = bindings.ChannelConfig_default();
-		ChannelConfig ret_hu_conv = new ChannelConfig(null, ret);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		ChannelConfig ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ChannelConfig(null, ret); }
 		ret_hu_conv.ptrs_to.add(ret_hu_conv);
 		return ret_hu_conv;
 	}
@@ -204,8 +352,9 @@ public class ChannelConfig extends CommonBase {
 	/**
 	 * Read a ChannelConfig from a byte array, created by ChannelConfig_write
 	 */
-	public static Result_ChannelConfigDecodeErrorZ constructor_read(byte[] ser) {
+	public static Result_ChannelConfigDecodeErrorZ read(byte[] ser) {
 		long ret = bindings.ChannelConfig_read(ser);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_ChannelConfigDecodeErrorZ ret_hu_conv = Result_ChannelConfigDecodeErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}