6 namespace org { namespace ldk { namespace structs {
10 * Options which apply on a per-channel basis and may change at runtime or based on negotiation
11 * with our counterparty.
13 public class ChannelConfig : CommonBase {
14 internal ChannelConfig(object _dummy, long ptr) : base(ptr) { }
16 if (ptr != 0) { bindings.ChannelConfig_free(ptr); }
20 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
22 * This may be allowed to change at runtime in a later update, however doing so must result in
23 * update messages sent to notify all nodes of our updated relay fee.
27 public int get_forwarding_fee_proportional_millionths() {
28 int ret = bindings.ChannelConfig_get_forwarding_fee_proportional_millionths(this.ptr);
34 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
36 * This may be allowed to change at runtime in a later update, however doing so must result in
37 * update messages sent to notify all nodes of our updated relay fee.
41 public void set_forwarding_fee_proportional_millionths(int val) {
42 bindings.ChannelConfig_set_forwarding_fee_proportional_millionths(this.ptr, val);
48 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
49 * excess of [`forwarding_fee_proportional_millionths`].
50 * This may be allowed to change at runtime in a later update, however doing so must result in
51 * update messages sent to notify all nodes of our updated relay fee.
53 * The default value of a single satoshi roughly matches the market rate on many routing nodes
54 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
57 * Default value: 1000.
59 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
61 public int get_forwarding_fee_base_msat() {
62 int ret = bindings.ChannelConfig_get_forwarding_fee_base_msat(this.ptr);
68 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
69 * excess of [`forwarding_fee_proportional_millionths`].
70 * This may be allowed to change at runtime in a later update, however doing so must result in
71 * update messages sent to notify all nodes of our updated relay fee.
73 * The default value of a single satoshi roughly matches the market rate on many routing nodes
74 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
77 * Default value: 1000.
79 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
81 public void set_forwarding_fee_base_msat(int val) {
82 bindings.ChannelConfig_set_forwarding_fee_base_msat(this.ptr, val);
88 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
89 * the channel this config applies to.
91 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
92 * HTLC balance when a channel appears on-chain whereas
93 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
94 * (non-HTLC-encumbered) balance.
96 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
97 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
98 * commitment transaction at least once per this many blocks (minus some margin to allow us
99 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
100 * the spending transaction).
102 * Default value: 72 (12 hours at an average of 6 blocks/hour).
103 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
104 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
106 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
108 public short get_cltv_expiry_delta() {
109 short ret = bindings.ChannelConfig_get_cltv_expiry_delta(this.ptr);
115 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
116 * the channel this config applies to.
118 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
119 * HTLC balance when a channel appears on-chain whereas
120 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
121 * (non-HTLC-encumbered) balance.
123 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
124 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
125 * commitment transaction at least once per this many blocks (minus some margin to allow us
126 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
127 * the spending transaction).
129 * Default value: 72 (12 hours at an average of 6 blocks/hour).
130 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
131 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
133 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
135 public void set_cltv_expiry_delta(short val) {
136 bindings.ChannelConfig_set_cltv_expiry_delta(this.ptr, val);
142 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
143 * small to claim on-chain.
145 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
146 * not be claimable on-chain, instead being turned into additional miner fees if either
147 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
148 * to such payments may be sustantial if there are many dust HTLCs present when the
149 * channel is force-closed.
151 * The dust threshold for each HTLC is based on the `dust_limit_satoshis` for each party in a
152 * channel negotiated throughout the channel open process, along with the fees required to have
153 * a broadcastable HTLC spending transaction. When a channel supports anchor outputs
154 * (specifically the zero fee HTLC transaction variant), this threshold no longer takes into
155 * account the HTLC transaction fee as it is zero.
157 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
158 * exposure across all three types per-channel. Setting this too low may prevent the
159 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
160 * important to prevent stealing of dust HTLCs by miners.
162 * Default value: 5_000_000 msat.
164 public long get_max_dust_htlc_exposure_msat() {
165 long ret = bindings.ChannelConfig_get_max_dust_htlc_exposure_msat(this.ptr);
171 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
172 * small to claim on-chain.
174 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
175 * not be claimable on-chain, instead being turned into additional miner fees if either
176 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
177 * to such payments may be sustantial if there are many dust HTLCs present when the
178 * channel is force-closed.
180 * The dust threshold for each HTLC is based on the `dust_limit_satoshis` for each party in a
181 * channel negotiated throughout the channel open process, along with the fees required to have
182 * a broadcastable HTLC spending transaction. When a channel supports anchor outputs
183 * (specifically the zero fee HTLC transaction variant), this threshold no longer takes into
184 * account the HTLC transaction fee as it is zero.
186 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
187 * exposure across all three types per-channel. Setting this too low may prevent the
188 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
189 * important to prevent stealing of dust HTLCs by miners.
191 * Default value: 5_000_000 msat.
193 public void set_max_dust_htlc_exposure_msat(long val) {
194 bindings.ChannelConfig_set_max_dust_htlc_exposure_msat(this.ptr, val);
200 * The additional fee we're willing to pay to avoid waiting for the counterparty's
201 * `to_self_delay` to reclaim funds.
203 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
204 * closing transaction which both sides find acceptable, ultimately paid by the channel
207 * When we are the funder, because we have to pay the channel closing fee, we bound the
208 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
209 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
210 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
211 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
214 * When we are not the funder, we require the closing transaction fee pay at least our
215 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
216 * Thus, this value is ignored when we are not the funder.
218 * Default value: 1000 satoshis.
220 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
221 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
223 public long get_force_close_avoidance_max_fee_satoshis() {
224 long ret = bindings.ChannelConfig_get_force_close_avoidance_max_fee_satoshis(this.ptr);
230 * The additional fee we're willing to pay to avoid waiting for the counterparty's
231 * `to_self_delay` to reclaim funds.
233 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
234 * closing transaction which both sides find acceptable, ultimately paid by the channel
237 * When we are the funder, because we have to pay the channel closing fee, we bound the
238 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
239 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
240 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
241 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
244 * When we are not the funder, we require the closing transaction fee pay at least our
245 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
246 * Thus, this value is ignored when we are not the funder.
248 * Default value: 1000 satoshis.
250 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
251 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
253 public void set_force_close_avoidance_max_fee_satoshis(long val) {
254 bindings.ChannelConfig_set_force_close_avoidance_max_fee_satoshis(this.ptr, val);
260 * Constructs a new ChannelConfig given each field
262 public static ChannelConfig of(int forwarding_fee_proportional_millionths_arg, int forwarding_fee_base_msat_arg, short cltv_expiry_delta_arg, long max_dust_htlc_exposure_msat_arg, long force_close_avoidance_max_fee_satoshis_arg) {
263 long ret = bindings.ChannelConfig_new(forwarding_fee_proportional_millionths_arg, forwarding_fee_base_msat_arg, cltv_expiry_delta_arg, max_dust_htlc_exposure_msat_arg, force_close_avoidance_max_fee_satoshis_arg);
264 GC.KeepAlive(forwarding_fee_proportional_millionths_arg);
265 GC.KeepAlive(forwarding_fee_base_msat_arg);
266 GC.KeepAlive(cltv_expiry_delta_arg);
267 GC.KeepAlive(max_dust_htlc_exposure_msat_arg);
268 GC.KeepAlive(force_close_avoidance_max_fee_satoshis_arg);
269 if (ret >= 0 && ret <= 4096) { return null; }
270 org.ldk.structs.ChannelConfig ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelConfig(null, ret); }
271 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
275 internal long clone_ptr() {
276 long ret = bindings.ChannelConfig_clone_ptr(this.ptr);
282 * Creates a copy of the ChannelConfig
284 public ChannelConfig clone() {
285 long ret = bindings.ChannelConfig_clone(this.ptr);
287 if (ret >= 0 && ret <= 4096) { return null; }
288 org.ldk.structs.ChannelConfig ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelConfig(null, ret); }
289 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
294 * Checks if two ChannelConfigs contain equal inner contents.
295 * This ignores pointers and is_owned flags and looks at the values in fields.
296 * Two objects with NULL inner values will be considered "equal" here.
298 public bool eq(org.ldk.structs.ChannelConfig b) {
299 bool ret = bindings.ChannelConfig_eq(this.ptr, b == null ? 0 : b.ptr);
302 if (this != null) { this.ptrs_to.AddLast(b); };
306 public override bool Equals(object o) {
307 if (!(o is ChannelConfig)) return false;
308 return this.eq((ChannelConfig)o);
311 * Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
313 public static ChannelConfig with_default() {
314 long ret = bindings.ChannelConfig_default();
315 if (ret >= 0 && ret <= 4096) { return null; }
316 org.ldk.structs.ChannelConfig ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelConfig(null, ret); }
317 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
322 * Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read
324 public byte[] write() {
325 byte[] ret = bindings.ChannelConfig_write(this.ptr);
331 * Read a ChannelConfig from a byte array, created by ChannelConfig_write
333 public static Result_ChannelConfigDecodeErrorZ read(byte[] ser) {
334 long ret = bindings.ChannelConfig_read(ser);
336 if (ret >= 0 && ret <= 4096) { return null; }
337 Result_ChannelConfigDecodeErrorZ ret_hu_conv = Result_ChannelConfigDecodeErrorZ.constr_from_ptr(ret);