e83fb2b63ccef7bdb72bb818abe65815471ad9d2
[ldk-c-bindings] / lightning-c-bindings / src / lightning / util / config.rs
1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
3 //
4 // This file is licensed under the license available in the LICENSE or LICENSE.md
5 // file in the root of this repository or, if no such file exists, the same
6 // license as that which applies to the original source files from which this
7 // source was automatically generated.
8
9 //! Various user-configurable channel limits and settings which ChannelManager
10 //! applies for you.
11
12 use alloc::str::FromStr;
13 use alloc::string::String;
14 use core::ffi::c_void;
15 use core::convert::Infallible;
16 use bitcoin::hashes::Hash;
17 use crate::c_types::*;
18 #[cfg(feature="no-std")]
19 use alloc::{vec::Vec, boxed::Box};
20
21
22 use lightning::util::config::ChannelHandshakeConfig as nativeChannelHandshakeConfigImport;
23 pub(crate) type nativeChannelHandshakeConfig = nativeChannelHandshakeConfigImport;
24
25 /// Configuration we set when applicable.
26 ///
27 /// Default::default() provides sane defaults.
28 #[must_use]
29 #[repr(C)]
30 pub struct ChannelHandshakeConfig {
31         /// A pointer to the opaque Rust object.
32
33         /// Nearly everywhere, inner must be non-null, however in places where
34         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
35         pub inner: *mut nativeChannelHandshakeConfig,
36         /// Indicates that this is the only struct which contains the same pointer.
37
38         /// Rust functions which take ownership of an object provided via an argument require
39         /// this to be true and invalidate the object pointed to by inner.
40         pub is_owned: bool,
41 }
42
43 impl Drop for ChannelHandshakeConfig {
44         fn drop(&mut self) {
45                 if self.is_owned && !<*mut nativeChannelHandshakeConfig>::is_null(self.inner) {
46                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
47                 }
48         }
49 }
50 /// Frees any resources used by the ChannelHandshakeConfig, if is_owned is set and inner is non-NULL.
51 #[no_mangle]
52 pub extern "C" fn ChannelHandshakeConfig_free(this_obj: ChannelHandshakeConfig) { }
53 #[allow(unused)]
54 /// Used only if an object of this type is returned as a trait impl by a method
55 pub(crate) extern "C" fn ChannelHandshakeConfig_free_void(this_ptr: *mut c_void) {
56         let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelHandshakeConfig) };
57 }
58 #[allow(unused)]
59 impl ChannelHandshakeConfig {
60         pub(crate) fn get_native_ref(&self) -> &'static nativeChannelHandshakeConfig {
61                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
62         }
63         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelHandshakeConfig {
64                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
65         }
66         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
67         pub(crate) fn take_inner(mut self) -> *mut nativeChannelHandshakeConfig {
68                 assert!(self.is_owned);
69                 let ret = ObjOps::untweak_ptr(self.inner);
70                 self.inner = core::ptr::null_mut();
71                 ret
72         }
73 }
74 /// Confirmations we will wait for before considering the channel locked in.
75 /// Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
76 /// equivalent limit applied to outbound channels).
77 ///
78 /// A lower-bound of 1 is applied, requiring all channels to have a confirmed commitment
79 /// transaction before operation. If you wish to accept channels with zero confirmations, see
80 /// [`UserConfig::manually_accept_inbound_channels`] and
81 /// [`ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`].
82 ///
83 /// Default value: 6.
84 ///
85 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
86 /// [`ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf
87 #[no_mangle]
88 pub extern "C" fn ChannelHandshakeConfig_get_minimum_depth(this_ptr: &ChannelHandshakeConfig) -> u32 {
89         let mut inner_val = &mut this_ptr.get_native_mut_ref().minimum_depth;
90         *inner_val
91 }
92 /// Confirmations we will wait for before considering the channel locked in.
93 /// Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
94 /// equivalent limit applied to outbound channels).
95 ///
96 /// A lower-bound of 1 is applied, requiring all channels to have a confirmed commitment
97 /// transaction before operation. If you wish to accept channels with zero confirmations, see
98 /// [`UserConfig::manually_accept_inbound_channels`] and
99 /// [`ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`].
100 ///
101 /// Default value: 6.
102 ///
103 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
104 /// [`ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf
105 #[no_mangle]
106 pub extern "C" fn ChannelHandshakeConfig_set_minimum_depth(this_ptr: &mut ChannelHandshakeConfig, mut val: u32) {
107         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.minimum_depth = val;
108 }
109 /// Set to the number of blocks we require our counterparty to wait to claim their money (ie
110 /// the number of blocks we have to punish our counterparty if they broadcast a revoked
111 /// transaction).
112 ///
113 /// This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
114 /// be online to check for revoked transactions on-chain at least once every our_to_self_delay
115 /// blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
116 /// possibly with time in between to RBF the spending transaction).
117 ///
118 /// Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
119 /// case of an honest unilateral channel close, which implicitly decrease the economic value of
120 /// our channel.
121 ///
122 /// Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
123 /// can tweak config to ask for more security, not less.
124 #[no_mangle]
125 pub extern "C" fn ChannelHandshakeConfig_get_our_to_self_delay(this_ptr: &ChannelHandshakeConfig) -> u16 {
126         let mut inner_val = &mut this_ptr.get_native_mut_ref().our_to_self_delay;
127         *inner_val
128 }
129 /// Set to the number of blocks we require our counterparty to wait to claim their money (ie
130 /// the number of blocks we have to punish our counterparty if they broadcast a revoked
131 /// transaction).
132 ///
133 /// This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
134 /// be online to check for revoked transactions on-chain at least once every our_to_self_delay
135 /// blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
136 /// possibly with time in between to RBF the spending transaction).
137 ///
138 /// Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
139 /// case of an honest unilateral channel close, which implicitly decrease the economic value of
140 /// our channel.
141 ///
142 /// Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
143 /// can tweak config to ask for more security, not less.
144 #[no_mangle]
145 pub extern "C" fn ChannelHandshakeConfig_set_our_to_self_delay(this_ptr: &mut ChannelHandshakeConfig, mut val: u16) {
146         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.our_to_self_delay = val;
147 }
148 /// Set to the smallest value HTLC we will accept to process.
149 ///
150 /// This value is sent to our counterparty on channel-open and we close the channel any time
151 /// our counterparty misbehaves by sending us an HTLC with a value smaller than this.
152 ///
153 /// Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
154 /// by the protocol.
155 #[no_mangle]
156 pub extern "C" fn ChannelHandshakeConfig_get_our_htlc_minimum_msat(this_ptr: &ChannelHandshakeConfig) -> u64 {
157         let mut inner_val = &mut this_ptr.get_native_mut_ref().our_htlc_minimum_msat;
158         *inner_val
159 }
160 /// Set to the smallest value HTLC we will accept to process.
161 ///
162 /// This value is sent to our counterparty on channel-open and we close the channel any time
163 /// our counterparty misbehaves by sending us an HTLC with a value smaller than this.
164 ///
165 /// Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
166 /// by the protocol.
167 #[no_mangle]
168 pub extern "C" fn ChannelHandshakeConfig_set_our_htlc_minimum_msat(this_ptr: &mut ChannelHandshakeConfig, mut val: u64) {
169         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.our_htlc_minimum_msat = val;
170 }
171 /// Sets the percentage of the channel value we will cap the total value of outstanding inbound
172 /// HTLCs to.
173 ///
174 /// This can be set to a value between 1-100, where the value corresponds to the percent of the
175 /// channel value in whole percentages.
176 ///
177 /// Note that:
178 /// * If configured to another value than the default value 10, any new channels created with
179 /// the non default value will cause versions of LDK prior to 0.0.104 to refuse to read the
180 /// `ChannelManager`.
181 ///
182 /// * This caps the total value for inbound HTLCs in-flight only, and there's currently
183 /// no way to configure the cap for the total value of outbound HTLCs in-flight.
184 ///
185 /// * The requirements for your node being online to ensure the safety of HTLC-encumbered funds
186 /// are different from the non-HTLC-encumbered funds. This makes this an important knob to
187 /// restrict exposure to loss due to being offline for too long.
188 /// See [`ChannelHandshakeConfig::our_to_self_delay`] and [`ChannelConfig::cltv_expiry_delta`]
189 /// for more information.
190 ///
191 /// Default value: 10.
192 /// Minimum value: 1, any values less than 1 will be treated as 1 instead.
193 /// Maximum value: 100, any values larger than 100 will be treated as 100 instead.
194 #[no_mangle]
195 pub extern "C" fn ChannelHandshakeConfig_get_max_inbound_htlc_value_in_flight_percent_of_channel(this_ptr: &ChannelHandshakeConfig) -> u8 {
196         let mut inner_val = &mut this_ptr.get_native_mut_ref().max_inbound_htlc_value_in_flight_percent_of_channel;
197         *inner_val
198 }
199 /// Sets the percentage of the channel value we will cap the total value of outstanding inbound
200 /// HTLCs to.
201 ///
202 /// This can be set to a value between 1-100, where the value corresponds to the percent of the
203 /// channel value in whole percentages.
204 ///
205 /// Note that:
206 /// * If configured to another value than the default value 10, any new channels created with
207 /// the non default value will cause versions of LDK prior to 0.0.104 to refuse to read the
208 /// `ChannelManager`.
209 ///
210 /// * This caps the total value for inbound HTLCs in-flight only, and there's currently
211 /// no way to configure the cap for the total value of outbound HTLCs in-flight.
212 ///
213 /// * The requirements for your node being online to ensure the safety of HTLC-encumbered funds
214 /// are different from the non-HTLC-encumbered funds. This makes this an important knob to
215 /// restrict exposure to loss due to being offline for too long.
216 /// See [`ChannelHandshakeConfig::our_to_self_delay`] and [`ChannelConfig::cltv_expiry_delta`]
217 /// for more information.
218 ///
219 /// Default value: 10.
220 /// Minimum value: 1, any values less than 1 will be treated as 1 instead.
221 /// Maximum value: 100, any values larger than 100 will be treated as 100 instead.
222 #[no_mangle]
223 pub extern "C" fn ChannelHandshakeConfig_set_max_inbound_htlc_value_in_flight_percent_of_channel(this_ptr: &mut ChannelHandshakeConfig, mut val: u8) {
224         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_inbound_htlc_value_in_flight_percent_of_channel = val;
225 }
226 /// If set, we attempt to negotiate the `scid_privacy` (referred to as `scid_alias` in the
227 /// BOLTs) option for outbound private channels. This provides better privacy by not including
228 /// our real on-chain channel UTXO in each invoice and requiring that our counterparty only
229 /// relay HTLCs to us using the channel's SCID alias.
230 ///
231 /// If this option is set, channels may be created that will not be readable by LDK versions
232 /// prior to 0.0.106, causing [`ChannelManager`]'s read method to return a
233 /// [`DecodeError::InvalidValue`].
234 ///
235 /// Note that setting this to true does *not* prevent us from opening channels with
236 /// counterparties that do not support the `scid_alias` option; we will simply fall back to a
237 /// private channel without that option.
238 ///
239 /// Ignored if the channel is negotiated to be announced, see
240 /// [`ChannelHandshakeConfig::announced_channel`] and
241 /// [`ChannelHandshakeLimits::force_announced_channel_preference`] for more.
242 ///
243 /// Default value: false. This value is likely to change to true in the future.
244 ///
245 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
246 /// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
247 #[no_mangle]
248 pub extern "C" fn ChannelHandshakeConfig_get_negotiate_scid_privacy(this_ptr: &ChannelHandshakeConfig) -> bool {
249         let mut inner_val = &mut this_ptr.get_native_mut_ref().negotiate_scid_privacy;
250         *inner_val
251 }
252 /// If set, we attempt to negotiate the `scid_privacy` (referred to as `scid_alias` in the
253 /// BOLTs) option for outbound private channels. This provides better privacy by not including
254 /// our real on-chain channel UTXO in each invoice and requiring that our counterparty only
255 /// relay HTLCs to us using the channel's SCID alias.
256 ///
257 /// If this option is set, channels may be created that will not be readable by LDK versions
258 /// prior to 0.0.106, causing [`ChannelManager`]'s read method to return a
259 /// [`DecodeError::InvalidValue`].
260 ///
261 /// Note that setting this to true does *not* prevent us from opening channels with
262 /// counterparties that do not support the `scid_alias` option; we will simply fall back to a
263 /// private channel without that option.
264 ///
265 /// Ignored if the channel is negotiated to be announced, see
266 /// [`ChannelHandshakeConfig::announced_channel`] and
267 /// [`ChannelHandshakeLimits::force_announced_channel_preference`] for more.
268 ///
269 /// Default value: false. This value is likely to change to true in the future.
270 ///
271 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
272 /// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
273 #[no_mangle]
274 pub extern "C" fn ChannelHandshakeConfig_set_negotiate_scid_privacy(this_ptr: &mut ChannelHandshakeConfig, mut val: bool) {
275         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.negotiate_scid_privacy = val;
276 }
277 /// Set to announce the channel publicly and notify all nodes that they can route via this
278 /// channel.
279 ///
280 /// This should only be set to true for nodes which expect to be online reliably.
281 ///
282 /// As the node which funds a channel picks this value this will only apply for new outbound
283 /// channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
284 ///
285 /// Default value: false.
286 #[no_mangle]
287 pub extern "C" fn ChannelHandshakeConfig_get_announced_channel(this_ptr: &ChannelHandshakeConfig) -> bool {
288         let mut inner_val = &mut this_ptr.get_native_mut_ref().announced_channel;
289         *inner_val
290 }
291 /// Set to announce the channel publicly and notify all nodes that they can route via this
292 /// channel.
293 ///
294 /// This should only be set to true for nodes which expect to be online reliably.
295 ///
296 /// As the node which funds a channel picks this value this will only apply for new outbound
297 /// channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
298 ///
299 /// Default value: false.
300 #[no_mangle]
301 pub extern "C" fn ChannelHandshakeConfig_set_announced_channel(this_ptr: &mut ChannelHandshakeConfig, mut val: bool) {
302         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.announced_channel = val;
303 }
304 /// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
305 /// supports it, they will then enforce the mutual-close output to us matches what we provided
306 /// at intialization, preventing us from closing to an alternate pubkey.
307 ///
308 /// This is set to true by default to provide a slight increase in security, though ultimately
309 /// any attacker who is able to take control of a channel can just as easily send the funds via
310 /// lightning payments, so we never require that our counterparties support this option.
311 ///
312 /// The upfront key committed is provided from [`SignerProvider::get_shutdown_scriptpubkey`].
313 ///
314 /// Default value: true.
315 ///
316 /// [`SignerProvider::get_shutdown_scriptpubkey`]: crate::sign::SignerProvider::get_shutdown_scriptpubkey
317 #[no_mangle]
318 pub extern "C" fn ChannelHandshakeConfig_get_commit_upfront_shutdown_pubkey(this_ptr: &ChannelHandshakeConfig) -> bool {
319         let mut inner_val = &mut this_ptr.get_native_mut_ref().commit_upfront_shutdown_pubkey;
320         *inner_val
321 }
322 /// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
323 /// supports it, they will then enforce the mutual-close output to us matches what we provided
324 /// at intialization, preventing us from closing to an alternate pubkey.
325 ///
326 /// This is set to true by default to provide a slight increase in security, though ultimately
327 /// any attacker who is able to take control of a channel can just as easily send the funds via
328 /// lightning payments, so we never require that our counterparties support this option.
329 ///
330 /// The upfront key committed is provided from [`SignerProvider::get_shutdown_scriptpubkey`].
331 ///
332 /// Default value: true.
333 ///
334 /// [`SignerProvider::get_shutdown_scriptpubkey`]: crate::sign::SignerProvider::get_shutdown_scriptpubkey
335 #[no_mangle]
336 pub extern "C" fn ChannelHandshakeConfig_set_commit_upfront_shutdown_pubkey(this_ptr: &mut ChannelHandshakeConfig, mut val: bool) {
337         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.commit_upfront_shutdown_pubkey = val;
338 }
339 /// The Proportion of the channel value to configure as counterparty's channel reserve,
340 /// i.e., `their_channel_reserve_satoshis` for both outbound and inbound channels.
341 ///
342 /// `their_channel_reserve_satoshis` is the minimum balance that the other node has to maintain
343 /// on their side, at all times.
344 /// This ensures that if our counterparty broadcasts a revoked state, we can punish them by
345 /// claiming at least this value on chain.
346 ///
347 /// Channel reserve values greater than 30% could be considered highly unreasonable, since that
348 /// amount can never be used for payments.
349 /// Also, if our selected channel reserve for counterparty and counterparty's selected
350 /// channel reserve for us sum up to equal or greater than channel value, channel negotiations
351 /// will fail.
352 ///
353 /// Note: Versions of LDK earlier than v0.0.104 will fail to read channels with any channel reserve
354 /// other than the default value.
355 ///
356 /// Default value: 1% of channel value, i.e., configured as 10,000 millionths.
357 /// Minimum value: If the calculated proportional value is less than 1000 sats, it will be treated
358 ///                as 1000 sats instead, which is a safe implementation-specific lower bound.
359 /// Maximum value: 1,000,000, any values larger than 1 Million will be treated as 1 Million (or 100%)
360 ///                instead, although channel negotiations will fail in that case.
361 #[no_mangle]
362 pub extern "C" fn ChannelHandshakeConfig_get_their_channel_reserve_proportional_millionths(this_ptr: &ChannelHandshakeConfig) -> u32 {
363         let mut inner_val = &mut this_ptr.get_native_mut_ref().their_channel_reserve_proportional_millionths;
364         *inner_val
365 }
366 /// The Proportion of the channel value to configure as counterparty's channel reserve,
367 /// i.e., `their_channel_reserve_satoshis` for both outbound and inbound channels.
368 ///
369 /// `their_channel_reserve_satoshis` is the minimum balance that the other node has to maintain
370 /// on their side, at all times.
371 /// This ensures that if our counterparty broadcasts a revoked state, we can punish them by
372 /// claiming at least this value on chain.
373 ///
374 /// Channel reserve values greater than 30% could be considered highly unreasonable, since that
375 /// amount can never be used for payments.
376 /// Also, if our selected channel reserve for counterparty and counterparty's selected
377 /// channel reserve for us sum up to equal or greater than channel value, channel negotiations
378 /// will fail.
379 ///
380 /// Note: Versions of LDK earlier than v0.0.104 will fail to read channels with any channel reserve
381 /// other than the default value.
382 ///
383 /// Default value: 1% of channel value, i.e., configured as 10,000 millionths.
384 /// Minimum value: If the calculated proportional value is less than 1000 sats, it will be treated
385 ///                as 1000 sats instead, which is a safe implementation-specific lower bound.
386 /// Maximum value: 1,000,000, any values larger than 1 Million will be treated as 1 Million (or 100%)
387 ///                instead, although channel negotiations will fail in that case.
388 #[no_mangle]
389 pub extern "C" fn ChannelHandshakeConfig_set_their_channel_reserve_proportional_millionths(this_ptr: &mut ChannelHandshakeConfig, mut val: u32) {
390         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.their_channel_reserve_proportional_millionths = val;
391 }
392 /// If set, we attempt to negotiate the `anchors_zero_fee_htlc_tx`option for all future
393 /// channels. This feature requires having a reserve of onchain funds readily available to bump
394 /// transactions in the event of a channel force close to avoid the possibility of losing funds.
395 ///
396 /// Note that if you wish accept inbound channels with anchor outputs, you must enable
397 /// [`UserConfig::manually_accept_inbound_channels`] and manually accept them with
398 /// [`ChannelManager::accept_inbound_channel`]. This is done to give you the chance to check
399 /// whether your reserve of onchain funds is enough to cover the fees for all existing and new
400 /// channels featuring anchor outputs in the event of a force close.
401 ///
402 /// If this option is set, channels may be created that will not be readable by LDK versions
403 /// prior to 0.0.116, causing [`ChannelManager`]'s read method to return a
404 /// [`DecodeError::InvalidValue`].
405 ///
406 /// Note that setting this to true does *not* prevent us from opening channels with
407 /// counterparties that do not support the `anchors_zero_fee_htlc_tx` option; we will simply
408 /// fall back to a `static_remote_key` channel.
409 ///
410 /// LDK will not support the legacy `option_anchors` commitment version due to a discovered
411 /// vulnerability after its deployment. For more context, see the [`SIGHASH_SINGLE + update_fee
412 /// Considered Harmful`] mailing list post.
413 ///
414 /// Default value: false. This value is likely to change to true in the future.
415 ///
416 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
417 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
418 /// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
419 /// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
420 #[no_mangle]
421 pub extern "C" fn ChannelHandshakeConfig_get_negotiate_anchors_zero_fee_htlc_tx(this_ptr: &ChannelHandshakeConfig) -> bool {
422         let mut inner_val = &mut this_ptr.get_native_mut_ref().negotiate_anchors_zero_fee_htlc_tx;
423         *inner_val
424 }
425 /// If set, we attempt to negotiate the `anchors_zero_fee_htlc_tx`option for all future
426 /// channels. This feature requires having a reserve of onchain funds readily available to bump
427 /// transactions in the event of a channel force close to avoid the possibility of losing funds.
428 ///
429 /// Note that if you wish accept inbound channels with anchor outputs, you must enable
430 /// [`UserConfig::manually_accept_inbound_channels`] and manually accept them with
431 /// [`ChannelManager::accept_inbound_channel`]. This is done to give you the chance to check
432 /// whether your reserve of onchain funds is enough to cover the fees for all existing and new
433 /// channels featuring anchor outputs in the event of a force close.
434 ///
435 /// If this option is set, channels may be created that will not be readable by LDK versions
436 /// prior to 0.0.116, causing [`ChannelManager`]'s read method to return a
437 /// [`DecodeError::InvalidValue`].
438 ///
439 /// Note that setting this to true does *not* prevent us from opening channels with
440 /// counterparties that do not support the `anchors_zero_fee_htlc_tx` option; we will simply
441 /// fall back to a `static_remote_key` channel.
442 ///
443 /// LDK will not support the legacy `option_anchors` commitment version due to a discovered
444 /// vulnerability after its deployment. For more context, see the [`SIGHASH_SINGLE + update_fee
445 /// Considered Harmful`] mailing list post.
446 ///
447 /// Default value: false. This value is likely to change to true in the future.
448 ///
449 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
450 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
451 /// [`DecodeError::InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
452 /// [`SIGHASH_SINGLE + update_fee Considered Harmful`]: https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-September/002796.html
453 #[no_mangle]
454 pub extern "C" fn ChannelHandshakeConfig_set_negotiate_anchors_zero_fee_htlc_tx(this_ptr: &mut ChannelHandshakeConfig, mut val: bool) {
455         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.negotiate_anchors_zero_fee_htlc_tx = val;
456 }
457 /// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
458 ///
459 /// Increasing the value can help improve liquidity and stability in
460 /// routing at the cost of higher long term disk / DB usage.
461 ///
462 /// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
463 /// other than the default value.
464 ///
465 /// Default value: 50
466 /// Maximum value: 483, any values larger will be treated as 483.
467 ///                     This is the BOLT #2 spec limit on `max_accepted_htlcs`.
468 #[no_mangle]
469 pub extern "C" fn ChannelHandshakeConfig_get_our_max_accepted_htlcs(this_ptr: &ChannelHandshakeConfig) -> u16 {
470         let mut inner_val = &mut this_ptr.get_native_mut_ref().our_max_accepted_htlcs;
471         *inner_val
472 }
473 /// The maximum number of HTLCs in-flight from our counterparty towards us at the same time.
474 ///
475 /// Increasing the value can help improve liquidity and stability in
476 /// routing at the cost of higher long term disk / DB usage.
477 ///
478 /// Note: Versions of LDK earlier than v0.0.115 will fail to read channels with a configuration
479 /// other than the default value.
480 ///
481 /// Default value: 50
482 /// Maximum value: 483, any values larger will be treated as 483.
483 ///                     This is the BOLT #2 spec limit on `max_accepted_htlcs`.
484 #[no_mangle]
485 pub extern "C" fn ChannelHandshakeConfig_set_our_max_accepted_htlcs(this_ptr: &mut ChannelHandshakeConfig, mut val: u16) {
486         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.our_max_accepted_htlcs = val;
487 }
488 /// Constructs a new ChannelHandshakeConfig given each field
489 #[must_use]
490 #[no_mangle]
491 pub extern "C" fn ChannelHandshakeConfig_new(mut minimum_depth_arg: u32, mut our_to_self_delay_arg: u16, mut our_htlc_minimum_msat_arg: u64, mut max_inbound_htlc_value_in_flight_percent_of_channel_arg: u8, mut negotiate_scid_privacy_arg: bool, mut announced_channel_arg: bool, mut commit_upfront_shutdown_pubkey_arg: bool, mut their_channel_reserve_proportional_millionths_arg: u32, mut negotiate_anchors_zero_fee_htlc_tx_arg: bool, mut our_max_accepted_htlcs_arg: u16) -> ChannelHandshakeConfig {
492         ChannelHandshakeConfig { inner: ObjOps::heap_alloc(nativeChannelHandshakeConfig {
493                 minimum_depth: minimum_depth_arg,
494                 our_to_self_delay: our_to_self_delay_arg,
495                 our_htlc_minimum_msat: our_htlc_minimum_msat_arg,
496                 max_inbound_htlc_value_in_flight_percent_of_channel: max_inbound_htlc_value_in_flight_percent_of_channel_arg,
497                 negotiate_scid_privacy: negotiate_scid_privacy_arg,
498                 announced_channel: announced_channel_arg,
499                 commit_upfront_shutdown_pubkey: commit_upfront_shutdown_pubkey_arg,
500                 their_channel_reserve_proportional_millionths: their_channel_reserve_proportional_millionths_arg,
501                 negotiate_anchors_zero_fee_htlc_tx: negotiate_anchors_zero_fee_htlc_tx_arg,
502                 our_max_accepted_htlcs: our_max_accepted_htlcs_arg,
503         }), is_owned: true }
504 }
505 impl Clone for ChannelHandshakeConfig {
506         fn clone(&self) -> Self {
507                 Self {
508                         inner: if <*mut nativeChannelHandshakeConfig>::is_null(self.inner) { core::ptr::null_mut() } else {
509                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
510                         is_owned: true,
511                 }
512         }
513 }
514 #[allow(unused)]
515 /// Used only if an object of this type is returned as a trait impl by a method
516 pub(crate) extern "C" fn ChannelHandshakeConfig_clone_void(this_ptr: *const c_void) -> *mut c_void {
517         Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeChannelHandshakeConfig)).clone() })) as *mut c_void
518 }
519 #[no_mangle]
520 /// Creates a copy of the ChannelHandshakeConfig
521 pub extern "C" fn ChannelHandshakeConfig_clone(orig: &ChannelHandshakeConfig) -> ChannelHandshakeConfig {
522         orig.clone()
523 }
524 /// Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used.
525 #[must_use]
526 #[no_mangle]
527 pub extern "C" fn ChannelHandshakeConfig_default() -> ChannelHandshakeConfig {
528         ChannelHandshakeConfig { inner: ObjOps::heap_alloc(Default::default()), is_owned: true }
529 }
530
531 use lightning::util::config::ChannelHandshakeLimits as nativeChannelHandshakeLimitsImport;
532 pub(crate) type nativeChannelHandshakeLimits = nativeChannelHandshakeLimitsImport;
533
534 /// Optional channel limits which are applied during channel creation.
535 ///
536 /// These limits are only applied to our counterparty's limits, not our own.
537 ///
538 /// Use 0/`<type>::max_value()` as appropriate to skip checking.
539 ///
540 /// Provides sane defaults for most configurations.
541 ///
542 /// Most additional limits are disabled except those with which specify a default in individual
543 /// field documentation. Note that this may result in barely-usable channels, but since they
544 /// are applied mostly only to incoming channels that's not much of a problem.
545 #[must_use]
546 #[repr(C)]
547 pub struct ChannelHandshakeLimits {
548         /// A pointer to the opaque Rust object.
549
550         /// Nearly everywhere, inner must be non-null, however in places where
551         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
552         pub inner: *mut nativeChannelHandshakeLimits,
553         /// Indicates that this is the only struct which contains the same pointer.
554
555         /// Rust functions which take ownership of an object provided via an argument require
556         /// this to be true and invalidate the object pointed to by inner.
557         pub is_owned: bool,
558 }
559
560 impl Drop for ChannelHandshakeLimits {
561         fn drop(&mut self) {
562                 if self.is_owned && !<*mut nativeChannelHandshakeLimits>::is_null(self.inner) {
563                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
564                 }
565         }
566 }
567 /// Frees any resources used by the ChannelHandshakeLimits, if is_owned is set and inner is non-NULL.
568 #[no_mangle]
569 pub extern "C" fn ChannelHandshakeLimits_free(this_obj: ChannelHandshakeLimits) { }
570 #[allow(unused)]
571 /// Used only if an object of this type is returned as a trait impl by a method
572 pub(crate) extern "C" fn ChannelHandshakeLimits_free_void(this_ptr: *mut c_void) {
573         let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelHandshakeLimits) };
574 }
575 #[allow(unused)]
576 impl ChannelHandshakeLimits {
577         pub(crate) fn get_native_ref(&self) -> &'static nativeChannelHandshakeLimits {
578                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
579         }
580         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelHandshakeLimits {
581                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
582         }
583         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
584         pub(crate) fn take_inner(mut self) -> *mut nativeChannelHandshakeLimits {
585                 assert!(self.is_owned);
586                 let ret = ObjOps::untweak_ptr(self.inner);
587                 self.inner = core::ptr::null_mut();
588                 ret
589         }
590 }
591 /// Minimum allowed satoshis when a channel is funded. This is supplied by the sender and so
592 /// only applies to inbound channels.
593 ///
594 /// Default value: 0.
595 #[no_mangle]
596 pub extern "C" fn ChannelHandshakeLimits_get_min_funding_satoshis(this_ptr: &ChannelHandshakeLimits) -> u64 {
597         let mut inner_val = &mut this_ptr.get_native_mut_ref().min_funding_satoshis;
598         *inner_val
599 }
600 /// Minimum allowed satoshis when a channel is funded. This is supplied by the sender and so
601 /// only applies to inbound channels.
602 ///
603 /// Default value: 0.
604 #[no_mangle]
605 pub extern "C" fn ChannelHandshakeLimits_set_min_funding_satoshis(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
606         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.min_funding_satoshis = val;
607 }
608 /// Maximum allowed satoshis when a channel is funded. This is supplied by the sender and so
609 /// only applies to inbound channels.
610 ///
611 /// Default value: 2^24 - 1.
612 #[no_mangle]
613 pub extern "C" fn ChannelHandshakeLimits_get_max_funding_satoshis(this_ptr: &ChannelHandshakeLimits) -> u64 {
614         let mut inner_val = &mut this_ptr.get_native_mut_ref().max_funding_satoshis;
615         *inner_val
616 }
617 /// Maximum allowed satoshis when a channel is funded. This is supplied by the sender and so
618 /// only applies to inbound channels.
619 ///
620 /// Default value: 2^24 - 1.
621 #[no_mangle]
622 pub extern "C" fn ChannelHandshakeLimits_set_max_funding_satoshis(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
623         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_funding_satoshis = val;
624 }
625 /// The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
626 /// you to limit the maximum minimum-size they can require.
627 ///
628 /// Default value: u64::max_value.
629 #[no_mangle]
630 pub extern "C" fn ChannelHandshakeLimits_get_max_htlc_minimum_msat(this_ptr: &ChannelHandshakeLimits) -> u64 {
631         let mut inner_val = &mut this_ptr.get_native_mut_ref().max_htlc_minimum_msat;
632         *inner_val
633 }
634 /// The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
635 /// you to limit the maximum minimum-size they can require.
636 ///
637 /// Default value: u64::max_value.
638 #[no_mangle]
639 pub extern "C" fn ChannelHandshakeLimits_set_max_htlc_minimum_msat(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
640         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_htlc_minimum_msat = val;
641 }
642 /// The remote node sets a limit on the maximum value of pending HTLCs to them at any given
643 /// time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
644 ///
645 /// Default value: 0.
646 #[no_mangle]
647 pub extern "C" fn ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(this_ptr: &ChannelHandshakeLimits) -> u64 {
648         let mut inner_val = &mut this_ptr.get_native_mut_ref().min_max_htlc_value_in_flight_msat;
649         *inner_val
650 }
651 /// The remote node sets a limit on the maximum value of pending HTLCs to them at any given
652 /// time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
653 ///
654 /// Default value: 0.
655 #[no_mangle]
656 pub extern "C" fn ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
657         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.min_max_htlc_value_in_flight_msat = val;
658 }
659 /// The remote node will require we keep a certain amount in direct payment to ourselves at all
660 /// time, ensuring that we are able to be punished if we broadcast an old state. This allows to
661 /// you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
662 ///
663 /// Default value: u64::max_value.
664 #[no_mangle]
665 pub extern "C" fn ChannelHandshakeLimits_get_max_channel_reserve_satoshis(this_ptr: &ChannelHandshakeLimits) -> u64 {
666         let mut inner_val = &mut this_ptr.get_native_mut_ref().max_channel_reserve_satoshis;
667         *inner_val
668 }
669 /// The remote node will require we keep a certain amount in direct payment to ourselves at all
670 /// time, ensuring that we are able to be punished if we broadcast an old state. This allows to
671 /// you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
672 ///
673 /// Default value: u64::max_value.
674 #[no_mangle]
675 pub extern "C" fn ChannelHandshakeLimits_set_max_channel_reserve_satoshis(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
676         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_channel_reserve_satoshis = val;
677 }
678 /// The remote node sets a limit on the maximum number of pending HTLCs to them at any given
679 /// time. This allows you to set a minimum such value.
680 ///
681 /// Default value: 0.
682 #[no_mangle]
683 pub extern "C" fn ChannelHandshakeLimits_get_min_max_accepted_htlcs(this_ptr: &ChannelHandshakeLimits) -> u16 {
684         let mut inner_val = &mut this_ptr.get_native_mut_ref().min_max_accepted_htlcs;
685         *inner_val
686 }
687 /// The remote node sets a limit on the maximum number of pending HTLCs to them at any given
688 /// time. This allows you to set a minimum such value.
689 ///
690 /// Default value: 0.
691 #[no_mangle]
692 pub extern "C" fn ChannelHandshakeLimits_set_min_max_accepted_htlcs(this_ptr: &mut ChannelHandshakeLimits, mut val: u16) {
693         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.min_max_accepted_htlcs = val;
694 }
695 /// Before a channel is usable the funding transaction will need to be confirmed by at least a
696 /// certain number of blocks, specified by the node which is not the funder (as the funder can
697 /// assume they aren't going to double-spend themselves).
698 /// This config allows you to set a limit on the maximum amount of time to wait.
699 ///
700 /// Default value: 144, or roughly one day and only applies to outbound channels.
701 #[no_mangle]
702 pub extern "C" fn ChannelHandshakeLimits_get_max_minimum_depth(this_ptr: &ChannelHandshakeLimits) -> u32 {
703         let mut inner_val = &mut this_ptr.get_native_mut_ref().max_minimum_depth;
704         *inner_val
705 }
706 /// Before a channel is usable the funding transaction will need to be confirmed by at least a
707 /// certain number of blocks, specified by the node which is not the funder (as the funder can
708 /// assume they aren't going to double-spend themselves).
709 /// This config allows you to set a limit on the maximum amount of time to wait.
710 ///
711 /// Default value: 144, or roughly one day and only applies to outbound channels.
712 #[no_mangle]
713 pub extern "C" fn ChannelHandshakeLimits_set_max_minimum_depth(this_ptr: &mut ChannelHandshakeLimits, mut val: u32) {
714         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_minimum_depth = val;
715 }
716 /// Whether we implicitly trust funding transactions generated by us for our own outbound
717 /// channels to not be double-spent.
718 ///
719 /// If this is set, we assume that our own funding transactions are *never* double-spent, and
720 /// thus we can trust them without any confirmations. This is generally a reasonable
721 /// assumption, given we're the only ones who could ever double-spend it (assuming we have sole
722 /// control of the signing keys).
723 ///
724 /// You may wish to un-set this if you allow the user to (or do in an automated fashion)
725 /// double-spend the funding transaction to RBF with an alternative channel open.
726 ///
727 /// This only applies if our counterparty set their confirmations-required value to 0, and we
728 /// always trust our own funding transaction at 1 confirmation irrespective of this value.
729 /// Thus, this effectively acts as a `min_minimum_depth`, with the only possible values being
730 /// `true` (0) and `false` (1).
731 ///
732 /// Default value: true
733 #[no_mangle]
734 pub extern "C" fn ChannelHandshakeLimits_get_trust_own_funding_0conf(this_ptr: &ChannelHandshakeLimits) -> bool {
735         let mut inner_val = &mut this_ptr.get_native_mut_ref().trust_own_funding_0conf;
736         *inner_val
737 }
738 /// Whether we implicitly trust funding transactions generated by us for our own outbound
739 /// channels to not be double-spent.
740 ///
741 /// If this is set, we assume that our own funding transactions are *never* double-spent, and
742 /// thus we can trust them without any confirmations. This is generally a reasonable
743 /// assumption, given we're the only ones who could ever double-spend it (assuming we have sole
744 /// control of the signing keys).
745 ///
746 /// You may wish to un-set this if you allow the user to (or do in an automated fashion)
747 /// double-spend the funding transaction to RBF with an alternative channel open.
748 ///
749 /// This only applies if our counterparty set their confirmations-required value to 0, and we
750 /// always trust our own funding transaction at 1 confirmation irrespective of this value.
751 /// Thus, this effectively acts as a `min_minimum_depth`, with the only possible values being
752 /// `true` (0) and `false` (1).
753 ///
754 /// Default value: true
755 #[no_mangle]
756 pub extern "C" fn ChannelHandshakeLimits_set_trust_own_funding_0conf(this_ptr: &mut ChannelHandshakeLimits, mut val: bool) {
757         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.trust_own_funding_0conf = val;
758 }
759 /// Set to force an incoming channel to match our announced channel preference in
760 /// [`ChannelHandshakeConfig::announced_channel`].
761 ///
762 /// For a node which is not online reliably, this should be set to true and
763 /// [`ChannelHandshakeConfig::announced_channel`] set to false, ensuring that no announced (aka public)
764 /// channels will ever be opened.
765 ///
766 /// Default value: true.
767 #[no_mangle]
768 pub extern "C" fn ChannelHandshakeLimits_get_force_announced_channel_preference(this_ptr: &ChannelHandshakeLimits) -> bool {
769         let mut inner_val = &mut this_ptr.get_native_mut_ref().force_announced_channel_preference;
770         *inner_val
771 }
772 /// Set to force an incoming channel to match our announced channel preference in
773 /// [`ChannelHandshakeConfig::announced_channel`].
774 ///
775 /// For a node which is not online reliably, this should be set to true and
776 /// [`ChannelHandshakeConfig::announced_channel`] set to false, ensuring that no announced (aka public)
777 /// channels will ever be opened.
778 ///
779 /// Default value: true.
780 #[no_mangle]
781 pub extern "C" fn ChannelHandshakeLimits_set_force_announced_channel_preference(this_ptr: &mut ChannelHandshakeLimits, mut val: bool) {
782         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.force_announced_channel_preference = val;
783 }
784 /// Set to the amount of time we're willing to wait to claim money back to us.
785 ///
786 /// Not checking this value would be a security issue, as our peer would be able to set it to
787 /// max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
788 ///
789 /// Default value: 2016, which we also enforce as a maximum value so you can tweak config to
790 /// reduce the loss of having useless locked funds (if your peer accepts)
791 #[no_mangle]
792 pub extern "C" fn ChannelHandshakeLimits_get_their_to_self_delay(this_ptr: &ChannelHandshakeLimits) -> u16 {
793         let mut inner_val = &mut this_ptr.get_native_mut_ref().their_to_self_delay;
794         *inner_val
795 }
796 /// Set to the amount of time we're willing to wait to claim money back to us.
797 ///
798 /// Not checking this value would be a security issue, as our peer would be able to set it to
799 /// max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
800 ///
801 /// Default value: 2016, which we also enforce as a maximum value so you can tweak config to
802 /// reduce the loss of having useless locked funds (if your peer accepts)
803 #[no_mangle]
804 pub extern "C" fn ChannelHandshakeLimits_set_their_to_self_delay(this_ptr: &mut ChannelHandshakeLimits, mut val: u16) {
805         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.their_to_self_delay = val;
806 }
807 /// Constructs a new ChannelHandshakeLimits given each field
808 #[must_use]
809 #[no_mangle]
810 pub extern "C" fn ChannelHandshakeLimits_new(mut min_funding_satoshis_arg: u64, mut max_funding_satoshis_arg: u64, mut max_htlc_minimum_msat_arg: u64, mut min_max_htlc_value_in_flight_msat_arg: u64, mut max_channel_reserve_satoshis_arg: u64, mut min_max_accepted_htlcs_arg: u16, mut max_minimum_depth_arg: u32, mut trust_own_funding_0conf_arg: bool, mut force_announced_channel_preference_arg: bool, mut their_to_self_delay_arg: u16) -> ChannelHandshakeLimits {
811         ChannelHandshakeLimits { inner: ObjOps::heap_alloc(nativeChannelHandshakeLimits {
812                 min_funding_satoshis: min_funding_satoshis_arg,
813                 max_funding_satoshis: max_funding_satoshis_arg,
814                 max_htlc_minimum_msat: max_htlc_minimum_msat_arg,
815                 min_max_htlc_value_in_flight_msat: min_max_htlc_value_in_flight_msat_arg,
816                 max_channel_reserve_satoshis: max_channel_reserve_satoshis_arg,
817                 min_max_accepted_htlcs: min_max_accepted_htlcs_arg,
818                 max_minimum_depth: max_minimum_depth_arg,
819                 trust_own_funding_0conf: trust_own_funding_0conf_arg,
820                 force_announced_channel_preference: force_announced_channel_preference_arg,
821                 their_to_self_delay: their_to_self_delay_arg,
822         }), is_owned: true }
823 }
824 impl Clone for ChannelHandshakeLimits {
825         fn clone(&self) -> Self {
826                 Self {
827                         inner: if <*mut nativeChannelHandshakeLimits>::is_null(self.inner) { core::ptr::null_mut() } else {
828                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
829                         is_owned: true,
830                 }
831         }
832 }
833 #[allow(unused)]
834 /// Used only if an object of this type is returned as a trait impl by a method
835 pub(crate) extern "C" fn ChannelHandshakeLimits_clone_void(this_ptr: *const c_void) -> *mut c_void {
836         Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeChannelHandshakeLimits)).clone() })) as *mut c_void
837 }
838 #[no_mangle]
839 /// Creates a copy of the ChannelHandshakeLimits
840 pub extern "C" fn ChannelHandshakeLimits_clone(orig: &ChannelHandshakeLimits) -> ChannelHandshakeLimits {
841         orig.clone()
842 }
843 /// Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used.
844 #[must_use]
845 #[no_mangle]
846 pub extern "C" fn ChannelHandshakeLimits_default() -> ChannelHandshakeLimits {
847         ChannelHandshakeLimits { inner: ObjOps::heap_alloc(Default::default()), is_owned: true }
848 }
849 /// Options for how to set the max dust HTLC exposure allowed on a channel. See
850 /// [`ChannelConfig::max_dust_htlc_exposure`] for details.
851 #[derive(Clone)]
852 #[must_use]
853 #[repr(C)]
854 pub enum MaxDustHTLCExposure {
855         /// This sets a fixed limit on the total dust exposure in millisatoshis. Setting this too low
856         /// may prevent the sending or receipt of low-value HTLCs on high-traffic nodes, however this
857         /// limit is very important to prevent stealing of large amounts of dust HTLCs by miners
858         /// through [fee griefing
859         /// attacks](https://lists.linuxfoundation.org/pipermail/lightning-dev/2020-May/002714.html).
860         ///
861         /// Note that if the feerate increases significantly, without a manual increase
862         /// to this maximum the channel may be unable to send/receive HTLCs between the maximum dust
863         /// exposure and the new minimum value for HTLCs to be economically viable to claim.
864         FixedLimitMsat(
865                 u64),
866         /// This sets a multiplier on the estimated high priority feerate (sats/KW, as obtained from
867         /// [`FeeEstimator`]) to determine the maximum allowed dust exposure. If this variant is used
868         /// then the maximum dust exposure in millisatoshis is calculated as:
869         /// `high_priority_feerate_per_kw * value`. For example, with our default value
870         /// `FeeRateMultiplier(5000)`:
871         ///
872         /// - For the minimum fee rate of 1 sat/vByte (250 sat/KW, although the minimum
873         /// defaults to 253 sats/KW for rounding, see [`FeeEstimator`]), the max dust exposure would
874         /// be 253 * 5000 = 1,265,000 msats.
875         /// - For a fee rate of 30 sat/vByte (7500 sat/KW), the max dust exposure would be
876         /// 7500 * 5000 = 37,500,000 msats.
877         ///
878         /// This allows the maximum dust exposure to automatically scale with fee rate changes.
879         ///
880         /// Note, if you're using a third-party fee estimator, this may leave you more exposed to a
881         /// fee griefing attack, where your fee estimator may purposely overestimate the fee rate,
882         /// causing you to accept more dust HTLCs than you would otherwise.
883         ///
884         /// This variant is primarily meant to serve pre-anchor channels, as HTLC fees being included
885         /// on HTLC outputs means your channel may be subject to more dust exposure in the event of
886         /// increases in fee rate.
887         ///
888         /// # Backwards Compatibility
889         /// This variant only became available in LDK 0.0.116, so if you downgrade to a prior version
890         /// by default this will be set to a [`Self::FixedLimitMsat`] of 5,000,000 msat.
891         ///
892         /// [`FeeEstimator`]: crate::chain::chaininterface::FeeEstimator
893         FeeRateMultiplier(
894                 u64),
895 }
896 use lightning::util::config::MaxDustHTLCExposure as MaxDustHTLCExposureImport;
897 pub(crate) type nativeMaxDustHTLCExposure = MaxDustHTLCExposureImport;
898
899 impl MaxDustHTLCExposure {
900         #[allow(unused)]
901         pub(crate) fn to_native(&self) -> nativeMaxDustHTLCExposure {
902                 match self {
903                         MaxDustHTLCExposure::FixedLimitMsat (ref a, ) => {
904                                 let mut a_nonref = Clone::clone(a);
905                                 nativeMaxDustHTLCExposure::FixedLimitMsat (
906                                         a_nonref,
907                                 )
908                         },
909                         MaxDustHTLCExposure::FeeRateMultiplier (ref a, ) => {
910                                 let mut a_nonref = Clone::clone(a);
911                                 nativeMaxDustHTLCExposure::FeeRateMultiplier (
912                                         a_nonref,
913                                 )
914                         },
915                 }
916         }
917         #[allow(unused)]
918         pub(crate) fn into_native(self) -> nativeMaxDustHTLCExposure {
919                 match self {
920                         MaxDustHTLCExposure::FixedLimitMsat (mut a, ) => {
921                                 nativeMaxDustHTLCExposure::FixedLimitMsat (
922                                         a,
923                                 )
924                         },
925                         MaxDustHTLCExposure::FeeRateMultiplier (mut a, ) => {
926                                 nativeMaxDustHTLCExposure::FeeRateMultiplier (
927                                         a,
928                                 )
929                         },
930                 }
931         }
932         #[allow(unused)]
933         pub(crate) fn from_native(native: &nativeMaxDustHTLCExposure) -> Self {
934                 match native {
935                         nativeMaxDustHTLCExposure::FixedLimitMsat (ref a, ) => {
936                                 let mut a_nonref = Clone::clone(a);
937                                 MaxDustHTLCExposure::FixedLimitMsat (
938                                         a_nonref,
939                                 )
940                         },
941                         nativeMaxDustHTLCExposure::FeeRateMultiplier (ref a, ) => {
942                                 let mut a_nonref = Clone::clone(a);
943                                 MaxDustHTLCExposure::FeeRateMultiplier (
944                                         a_nonref,
945                                 )
946                         },
947                 }
948         }
949         #[allow(unused)]
950         pub(crate) fn native_into(native: nativeMaxDustHTLCExposure) -> Self {
951                 match native {
952                         nativeMaxDustHTLCExposure::FixedLimitMsat (mut a, ) => {
953                                 MaxDustHTLCExposure::FixedLimitMsat (
954                                         a,
955                                 )
956                         },
957                         nativeMaxDustHTLCExposure::FeeRateMultiplier (mut a, ) => {
958                                 MaxDustHTLCExposure::FeeRateMultiplier (
959                                         a,
960                                 )
961                         },
962                 }
963         }
964 }
965 /// Frees any resources used by the MaxDustHTLCExposure
966 #[no_mangle]
967 pub extern "C" fn MaxDustHTLCExposure_free(this_ptr: MaxDustHTLCExposure) { }
968 /// Creates a copy of the MaxDustHTLCExposure
969 #[no_mangle]
970 pub extern "C" fn MaxDustHTLCExposure_clone(orig: &MaxDustHTLCExposure) -> MaxDustHTLCExposure {
971         orig.clone()
972 }
973 #[allow(unused)]
974 /// Used only if an object of this type is returned as a trait impl by a method
975 pub(crate) extern "C" fn MaxDustHTLCExposure_clone_void(this_ptr: *const c_void) -> *mut c_void {
976         Box::into_raw(Box::new(unsafe { (*(this_ptr as *const MaxDustHTLCExposure)).clone() })) as *mut c_void
977 }
978 #[allow(unused)]
979 /// Used only if an object of this type is returned as a trait impl by a method
980 pub(crate) extern "C" fn MaxDustHTLCExposure_free_void(this_ptr: *mut c_void) {
981         let _ = unsafe { Box::from_raw(this_ptr as *mut MaxDustHTLCExposure) };
982 }
983 #[no_mangle]
984 /// Utility method to constructs a new FixedLimitMsat-variant MaxDustHTLCExposure
985 pub extern "C" fn MaxDustHTLCExposure_fixed_limit_msat(a: u64) -> MaxDustHTLCExposure {
986         MaxDustHTLCExposure::FixedLimitMsat(a, )
987 }
988 #[no_mangle]
989 /// Utility method to constructs a new FeeRateMultiplier-variant MaxDustHTLCExposure
990 pub extern "C" fn MaxDustHTLCExposure_fee_rate_multiplier(a: u64) -> MaxDustHTLCExposure {
991         MaxDustHTLCExposure::FeeRateMultiplier(a, )
992 }
993 /// Checks if two MaxDustHTLCExposures contain equal inner contents.
994 /// This ignores pointers and is_owned flags and looks at the values in fields.
995 #[no_mangle]
996 pub extern "C" fn MaxDustHTLCExposure_eq(a: &MaxDustHTLCExposure, b: &MaxDustHTLCExposure) -> bool {
997         if &a.to_native() == &b.to_native() { true } else { false }
998 }
999 #[no_mangle]
1000 /// Serialize the MaxDustHTLCExposure object into a byte array which can be read by MaxDustHTLCExposure_read
1001 pub extern "C" fn MaxDustHTLCExposure_write(obj: &crate::lightning::util::config::MaxDustHTLCExposure) -> crate::c_types::derived::CVec_u8Z {
1002         crate::c_types::serialize_obj(&unsafe { &*obj }.to_native())
1003 }
1004 #[allow(unused)]
1005 pub(crate) extern "C" fn MaxDustHTLCExposure_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1006         MaxDustHTLCExposure_write(unsafe { &*(obj as *const MaxDustHTLCExposure) })
1007 }
1008 #[no_mangle]
1009 /// Read a MaxDustHTLCExposure from a byte array, created by MaxDustHTLCExposure_write
1010 pub extern "C" fn MaxDustHTLCExposure_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_MaxDustHTLCExposureDecodeErrorZ {
1011         let res: Result<lightning::util::config::MaxDustHTLCExposure, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1012         let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::util::config::MaxDustHTLCExposure::native_into(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
1013         local_res
1014 }
1015
1016 use lightning::util::config::ChannelConfig as nativeChannelConfigImport;
1017 pub(crate) type nativeChannelConfig = nativeChannelConfigImport;
1018
1019 /// Options which apply on a per-channel basis and may change at runtime or based on negotiation
1020 /// with our counterparty.
1021 #[must_use]
1022 #[repr(C)]
1023 pub struct ChannelConfig {
1024         /// A pointer to the opaque Rust object.
1025
1026         /// Nearly everywhere, inner must be non-null, however in places where
1027         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1028         pub inner: *mut nativeChannelConfig,
1029         /// Indicates that this is the only struct which contains the same pointer.
1030
1031         /// Rust functions which take ownership of an object provided via an argument require
1032         /// this to be true and invalidate the object pointed to by inner.
1033         pub is_owned: bool,
1034 }
1035
1036 impl Drop for ChannelConfig {
1037         fn drop(&mut self) {
1038                 if self.is_owned && !<*mut nativeChannelConfig>::is_null(self.inner) {
1039                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1040                 }
1041         }
1042 }
1043 /// Frees any resources used by the ChannelConfig, if is_owned is set and inner is non-NULL.
1044 #[no_mangle]
1045 pub extern "C" fn ChannelConfig_free(this_obj: ChannelConfig) { }
1046 #[allow(unused)]
1047 /// Used only if an object of this type is returned as a trait impl by a method
1048 pub(crate) extern "C" fn ChannelConfig_free_void(this_ptr: *mut c_void) {
1049         let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelConfig) };
1050 }
1051 #[allow(unused)]
1052 impl ChannelConfig {
1053         pub(crate) fn get_native_ref(&self) -> &'static nativeChannelConfig {
1054                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1055         }
1056         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelConfig {
1057                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1058         }
1059         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1060         pub(crate) fn take_inner(mut self) -> *mut nativeChannelConfig {
1061                 assert!(self.is_owned);
1062                 let ret = ObjOps::untweak_ptr(self.inner);
1063                 self.inner = core::ptr::null_mut();
1064                 ret
1065         }
1066 }
1067 /// Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
1068 /// over the channel.
1069 /// This may be allowed to change at runtime in a later update, however doing so must result in
1070 /// update messages sent to notify all nodes of our updated relay fee.
1071 ///
1072 /// Default value: 0.
1073 #[no_mangle]
1074 pub extern "C" fn ChannelConfig_get_forwarding_fee_proportional_millionths(this_ptr: &ChannelConfig) -> u32 {
1075         let mut inner_val = &mut this_ptr.get_native_mut_ref().forwarding_fee_proportional_millionths;
1076         *inner_val
1077 }
1078 /// Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
1079 /// over the channel.
1080 /// This may be allowed to change at runtime in a later update, however doing so must result in
1081 /// update messages sent to notify all nodes of our updated relay fee.
1082 ///
1083 /// Default value: 0.
1084 #[no_mangle]
1085 pub extern "C" fn ChannelConfig_set_forwarding_fee_proportional_millionths(this_ptr: &mut ChannelConfig, mut val: u32) {
1086         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.forwarding_fee_proportional_millionths = val;
1087 }
1088 /// Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
1089 /// excess of [`forwarding_fee_proportional_millionths`].
1090 /// This may be allowed to change at runtime in a later update, however doing so must result in
1091 /// update messages sent to notify all nodes of our updated relay fee.
1092 ///
1093 /// The default value of a single satoshi roughly matches the market rate on many routing nodes
1094 /// as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
1095 /// this node.
1096 ///
1097 /// Default value: 1000.
1098 ///
1099 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
1100 #[no_mangle]
1101 pub extern "C" fn ChannelConfig_get_forwarding_fee_base_msat(this_ptr: &ChannelConfig) -> u32 {
1102         let mut inner_val = &mut this_ptr.get_native_mut_ref().forwarding_fee_base_msat;
1103         *inner_val
1104 }
1105 /// Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
1106 /// excess of [`forwarding_fee_proportional_millionths`].
1107 /// This may be allowed to change at runtime in a later update, however doing so must result in
1108 /// update messages sent to notify all nodes of our updated relay fee.
1109 ///
1110 /// The default value of a single satoshi roughly matches the market rate on many routing nodes
1111 /// as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
1112 /// this node.
1113 ///
1114 /// Default value: 1000.
1115 ///
1116 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
1117 #[no_mangle]
1118 pub extern "C" fn ChannelConfig_set_forwarding_fee_base_msat(this_ptr: &mut ChannelConfig, mut val: u32) {
1119         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.forwarding_fee_base_msat = val;
1120 }
1121 /// The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
1122 /// the channel this config applies to.
1123 ///
1124 /// This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
1125 /// HTLC balance when a channel appears on-chain whereas
1126 /// [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
1127 /// (non-HTLC-encumbered) balance.
1128 ///
1129 /// Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
1130 /// we (or one of our watchtowers) MUST be online to check for broadcast of the current
1131 /// commitment transaction at least once per this many blocks (minus some margin to allow us
1132 /// enough time to broadcast and confirm a transaction, possibly with time in between to RBF
1133 /// the spending transaction).
1134 ///
1135 /// Default value: 72 (12 hours at an average of 6 blocks/hour).
1136 /// Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
1137 ///                [`MIN_CLTV_EXPIRY_DELTA`] instead.
1138 ///
1139 /// [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
1140 #[no_mangle]
1141 pub extern "C" fn ChannelConfig_get_cltv_expiry_delta(this_ptr: &ChannelConfig) -> u16 {
1142         let mut inner_val = &mut this_ptr.get_native_mut_ref().cltv_expiry_delta;
1143         *inner_val
1144 }
1145 /// The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
1146 /// the channel this config applies to.
1147 ///
1148 /// This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
1149 /// HTLC balance when a channel appears on-chain whereas
1150 /// [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
1151 /// (non-HTLC-encumbered) balance.
1152 ///
1153 /// Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
1154 /// we (or one of our watchtowers) MUST be online to check for broadcast of the current
1155 /// commitment transaction at least once per this many blocks (minus some margin to allow us
1156 /// enough time to broadcast and confirm a transaction, possibly with time in between to RBF
1157 /// the spending transaction).
1158 ///
1159 /// Default value: 72 (12 hours at an average of 6 blocks/hour).
1160 /// Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
1161 ///                [`MIN_CLTV_EXPIRY_DELTA`] instead.
1162 ///
1163 /// [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
1164 #[no_mangle]
1165 pub extern "C" fn ChannelConfig_set_cltv_expiry_delta(this_ptr: &mut ChannelConfig, mut val: u16) {
1166         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.cltv_expiry_delta = val;
1167 }
1168 /// Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
1169 /// small to claim on-chain.
1170 ///
1171 /// When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
1172 /// not be claimable on-chain, instead being turned into additional miner fees if either
1173 /// party force-closes the channel. Because the threshold is per-HTLC, our total exposure
1174 /// to such payments may be sustantial if there are many dust HTLCs present when the
1175 /// channel is force-closed.
1176 ///
1177 /// The dust threshold for each HTLC is based on the `dust_limit_satoshis` for each party in a
1178 /// channel negotiated throughout the channel open process, along with the fees required to have
1179 /// a broadcastable HTLC spending transaction. When a channel supports anchor outputs
1180 /// (specifically the zero fee HTLC transaction variant), this threshold no longer takes into
1181 /// account the HTLC transaction fee as it is zero. Because of this, you may want to set this
1182 /// value to a fixed limit for channels using anchor outputs, while the fee rate multiplier
1183 /// variant is primarily intended for use with pre-anchor channels.
1184 ///
1185 /// The selected limit is applied for sent, forwarded, and received HTLCs and limits the total
1186 /// exposure across all three types per-channel.
1187 ///
1188 /// Default value: [`MaxDustHTLCExposure::FeeRateMultiplier`] with a multiplier of 5000.
1189 #[no_mangle]
1190 pub extern "C" fn ChannelConfig_get_max_dust_htlc_exposure(this_ptr: &ChannelConfig) -> crate::lightning::util::config::MaxDustHTLCExposure {
1191         let mut inner_val = &mut this_ptr.get_native_mut_ref().max_dust_htlc_exposure;
1192         crate::lightning::util::config::MaxDustHTLCExposure::from_native(inner_val)
1193 }
1194 /// Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
1195 /// small to claim on-chain.
1196 ///
1197 /// When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
1198 /// not be claimable on-chain, instead being turned into additional miner fees if either
1199 /// party force-closes the channel. Because the threshold is per-HTLC, our total exposure
1200 /// to such payments may be sustantial if there are many dust HTLCs present when the
1201 /// channel is force-closed.
1202 ///
1203 /// The dust threshold for each HTLC is based on the `dust_limit_satoshis` for each party in a
1204 /// channel negotiated throughout the channel open process, along with the fees required to have
1205 /// a broadcastable HTLC spending transaction. When a channel supports anchor outputs
1206 /// (specifically the zero fee HTLC transaction variant), this threshold no longer takes into
1207 /// account the HTLC transaction fee as it is zero. Because of this, you may want to set this
1208 /// value to a fixed limit for channels using anchor outputs, while the fee rate multiplier
1209 /// variant is primarily intended for use with pre-anchor channels.
1210 ///
1211 /// The selected limit is applied for sent, forwarded, and received HTLCs and limits the total
1212 /// exposure across all three types per-channel.
1213 ///
1214 /// Default value: [`MaxDustHTLCExposure::FeeRateMultiplier`] with a multiplier of 5000.
1215 #[no_mangle]
1216 pub extern "C" fn ChannelConfig_set_max_dust_htlc_exposure(this_ptr: &mut ChannelConfig, mut val: crate::lightning::util::config::MaxDustHTLCExposure) {
1217         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_dust_htlc_exposure = val.into_native();
1218 }
1219 /// The additional fee we're willing to pay to avoid waiting for the counterparty's
1220 /// `to_self_delay` to reclaim funds.
1221 ///
1222 /// When we close a channel cooperatively with our counterparty, we negotiate a fee for the
1223 /// closing transaction which both sides find acceptable, ultimately paid by the channel
1224 /// funder/initiator.
1225 ///
1226 /// When we are the funder, because we have to pay the channel closing fee, we bound the
1227 /// acceptable fee by our [`ChannelCloseMinimum`] and [`NonAnchorChannelFee`] fees, with the upper bound increased by
1228 /// this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
1229 /// [`NonAnchorChannelFee`] feerate during normal operation, this value represents the additional fee we're
1230 /// willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
1231 /// funds.
1232 ///
1233 /// When we are not the funder, we require the closing transaction fee pay at least our
1234 /// [`ChannelCloseMinimum`] fee estimate, but allow our counterparty to pay as much fee as they like.
1235 /// Thus, this value is ignored when we are not the funder.
1236 ///
1237 /// Default value: 1000 satoshis.
1238 ///
1239 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
1240 /// [`ChannelCloseMinimum`]: crate::chain::chaininterface::ConfirmationTarget::ChannelCloseMinimum
1241 #[no_mangle]
1242 pub extern "C" fn ChannelConfig_get_force_close_avoidance_max_fee_satoshis(this_ptr: &ChannelConfig) -> u64 {
1243         let mut inner_val = &mut this_ptr.get_native_mut_ref().force_close_avoidance_max_fee_satoshis;
1244         *inner_val
1245 }
1246 /// The additional fee we're willing to pay to avoid waiting for the counterparty's
1247 /// `to_self_delay` to reclaim funds.
1248 ///
1249 /// When we close a channel cooperatively with our counterparty, we negotiate a fee for the
1250 /// closing transaction which both sides find acceptable, ultimately paid by the channel
1251 /// funder/initiator.
1252 ///
1253 /// When we are the funder, because we have to pay the channel closing fee, we bound the
1254 /// acceptable fee by our [`ChannelCloseMinimum`] and [`NonAnchorChannelFee`] fees, with the upper bound increased by
1255 /// this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
1256 /// [`NonAnchorChannelFee`] feerate during normal operation, this value represents the additional fee we're
1257 /// willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
1258 /// funds.
1259 ///
1260 /// When we are not the funder, we require the closing transaction fee pay at least our
1261 /// [`ChannelCloseMinimum`] fee estimate, but allow our counterparty to pay as much fee as they like.
1262 /// Thus, this value is ignored when we are not the funder.
1263 ///
1264 /// Default value: 1000 satoshis.
1265 ///
1266 /// [`NonAnchorChannelFee`]: crate::chain::chaininterface::ConfirmationTarget::NonAnchorChannelFee
1267 /// [`ChannelCloseMinimum`]: crate::chain::chaininterface::ConfirmationTarget::ChannelCloseMinimum
1268 #[no_mangle]
1269 pub extern "C" fn ChannelConfig_set_force_close_avoidance_max_fee_satoshis(this_ptr: &mut ChannelConfig, mut val: u64) {
1270         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.force_close_avoidance_max_fee_satoshis = val;
1271 }
1272 /// If set, allows this channel's counterparty to skim an additional fee off this node's inbound
1273 /// HTLCs. Useful for liquidity providers to offload on-chain channel costs to end users.
1274 ///
1275 /// Usage:
1276 /// - The payee will set this option and set its invoice route hints to use [intercept scids]
1277 ///   generated by this channel's counterparty.
1278 /// - The counterparty will get an [`HTLCIntercepted`] event upon payment forward, and call
1279 ///   [`forward_intercepted_htlc`] with less than the amount provided in
1280 ///   [`HTLCIntercepted::expected_outbound_amount_msat`]. The difference between the expected and
1281 ///   actual forward amounts is their fee.
1282 ///
1283 /// # Note
1284 /// It's important for payee wallet software to verify that [`PaymentClaimable::amount_msat`] is
1285 /// as-expected if this feature is activated, otherwise they may lose money!
1286 /// [`PaymentClaimable::counterparty_skimmed_fee_msat`] provides the fee taken by the
1287 /// counterparty.
1288 ///
1289 /// # Note
1290 /// Switching this config flag on may break compatibility with versions of LDK prior to 0.0.116.
1291 /// Unsetting this flag between restarts may lead to payment receive failures.
1292 ///
1293 /// Default value: false.
1294 ///
1295 /// [intercept scids]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
1296 /// [`forward_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::forward_intercepted_htlc
1297 /// [`HTLCIntercepted`]: crate::events::Event::HTLCIntercepted
1298 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: crate::events::Event::HTLCIntercepted::expected_outbound_amount_msat
1299 /// [`PaymentClaimable::amount_msat`]: crate::events::Event::PaymentClaimable::amount_msat
1300 /// [`PaymentClaimable::counterparty_skimmed_fee_msat`]: crate::events::Event::PaymentClaimable::counterparty_skimmed_fee_msat
1301 #[no_mangle]
1302 pub extern "C" fn ChannelConfig_get_accept_underpaying_htlcs(this_ptr: &ChannelConfig) -> bool {
1303         let mut inner_val = &mut this_ptr.get_native_mut_ref().accept_underpaying_htlcs;
1304         *inner_val
1305 }
1306 /// If set, allows this channel's counterparty to skim an additional fee off this node's inbound
1307 /// HTLCs. Useful for liquidity providers to offload on-chain channel costs to end users.
1308 ///
1309 /// Usage:
1310 /// - The payee will set this option and set its invoice route hints to use [intercept scids]
1311 ///   generated by this channel's counterparty.
1312 /// - The counterparty will get an [`HTLCIntercepted`] event upon payment forward, and call
1313 ///   [`forward_intercepted_htlc`] with less than the amount provided in
1314 ///   [`HTLCIntercepted::expected_outbound_amount_msat`]. The difference between the expected and
1315 ///   actual forward amounts is their fee.
1316 ///
1317 /// # Note
1318 /// It's important for payee wallet software to verify that [`PaymentClaimable::amount_msat`] is
1319 /// as-expected if this feature is activated, otherwise they may lose money!
1320 /// [`PaymentClaimable::counterparty_skimmed_fee_msat`] provides the fee taken by the
1321 /// counterparty.
1322 ///
1323 /// # Note
1324 /// Switching this config flag on may break compatibility with versions of LDK prior to 0.0.116.
1325 /// Unsetting this flag between restarts may lead to payment receive failures.
1326 ///
1327 /// Default value: false.
1328 ///
1329 /// [intercept scids]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
1330 /// [`forward_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::forward_intercepted_htlc
1331 /// [`HTLCIntercepted`]: crate::events::Event::HTLCIntercepted
1332 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: crate::events::Event::HTLCIntercepted::expected_outbound_amount_msat
1333 /// [`PaymentClaimable::amount_msat`]: crate::events::Event::PaymentClaimable::amount_msat
1334 /// [`PaymentClaimable::counterparty_skimmed_fee_msat`]: crate::events::Event::PaymentClaimable::counterparty_skimmed_fee_msat
1335 #[no_mangle]
1336 pub extern "C" fn ChannelConfig_set_accept_underpaying_htlcs(this_ptr: &mut ChannelConfig, mut val: bool) {
1337         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.accept_underpaying_htlcs = val;
1338 }
1339 /// Constructs a new ChannelConfig given each field
1340 #[must_use]
1341 #[no_mangle]
1342 pub extern "C" fn ChannelConfig_new(mut forwarding_fee_proportional_millionths_arg: u32, mut forwarding_fee_base_msat_arg: u32, mut cltv_expiry_delta_arg: u16, mut max_dust_htlc_exposure_arg: crate::lightning::util::config::MaxDustHTLCExposure, mut force_close_avoidance_max_fee_satoshis_arg: u64, mut accept_underpaying_htlcs_arg: bool) -> ChannelConfig {
1343         ChannelConfig { inner: ObjOps::heap_alloc(nativeChannelConfig {
1344                 forwarding_fee_proportional_millionths: forwarding_fee_proportional_millionths_arg,
1345                 forwarding_fee_base_msat: forwarding_fee_base_msat_arg,
1346                 cltv_expiry_delta: cltv_expiry_delta_arg,
1347                 max_dust_htlc_exposure: max_dust_htlc_exposure_arg.into_native(),
1348                 force_close_avoidance_max_fee_satoshis: force_close_avoidance_max_fee_satoshis_arg,
1349                 accept_underpaying_htlcs: accept_underpaying_htlcs_arg,
1350         }), is_owned: true }
1351 }
1352 impl Clone for ChannelConfig {
1353         fn clone(&self) -> Self {
1354                 Self {
1355                         inner: if <*mut nativeChannelConfig>::is_null(self.inner) { core::ptr::null_mut() } else {
1356                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1357                         is_owned: true,
1358                 }
1359         }
1360 }
1361 #[allow(unused)]
1362 /// Used only if an object of this type is returned as a trait impl by a method
1363 pub(crate) extern "C" fn ChannelConfig_clone_void(this_ptr: *const c_void) -> *mut c_void {
1364         Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeChannelConfig)).clone() })) as *mut c_void
1365 }
1366 #[no_mangle]
1367 /// Creates a copy of the ChannelConfig
1368 pub extern "C" fn ChannelConfig_clone(orig: &ChannelConfig) -> ChannelConfig {
1369         orig.clone()
1370 }
1371 /// Checks if two ChannelConfigs contain equal inner contents.
1372 /// This ignores pointers and is_owned flags and looks at the values in fields.
1373 /// Two objects with NULL inner values will be considered "equal" here.
1374 #[no_mangle]
1375 pub extern "C" fn ChannelConfig_eq(a: &ChannelConfig, b: &ChannelConfig) -> bool {
1376         if a.inner == b.inner { return true; }
1377         if a.inner.is_null() || b.inner.is_null() { return false; }
1378         if a.get_native_ref() == b.get_native_ref() { true } else { false }
1379 }
1380 /// Applies the given [`ChannelConfigUpdate`] as a partial update to the [`ChannelConfig`].
1381 #[no_mangle]
1382 pub extern "C" fn ChannelConfig_apply(this_arg: &mut crate::lightning::util::config::ChannelConfig, update: &crate::lightning::util::config::ChannelConfigUpdate) {
1383         unsafe { &mut (*ObjOps::untweak_ptr(this_arg.inner as *mut crate::lightning::util::config::nativeChannelConfig)) }.apply(update.get_native_ref())
1384 }
1385
1386 /// Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
1387 #[must_use]
1388 #[no_mangle]
1389 pub extern "C" fn ChannelConfig_default() -> ChannelConfig {
1390         ChannelConfig { inner: ObjOps::heap_alloc(Default::default()), is_owned: true }
1391 }
1392 #[no_mangle]
1393 /// Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read
1394 pub extern "C" fn ChannelConfig_write(obj: &crate::lightning::util::config::ChannelConfig) -> crate::c_types::derived::CVec_u8Z {
1395         crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
1396 }
1397 #[allow(unused)]
1398 pub(crate) extern "C" fn ChannelConfig_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1399         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelConfig) })
1400 }
1401 #[no_mangle]
1402 /// Read a ChannelConfig from a byte array, created by ChannelConfig_write
1403 pub extern "C" fn ChannelConfig_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelConfigDecodeErrorZ {
1404         let res: Result<lightning::util::config::ChannelConfig, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
1405         let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::util::config::ChannelConfig { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
1406         local_res
1407 }
1408
1409 use lightning::util::config::ChannelConfigUpdate as nativeChannelConfigUpdateImport;
1410 pub(crate) type nativeChannelConfigUpdate = nativeChannelConfigUpdateImport;
1411
1412 /// A parallel struct to [`ChannelConfig`] to define partial updates.
1413 #[must_use]
1414 #[repr(C)]
1415 pub struct ChannelConfigUpdate {
1416         /// A pointer to the opaque Rust object.
1417
1418         /// Nearly everywhere, inner must be non-null, however in places where
1419         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1420         pub inner: *mut nativeChannelConfigUpdate,
1421         /// Indicates that this is the only struct which contains the same pointer.
1422
1423         /// Rust functions which take ownership of an object provided via an argument require
1424         /// this to be true and invalidate the object pointed to by inner.
1425         pub is_owned: bool,
1426 }
1427
1428 impl Drop for ChannelConfigUpdate {
1429         fn drop(&mut self) {
1430                 if self.is_owned && !<*mut nativeChannelConfigUpdate>::is_null(self.inner) {
1431                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1432                 }
1433         }
1434 }
1435 /// Frees any resources used by the ChannelConfigUpdate, if is_owned is set and inner is non-NULL.
1436 #[no_mangle]
1437 pub extern "C" fn ChannelConfigUpdate_free(this_obj: ChannelConfigUpdate) { }
1438 #[allow(unused)]
1439 /// Used only if an object of this type is returned as a trait impl by a method
1440 pub(crate) extern "C" fn ChannelConfigUpdate_free_void(this_ptr: *mut c_void) {
1441         let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelConfigUpdate) };
1442 }
1443 #[allow(unused)]
1444 impl ChannelConfigUpdate {
1445         pub(crate) fn get_native_ref(&self) -> &'static nativeChannelConfigUpdate {
1446                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1447         }
1448         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelConfigUpdate {
1449                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1450         }
1451         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1452         pub(crate) fn take_inner(mut self) -> *mut nativeChannelConfigUpdate {
1453                 assert!(self.is_owned);
1454                 let ret = ObjOps::untweak_ptr(self.inner);
1455                 self.inner = core::ptr::null_mut();
1456                 ret
1457         }
1458 }
1459 #[no_mangle]
1460 pub extern "C" fn ChannelConfigUpdate_get_forwarding_fee_proportional_millionths(this_ptr: &ChannelConfigUpdate) -> crate::c_types::derived::COption_u32Z {
1461         let mut inner_val = &mut this_ptr.get_native_mut_ref().forwarding_fee_proportional_millionths;
1462         let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u32Z::None } else { crate::c_types::derived::COption_u32Z::Some( { inner_val.unwrap() }) };
1463         local_inner_val
1464 }
1465 #[no_mangle]
1466 pub extern "C" fn ChannelConfigUpdate_set_forwarding_fee_proportional_millionths(this_ptr: &mut ChannelConfigUpdate, mut val: crate::c_types::derived::COption_u32Z) {
1467         let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1468         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.forwarding_fee_proportional_millionths = local_val;
1469 }
1470 #[no_mangle]
1471 pub extern "C" fn ChannelConfigUpdate_get_forwarding_fee_base_msat(this_ptr: &ChannelConfigUpdate) -> crate::c_types::derived::COption_u32Z {
1472         let mut inner_val = &mut this_ptr.get_native_mut_ref().forwarding_fee_base_msat;
1473         let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u32Z::None } else { crate::c_types::derived::COption_u32Z::Some( { inner_val.unwrap() }) };
1474         local_inner_val
1475 }
1476 #[no_mangle]
1477 pub extern "C" fn ChannelConfigUpdate_set_forwarding_fee_base_msat(this_ptr: &mut ChannelConfigUpdate, mut val: crate::c_types::derived::COption_u32Z) {
1478         let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1479         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.forwarding_fee_base_msat = local_val;
1480 }
1481 #[no_mangle]
1482 pub extern "C" fn ChannelConfigUpdate_get_cltv_expiry_delta(this_ptr: &ChannelConfigUpdate) -> crate::c_types::derived::COption_u16Z {
1483         let mut inner_val = &mut this_ptr.get_native_mut_ref().cltv_expiry_delta;
1484         let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u16Z::None } else { crate::c_types::derived::COption_u16Z::Some( { inner_val.unwrap() }) };
1485         local_inner_val
1486 }
1487 #[no_mangle]
1488 pub extern "C" fn ChannelConfigUpdate_set_cltv_expiry_delta(this_ptr: &mut ChannelConfigUpdate, mut val: crate::c_types::derived::COption_u16Z) {
1489         let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1490         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.cltv_expiry_delta = local_val;
1491 }
1492 ///
1493 /// Returns a copy of the field.
1494 #[no_mangle]
1495 pub extern "C" fn ChannelConfigUpdate_get_max_dust_htlc_exposure_msat(this_ptr: &ChannelConfigUpdate) -> crate::c_types::derived::COption_MaxDustHTLCExposureZ {
1496         let mut inner_val = this_ptr.get_native_mut_ref().max_dust_htlc_exposure_msat.clone();
1497         let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_MaxDustHTLCExposureZ::None } else { crate::c_types::derived::COption_MaxDustHTLCExposureZ::Some( { crate::lightning::util::config::MaxDustHTLCExposure::native_into(inner_val.unwrap()) }) };
1498         local_inner_val
1499 }
1500 #[no_mangle]
1501 pub extern "C" fn ChannelConfigUpdate_set_max_dust_htlc_exposure_msat(this_ptr: &mut ChannelConfigUpdate, mut val: crate::c_types::derived::COption_MaxDustHTLCExposureZ) {
1502         let mut local_val = { /*val*/ let val_opt = val; if val_opt.is_none() { None } else { Some({ { { val_opt.take() }.into_native() }})} };
1503         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_dust_htlc_exposure_msat = local_val;
1504 }
1505 #[no_mangle]
1506 pub extern "C" fn ChannelConfigUpdate_get_force_close_avoidance_max_fee_satoshis(this_ptr: &ChannelConfigUpdate) -> crate::c_types::derived::COption_u64Z {
1507         let mut inner_val = &mut this_ptr.get_native_mut_ref().force_close_avoidance_max_fee_satoshis;
1508         let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u64Z::None } else { crate::c_types::derived::COption_u64Z::Some( { inner_val.unwrap() }) };
1509         local_inner_val
1510 }
1511 #[no_mangle]
1512 pub extern "C" fn ChannelConfigUpdate_set_force_close_avoidance_max_fee_satoshis(this_ptr: &mut ChannelConfigUpdate, mut val: crate::c_types::derived::COption_u64Z) {
1513         let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1514         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.force_close_avoidance_max_fee_satoshis = local_val;
1515 }
1516 /// Constructs a new ChannelConfigUpdate given each field
1517 #[must_use]
1518 #[no_mangle]
1519 pub extern "C" fn ChannelConfigUpdate_new(mut forwarding_fee_proportional_millionths_arg: crate::c_types::derived::COption_u32Z, mut forwarding_fee_base_msat_arg: crate::c_types::derived::COption_u32Z, mut cltv_expiry_delta_arg: crate::c_types::derived::COption_u16Z, mut max_dust_htlc_exposure_msat_arg: crate::c_types::derived::COption_MaxDustHTLCExposureZ, mut force_close_avoidance_max_fee_satoshis_arg: crate::c_types::derived::COption_u64Z) -> ChannelConfigUpdate {
1520         let mut local_forwarding_fee_proportional_millionths_arg = if forwarding_fee_proportional_millionths_arg.is_some() { Some( { forwarding_fee_proportional_millionths_arg.take() }) } else { None };
1521         let mut local_forwarding_fee_base_msat_arg = if forwarding_fee_base_msat_arg.is_some() { Some( { forwarding_fee_base_msat_arg.take() }) } else { None };
1522         let mut local_cltv_expiry_delta_arg = if cltv_expiry_delta_arg.is_some() { Some( { cltv_expiry_delta_arg.take() }) } else { None };
1523         let mut local_max_dust_htlc_exposure_msat_arg = { /*max_dust_htlc_exposure_msat_arg*/ let max_dust_htlc_exposure_msat_arg_opt = max_dust_htlc_exposure_msat_arg; if max_dust_htlc_exposure_msat_arg_opt.is_none() { None } else { Some({ { { max_dust_htlc_exposure_msat_arg_opt.take() }.into_native() }})} };
1524         let mut local_force_close_avoidance_max_fee_satoshis_arg = if force_close_avoidance_max_fee_satoshis_arg.is_some() { Some( { force_close_avoidance_max_fee_satoshis_arg.take() }) } else { None };
1525         ChannelConfigUpdate { inner: ObjOps::heap_alloc(nativeChannelConfigUpdate {
1526                 forwarding_fee_proportional_millionths: local_forwarding_fee_proportional_millionths_arg,
1527                 forwarding_fee_base_msat: local_forwarding_fee_base_msat_arg,
1528                 cltv_expiry_delta: local_cltv_expiry_delta_arg,
1529                 max_dust_htlc_exposure_msat: local_max_dust_htlc_exposure_msat_arg,
1530                 force_close_avoidance_max_fee_satoshis: local_force_close_avoidance_max_fee_satoshis_arg,
1531         }), is_owned: true }
1532 }
1533 /// Creates a "default" ChannelConfigUpdate. See struct and individual field documentaiton for details on which values are used.
1534 #[must_use]
1535 #[no_mangle]
1536 pub extern "C" fn ChannelConfigUpdate_default() -> ChannelConfigUpdate {
1537         ChannelConfigUpdate { inner: ObjOps::heap_alloc(Default::default()), is_owned: true }
1538 }
1539
1540 use lightning::util::config::UserConfig as nativeUserConfigImport;
1541 pub(crate) type nativeUserConfig = nativeUserConfigImport;
1542
1543 /// Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
1544 ///
1545 /// Default::default() provides sane defaults for most configurations
1546 /// (but currently with 0 relay fees!)
1547 #[must_use]
1548 #[repr(C)]
1549 pub struct UserConfig {
1550         /// A pointer to the opaque Rust object.
1551
1552         /// Nearly everywhere, inner must be non-null, however in places where
1553         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1554         pub inner: *mut nativeUserConfig,
1555         /// Indicates that this is the only struct which contains the same pointer.
1556
1557         /// Rust functions which take ownership of an object provided via an argument require
1558         /// this to be true and invalidate the object pointed to by inner.
1559         pub is_owned: bool,
1560 }
1561
1562 impl Drop for UserConfig {
1563         fn drop(&mut self) {
1564                 if self.is_owned && !<*mut nativeUserConfig>::is_null(self.inner) {
1565                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1566                 }
1567         }
1568 }
1569 /// Frees any resources used by the UserConfig, if is_owned is set and inner is non-NULL.
1570 #[no_mangle]
1571 pub extern "C" fn UserConfig_free(this_obj: UserConfig) { }
1572 #[allow(unused)]
1573 /// Used only if an object of this type is returned as a trait impl by a method
1574 pub(crate) extern "C" fn UserConfig_free_void(this_ptr: *mut c_void) {
1575         let _ = unsafe { Box::from_raw(this_ptr as *mut nativeUserConfig) };
1576 }
1577 #[allow(unused)]
1578 impl UserConfig {
1579         pub(crate) fn get_native_ref(&self) -> &'static nativeUserConfig {
1580                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1581         }
1582         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeUserConfig {
1583                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1584         }
1585         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1586         pub(crate) fn take_inner(mut self) -> *mut nativeUserConfig {
1587                 assert!(self.is_owned);
1588                 let ret = ObjOps::untweak_ptr(self.inner);
1589                 self.inner = core::ptr::null_mut();
1590                 ret
1591         }
1592 }
1593 /// Channel handshake config that we propose to our counterparty.
1594 #[no_mangle]
1595 pub extern "C" fn UserConfig_get_channel_handshake_config(this_ptr: &UserConfig) -> crate::lightning::util::config::ChannelHandshakeConfig {
1596         let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_handshake_config;
1597         crate::lightning::util::config::ChannelHandshakeConfig { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::util::config::ChannelHandshakeConfig<>) as *mut _) }, is_owned: false }
1598 }
1599 /// Channel handshake config that we propose to our counterparty.
1600 #[no_mangle]
1601 pub extern "C" fn UserConfig_set_channel_handshake_config(this_ptr: &mut UserConfig, mut val: crate::lightning::util::config::ChannelHandshakeConfig) {
1602         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_handshake_config = *unsafe { Box::from_raw(val.take_inner()) };
1603 }
1604 /// Limits applied to our counterparty's proposed channel handshake config settings.
1605 #[no_mangle]
1606 pub extern "C" fn UserConfig_get_channel_handshake_limits(this_ptr: &UserConfig) -> crate::lightning::util::config::ChannelHandshakeLimits {
1607         let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_handshake_limits;
1608         crate::lightning::util::config::ChannelHandshakeLimits { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::util::config::ChannelHandshakeLimits<>) as *mut _) }, is_owned: false }
1609 }
1610 /// Limits applied to our counterparty's proposed channel handshake config settings.
1611 #[no_mangle]
1612 pub extern "C" fn UserConfig_set_channel_handshake_limits(this_ptr: &mut UserConfig, mut val: crate::lightning::util::config::ChannelHandshakeLimits) {
1613         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_handshake_limits = *unsafe { Box::from_raw(val.take_inner()) };
1614 }
1615 /// Channel config which affects behavior during channel lifetime.
1616 #[no_mangle]
1617 pub extern "C" fn UserConfig_get_channel_config(this_ptr: &UserConfig) -> crate::lightning::util::config::ChannelConfig {
1618         let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_config;
1619         crate::lightning::util::config::ChannelConfig { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::util::config::ChannelConfig<>) as *mut _) }, is_owned: false }
1620 }
1621 /// Channel config which affects behavior during channel lifetime.
1622 #[no_mangle]
1623 pub extern "C" fn UserConfig_set_channel_config(this_ptr: &mut UserConfig, mut val: crate::lightning::util::config::ChannelConfig) {
1624         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_config = *unsafe { Box::from_raw(val.take_inner()) };
1625 }
1626 /// If this is set to false, we will reject any HTLCs which were to be forwarded over private
1627 /// channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
1628 /// node which is not online reliably.
1629 ///
1630 /// For nodes which are not online reliably, you should set all channels to *not* be announced
1631 /// (using [`ChannelHandshakeConfig::announced_channel`] and
1632 /// [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
1633 /// ensure you are not exposed to any forwarding risk.
1634 ///
1635 /// Note that because you cannot change a channel's announced state after creation, there is no
1636 /// way to disable forwarding on public channels retroactively. Thus, in order to change a node
1637 /// from a publicly-announced forwarding node to a private non-forwarding node you must close
1638 /// all your channels and open new ones. For privacy, you should also change your node_id
1639 /// (swapping all private and public key material for new ones) at that time.
1640 ///
1641 /// Default value: false.
1642 #[no_mangle]
1643 pub extern "C" fn UserConfig_get_accept_forwards_to_priv_channels(this_ptr: &UserConfig) -> bool {
1644         let mut inner_val = &mut this_ptr.get_native_mut_ref().accept_forwards_to_priv_channels;
1645         *inner_val
1646 }
1647 /// If this is set to false, we will reject any HTLCs which were to be forwarded over private
1648 /// channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
1649 /// node which is not online reliably.
1650 ///
1651 /// For nodes which are not online reliably, you should set all channels to *not* be announced
1652 /// (using [`ChannelHandshakeConfig::announced_channel`] and
1653 /// [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
1654 /// ensure you are not exposed to any forwarding risk.
1655 ///
1656 /// Note that because you cannot change a channel's announced state after creation, there is no
1657 /// way to disable forwarding on public channels retroactively. Thus, in order to change a node
1658 /// from a publicly-announced forwarding node to a private non-forwarding node you must close
1659 /// all your channels and open new ones. For privacy, you should also change your node_id
1660 /// (swapping all private and public key material for new ones) at that time.
1661 ///
1662 /// Default value: false.
1663 #[no_mangle]
1664 pub extern "C" fn UserConfig_set_accept_forwards_to_priv_channels(this_ptr: &mut UserConfig, mut val: bool) {
1665         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.accept_forwards_to_priv_channels = val;
1666 }
1667 /// If this is set to false, we do not accept inbound requests to open a new channel.
1668 /// Default value: true.
1669 #[no_mangle]
1670 pub extern "C" fn UserConfig_get_accept_inbound_channels(this_ptr: &UserConfig) -> bool {
1671         let mut inner_val = &mut this_ptr.get_native_mut_ref().accept_inbound_channels;
1672         *inner_val
1673 }
1674 /// If this is set to false, we do not accept inbound requests to open a new channel.
1675 /// Default value: true.
1676 #[no_mangle]
1677 pub extern "C" fn UserConfig_set_accept_inbound_channels(this_ptr: &mut UserConfig, mut val: bool) {
1678         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.accept_inbound_channels = val;
1679 }
1680 /// If this is set to true, the user needs to manually accept inbound requests to open a new
1681 /// channel.
1682 ///
1683 /// When set to true, [`Event::OpenChannelRequest`] will be triggered once a request to open a
1684 /// new inbound channel is received through a [`msgs::OpenChannel`] message. In that case, a
1685 /// [`msgs::AcceptChannel`] message will not be sent back to the counterparty node unless the
1686 /// user explicitly chooses to accept the request.
1687 ///
1688 /// Default value: false.
1689 ///
1690 /// [`Event::OpenChannelRequest`]: crate::events::Event::OpenChannelRequest
1691 /// [`msgs::OpenChannel`]: crate::ln::msgs::OpenChannel
1692 /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
1693 #[no_mangle]
1694 pub extern "C" fn UserConfig_get_manually_accept_inbound_channels(this_ptr: &UserConfig) -> bool {
1695         let mut inner_val = &mut this_ptr.get_native_mut_ref().manually_accept_inbound_channels;
1696         *inner_val
1697 }
1698 /// If this is set to true, the user needs to manually accept inbound requests to open a new
1699 /// channel.
1700 ///
1701 /// When set to true, [`Event::OpenChannelRequest`] will be triggered once a request to open a
1702 /// new inbound channel is received through a [`msgs::OpenChannel`] message. In that case, a
1703 /// [`msgs::AcceptChannel`] message will not be sent back to the counterparty node unless the
1704 /// user explicitly chooses to accept the request.
1705 ///
1706 /// Default value: false.
1707 ///
1708 /// [`Event::OpenChannelRequest`]: crate::events::Event::OpenChannelRequest
1709 /// [`msgs::OpenChannel`]: crate::ln::msgs::OpenChannel
1710 /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
1711 #[no_mangle]
1712 pub extern "C" fn UserConfig_set_manually_accept_inbound_channels(this_ptr: &mut UserConfig, mut val: bool) {
1713         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.manually_accept_inbound_channels = val;
1714 }
1715 ///  If this is set to true, LDK will intercept HTLCs that are attempting to be forwarded over
1716 ///  fake short channel ids generated via [`ChannelManager::get_intercept_scid`]. Upon HTLC
1717 ///  intercept, LDK will generate an [`Event::HTLCIntercepted`] which MUST be handled by the user.
1718 ///
1719 ///  Setting this to true may break backwards compatibility with LDK versions < 0.0.113.
1720 ///
1721 ///  Default value: false.
1722 ///
1723 /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
1724 /// [`Event::HTLCIntercepted`]: crate::events::Event::HTLCIntercepted
1725 #[no_mangle]
1726 pub extern "C" fn UserConfig_get_accept_intercept_htlcs(this_ptr: &UserConfig) -> bool {
1727         let mut inner_val = &mut this_ptr.get_native_mut_ref().accept_intercept_htlcs;
1728         *inner_val
1729 }
1730 ///  If this is set to true, LDK will intercept HTLCs that are attempting to be forwarded over
1731 ///  fake short channel ids generated via [`ChannelManager::get_intercept_scid`]. Upon HTLC
1732 ///  intercept, LDK will generate an [`Event::HTLCIntercepted`] which MUST be handled by the user.
1733 ///
1734 ///  Setting this to true may break backwards compatibility with LDK versions < 0.0.113.
1735 ///
1736 ///  Default value: false.
1737 ///
1738 /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
1739 /// [`Event::HTLCIntercepted`]: crate::events::Event::HTLCIntercepted
1740 #[no_mangle]
1741 pub extern "C" fn UserConfig_set_accept_intercept_htlcs(this_ptr: &mut UserConfig, mut val: bool) {
1742         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.accept_intercept_htlcs = val;
1743 }
1744 /// If this is set to false, when receiving a keysend payment we'll fail it if it has multiple
1745 /// parts. If this is set to true, we'll accept the payment.
1746 ///
1747 /// Setting this to true will break backwards compatibility upon downgrading to an LDK
1748 /// version < 0.0.116 while receiving an MPP keysend. If we have already received an MPP
1749 /// keysend, downgrading will cause us to fail to deserialize [`ChannelManager`].
1750 ///
1751 /// Default value: false.
1752 ///
1753 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
1754 #[no_mangle]
1755 pub extern "C" fn UserConfig_get_accept_mpp_keysend(this_ptr: &UserConfig) -> bool {
1756         let mut inner_val = &mut this_ptr.get_native_mut_ref().accept_mpp_keysend;
1757         *inner_val
1758 }
1759 /// If this is set to false, when receiving a keysend payment we'll fail it if it has multiple
1760 /// parts. If this is set to true, we'll accept the payment.
1761 ///
1762 /// Setting this to true will break backwards compatibility upon downgrading to an LDK
1763 /// version < 0.0.116 while receiving an MPP keysend. If we have already received an MPP
1764 /// keysend, downgrading will cause us to fail to deserialize [`ChannelManager`].
1765 ///
1766 /// Default value: false.
1767 ///
1768 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
1769 #[no_mangle]
1770 pub extern "C" fn UserConfig_set_accept_mpp_keysend(this_ptr: &mut UserConfig, mut val: bool) {
1771         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.accept_mpp_keysend = val;
1772 }
1773 /// Constructs a new UserConfig given each field
1774 #[must_use]
1775 #[no_mangle]
1776 pub extern "C" fn UserConfig_new(mut channel_handshake_config_arg: crate::lightning::util::config::ChannelHandshakeConfig, mut channel_handshake_limits_arg: crate::lightning::util::config::ChannelHandshakeLimits, mut channel_config_arg: crate::lightning::util::config::ChannelConfig, mut accept_forwards_to_priv_channels_arg: bool, mut accept_inbound_channels_arg: bool, mut manually_accept_inbound_channels_arg: bool, mut accept_intercept_htlcs_arg: bool, mut accept_mpp_keysend_arg: bool) -> UserConfig {
1777         UserConfig { inner: ObjOps::heap_alloc(nativeUserConfig {
1778                 channel_handshake_config: *unsafe { Box::from_raw(channel_handshake_config_arg.take_inner()) },
1779                 channel_handshake_limits: *unsafe { Box::from_raw(channel_handshake_limits_arg.take_inner()) },
1780                 channel_config: *unsafe { Box::from_raw(channel_config_arg.take_inner()) },
1781                 accept_forwards_to_priv_channels: accept_forwards_to_priv_channels_arg,
1782                 accept_inbound_channels: accept_inbound_channels_arg,
1783                 manually_accept_inbound_channels: manually_accept_inbound_channels_arg,
1784                 accept_intercept_htlcs: accept_intercept_htlcs_arg,
1785                 accept_mpp_keysend: accept_mpp_keysend_arg,
1786         }), is_owned: true }
1787 }
1788 impl Clone for UserConfig {
1789         fn clone(&self) -> Self {
1790                 Self {
1791                         inner: if <*mut nativeUserConfig>::is_null(self.inner) { core::ptr::null_mut() } else {
1792                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1793                         is_owned: true,
1794                 }
1795         }
1796 }
1797 #[allow(unused)]
1798 /// Used only if an object of this type is returned as a trait impl by a method
1799 pub(crate) extern "C" fn UserConfig_clone_void(this_ptr: *const c_void) -> *mut c_void {
1800         Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeUserConfig)).clone() })) as *mut c_void
1801 }
1802 #[no_mangle]
1803 /// Creates a copy of the UserConfig
1804 pub extern "C" fn UserConfig_clone(orig: &UserConfig) -> UserConfig {
1805         orig.clone()
1806 }
1807 /// Creates a "default" UserConfig. See struct and individual field documentaiton for details on which values are used.
1808 #[must_use]
1809 #[no_mangle]
1810 pub extern "C" fn UserConfig_default() -> UserConfig {
1811         UserConfig { inner: ObjOps::heap_alloc(Default::default()), is_owned: true }
1812 }