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 std::str::FromStr;
14 use bitcoin::hashes::Hash;
15 use crate::c_types::*;
18 use lightning::util::config::ChannelHandshakeConfig as nativeChannelHandshakeConfigImport;
19 type nativeChannelHandshakeConfig = nativeChannelHandshakeConfigImport;
21 /// Configuration we set when applicable.
23 /// Default::default() provides sane defaults.
26 pub struct ChannelHandshakeConfig {
27 /// A pointer to the opaque Rust object.
29 /// Nearly everywhere, inner must be non-null, however in places where
30 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
31 pub inner: *mut nativeChannelHandshakeConfig,
32 /// Indicates that this is the only struct which contains the same pointer.
34 /// Rust functions which take ownership of an object provided via an argument require
35 /// this to be true and invalidate the object pointed to by inner.
39 impl Drop for ChannelHandshakeConfig {
41 if self.is_owned && !<*mut nativeChannelHandshakeConfig>::is_null(self.inner) {
42 let _ = unsafe { Box::from_raw(self.inner) };
46 /// Frees any resources used by the ChannelHandshakeConfig, if is_owned is set and inner is non-NULL.
48 pub extern "C" fn ChannelHandshakeConfig_free(this_obj: ChannelHandshakeConfig) { }
50 /// Used only if an object of this type is returned as a trait impl by a method
51 extern "C" fn ChannelHandshakeConfig_free_void(this_ptr: *mut c_void) {
52 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelHandshakeConfig); }
55 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
56 impl ChannelHandshakeConfig {
57 pub(crate) fn take_inner(mut self) -> *mut nativeChannelHandshakeConfig {
58 assert!(self.is_owned);
60 self.inner = std::ptr::null_mut();
64 /// Confirmations we will wait for before considering the channel locked in.
65 /// Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
66 /// equivalent limit applied to outbound channels).
70 pub extern "C" fn ChannelHandshakeConfig_get_minimum_depth(this_ptr: &ChannelHandshakeConfig) -> u32 {
71 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.minimum_depth;
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).
80 pub extern "C" fn ChannelHandshakeConfig_set_minimum_depth(this_ptr: &mut ChannelHandshakeConfig, mut val: u32) {
81 unsafe { &mut *this_ptr.inner }.minimum_depth = val;
83 /// Set to the number of blocks we require our counterparty to wait to claim their money (ie
84 /// the number of blocks we have to punish our counterparty if they broadcast a revoked
87 /// This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
88 /// be online to check for revoked transactions on-chain at least once every our_to_self_delay
89 /// blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
90 /// possibly with time in between to RBF the spending transaction).
92 /// Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
93 /// case of an honest unilateral channel close, which implicitly decrease the economic value of
96 /// Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
97 /// can tweak config to ask for more security, not less.
99 pub extern "C" fn ChannelHandshakeConfig_get_our_to_self_delay(this_ptr: &ChannelHandshakeConfig) -> u16 {
100 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.our_to_self_delay;
103 /// Set to the number of blocks we require our counterparty to wait to claim their money (ie
104 /// the number of blocks we have to punish our counterparty if they broadcast a revoked
107 /// This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
108 /// be online to check for revoked transactions on-chain at least once every our_to_self_delay
109 /// blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
110 /// possibly with time in between to RBF the spending transaction).
112 /// Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
113 /// case of an honest unilateral channel close, which implicitly decrease the economic value of
116 /// Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
117 /// can tweak config to ask for more security, not less.
119 pub extern "C" fn ChannelHandshakeConfig_set_our_to_self_delay(this_ptr: &mut ChannelHandshakeConfig, mut val: u16) {
120 unsafe { &mut *this_ptr.inner }.our_to_self_delay = val;
122 /// Set to the smallest value HTLC we will accept to process.
124 /// This value is sent to our counterparty on channel-open and we close the channel any time
125 /// our counterparty misbehaves by sending us an HTLC with a value smaller than this.
127 /// Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
130 pub extern "C" fn ChannelHandshakeConfig_get_our_htlc_minimum_msat(this_ptr: &ChannelHandshakeConfig) -> u64 {
131 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.our_htlc_minimum_msat;
134 /// Set to the smallest value HTLC we will accept to process.
136 /// This value is sent to our counterparty on channel-open and we close the channel any time
137 /// our counterparty misbehaves by sending us an HTLC with a value smaller than this.
139 /// Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
142 pub extern "C" fn ChannelHandshakeConfig_set_our_htlc_minimum_msat(this_ptr: &mut ChannelHandshakeConfig, mut val: u64) {
143 unsafe { &mut *this_ptr.inner }.our_htlc_minimum_msat = val;
145 /// Constructs a new ChannelHandshakeConfig given each field
148 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) -> ChannelHandshakeConfig {
149 ChannelHandshakeConfig { inner: Box::into_raw(Box::new(nativeChannelHandshakeConfig {
150 minimum_depth: minimum_depth_arg,
151 our_to_self_delay: our_to_self_delay_arg,
152 our_htlc_minimum_msat: our_htlc_minimum_msat_arg,
153 })), is_owned: true }
155 impl Clone for ChannelHandshakeConfig {
156 fn clone(&self) -> Self {
158 inner: if <*mut nativeChannelHandshakeConfig>::is_null(self.inner) { std::ptr::null_mut() } else {
159 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
165 /// Used only if an object of this type is returned as a trait impl by a method
166 pub(crate) extern "C" fn ChannelHandshakeConfig_clone_void(this_ptr: *const c_void) -> *mut c_void {
167 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelHandshakeConfig)).clone() })) as *mut c_void
170 /// Creates a copy of the ChannelHandshakeConfig
171 pub extern "C" fn ChannelHandshakeConfig_clone(orig: &ChannelHandshakeConfig) -> ChannelHandshakeConfig {
174 /// Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used.
177 pub extern "C" fn ChannelHandshakeConfig_default() -> ChannelHandshakeConfig {
178 ChannelHandshakeConfig { inner: Box::into_raw(Box::new(Default::default())), is_owned: true }
181 use lightning::util::config::ChannelHandshakeLimits as nativeChannelHandshakeLimitsImport;
182 type nativeChannelHandshakeLimits = nativeChannelHandshakeLimitsImport;
184 /// Optional channel limits which are applied during channel creation.
186 /// These limits are only applied to our counterparty's limits, not our own.
188 /// Use 0/<type>::max_value() as appropriate to skip checking.
190 /// Provides sane defaults for most configurations.
192 /// Most additional limits are disabled except those with which specify a default in individual
193 /// field documentation. Note that this may result in barely-usable channels, but since they
194 /// are applied mostly only to incoming channels that's not much of a problem.
197 pub struct ChannelHandshakeLimits {
198 /// A pointer to the opaque Rust object.
200 /// Nearly everywhere, inner must be non-null, however in places where
201 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
202 pub inner: *mut nativeChannelHandshakeLimits,
203 /// Indicates that this is the only struct which contains the same pointer.
205 /// Rust functions which take ownership of an object provided via an argument require
206 /// this to be true and invalidate the object pointed to by inner.
210 impl Drop for ChannelHandshakeLimits {
212 if self.is_owned && !<*mut nativeChannelHandshakeLimits>::is_null(self.inner) {
213 let _ = unsafe { Box::from_raw(self.inner) };
217 /// Frees any resources used by the ChannelHandshakeLimits, if is_owned is set and inner is non-NULL.
219 pub extern "C" fn ChannelHandshakeLimits_free(this_obj: ChannelHandshakeLimits) { }
221 /// Used only if an object of this type is returned as a trait impl by a method
222 extern "C" fn ChannelHandshakeLimits_free_void(this_ptr: *mut c_void) {
223 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelHandshakeLimits); }
226 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
227 impl ChannelHandshakeLimits {
228 pub(crate) fn take_inner(mut self) -> *mut nativeChannelHandshakeLimits {
229 assert!(self.is_owned);
230 let ret = self.inner;
231 self.inner = std::ptr::null_mut();
235 /// Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
236 /// only applies to inbound channels.
238 /// Default value: 0.
240 pub extern "C" fn ChannelHandshakeLimits_get_min_funding_satoshis(this_ptr: &ChannelHandshakeLimits) -> u64 {
241 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.min_funding_satoshis;
244 /// Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
245 /// only applies to inbound channels.
247 /// Default value: 0.
249 pub extern "C" fn ChannelHandshakeLimits_set_min_funding_satoshis(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
250 unsafe { &mut *this_ptr.inner }.min_funding_satoshis = val;
252 /// The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
253 /// you to limit the maximum minimum-size they can require.
255 /// Default value: u64::max_value.
257 pub extern "C" fn ChannelHandshakeLimits_get_max_htlc_minimum_msat(this_ptr: &ChannelHandshakeLimits) -> u64 {
258 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.max_htlc_minimum_msat;
261 /// The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
262 /// you to limit the maximum minimum-size they can require.
264 /// Default value: u64::max_value.
266 pub extern "C" fn ChannelHandshakeLimits_set_max_htlc_minimum_msat(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
267 unsafe { &mut *this_ptr.inner }.max_htlc_minimum_msat = val;
269 /// The remote node sets a limit on the maximum value of pending HTLCs to them at any given
270 /// time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
272 /// Default value: 0.
274 pub extern "C" fn ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(this_ptr: &ChannelHandshakeLimits) -> u64 {
275 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.min_max_htlc_value_in_flight_msat;
278 /// The remote node sets a limit on the maximum value of pending HTLCs to them at any given
279 /// time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
281 /// Default value: 0.
283 pub extern "C" fn ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
284 unsafe { &mut *this_ptr.inner }.min_max_htlc_value_in_flight_msat = val;
286 /// The remote node will require we keep a certain amount in direct payment to ourselves at all
287 /// time, ensuring that we are able to be punished if we broadcast an old state. This allows to
288 /// you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
290 /// Default value: u64::max_value.
292 pub extern "C" fn ChannelHandshakeLimits_get_max_channel_reserve_satoshis(this_ptr: &ChannelHandshakeLimits) -> u64 {
293 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.max_channel_reserve_satoshis;
296 /// The remote node will require we keep a certain amount in direct payment to ourselves at all
297 /// time, ensuring that we are able to be punished if we broadcast an old state. This allows to
298 /// you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
300 /// Default value: u64::max_value.
302 pub extern "C" fn ChannelHandshakeLimits_set_max_channel_reserve_satoshis(this_ptr: &mut ChannelHandshakeLimits, mut val: u64) {
303 unsafe { &mut *this_ptr.inner }.max_channel_reserve_satoshis = val;
305 /// The remote node sets a limit on the maximum number of pending HTLCs to them at any given
306 /// time. This allows you to set a minimum such value.
308 /// Default value: 0.
310 pub extern "C" fn ChannelHandshakeLimits_get_min_max_accepted_htlcs(this_ptr: &ChannelHandshakeLimits) -> u16 {
311 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.min_max_accepted_htlcs;
314 /// The remote node sets a limit on the maximum number of pending HTLCs to them at any given
315 /// time. This allows you to set a minimum such value.
317 /// Default value: 0.
319 pub extern "C" fn ChannelHandshakeLimits_set_min_max_accepted_htlcs(this_ptr: &mut ChannelHandshakeLimits, mut val: u16) {
320 unsafe { &mut *this_ptr.inner }.min_max_accepted_htlcs = val;
322 /// Before a channel is usable the funding transaction will need to be confirmed by at least a
323 /// certain number of blocks, specified by the node which is not the funder (as the funder can
324 /// assume they aren't going to double-spend themselves).
325 /// This config allows you to set a limit on the maximum amount of time to wait.
327 /// Default value: 144, or roughly one day and only applies to outbound channels.
329 pub extern "C" fn ChannelHandshakeLimits_get_max_minimum_depth(this_ptr: &ChannelHandshakeLimits) -> u32 {
330 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.max_minimum_depth;
333 /// Before a channel is usable the funding transaction will need to be confirmed by at least a
334 /// certain number of blocks, specified by the node which is not the funder (as the funder can
335 /// assume they aren't going to double-spend themselves).
336 /// This config allows you to set a limit on the maximum amount of time to wait.
338 /// Default value: 144, or roughly one day and only applies to outbound channels.
340 pub extern "C" fn ChannelHandshakeLimits_set_max_minimum_depth(this_ptr: &mut ChannelHandshakeLimits, mut val: u32) {
341 unsafe { &mut *this_ptr.inner }.max_minimum_depth = val;
343 /// Set to force an incoming channel to match our announced channel preference in
344 /// [`ChannelConfig::announced_channel`].
346 /// For a node which is not online reliably, this should be set to true and
347 /// [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
348 /// channels will ever be opened.
350 /// Default value: true.
352 pub extern "C" fn ChannelHandshakeLimits_get_force_announced_channel_preference(this_ptr: &ChannelHandshakeLimits) -> bool {
353 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.force_announced_channel_preference;
356 /// Set to force an incoming channel to match our announced channel preference in
357 /// [`ChannelConfig::announced_channel`].
359 /// For a node which is not online reliably, this should be set to true and
360 /// [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
361 /// channels will ever be opened.
363 /// Default value: true.
365 pub extern "C" fn ChannelHandshakeLimits_set_force_announced_channel_preference(this_ptr: &mut ChannelHandshakeLimits, mut val: bool) {
366 unsafe { &mut *this_ptr.inner }.force_announced_channel_preference = val;
368 /// Set to the amount of time we're willing to wait to claim money back to us.
370 /// Not checking this value would be a security issue, as our peer would be able to set it to
371 /// max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
373 /// Default value: 2016, which we also enforce as a maximum value so you can tweak config to
374 /// reduce the loss of having useless locked funds (if your peer accepts)
376 pub extern "C" fn ChannelHandshakeLimits_get_their_to_self_delay(this_ptr: &ChannelHandshakeLimits) -> u16 {
377 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.their_to_self_delay;
380 /// Set to the amount of time we're willing to wait to claim money back to us.
382 /// Not checking this value would be a security issue, as our peer would be able to set it to
383 /// max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
385 /// Default value: 2016, which we also enforce as a maximum value so you can tweak config to
386 /// reduce the loss of having useless locked funds (if your peer accepts)
388 pub extern "C" fn ChannelHandshakeLimits_set_their_to_self_delay(this_ptr: &mut ChannelHandshakeLimits, mut val: u16) {
389 unsafe { &mut *this_ptr.inner }.their_to_self_delay = val;
391 /// Constructs a new ChannelHandshakeLimits given each field
394 pub extern "C" fn ChannelHandshakeLimits_new(mut min_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 force_announced_channel_preference_arg: bool, mut their_to_self_delay_arg: u16) -> ChannelHandshakeLimits {
395 ChannelHandshakeLimits { inner: Box::into_raw(Box::new(nativeChannelHandshakeLimits {
396 min_funding_satoshis: min_funding_satoshis_arg,
397 max_htlc_minimum_msat: max_htlc_minimum_msat_arg,
398 min_max_htlc_value_in_flight_msat: min_max_htlc_value_in_flight_msat_arg,
399 max_channel_reserve_satoshis: max_channel_reserve_satoshis_arg,
400 min_max_accepted_htlcs: min_max_accepted_htlcs_arg,
401 max_minimum_depth: max_minimum_depth_arg,
402 force_announced_channel_preference: force_announced_channel_preference_arg,
403 their_to_self_delay: their_to_self_delay_arg,
404 })), is_owned: true }
406 impl Clone for ChannelHandshakeLimits {
407 fn clone(&self) -> Self {
409 inner: if <*mut nativeChannelHandshakeLimits>::is_null(self.inner) { std::ptr::null_mut() } else {
410 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
416 /// Used only if an object of this type is returned as a trait impl by a method
417 pub(crate) extern "C" fn ChannelHandshakeLimits_clone_void(this_ptr: *const c_void) -> *mut c_void {
418 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelHandshakeLimits)).clone() })) as *mut c_void
421 /// Creates a copy of the ChannelHandshakeLimits
422 pub extern "C" fn ChannelHandshakeLimits_clone(orig: &ChannelHandshakeLimits) -> ChannelHandshakeLimits {
425 /// Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used.
428 pub extern "C" fn ChannelHandshakeLimits_default() -> ChannelHandshakeLimits {
429 ChannelHandshakeLimits { inner: Box::into_raw(Box::new(Default::default())), is_owned: true }
432 use lightning::util::config::ChannelConfig as nativeChannelConfigImport;
433 type nativeChannelConfig = nativeChannelConfigImport;
435 /// Options which apply on a per-channel basis and may change at runtime or based on negotiation
436 /// with our counterparty.
439 pub struct ChannelConfig {
440 /// A pointer to the opaque Rust object.
442 /// Nearly everywhere, inner must be non-null, however in places where
443 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
444 pub inner: *mut nativeChannelConfig,
445 /// Indicates that this is the only struct which contains the same pointer.
447 /// Rust functions which take ownership of an object provided via an argument require
448 /// this to be true and invalidate the object pointed to by inner.
452 impl Drop for ChannelConfig {
454 if self.is_owned && !<*mut nativeChannelConfig>::is_null(self.inner) {
455 let _ = unsafe { Box::from_raw(self.inner) };
459 /// Frees any resources used by the ChannelConfig, if is_owned is set and inner is non-NULL.
461 pub extern "C" fn ChannelConfig_free(this_obj: ChannelConfig) { }
463 /// Used only if an object of this type is returned as a trait impl by a method
464 extern "C" fn ChannelConfig_free_void(this_ptr: *mut c_void) {
465 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelConfig); }
468 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
470 pub(crate) fn take_inner(mut self) -> *mut nativeChannelConfig {
471 assert!(self.is_owned);
472 let ret = self.inner;
473 self.inner = std::ptr::null_mut();
477 /// Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
478 /// over the channel.
479 /// This may be allowed to change at runtime in a later update, however doing so must result in
480 /// update messages sent to notify all nodes of our updated relay fee.
482 /// Default value: 0.
484 pub extern "C" fn ChannelConfig_get_forwarding_fee_proportional_millionths(this_ptr: &ChannelConfig) -> u32 {
485 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.forwarding_fee_proportional_millionths;
488 /// Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
489 /// over the channel.
490 /// This may be allowed to change at runtime in a later update, however doing so must result in
491 /// update messages sent to notify all nodes of our updated relay fee.
493 /// Default value: 0.
495 pub extern "C" fn ChannelConfig_set_forwarding_fee_proportional_millionths(this_ptr: &mut ChannelConfig, mut val: u32) {
496 unsafe { &mut *this_ptr.inner }.forwarding_fee_proportional_millionths = val;
498 /// Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
499 /// excess of [`forwarding_fee_proportional_millionths`].
500 /// This may be allowed to change at runtime in a later update, however doing so must result in
501 /// update messages sent to notify all nodes of our updated relay fee.
503 /// The default value of a single satoshi roughly matches the market rate on many routing nodes
504 /// as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
507 /// Default value: 1000.
509 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
511 pub extern "C" fn ChannelConfig_get_forwarding_fee_base_msat(this_ptr: &ChannelConfig) -> u32 {
512 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.forwarding_fee_base_msat;
515 /// Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
516 /// excess of [`forwarding_fee_proportional_millionths`].
517 /// This may be allowed to change at runtime in a later update, however doing so must result in
518 /// update messages sent to notify all nodes of our updated relay fee.
520 /// The default value of a single satoshi roughly matches the market rate on many routing nodes
521 /// as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
524 /// Default value: 1000.
526 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
528 pub extern "C" fn ChannelConfig_set_forwarding_fee_base_msat(this_ptr: &mut ChannelConfig, mut val: u32) {
529 unsafe { &mut *this_ptr.inner }.forwarding_fee_base_msat = val;
531 /// The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
532 /// the channel this config applies to.
534 /// This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
535 /// HTLC balance when a channel appears on-chain whereas
536 /// [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
537 /// (non-HTLC-encumbered) balance.
539 /// Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
540 /// we (or one of our watchtowers) MUST be online to check for broadcast of the current
541 /// commitment transaction at least once per this many blocks (minus some margin to allow us
542 /// enough time to broadcast and confirm a transaction, possibly with time in between to RBF
543 /// the spending transaction).
545 /// Default value: 72 (12 hours at an average of 6 blocks/hour).
546 /// Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
547 /// [`MIN_CLTV_EXPIRY_DELTA`] instead.
549 /// [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
551 pub extern "C" fn ChannelConfig_get_cltv_expiry_delta(this_ptr: &ChannelConfig) -> u16 {
552 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.cltv_expiry_delta;
555 /// The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
556 /// the channel this config applies to.
558 /// This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
559 /// HTLC balance when a channel appears on-chain whereas
560 /// [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
561 /// (non-HTLC-encumbered) balance.
563 /// Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
564 /// we (or one of our watchtowers) MUST be online to check for broadcast of the current
565 /// commitment transaction at least once per this many blocks (minus some margin to allow us
566 /// enough time to broadcast and confirm a transaction, possibly with time in between to RBF
567 /// the spending transaction).
569 /// Default value: 72 (12 hours at an average of 6 blocks/hour).
570 /// Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
571 /// [`MIN_CLTV_EXPIRY_DELTA`] instead.
573 /// [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
575 pub extern "C" fn ChannelConfig_set_cltv_expiry_delta(this_ptr: &mut ChannelConfig, mut val: u16) {
576 unsafe { &mut *this_ptr.inner }.cltv_expiry_delta = val;
578 /// Set to announce the channel publicly and notify all nodes that they can route via this
581 /// This should only be set to true for nodes which expect to be online reliably.
583 /// As the node which funds a channel picks this value this will only apply for new outbound
584 /// channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
586 /// This cannot be changed after the initial channel handshake.
588 /// Default value: false.
590 pub extern "C" fn ChannelConfig_get_announced_channel(this_ptr: &ChannelConfig) -> bool {
591 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.announced_channel;
594 /// Set to announce the channel publicly and notify all nodes that they can route via this
597 /// This should only be set to true for nodes which expect to be online reliably.
599 /// As the node which funds a channel picks this value this will only apply for new outbound
600 /// channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
602 /// This cannot be changed after the initial channel handshake.
604 /// Default value: false.
606 pub extern "C" fn ChannelConfig_set_announced_channel(this_ptr: &mut ChannelConfig, mut val: bool) {
607 unsafe { &mut *this_ptr.inner }.announced_channel = val;
609 /// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
610 /// supports it, they will then enforce the mutual-close output to us matches what we provided
611 /// at intialization, preventing us from closing to an alternate pubkey.
613 /// This is set to true by default to provide a slight increase in security, though ultimately
614 /// any attacker who is able to take control of a channel can just as easily send the funds via
615 /// lightning payments, so we never require that our counterparties support this option.
617 /// This cannot be changed after a channel has been initialized.
619 /// Default value: true.
621 pub extern "C" fn ChannelConfig_get_commit_upfront_shutdown_pubkey(this_ptr: &ChannelConfig) -> bool {
622 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.commit_upfront_shutdown_pubkey;
625 /// When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
626 /// supports it, they will then enforce the mutual-close output to us matches what we provided
627 /// at intialization, preventing us from closing to an alternate pubkey.
629 /// This is set to true by default to provide a slight increase in security, though ultimately
630 /// any attacker who is able to take control of a channel can just as easily send the funds via
631 /// lightning payments, so we never require that our counterparties support this option.
633 /// This cannot be changed after a channel has been initialized.
635 /// Default value: true.
637 pub extern "C" fn ChannelConfig_set_commit_upfront_shutdown_pubkey(this_ptr: &mut ChannelConfig, mut val: bool) {
638 unsafe { &mut *this_ptr.inner }.commit_upfront_shutdown_pubkey = val;
640 /// Constructs a new ChannelConfig given each field
643 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) -> ChannelConfig {
644 ChannelConfig { inner: Box::into_raw(Box::new(nativeChannelConfig {
645 forwarding_fee_proportional_millionths: forwarding_fee_proportional_millionths_arg,
646 forwarding_fee_base_msat: forwarding_fee_base_msat_arg,
647 cltv_expiry_delta: cltv_expiry_delta_arg,
648 announced_channel: announced_channel_arg,
649 commit_upfront_shutdown_pubkey: commit_upfront_shutdown_pubkey_arg,
650 })), is_owned: true }
652 impl Clone for ChannelConfig {
653 fn clone(&self) -> Self {
655 inner: if <*mut nativeChannelConfig>::is_null(self.inner) { std::ptr::null_mut() } else {
656 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
662 /// Used only if an object of this type is returned as a trait impl by a method
663 pub(crate) extern "C" fn ChannelConfig_clone_void(this_ptr: *const c_void) -> *mut c_void {
664 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelConfig)).clone() })) as *mut c_void
667 /// Creates a copy of the ChannelConfig
668 pub extern "C" fn ChannelConfig_clone(orig: &ChannelConfig) -> ChannelConfig {
671 /// Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
674 pub extern "C" fn ChannelConfig_default() -> ChannelConfig {
675 ChannelConfig { inner: Box::into_raw(Box::new(Default::default())), is_owned: true }
678 /// Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read
679 pub extern "C" fn ChannelConfig_write(obj: &ChannelConfig) -> crate::c_types::derived::CVec_u8Z {
680 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
683 pub(crate) extern "C" fn ChannelConfig_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
684 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelConfig) })
687 /// Read a ChannelConfig from a byte array, created by ChannelConfig_write
688 pub extern "C" fn ChannelConfig_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelConfigDecodeErrorZ {
689 let res = crate::c_types::deserialize_obj(ser);
690 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::util::config::ChannelConfig { inner: Box::into_raw(Box::new(o)), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };
694 use lightning::util::config::UserConfig as nativeUserConfigImport;
695 type nativeUserConfig = nativeUserConfigImport;
697 /// Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
699 /// Default::default() provides sane defaults for most configurations
700 /// (but currently with 0 relay fees!)
703 pub struct UserConfig {
704 /// A pointer to the opaque Rust object.
706 /// Nearly everywhere, inner must be non-null, however in places where
707 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
708 pub inner: *mut nativeUserConfig,
709 /// Indicates that this is the only struct which contains the same pointer.
711 /// Rust functions which take ownership of an object provided via an argument require
712 /// this to be true and invalidate the object pointed to by inner.
716 impl Drop for UserConfig {
718 if self.is_owned && !<*mut nativeUserConfig>::is_null(self.inner) {
719 let _ = unsafe { Box::from_raw(self.inner) };
723 /// Frees any resources used by the UserConfig, if is_owned is set and inner is non-NULL.
725 pub extern "C" fn UserConfig_free(this_obj: UserConfig) { }
727 /// Used only if an object of this type is returned as a trait impl by a method
728 extern "C" fn UserConfig_free_void(this_ptr: *mut c_void) {
729 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeUserConfig); }
732 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
734 pub(crate) fn take_inner(mut self) -> *mut nativeUserConfig {
735 assert!(self.is_owned);
736 let ret = self.inner;
737 self.inner = std::ptr::null_mut();
741 /// Channel config that we propose to our counterparty.
743 pub extern "C" fn UserConfig_get_own_channel_config(this_ptr: &UserConfig) -> crate::lightning::util::config::ChannelHandshakeConfig {
744 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.own_channel_config;
745 crate::lightning::util::config::ChannelHandshakeConfig { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
747 /// Channel config that we propose to our counterparty.
749 pub extern "C" fn UserConfig_set_own_channel_config(this_ptr: &mut UserConfig, mut val: crate::lightning::util::config::ChannelHandshakeConfig) {
750 unsafe { &mut *this_ptr.inner }.own_channel_config = *unsafe { Box::from_raw(val.take_inner()) };
752 /// Limits applied to our counterparty's proposed channel config settings.
754 pub extern "C" fn UserConfig_get_peer_channel_config_limits(this_ptr: &UserConfig) -> crate::lightning::util::config::ChannelHandshakeLimits {
755 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.peer_channel_config_limits;
756 crate::lightning::util::config::ChannelHandshakeLimits { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
758 /// Limits applied to our counterparty's proposed channel config settings.
760 pub extern "C" fn UserConfig_set_peer_channel_config_limits(this_ptr: &mut UserConfig, mut val: crate::lightning::util::config::ChannelHandshakeLimits) {
761 unsafe { &mut *this_ptr.inner }.peer_channel_config_limits = *unsafe { Box::from_raw(val.take_inner()) };
763 /// Channel config which affects behavior during channel lifetime.
765 pub extern "C" fn UserConfig_get_channel_options(this_ptr: &UserConfig) -> crate::lightning::util::config::ChannelConfig {
766 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_options;
767 crate::lightning::util::config::ChannelConfig { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
769 /// Channel config which affects behavior during channel lifetime.
771 pub extern "C" fn UserConfig_set_channel_options(this_ptr: &mut UserConfig, mut val: crate::lightning::util::config::ChannelConfig) {
772 unsafe { &mut *this_ptr.inner }.channel_options = *unsafe { Box::from_raw(val.take_inner()) };
774 /// If this is set to false, we will reject any HTLCs which were to be forwarded over private
775 /// channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
776 /// node which is not online reliably.
778 /// For nodes which are not online reliably, you should set all channels to *not* be announced
779 /// (using [`ChannelConfig::announced_channel`] and
780 /// [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
781 /// ensure you are not exposed to any forwarding risk.
783 /// Note that because you cannot change a channel's announced state after creation, there is no
784 /// way to disable forwarding on public channels retroactively. Thus, in order to change a node
785 /// from a publicly-announced forwarding node to a private non-forwarding node you must close
786 /// all your channels and open new ones. For privacy, you should also change your node_id
787 /// (swapping all private and public key material for new ones) at that time.
789 /// Default value: false.
791 pub extern "C" fn UserConfig_get_accept_forwards_to_priv_channels(this_ptr: &UserConfig) -> bool {
792 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.accept_forwards_to_priv_channels;
795 /// If this is set to false, we will reject any HTLCs which were to be forwarded over private
796 /// channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
797 /// node which is not online reliably.
799 /// For nodes which are not online reliably, you should set all channels to *not* be announced
800 /// (using [`ChannelConfig::announced_channel`] and
801 /// [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
802 /// ensure you are not exposed to any forwarding risk.
804 /// Note that because you cannot change a channel's announced state after creation, there is no
805 /// way to disable forwarding on public channels retroactively. Thus, in order to change a node
806 /// from a publicly-announced forwarding node to a private non-forwarding node you must close
807 /// all your channels and open new ones. For privacy, you should also change your node_id
808 /// (swapping all private and public key material for new ones) at that time.
810 /// Default value: false.
812 pub extern "C" fn UserConfig_set_accept_forwards_to_priv_channels(this_ptr: &mut UserConfig, mut val: bool) {
813 unsafe { &mut *this_ptr.inner }.accept_forwards_to_priv_channels = val;
815 /// Constructs a new UserConfig given each field
818 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) -> UserConfig {
819 UserConfig { inner: Box::into_raw(Box::new(nativeUserConfig {
820 own_channel_config: *unsafe { Box::from_raw(own_channel_config_arg.take_inner()) },
821 peer_channel_config_limits: *unsafe { Box::from_raw(peer_channel_config_limits_arg.take_inner()) },
822 channel_options: *unsafe { Box::from_raw(channel_options_arg.take_inner()) },
823 accept_forwards_to_priv_channels: accept_forwards_to_priv_channels_arg,
824 })), is_owned: true }
826 impl Clone for UserConfig {
827 fn clone(&self) -> Self {
829 inner: if <*mut nativeUserConfig>::is_null(self.inner) { std::ptr::null_mut() } else {
830 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
836 /// Used only if an object of this type is returned as a trait impl by a method
837 pub(crate) extern "C" fn UserConfig_clone_void(this_ptr: *const c_void) -> *mut c_void {
838 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeUserConfig)).clone() })) as *mut c_void
841 /// Creates a copy of the UserConfig
842 pub extern "C" fn UserConfig_clone(orig: &UserConfig) -> UserConfig {
845 /// Creates a "default" UserConfig. See struct and individual field documentaiton for details on which values are used.
848 pub extern "C" fn UserConfig_default() -> UserConfig {
849 UserConfig { inner: Box::into_raw(Box::new(Default::default())), is_owned: true }