1 // This file is Copyright its original authors, visible in version control
2 // history and in the source files from which this was generated.
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.
9 //! Various user-configurable channel limits and settings which ChannelManager
12 use alloc::str::FromStr;
13 use core::ffi::c_void;
14 use core::convert::Infallible;
15 use bitcoin::hashes::Hash;
16 use crate::c_types::*;
17 #[cfg(feature="no-std")]
18 use alloc::{vec::Vec, boxed::Box};
21 use lightning::util::config::ChannelHandshakeConfig as nativeChannelHandshakeConfigImport;
22 pub(crate) type nativeChannelHandshakeConfig = nativeChannelHandshakeConfigImport;
24 /// Configuration we set when applicable.
26 /// Default::default() provides sane defaults.
29 pub struct ChannelHandshakeConfig {
30 /// A pointer to the opaque Rust object.
32 /// Nearly everywhere, inner must be non-null, however in places where
33 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
34 pub inner: *mut nativeChannelHandshakeConfig,
35 /// Indicates that this is the only struct which contains the same pointer.
37 /// Rust functions which take ownership of an object provided via an argument require
38 /// this to be true and invalidate the object pointed to by inner.
42 impl Drop for ChannelHandshakeConfig {
44 if self.is_owned && !<*mut nativeChannelHandshakeConfig>::is_null(self.inner) {
45 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
49 /// Frees any resources used by the ChannelHandshakeConfig, if is_owned is set and inner is non-NULL.
51 pub extern "C" fn ChannelHandshakeConfig_free(this_obj: ChannelHandshakeConfig) { }
53 /// Used only if an object of this type is returned as a trait impl by a method
54 pub(crate) extern "C" fn ChannelHandshakeConfig_free_void(this_ptr: *mut c_void) {
55 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelHandshakeConfig); }
58 impl ChannelHandshakeConfig {
59 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelHandshakeConfig {
60 unsafe { &*ObjOps::untweak_ptr(self.inner) }
62 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelHandshakeConfig {
63 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
65 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
66 pub(crate) fn take_inner(mut self) -> *mut nativeChannelHandshakeConfig {
67 assert!(self.is_owned);
68 let ret = ObjOps::untweak_ptr(self.inner);
69 self.inner = core::ptr::null_mut();
73 /// Confirmations we will wait for before considering the channel locked in.
74 /// Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
75 /// equivalent limit applied to outbound channels).
77 /// A lower-bound of 1 is applied, requiring all channels to have a confirmed commitment
78 /// transaction before operation. If you wish to accept channels with zero confirmations, see
79 /// [`UserConfig::manually_accept_inbound_channels`] and
80 /// [`ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`].
84 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
85 /// [`ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf
87 pub extern "C" fn ChannelHandshakeConfig_get_minimum_depth(this_ptr: &ChannelHandshakeConfig) -> u32 {
88 let mut inner_val = &mut this_ptr.get_native_mut_ref().minimum_depth;
91 /// Confirmations we will wait for before considering the channel locked in.
92 /// Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
93 /// equivalent limit applied to outbound channels).
95 /// A lower-bound of 1 is applied, requiring all channels to have a confirmed commitment
96 /// transaction before operation. If you wish to accept channels with zero confirmations, see
97 /// [`UserConfig::manually_accept_inbound_channels`] and
98 /// [`ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`].
100 /// Default value: 6.
102 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
103 /// [`ChannelManager::accept_inbound_channel_from_trusted_peer_0conf`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel_from_trusted_peer_0conf
105 pub extern "C" fn ChannelHandshakeConfig_set_minimum_depth(this_ptr: &mut ChannelHandshakeConfig, mut val: u32) {
106 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.minimum_depth = val;
108 /// Set to the number of blocks we require our counterparty to wait to claim their money (ie
109 /// the number of blocks we have to punish our counterparty if they broadcast a revoked
112 /// This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
113 /// be online to check for revoked transactions on-chain at least once every our_to_self_delay
114 /// blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
115 /// possibly with time in between to RBF the spending transaction).
117 /// Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
118 /// case of an honest unilateral channel close, which implicitly decrease the economic value of
121 /// Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
122 /// can tweak config to ask for more security, not less.
124 pub extern "C" fn ChannelHandshakeConfig_get_our_to_self_delay(this_ptr: &ChannelHandshakeConfig) -> u16 {
125 let mut inner_val = &mut this_ptr.get_native_mut_ref().our_to_self_delay;
128 /// Set to the number of blocks we require our counterparty to wait to claim their money (ie
129 /// the number of blocks we have to punish our counterparty if they broadcast a revoked
132 /// This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
133 /// be online to check for revoked transactions on-chain at least once every our_to_self_delay
134 /// blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
135 /// possibly with time in between to RBF the spending transaction).
137 /// Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
138 /// case of an honest unilateral channel close, which implicitly decrease the economic value of
141 /// Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
142 /// can tweak config to ask for more security, not less.
144 pub extern "C" fn ChannelHandshakeConfig_set_our_to_self_delay(this_ptr: &mut ChannelHandshakeConfig, mut val: u16) {
145 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.our_to_self_delay = val;
147 /// Set to the smallest value HTLC we will accept to process.
149 /// This value is sent to our counterparty on channel-open and we close the channel any time
150 /// our counterparty misbehaves by sending us an HTLC with a value smaller than this.
152 /// Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
155 pub extern "C" fn ChannelHandshakeConfig_get_our_htlc_minimum_msat(this_ptr: &ChannelHandshakeConfig) -> u64 {
156 let mut inner_val = &mut this_ptr.get_native_mut_ref().our_htlc_minimum_msat;
159 /// Set to the smallest value HTLC we will accept to process.
161 /// This value is sent to our counterparty on channel-open and we close the channel any time
162 /// our counterparty misbehaves by sending us an HTLC with a value smaller than this.
164 /// Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
167 pub extern "C" fn ChannelHandshakeConfig_set_our_htlc_minimum_msat(this_ptr: &mut ChannelHandshakeConfig, mut val: u64) {
168 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.our_htlc_minimum_msat = val;
170 /// Sets the percentage of the channel value we will cap the total value of outstanding inbound
173 /// This can be set to a value between 1-100, where the value corresponds to the percent of the
174 /// channel value in whole percentages.
177 /// * If configured to another value than the default value 10, any new channels created with
178 /// the non default value will cause versions of LDK prior to 0.0.104 to refuse to read the
179 /// `ChannelManager`.
181 /// * This caps the total value for inbound HTLCs in-flight only, and there's currently
182 /// no way to configure the cap for the total value of outbound HTLCs in-flight.
184 /// * The requirements for your node being online to ensure the safety of HTLC-encumbered funds
185 /// are different from the non-HTLC-encumbered funds. This makes this an important knob to
186 /// restrict exposure to loss due to being offline for too long.
187 /// See [`ChannelHandshakeConfig::our_to_self_delay`] and [`ChannelConfig::cltv_expiry_delta`]
188 /// for more information.
190 /// Default value: 10.
191 /// Minimum value: 1, any values less than 1 will be treated as 1 instead.
192 /// Maximum value: 100, any values larger than 100 will be treated as 100 instead.
194 pub extern "C" fn ChannelHandshakeConfig_get_max_inbound_htlc_value_in_flight_percent_of_channel(this_ptr: &ChannelHandshakeConfig) -> u8 {
195 let mut inner_val = &mut this_ptr.get_native_mut_ref().max_inbound_htlc_value_in_flight_percent_of_channel;
198 /// Sets the percentage of the channel value we will cap the total value of outstanding inbound
201 /// This can be set to a value between 1-100, where the value corresponds to the percent of the
202 /// channel value in whole percentages.
205 /// * If configured to another value than the default value 10, any new channels created with
206 /// the non default value will cause versions of LDK prior to 0.0.104 to refuse to read the
207 /// `ChannelManager`.
209 /// * This caps the total value for inbound HTLCs in-flight only, and there's currently
210 /// no way to configure the cap for the total value of outbound HTLCs in-flight.
212 /// * The requirements for your node being online to ensure the safety of HTLC-encumbered funds
213 /// are different from the non-HTLC-encumbered funds. This makes this an important knob to
214 /// restrict exposure to loss due to being offline for too long.
215 /// See [`ChannelHandshakeConfig::our_to_self_delay`] and [`ChannelConfig::cltv_expiry_delta`]
216 /// for more information.
218 /// Default value: 10.
219 /// Minimum value: 1, any values less than 1 will be treated as 1 instead.
220 /// Maximum value: 100, any values larger than 100 will be treated as 100 instead.
222 pub extern "C" fn ChannelHandshakeConfig_set_max_inbound_htlc_value_in_flight_percent_of_channel(this_ptr: &mut ChannelHandshakeConfig, mut val: u8) {
223 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_inbound_htlc_value_in_flight_percent_of_channel = val;
225 /// If set, we attempt to negotiate the `scid_privacy` (referred to as `scid_alias` in the
226 /// BOLTs) option for outbound private channels. This provides better privacy by not including
227 /// our real on-chain channel UTXO in each invoice and requiring that our counterparty only
228 /// relay HTLCs to us using the channel's SCID alias.
230 /// If this option is set, channels may be created that will not be readable by LDK versions
231 /// prior to 0.0.106, causing [`ChannelManager`]'s read method to return a
232 /// [`DecodeError:InvalidValue`].
234 /// Note that setting this to true does *not* prevent us from opening channels with
235 /// counterparties that do not support the `scid_alias` option; we will simply fall back to a
236 /// private channel without that option.
238 /// Ignored if the channel is negotiated to be announced, see
239 /// [`ChannelConfig::announced_channel`] and
240 /// [`ChannelHandshakeLimits::force_announced_channel_preference`] for more.
242 /// Default value: false. This value is likely to change to true in the future.
244 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
245 /// [`DecodeError:InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
247 pub extern "C" fn ChannelHandshakeConfig_get_negotiate_scid_privacy(this_ptr: &ChannelHandshakeConfig) -> bool {
248 let mut inner_val = &mut this_ptr.get_native_mut_ref().negotiate_scid_privacy;
251 /// If set, we attempt to negotiate the `scid_privacy` (referred to as `scid_alias` in the
252 /// BOLTs) option for outbound private channels. This provides better privacy by not including
253 /// our real on-chain channel UTXO in each invoice and requiring that our counterparty only
254 /// relay HTLCs to us using the channel's SCID alias.
256 /// If this option is set, channels may be created that will not be readable by LDK versions
257 /// prior to 0.0.106, causing [`ChannelManager`]'s read method to return a
258 /// [`DecodeError:InvalidValue`].
260 /// Note that setting this to true does *not* prevent us from opening channels with
261 /// counterparties that do not support the `scid_alias` option; we will simply fall back to a
262 /// private channel without that option.
264 /// Ignored if the channel is negotiated to be announced, see
265 /// [`ChannelConfig::announced_channel`] and
266 /// [`ChannelHandshakeLimits::force_announced_channel_preference`] for more.
268 /// Default value: false. This value is likely to change to true in the future.
270 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
271 /// [`DecodeError:InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
273 pub extern "C" fn ChannelHandshakeConfig_set_negotiate_scid_privacy(this_ptr: &mut ChannelHandshakeConfig, mut val: bool) {
274 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.negotiate_scid_privacy = val;
276 /// Constructs a new ChannelHandshakeConfig given each field
279 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) -> ChannelHandshakeConfig {
280 ChannelHandshakeConfig { inner: ObjOps::heap_alloc(nativeChannelHandshakeConfig {
281 minimum_depth: minimum_depth_arg,
282 our_to_self_delay: our_to_self_delay_arg,
283 our_htlc_minimum_msat: our_htlc_minimum_msat_arg,
284 max_inbound_htlc_value_in_flight_percent_of_channel: max_inbound_htlc_value_in_flight_percent_of_channel_arg,
285 negotiate_scid_privacy: negotiate_scid_privacy_arg,
288 impl Clone for ChannelHandshakeConfig {
289 fn clone(&self) -> Self {
291 inner: if <*mut nativeChannelHandshakeConfig>::is_null(self.inner) { core::ptr::null_mut() } else {
292 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
298 /// Used only if an object of this type is returned as a trait impl by a method
299 pub(crate) extern "C" fn ChannelHandshakeConfig_clone_void(this_ptr: *const c_void) -> *mut c_void {
300 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelHandshakeConfig)).clone() })) as *mut c_void
303 /// Creates a copy of the ChannelHandshakeConfig
304 pub extern "C" fn ChannelHandshakeConfig_clone(orig: &ChannelHandshakeConfig) -> ChannelHandshakeConfig {
307 /// Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used.
310 pub extern "C" fn ChannelHandshakeConfig_default() -> ChannelHandshakeConfig {
311 ChannelHandshakeConfig { inner: ObjOps::heap_alloc(Default::default()), is_owned: true }
314 use lightning::util::config::ChannelHandshakeLimits as nativeChannelHandshakeLimitsImport;
315 pub(crate) type nativeChannelHandshakeLimits = nativeChannelHandshakeLimitsImport;
317 /// Optional channel limits which are applied during channel creation.
319 /// These limits are only applied to our counterparty's limits, not our own.
321 /// Use 0/<type>::max_value() as appropriate to skip checking.
323 /// Provides sane defaults for most configurations.
325 /// Most additional limits are disabled except those with which specify a default in individual
326 /// field documentation. Note that this may result in barely-usable channels, but since they
327 /// are applied mostly only to incoming channels that's not much of a problem.
330 pub struct ChannelHandshakeLimits {
331 /// A pointer to the opaque Rust object.
333 /// Nearly everywhere, inner must be non-null, however in places where
334 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
335 pub inner: *mut nativeChannelHandshakeLimits,
336 /// Indicates that this is the only struct which contains the same pointer.
338 /// Rust functions which take ownership of an object provided via an argument require
339 /// this to be true and invalidate the object pointed to by inner.
343 impl Drop for ChannelHandshakeLimits {
345 if self.is_owned && !<*mut nativeChannelHandshakeLimits>::is_null(self.inner) {
346 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
350 /// Frees any resources used by the ChannelHandshakeLimits, if is_owned is set and inner is non-NULL.
352 pub extern "C" fn ChannelHandshakeLimits_free(this_obj: ChannelHandshakeLimits) { }
354 /// Used only if an object of this type is returned as a trait impl by a method
355 pub(crate) extern "C" fn ChannelHandshakeLimits_free_void(this_ptr: *mut c_void) {
356 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelHandshakeLimits); }
359 impl ChannelHandshakeLimits {
360 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelHandshakeLimits {
361 unsafe { &*ObjOps::untweak_ptr(self.inner) }
363 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelHandshakeLimits {
364 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
366 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
367 pub(crate) fn take_inner(mut self) -> *mut nativeChannelHandshakeLimits {
368 assert!(self.is_owned);
369 let ret = ObjOps::untweak_ptr(self.inner);
370 self.inner = core::ptr::null_mut();
374 /// Minimum allowed satoshis when a channel is funded. This is supplied by the sender and so
375 /// only applies to inbound channels.
377 /// Default value: 0.
379 pub extern "C" fn ChannelHandshakeLimits_get_min_funding_satoshis(this_ptr: &ChannelHandshakeLimits) -> u64 {
380 let mut inner_val = &mut this_ptr.get_native_mut_ref().min_funding_satoshis;
383 /// Minimum allowed satoshis when a channel is funded. This is supplied by the sender and so
384 /// only applies to inbound channels.
386 /// Default value: 0.
388 pub extern "C" fn ChannelHandshakeLimits_set_min_funding_satoshis(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
389 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.min_funding_satoshis = val;
391 /// Maximum allowed satoshis when a channel is funded. This is supplied by the sender and so
392 /// only applies to inbound channels.
394 /// Default value: 2^24 - 1.
396 pub extern "C" fn ChannelHandshakeLimits_get_max_funding_satoshis(this_ptr: &ChannelHandshakeLimits) -> u64 {
397 let mut inner_val = &mut this_ptr.get_native_mut_ref().max_funding_satoshis;
400 /// Maximum allowed satoshis when a channel is funded. This is supplied by the sender and so
401 /// only applies to inbound channels.
403 /// Default value: 2^24 - 1.
405 pub extern "C" fn ChannelHandshakeLimits_set_max_funding_satoshis(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
406 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_funding_satoshis = val;
408 /// The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
409 /// you to limit the maximum minimum-size they can require.
411 /// Default value: u64::max_value.
413 pub extern "C" fn ChannelHandshakeLimits_get_max_htlc_minimum_msat(this_ptr: &ChannelHandshakeLimits) -> u64 {
414 let mut inner_val = &mut this_ptr.get_native_mut_ref().max_htlc_minimum_msat;
417 /// The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
418 /// you to limit the maximum minimum-size they can require.
420 /// Default value: u64::max_value.
422 pub extern "C" fn ChannelHandshakeLimits_set_max_htlc_minimum_msat(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
423 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_htlc_minimum_msat = val;
425 /// The remote node sets a limit on the maximum value of pending HTLCs to them at any given
426 /// time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
428 /// Default value: 0.
430 pub extern "C" fn ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(this_ptr: &ChannelHandshakeLimits) -> u64 {
431 let mut inner_val = &mut this_ptr.get_native_mut_ref().min_max_htlc_value_in_flight_msat;
434 /// The remote node sets a limit on the maximum value of pending HTLCs to them at any given
435 /// time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
437 /// Default value: 0.
439 pub extern "C" fn ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
440 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.min_max_htlc_value_in_flight_msat = val;
442 /// The remote node will require we keep a certain amount in direct payment to ourselves at all
443 /// time, ensuring that we are able to be punished if we broadcast an old state. This allows to
444 /// you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
446 /// Default value: u64::max_value.
448 pub extern "C" fn ChannelHandshakeLimits_get_max_channel_reserve_satoshis(this_ptr: &ChannelHandshakeLimits) -> u64 {
449 let mut inner_val = &mut this_ptr.get_native_mut_ref().max_channel_reserve_satoshis;
452 /// The remote node will require we keep a certain amount in direct payment to ourselves at all
453 /// time, ensuring that we are able to be punished if we broadcast an old state. This allows to
454 /// you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
456 /// Default value: u64::max_value.
458 pub extern "C" fn ChannelHandshakeLimits_set_max_channel_reserve_satoshis(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
459 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_channel_reserve_satoshis = val;
461 /// The remote node sets a limit on the maximum number of pending HTLCs to them at any given
462 /// time. This allows you to set a minimum such value.
464 /// Default value: 0.
466 pub extern "C" fn ChannelHandshakeLimits_get_min_max_accepted_htlcs(this_ptr: &ChannelHandshakeLimits) -> u16 {
467 let mut inner_val = &mut this_ptr.get_native_mut_ref().min_max_accepted_htlcs;
470 /// The remote node sets a limit on the maximum number of pending HTLCs to them at any given
471 /// time. This allows you to set a minimum such value.
473 /// Default value: 0.
475 pub extern "C" fn ChannelHandshakeLimits_set_min_max_accepted_htlcs(this_ptr: &mut ChannelHandshakeLimits, mut val: u16) {
476 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.min_max_accepted_htlcs = val;
478 /// Before a channel is usable the funding transaction will need to be confirmed by at least a
479 /// certain number of blocks, specified by the node which is not the funder (as the funder can
480 /// assume they aren't going to double-spend themselves).
481 /// This config allows you to set a limit on the maximum amount of time to wait.
483 /// Default value: 144, or roughly one day and only applies to outbound channels.
485 pub extern "C" fn ChannelHandshakeLimits_get_max_minimum_depth(this_ptr: &ChannelHandshakeLimits) -> u32 {
486 let mut inner_val = &mut this_ptr.get_native_mut_ref().max_minimum_depth;
489 /// Before a channel is usable the funding transaction will need to be confirmed by at least a
490 /// certain number of blocks, specified by the node which is not the funder (as the funder can
491 /// assume they aren't going to double-spend themselves).
492 /// This config allows you to set a limit on the maximum amount of time to wait.
494 /// Default value: 144, or roughly one day and only applies to outbound channels.
496 pub extern "C" fn ChannelHandshakeLimits_set_max_minimum_depth(this_ptr: &mut ChannelHandshakeLimits, mut val: u32) {
497 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_minimum_depth = val;
499 /// Whether we implicitly trust funding transactions generated by us for our own outbound
500 /// channels to not be double-spent.
502 /// If this is set, we assume that our own funding transactions are *never* double-spent, and
503 /// thus we can trust them without any confirmations. This is generally a reasonable
504 /// assumption, given we're the only ones who could ever double-spend it (assuming we have sole
505 /// control of the signing keys).
507 /// You may wish to un-set this if you allow the user to (or do in an automated fashion)
508 /// double-spend the funding transaction to RBF with an alternative channel open.
510 /// This only applies if our counterparty set their confirmations-required value to 0, and we
511 /// always trust our own funding transaction at 1 confirmation irrespective of this value.
512 /// Thus, this effectively acts as a `min_minimum_depth`, with the only possible values being
513 /// `true` (0) and `false` (1).
515 /// Default value: true
517 pub extern "C" fn ChannelHandshakeLimits_get_trust_own_funding_0conf(this_ptr: &ChannelHandshakeLimits) -> bool {
518 let mut inner_val = &mut this_ptr.get_native_mut_ref().trust_own_funding_0conf;
521 /// Whether we implicitly trust funding transactions generated by us for our own outbound
522 /// channels to not be double-spent.
524 /// If this is set, we assume that our own funding transactions are *never* double-spent, and
525 /// thus we can trust them without any confirmations. This is generally a reasonable
526 /// assumption, given we're the only ones who could ever double-spend it (assuming we have sole
527 /// control of the signing keys).
529 /// You may wish to un-set this if you allow the user to (or do in an automated fashion)
530 /// double-spend the funding transaction to RBF with an alternative channel open.
532 /// This only applies if our counterparty set their confirmations-required value to 0, and we
533 /// always trust our own funding transaction at 1 confirmation irrespective of this value.
534 /// Thus, this effectively acts as a `min_minimum_depth`, with the only possible values being
535 /// `true` (0) and `false` (1).
537 /// Default value: true
539 pub extern "C" fn ChannelHandshakeLimits_set_trust_own_funding_0conf(this_ptr: &mut ChannelHandshakeLimits, mut val: bool) {
540 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.trust_own_funding_0conf = val;
542 /// Set to force an incoming channel to match our announced channel preference in
543 /// [`ChannelConfig::announced_channel`].
545 /// For a node which is not online reliably, this should be set to true and
546 /// [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
547 /// channels will ever be opened.
549 /// Default value: true.
551 pub extern "C" fn ChannelHandshakeLimits_get_force_announced_channel_preference(this_ptr: &ChannelHandshakeLimits) -> bool {
552 let mut inner_val = &mut this_ptr.get_native_mut_ref().force_announced_channel_preference;
555 /// Set to force an incoming channel to match our announced channel preference in
556 /// [`ChannelConfig::announced_channel`].
558 /// For a node which is not online reliably, this should be set to true and
559 /// [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
560 /// channels will ever be opened.
562 /// Default value: true.
564 pub extern "C" fn ChannelHandshakeLimits_set_force_announced_channel_preference(this_ptr: &mut ChannelHandshakeLimits, mut val: bool) {
565 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.force_announced_channel_preference = val;
567 /// Set to the amount of time we're willing to wait to claim money back to us.
569 /// Not checking this value would be a security issue, as our peer would be able to set it to
570 /// max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
572 /// Default value: 2016, which we also enforce as a maximum value so you can tweak config to
573 /// reduce the loss of having useless locked funds (if your peer accepts)
575 pub extern "C" fn ChannelHandshakeLimits_get_their_to_self_delay(this_ptr: &ChannelHandshakeLimits) -> u16 {
576 let mut inner_val = &mut this_ptr.get_native_mut_ref().their_to_self_delay;
579 /// Set to the amount of time we're willing to wait to claim money back to us.
581 /// Not checking this value would be a security issue, as our peer would be able to set it to
582 /// max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
584 /// Default value: 2016, which we also enforce as a maximum value so you can tweak config to
585 /// reduce the loss of having useless locked funds (if your peer accepts)
587 pub extern "C" fn ChannelHandshakeLimits_set_their_to_self_delay(this_ptr: &mut ChannelHandshakeLimits, mut val: u16) {
588 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.their_to_self_delay = val;
590 /// Constructs a new ChannelHandshakeLimits given each field
593 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 {
594 ChannelHandshakeLimits { inner: ObjOps::heap_alloc(nativeChannelHandshakeLimits {
595 min_funding_satoshis: min_funding_satoshis_arg,
596 max_funding_satoshis: max_funding_satoshis_arg,
597 max_htlc_minimum_msat: max_htlc_minimum_msat_arg,
598 min_max_htlc_value_in_flight_msat: min_max_htlc_value_in_flight_msat_arg,
599 max_channel_reserve_satoshis: max_channel_reserve_satoshis_arg,
600 min_max_accepted_htlcs: min_max_accepted_htlcs_arg,
601 max_minimum_depth: max_minimum_depth_arg,
602 trust_own_funding_0conf: trust_own_funding_0conf_arg,
603 force_announced_channel_preference: force_announced_channel_preference_arg,
604 their_to_self_delay: their_to_self_delay_arg,
607 impl Clone for ChannelHandshakeLimits {
608 fn clone(&self) -> Self {
610 inner: if <*mut nativeChannelHandshakeLimits>::is_null(self.inner) { core::ptr::null_mut() } else {
611 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
617 /// Used only if an object of this type is returned as a trait impl by a method
618 pub(crate) extern "C" fn ChannelHandshakeLimits_clone_void(this_ptr: *const c_void) -> *mut c_void {
619 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelHandshakeLimits)).clone() })) as *mut c_void
622 /// Creates a copy of the ChannelHandshakeLimits
623 pub extern "C" fn ChannelHandshakeLimits_clone(orig: &ChannelHandshakeLimits) -> ChannelHandshakeLimits {
626 /// Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used.
629 pub extern "C" fn ChannelHandshakeLimits_default() -> ChannelHandshakeLimits {
630 ChannelHandshakeLimits { inner: ObjOps::heap_alloc(Default::default()), is_owned: true }
633 use lightning::util::config::ChannelConfig as nativeChannelConfigImport;
634 pub(crate) type nativeChannelConfig = nativeChannelConfigImport;
636 /// Options which apply on a per-channel basis and may change at runtime or based on negotiation
637 /// with our counterparty.
640 pub struct ChannelConfig {
641 /// A pointer to the opaque Rust object.
643 /// Nearly everywhere, inner must be non-null, however in places where
644 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
645 pub inner: *mut nativeChannelConfig,
646 /// Indicates that this is the only struct which contains the same pointer.
648 /// Rust functions which take ownership of an object provided via an argument require
649 /// this to be true and invalidate the object pointed to by inner.
653 impl Drop for ChannelConfig {
655 if self.is_owned && !<*mut nativeChannelConfig>::is_null(self.inner) {
656 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
660 /// Frees any resources used by the ChannelConfig, if is_owned is set and inner is non-NULL.
662 pub extern "C" fn ChannelConfig_free(this_obj: ChannelConfig) { }
664 /// Used only if an object of this type is returned as a trait impl by a method
665 pub(crate) extern "C" fn ChannelConfig_free_void(this_ptr: *mut c_void) {
666 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelConfig); }
670 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelConfig {
671 unsafe { &*ObjOps::untweak_ptr(self.inner) }
673 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelConfig {
674 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
676 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
677 pub(crate) fn take_inner(mut self) -> *mut nativeChannelConfig {
678 assert!(self.is_owned);
679 let ret = ObjOps::untweak_ptr(self.inner);
680 self.inner = core::ptr::null_mut();
684 /// Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
685 /// over the channel.
686 /// This may be allowed to change at runtime in a later update, however doing so must result in
687 /// update messages sent to notify all nodes of our updated relay fee.
689 /// Default value: 0.
691 pub extern "C" fn ChannelConfig_get_forwarding_fee_proportional_millionths(this_ptr: &ChannelConfig) -> u32 {
692 let mut inner_val = &mut this_ptr.get_native_mut_ref().forwarding_fee_proportional_millionths;
695 /// Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
696 /// over the channel.
697 /// This may be allowed to change at runtime in a later update, however doing so must result in
698 /// update messages sent to notify all nodes of our updated relay fee.
700 /// Default value: 0.
702 pub extern "C" fn ChannelConfig_set_forwarding_fee_proportional_millionths(this_ptr: &mut ChannelConfig, mut val: u32) {
703 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.forwarding_fee_proportional_millionths = val;
705 /// Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
706 /// excess of [`forwarding_fee_proportional_millionths`].
707 /// This may be allowed to change at runtime in a later update, however doing so must result in
708 /// update messages sent to notify all nodes of our updated relay fee.
710 /// The default value of a single satoshi roughly matches the market rate on many routing nodes
711 /// as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
714 /// Default value: 1000.
716 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
718 pub extern "C" fn ChannelConfig_get_forwarding_fee_base_msat(this_ptr: &ChannelConfig) -> u32 {
719 let mut inner_val = &mut this_ptr.get_native_mut_ref().forwarding_fee_base_msat;
722 /// Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
723 /// excess of [`forwarding_fee_proportional_millionths`].
724 /// This may be allowed to change at runtime in a later update, however doing so must result in
725 /// update messages sent to notify all nodes of our updated relay fee.
727 /// The default value of a single satoshi roughly matches the market rate on many routing nodes
728 /// as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
731 /// Default value: 1000.
733 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
735 pub extern "C" fn ChannelConfig_set_forwarding_fee_base_msat(this_ptr: &mut ChannelConfig, mut val: u32) {
736 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.forwarding_fee_base_msat = val;
738 /// The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
739 /// the channel this config applies to.
741 /// This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
742 /// HTLC balance when a channel appears on-chain whereas
743 /// [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
744 /// (non-HTLC-encumbered) balance.
746 /// Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
747 /// we (or one of our watchtowers) MUST be online to check for broadcast of the current
748 /// commitment transaction at least once per this many blocks (minus some margin to allow us
749 /// enough time to broadcast and confirm a transaction, possibly with time in between to RBF
750 /// the spending transaction).
752 /// Default value: 72 (12 hours at an average of 6 blocks/hour).
753 /// Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
754 /// [`MIN_CLTV_EXPIRY_DELTA`] instead.
756 /// [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
758 pub extern "C" fn ChannelConfig_get_cltv_expiry_delta(this_ptr: &ChannelConfig) -> u16 {
759 let mut inner_val = &mut this_ptr.get_native_mut_ref().cltv_expiry_delta;
762 /// The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
763 /// the channel this config applies to.
765 /// This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
766 /// HTLC balance when a channel appears on-chain whereas
767 /// [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
768 /// (non-HTLC-encumbered) balance.
770 /// Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
771 /// we (or one of our watchtowers) MUST be online to check for broadcast of the current
772 /// commitment transaction at least once per this many blocks (minus some margin to allow us
773 /// enough time to broadcast and confirm a transaction, possibly with time in between to RBF
774 /// the spending transaction).
776 /// Default value: 72 (12 hours at an average of 6 blocks/hour).
777 /// Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
778 /// [`MIN_CLTV_EXPIRY_DELTA`] instead.
780 /// [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
782 pub extern "C" fn ChannelConfig_set_cltv_expiry_delta(this_ptr: &mut ChannelConfig, mut val: u16) {
783 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.cltv_expiry_delta = val;
785 /// Set to announce the channel publicly and notify all nodes that they can route via this
788 /// This should only be set to true for nodes which expect to be online reliably.
790 /// As the node which funds a channel picks this value this will only apply for new outbound
791 /// channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
793 /// This cannot be changed after the initial channel handshake.
795 /// Default value: false.
797 pub extern "C" fn ChannelConfig_get_announced_channel(this_ptr: &ChannelConfig) -> bool {
798 let mut inner_val = &mut this_ptr.get_native_mut_ref().announced_channel;
801 /// Set to announce the channel publicly and notify all nodes that they can route via this
804 /// This should only be set to true for nodes which expect to be online reliably.
806 /// As the node which funds a channel picks this value this will only apply for new outbound
807 /// channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
809 /// This cannot be changed after the initial channel handshake.
811 /// Default value: false.
813 pub extern "C" fn ChannelConfig_set_announced_channel(this_ptr: &mut ChannelConfig, mut val: bool) {
814 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.announced_channel = val;
816 /// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
817 /// supports it, they will then enforce the mutual-close output to us matches what we provided
818 /// at intialization, preventing us from closing to an alternate pubkey.
820 /// This is set to true by default to provide a slight increase in security, though ultimately
821 /// any attacker who is able to take control of a channel can just as easily send the funds via
822 /// lightning payments, so we never require that our counterparties support this option.
824 /// This cannot be changed after a channel has been initialized.
826 /// Default value: true.
828 pub extern "C" fn ChannelConfig_get_commit_upfront_shutdown_pubkey(this_ptr: &ChannelConfig) -> bool {
829 let mut inner_val = &mut this_ptr.get_native_mut_ref().commit_upfront_shutdown_pubkey;
832 /// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
833 /// supports it, they will then enforce the mutual-close output to us matches what we provided
834 /// at intialization, preventing us from closing to an alternate pubkey.
836 /// This is set to true by default to provide a slight increase in security, though ultimately
837 /// any attacker who is able to take control of a channel can just as easily send the funds via
838 /// lightning payments, so we never require that our counterparties support this option.
840 /// This cannot be changed after a channel has been initialized.
842 /// Default value: true.
844 pub extern "C" fn ChannelConfig_set_commit_upfront_shutdown_pubkey(this_ptr: &mut ChannelConfig, mut val: bool) {
845 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.commit_upfront_shutdown_pubkey = val;
847 /// Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
848 /// small to claim on-chain.
850 /// When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
851 /// not be claimable on-chain, instead being turned into additional miner fees if either
852 /// party force-closes the channel. Because the threshold is per-HTLC, our total exposure
853 /// to such payments may be sustantial if there are many dust HTLCs present when the
854 /// channel is force-closed.
856 /// This limit is applied for sent, forwarded, and received HTLCs and limits the total
857 /// exposure across all three types per-channel. Setting this too low may prevent the
858 /// sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
859 /// important to prevent stealing of dust HTLCs by miners.
861 /// Default value: 5_000_000 msat.
863 pub extern "C" fn ChannelConfig_get_max_dust_htlc_exposure_msat(this_ptr: &ChannelConfig) -> u64 {
864 let mut inner_val = &mut this_ptr.get_native_mut_ref().max_dust_htlc_exposure_msat;
867 /// Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
868 /// small to claim on-chain.
870 /// When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
871 /// not be claimable on-chain, instead being turned into additional miner fees if either
872 /// party force-closes the channel. Because the threshold is per-HTLC, our total exposure
873 /// to such payments may be sustantial if there are many dust HTLCs present when the
874 /// channel is force-closed.
876 /// This limit is applied for sent, forwarded, and received HTLCs and limits the total
877 /// exposure across all three types per-channel. Setting this too low may prevent the
878 /// sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
879 /// important to prevent stealing of dust HTLCs by miners.
881 /// Default value: 5_000_000 msat.
883 pub extern "C" fn ChannelConfig_set_max_dust_htlc_exposure_msat(this_ptr: &mut ChannelConfig, mut val: u64) {
884 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.max_dust_htlc_exposure_msat = val;
886 /// The additional fee we're willing to pay to avoid waiting for the counterparty's
887 /// `to_self_delay` to reclaim funds.
889 /// When we close a channel cooperatively with our counterparty, we negotiate a fee for the
890 /// closing transaction which both sides find acceptable, ultimately paid by the channel
891 /// funder/initiator.
893 /// When we are the funder, because we have to pay the channel closing fee, we bound the
894 /// acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
895 /// this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
896 /// [`Normal`] feerate during normal operation, this value represents the additional fee we're
897 /// willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
900 /// When we are not the funder, we require the closing transaction fee pay at least our
901 /// [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
902 /// Thus, this value is ignored when we are not the funder.
904 /// Default value: 1000 satoshis.
906 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
907 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
909 pub extern "C" fn ChannelConfig_get_force_close_avoidance_max_fee_satoshis(this_ptr: &ChannelConfig) -> u64 {
910 let mut inner_val = &mut this_ptr.get_native_mut_ref().force_close_avoidance_max_fee_satoshis;
913 /// The additional fee we're willing to pay to avoid waiting for the counterparty's
914 /// `to_self_delay` to reclaim funds.
916 /// When we close a channel cooperatively with our counterparty, we negotiate a fee for the
917 /// closing transaction which both sides find acceptable, ultimately paid by the channel
918 /// funder/initiator.
920 /// When we are the funder, because we have to pay the channel closing fee, we bound the
921 /// acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
922 /// this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
923 /// [`Normal`] feerate during normal operation, this value represents the additional fee we're
924 /// willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
927 /// When we are not the funder, we require the closing transaction fee pay at least our
928 /// [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
929 /// Thus, this value is ignored when we are not the funder.
931 /// Default value: 1000 satoshis.
933 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
934 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
936 pub extern "C" fn ChannelConfig_set_force_close_avoidance_max_fee_satoshis(this_ptr: &mut ChannelConfig, mut val: u64) {
937 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.force_close_avoidance_max_fee_satoshis = val;
939 /// Constructs a new ChannelConfig given each field
942 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 announced_channel_arg: bool, mut commit_upfront_shutdown_pubkey_arg: bool, mut max_dust_htlc_exposure_msat_arg: u64, mut force_close_avoidance_max_fee_satoshis_arg: u64) -> ChannelConfig {
943 ChannelConfig { inner: ObjOps::heap_alloc(nativeChannelConfig {
944 forwarding_fee_proportional_millionths: forwarding_fee_proportional_millionths_arg,
945 forwarding_fee_base_msat: forwarding_fee_base_msat_arg,
946 cltv_expiry_delta: cltv_expiry_delta_arg,
947 announced_channel: announced_channel_arg,
948 commit_upfront_shutdown_pubkey: commit_upfront_shutdown_pubkey_arg,
949 max_dust_htlc_exposure_msat: max_dust_htlc_exposure_msat_arg,
950 force_close_avoidance_max_fee_satoshis: force_close_avoidance_max_fee_satoshis_arg,
953 impl Clone for ChannelConfig {
954 fn clone(&self) -> Self {
956 inner: if <*mut nativeChannelConfig>::is_null(self.inner) { core::ptr::null_mut() } else {
957 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
963 /// Used only if an object of this type is returned as a trait impl by a method
964 pub(crate) extern "C" fn ChannelConfig_clone_void(this_ptr: *const c_void) -> *mut c_void {
965 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelConfig)).clone() })) as *mut c_void
968 /// Creates a copy of the ChannelConfig
969 pub extern "C" fn ChannelConfig_clone(orig: &ChannelConfig) -> ChannelConfig {
972 /// Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
975 pub extern "C" fn ChannelConfig_default() -> ChannelConfig {
976 ChannelConfig { inner: ObjOps::heap_alloc(Default::default()), is_owned: true }
979 /// Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read
980 pub extern "C" fn ChannelConfig_write(obj: &crate::lightning::util::config::ChannelConfig) -> crate::c_types::derived::CVec_u8Z {
981 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
984 pub(crate) extern "C" fn ChannelConfig_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
985 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelConfig) })
988 /// Read a ChannelConfig from a byte array, created by ChannelConfig_write
989 pub extern "C" fn ChannelConfig_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelConfigDecodeErrorZ {
990 let res: Result<lightning::util::config::ChannelConfig, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
991 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
995 use lightning::util::config::UserConfig as nativeUserConfigImport;
996 pub(crate) type nativeUserConfig = nativeUserConfigImport;
998 /// Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
1000 /// Default::default() provides sane defaults for most configurations
1001 /// (but currently with 0 relay fees!)
1004 pub struct UserConfig {
1005 /// A pointer to the opaque Rust object.
1007 /// Nearly everywhere, inner must be non-null, however in places where
1008 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1009 pub inner: *mut nativeUserConfig,
1010 /// Indicates that this is the only struct which contains the same pointer.
1012 /// Rust functions which take ownership of an object provided via an argument require
1013 /// this to be true and invalidate the object pointed to by inner.
1017 impl Drop for UserConfig {
1018 fn drop(&mut self) {
1019 if self.is_owned && !<*mut nativeUserConfig>::is_null(self.inner) {
1020 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1024 /// Frees any resources used by the UserConfig, if is_owned is set and inner is non-NULL.
1026 pub extern "C" fn UserConfig_free(this_obj: UserConfig) { }
1028 /// Used only if an object of this type is returned as a trait impl by a method
1029 pub(crate) extern "C" fn UserConfig_free_void(this_ptr: *mut c_void) {
1030 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeUserConfig); }
1034 pub(crate) fn get_native_ref(&self) -> &'static nativeUserConfig {
1035 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1037 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeUserConfig {
1038 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1040 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1041 pub(crate) fn take_inner(mut self) -> *mut nativeUserConfig {
1042 assert!(self.is_owned);
1043 let ret = ObjOps::untweak_ptr(self.inner);
1044 self.inner = core::ptr::null_mut();
1048 /// Channel config that we propose to our counterparty.
1050 pub extern "C" fn UserConfig_get_own_channel_config(this_ptr: &UserConfig) -> crate::lightning::util::config::ChannelHandshakeConfig {
1051 let mut inner_val = &mut this_ptr.get_native_mut_ref().own_channel_config;
1052 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 }
1054 /// Channel config that we propose to our counterparty.
1056 pub extern "C" fn UserConfig_set_own_channel_config(this_ptr: &mut UserConfig, mut val: crate::lightning::util::config::ChannelHandshakeConfig) {
1057 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.own_channel_config = *unsafe { Box::from_raw(val.take_inner()) };
1059 /// Limits applied to our counterparty's proposed channel config settings.
1061 pub extern "C" fn UserConfig_get_peer_channel_config_limits(this_ptr: &UserConfig) -> crate::lightning::util::config::ChannelHandshakeLimits {
1062 let mut inner_val = &mut this_ptr.get_native_mut_ref().peer_channel_config_limits;
1063 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 }
1065 /// Limits applied to our counterparty's proposed channel config settings.
1067 pub extern "C" fn UserConfig_set_peer_channel_config_limits(this_ptr: &mut UserConfig, mut val: crate::lightning::util::config::ChannelHandshakeLimits) {
1068 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.peer_channel_config_limits = *unsafe { Box::from_raw(val.take_inner()) };
1070 /// Channel config which affects behavior during channel lifetime.
1072 pub extern "C" fn UserConfig_get_channel_options(this_ptr: &UserConfig) -> crate::lightning::util::config::ChannelConfig {
1073 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_options;
1074 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 }
1076 /// Channel config which affects behavior during channel lifetime.
1078 pub extern "C" fn UserConfig_set_channel_options(this_ptr: &mut UserConfig, mut val: crate::lightning::util::config::ChannelConfig) {
1079 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_options = *unsafe { Box::from_raw(val.take_inner()) };
1081 /// If this is set to false, we will reject any HTLCs which were to be forwarded over private
1082 /// channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
1083 /// node which is not online reliably.
1085 /// For nodes which are not online reliably, you should set all channels to *not* be announced
1086 /// (using [`ChannelConfig::announced_channel`] and
1087 /// [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
1088 /// ensure you are not exposed to any forwarding risk.
1090 /// Note that because you cannot change a channel's announced state after creation, there is no
1091 /// way to disable forwarding on public channels retroactively. Thus, in order to change a node
1092 /// from a publicly-announced forwarding node to a private non-forwarding node you must close
1093 /// all your channels and open new ones. For privacy, you should also change your node_id
1094 /// (swapping all private and public key material for new ones) at that time.
1096 /// Default value: false.
1098 pub extern "C" fn UserConfig_get_accept_forwards_to_priv_channels(this_ptr: &UserConfig) -> bool {
1099 let mut inner_val = &mut this_ptr.get_native_mut_ref().accept_forwards_to_priv_channels;
1102 /// If this is set to false, we will reject any HTLCs which were to be forwarded over private
1103 /// channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
1104 /// node which is not online reliably.
1106 /// For nodes which are not online reliably, you should set all channels to *not* be announced
1107 /// (using [`ChannelConfig::announced_channel`] and
1108 /// [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
1109 /// ensure you are not exposed to any forwarding risk.
1111 /// Note that because you cannot change a channel's announced state after creation, there is no
1112 /// way to disable forwarding on public channels retroactively. Thus, in order to change a node
1113 /// from a publicly-announced forwarding node to a private non-forwarding node you must close
1114 /// all your channels and open new ones. For privacy, you should also change your node_id
1115 /// (swapping all private and public key material for new ones) at that time.
1117 /// Default value: false.
1119 pub extern "C" fn UserConfig_set_accept_forwards_to_priv_channels(this_ptr: &mut UserConfig, mut val: bool) {
1120 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.accept_forwards_to_priv_channels = val;
1122 /// If this is set to false, we do not accept inbound requests to open a new channel.
1123 /// Default value: true.
1125 pub extern "C" fn UserConfig_get_accept_inbound_channels(this_ptr: &UserConfig) -> bool {
1126 let mut inner_val = &mut this_ptr.get_native_mut_ref().accept_inbound_channels;
1129 /// If this is set to false, we do not accept inbound requests to open a new channel.
1130 /// Default value: true.
1132 pub extern "C" fn UserConfig_set_accept_inbound_channels(this_ptr: &mut UserConfig, mut val: bool) {
1133 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.accept_inbound_channels = val;
1135 /// If this is set to true, the user needs to manually accept inbound requests to open a new
1138 /// When set to true, [`Event::OpenChannelRequest`] will be triggered once a request to open a
1139 /// new inbound channel is received through a [`msgs::OpenChannel`] message. In that case, a
1140 /// [`msgs::AcceptChannel`] message will not be sent back to the counterparty node unless the
1141 /// user explicitly chooses to accept the request.
1143 /// Default value: false.
1145 /// [`Event::OpenChannelRequest`]: crate::util::events::Event::OpenChannelRequest
1146 /// [`msgs::OpenChannel`]: crate::ln::msgs::OpenChannel
1147 /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
1149 pub extern "C" fn UserConfig_get_manually_accept_inbound_channels(this_ptr: &UserConfig) -> bool {
1150 let mut inner_val = &mut this_ptr.get_native_mut_ref().manually_accept_inbound_channels;
1153 /// If this is set to true, the user needs to manually accept inbound requests to open a new
1156 /// When set to true, [`Event::OpenChannelRequest`] will be triggered once a request to open a
1157 /// new inbound channel is received through a [`msgs::OpenChannel`] message. In that case, a
1158 /// [`msgs::AcceptChannel`] message will not be sent back to the counterparty node unless the
1159 /// user explicitly chooses to accept the request.
1161 /// Default value: false.
1163 /// [`Event::OpenChannelRequest`]: crate::util::events::Event::OpenChannelRequest
1164 /// [`msgs::OpenChannel`]: crate::ln::msgs::OpenChannel
1165 /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
1167 pub extern "C" fn UserConfig_set_manually_accept_inbound_channels(this_ptr: &mut UserConfig, mut val: bool) {
1168 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.manually_accept_inbound_channels = val;
1170 /// Constructs a new UserConfig given each field
1173 pub extern "C" fn UserConfig_new(mut own_channel_config_arg: crate::lightning::util::config::ChannelHandshakeConfig, mut peer_channel_config_limits_arg: crate::lightning::util::config::ChannelHandshakeLimits, mut channel_options_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) -> UserConfig {
1174 UserConfig { inner: ObjOps::heap_alloc(nativeUserConfig {
1175 own_channel_config: *unsafe { Box::from_raw(own_channel_config_arg.take_inner()) },
1176 peer_channel_config_limits: *unsafe { Box::from_raw(peer_channel_config_limits_arg.take_inner()) },
1177 channel_options: *unsafe { Box::from_raw(channel_options_arg.take_inner()) },
1178 accept_forwards_to_priv_channels: accept_forwards_to_priv_channels_arg,
1179 accept_inbound_channels: accept_inbound_channels_arg,
1180 manually_accept_inbound_channels: manually_accept_inbound_channels_arg,
1181 }), is_owned: true }
1183 impl Clone for UserConfig {
1184 fn clone(&self) -> Self {
1186 inner: if <*mut nativeUserConfig>::is_null(self.inner) { core::ptr::null_mut() } else {
1187 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1193 /// Used only if an object of this type is returned as a trait impl by a method
1194 pub(crate) extern "C" fn UserConfig_clone_void(this_ptr: *const c_void) -> *mut c_void {
1195 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeUserConfig)).clone() })) as *mut c_void
1198 /// Creates a copy of the UserConfig
1199 pub extern "C" fn UserConfig_clone(orig: &UserConfig) -> UserConfig {
1202 /// Creates a "default" UserConfig. See struct and individual field documentaiton for details on which values are used.
1205 pub extern "C" fn UserConfig_default() -> UserConfig {
1206 UserConfig { inner: ObjOps::heap_alloc(Default::default()), is_owned: true }