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 //! The top-level channel management and payment tracking stuff lives here.
11 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
12 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
13 //! upon reconnect to the relevant peer(s).
15 //! It does not manage routing logic (see routing::router::get_route for that) nor does it manage constructing
16 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
17 //! imply it needs to fail HTLCs/payments/channels it manages).
20 use std::str::FromStr;
22 use bitcoin::hashes::Hash;
23 use crate::c_types::*;
26 use lightning::ln::channelmanager::ChannelManager as nativeChannelManagerImport;
27 type nativeChannelManager = nativeChannelManagerImport<crate::lightning::chain::keysinterface::Sign, crate::lightning::chain::Watch, crate::lightning::chain::chaininterface::BroadcasterInterface, crate::lightning::chain::keysinterface::KeysInterface, crate::lightning::chain::chaininterface::FeeEstimator, crate::lightning::util::logger::Logger>;
29 /// Manager which keeps track of a number of channels and sends messages to the appropriate
30 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
32 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
33 /// to individual Channels.
35 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
36 /// all peers during write/read (though does not modify this instance, only the instance being
37 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
38 /// called funding_transaction_generated for outbound channels).
40 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
41 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
42 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
43 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
44 /// the serialization process). If the deserialized version is out-of-date compared to the
45 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
46 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
48 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
49 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
50 /// the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
51 /// block_connected() to step towards your best block) upon deserialization before using the
54 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
55 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
56 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
57 /// offline for a full minute. In order to track this, you must call
58 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
60 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
61 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
62 /// essentially you should default to using a SimpleRefChannelManager, and use a
63 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
64 /// you're using lightning-net-tokio.
67 pub struct ChannelManager {
68 /// A pointer to the opaque Rust object.
70 /// Nearly everywhere, inner must be non-null, however in places where
71 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
72 pub inner: *mut nativeChannelManager,
73 /// Indicates that this is the only struct which contains the same pointer.
75 /// Rust functions which take ownership of an object provided via an argument require
76 /// this to be true and invalidate the object pointed to by inner.
80 impl Drop for ChannelManager {
82 if self.is_owned && !<*mut nativeChannelManager>::is_null(self.inner) {
83 let _ = unsafe { Box::from_raw(self.inner) };
87 /// Frees any resources used by the ChannelManager, if is_owned is set and inner is non-NULL.
89 pub extern "C" fn ChannelManager_free(this_obj: ChannelManager) { }
91 /// Used only if an object of this type is returned as a trait impl by a method
92 extern "C" fn ChannelManager_free_void(this_ptr: *mut c_void) {
93 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelManager); }
96 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
98 pub(crate) fn take_inner(mut self) -> *mut nativeChannelManager {
99 assert!(self.is_owned);
100 let ret = self.inner;
101 self.inner = std::ptr::null_mut();
106 use lightning::ln::channelmanager::ChainParameters as nativeChainParametersImport;
107 type nativeChainParameters = nativeChainParametersImport;
109 /// Chain-related parameters used to construct a new `ChannelManager`.
111 /// Typically, the block-specific parameters are derived from the best block hash for the network,
112 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
113 /// are not needed when deserializing a previously constructed `ChannelManager`.
116 pub struct ChainParameters {
117 /// A pointer to the opaque Rust object.
119 /// Nearly everywhere, inner must be non-null, however in places where
120 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
121 pub inner: *mut nativeChainParameters,
122 /// Indicates that this is the only struct which contains the same pointer.
124 /// Rust functions which take ownership of an object provided via an argument require
125 /// this to be true and invalidate the object pointed to by inner.
129 impl Drop for ChainParameters {
131 if self.is_owned && !<*mut nativeChainParameters>::is_null(self.inner) {
132 let _ = unsafe { Box::from_raw(self.inner) };
136 /// Frees any resources used by the ChainParameters, if is_owned is set and inner is non-NULL.
138 pub extern "C" fn ChainParameters_free(this_obj: ChainParameters) { }
140 /// Used only if an object of this type is returned as a trait impl by a method
141 extern "C" fn ChainParameters_free_void(this_ptr: *mut c_void) {
142 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChainParameters); }
145 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
146 impl ChainParameters {
147 pub(crate) fn take_inner(mut self) -> *mut nativeChainParameters {
148 assert!(self.is_owned);
149 let ret = self.inner;
150 self.inner = std::ptr::null_mut();
154 /// The network for determining the `chain_hash` in Lightning messages.
156 pub extern "C" fn ChainParameters_get_network(this_ptr: &ChainParameters) -> crate::bitcoin::network::Network {
157 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.network;
158 crate::bitcoin::network::Network::from_bitcoin(inner_val)
160 /// The network for determining the `chain_hash` in Lightning messages.
162 pub extern "C" fn ChainParameters_set_network(this_ptr: &mut ChainParameters, mut val: crate::bitcoin::network::Network) {
163 unsafe { &mut *this_ptr.inner }.network = val.into_bitcoin();
165 /// The hash and height of the latest block successfully connected.
167 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
169 pub extern "C" fn ChainParameters_get_best_block(this_ptr: &ChainParameters) -> crate::lightning::chain::BestBlock {
170 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.best_block;
171 crate::lightning::chain::BestBlock { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
173 /// The hash and height of the latest block successfully connected.
175 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
177 pub extern "C" fn ChainParameters_set_best_block(this_ptr: &mut ChainParameters, mut val: crate::lightning::chain::BestBlock) {
178 unsafe { &mut *this_ptr.inner }.best_block = *unsafe { Box::from_raw(val.take_inner()) };
180 /// Constructs a new ChainParameters given each field
183 pub extern "C" fn ChainParameters_new(mut network_arg: crate::bitcoin::network::Network, mut best_block_arg: crate::lightning::chain::BestBlock) -> ChainParameters {
184 ChainParameters { inner: Box::into_raw(Box::new(nativeChainParameters {
185 network: network_arg.into_bitcoin(),
186 best_block: *unsafe { Box::from_raw(best_block_arg.take_inner()) },
187 })), is_owned: true }
189 impl Clone for ChainParameters {
190 fn clone(&self) -> Self {
192 inner: if <*mut nativeChainParameters>::is_null(self.inner) { std::ptr::null_mut() } else {
193 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
199 /// Used only if an object of this type is returned as a trait impl by a method
200 pub(crate) extern "C" fn ChainParameters_clone_void(this_ptr: *const c_void) -> *mut c_void {
201 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChainParameters)).clone() })) as *mut c_void
204 /// Creates a copy of the ChainParameters
205 pub extern "C" fn ChainParameters_clone(orig: &ChainParameters) -> ChainParameters {
208 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
209 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
211 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
213 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
216 pub static BREAKDOWN_TIMEOUT: u16 = lightning::ln::channelmanager::BREAKDOWN_TIMEOUT;
217 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
218 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
220 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
222 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
225 pub static MIN_CLTV_EXPIRY_DELTA: u16 = lightning::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA;
226 /// Minimum CLTV difference between the current block height and received inbound payments.
227 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
231 pub static MIN_FINAL_CLTV_EXPIRY: u32 = lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY;
233 use lightning::ln::channelmanager::ChannelCounterparty as nativeChannelCounterpartyImport;
234 type nativeChannelCounterparty = nativeChannelCounterpartyImport;
236 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
237 /// to better separate parameters.
240 pub struct ChannelCounterparty {
241 /// A pointer to the opaque Rust object.
243 /// Nearly everywhere, inner must be non-null, however in places where
244 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
245 pub inner: *mut nativeChannelCounterparty,
246 /// Indicates that this is the only struct which contains the same pointer.
248 /// Rust functions which take ownership of an object provided via an argument require
249 /// this to be true and invalidate the object pointed to by inner.
253 impl Drop for ChannelCounterparty {
255 if self.is_owned && !<*mut nativeChannelCounterparty>::is_null(self.inner) {
256 let _ = unsafe { Box::from_raw(self.inner) };
260 /// Frees any resources used by the ChannelCounterparty, if is_owned is set and inner is non-NULL.
262 pub extern "C" fn ChannelCounterparty_free(this_obj: ChannelCounterparty) { }
264 /// Used only if an object of this type is returned as a trait impl by a method
265 extern "C" fn ChannelCounterparty_free_void(this_ptr: *mut c_void) {
266 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelCounterparty); }
269 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
270 impl ChannelCounterparty {
271 pub(crate) fn take_inner(mut self) -> *mut nativeChannelCounterparty {
272 assert!(self.is_owned);
273 let ret = self.inner;
274 self.inner = std::ptr::null_mut();
278 /// The node_id of our counterparty
280 pub extern "C" fn ChannelCounterparty_get_node_id(this_ptr: &ChannelCounterparty) -> crate::c_types::PublicKey {
281 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.node_id;
282 crate::c_types::PublicKey::from_rust(&inner_val)
284 /// The node_id of our counterparty
286 pub extern "C" fn ChannelCounterparty_set_node_id(this_ptr: &mut ChannelCounterparty, mut val: crate::c_types::PublicKey) {
287 unsafe { &mut *this_ptr.inner }.node_id = val.into_rust();
289 /// The Features the channel counterparty provided upon last connection.
290 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
291 /// many routing-relevant features are present in the init context.
293 pub extern "C" fn ChannelCounterparty_get_features(this_ptr: &ChannelCounterparty) -> crate::lightning::ln::features::InitFeatures {
294 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.features;
295 crate::lightning::ln::features::InitFeatures { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
297 /// The Features the channel counterparty provided upon last connection.
298 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
299 /// many routing-relevant features are present in the init context.
301 pub extern "C" fn ChannelCounterparty_set_features(this_ptr: &mut ChannelCounterparty, mut val: crate::lightning::ln::features::InitFeatures) {
302 unsafe { &mut *this_ptr.inner }.features = *unsafe { Box::from_raw(val.take_inner()) };
304 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
305 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
306 /// claiming at least this value on chain.
308 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
310 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
312 pub extern "C" fn ChannelCounterparty_get_unspendable_punishment_reserve(this_ptr: &ChannelCounterparty) -> u64 {
313 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.unspendable_punishment_reserve;
316 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
317 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
318 /// claiming at least this value on chain.
320 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
322 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
324 pub extern "C" fn ChannelCounterparty_set_unspendable_punishment_reserve(this_ptr: &mut ChannelCounterparty, mut val: u64) {
325 unsafe { &mut *this_ptr.inner }.unspendable_punishment_reserve = val;
327 impl Clone for ChannelCounterparty {
328 fn clone(&self) -> Self {
330 inner: if <*mut nativeChannelCounterparty>::is_null(self.inner) { std::ptr::null_mut() } else {
331 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
337 /// Used only if an object of this type is returned as a trait impl by a method
338 pub(crate) extern "C" fn ChannelCounterparty_clone_void(this_ptr: *const c_void) -> *mut c_void {
339 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelCounterparty)).clone() })) as *mut c_void
342 /// Creates a copy of the ChannelCounterparty
343 pub extern "C" fn ChannelCounterparty_clone(orig: &ChannelCounterparty) -> ChannelCounterparty {
347 use lightning::ln::channelmanager::ChannelDetails as nativeChannelDetailsImport;
348 type nativeChannelDetails = nativeChannelDetailsImport;
350 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
353 pub struct ChannelDetails {
354 /// A pointer to the opaque Rust object.
356 /// Nearly everywhere, inner must be non-null, however in places where
357 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
358 pub inner: *mut nativeChannelDetails,
359 /// Indicates that this is the only struct which contains the same pointer.
361 /// Rust functions which take ownership of an object provided via an argument require
362 /// this to be true and invalidate the object pointed to by inner.
366 impl Drop for ChannelDetails {
368 if self.is_owned && !<*mut nativeChannelDetails>::is_null(self.inner) {
369 let _ = unsafe { Box::from_raw(self.inner) };
373 /// Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL.
375 pub extern "C" fn ChannelDetails_free(this_obj: ChannelDetails) { }
377 /// Used only if an object of this type is returned as a trait impl by a method
378 extern "C" fn ChannelDetails_free_void(this_ptr: *mut c_void) {
379 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelDetails); }
382 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
383 impl ChannelDetails {
384 pub(crate) fn take_inner(mut self) -> *mut nativeChannelDetails {
385 assert!(self.is_owned);
386 let ret = self.inner;
387 self.inner = std::ptr::null_mut();
391 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
392 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
393 /// Note that this means this value is *not* persistent - it can change once during the
394 /// lifetime of the channel.
396 pub extern "C" fn ChannelDetails_get_channel_id(this_ptr: &ChannelDetails) -> *const [u8; 32] {
397 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_id;
400 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
401 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
402 /// Note that this means this value is *not* persistent - it can change once during the
403 /// lifetime of the channel.
405 pub extern "C" fn ChannelDetails_set_channel_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::ThirtyTwoBytes) {
406 unsafe { &mut *this_ptr.inner }.channel_id = val.data;
408 /// Parameters which apply to our counterparty. See individual fields for more information.
410 pub extern "C" fn ChannelDetails_get_counterparty(this_ptr: &ChannelDetails) -> crate::lightning::ln::channelmanager::ChannelCounterparty {
411 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.counterparty;
412 crate::lightning::ln::channelmanager::ChannelCounterparty { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
414 /// Parameters which apply to our counterparty. See individual fields for more information.
416 pub extern "C" fn ChannelDetails_set_counterparty(this_ptr: &mut ChannelDetails, mut val: crate::lightning::ln::channelmanager::ChannelCounterparty) {
417 unsafe { &mut *this_ptr.inner }.counterparty = *unsafe { Box::from_raw(val.take_inner()) };
419 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
420 /// our counterparty already.
422 /// Note that, if this has been set, `channel_id` will be equivalent to
423 /// `funding_txo.unwrap().to_channel_id()`.
425 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
427 pub extern "C" fn ChannelDetails_get_funding_txo(this_ptr: &ChannelDetails) -> crate::lightning::chain::transaction::OutPoint {
428 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.funding_txo;
429 let mut local_inner_val = crate::lightning::chain::transaction::OutPoint { inner: unsafe { (if inner_val.is_none() { std::ptr::null() } else { { (inner_val.as_ref().unwrap()) } } as *const _) as *mut _ }, is_owned: false };
432 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
433 /// our counterparty already.
435 /// Note that, if this has been set, `channel_id` will be equivalent to
436 /// `funding_txo.unwrap().to_channel_id()`.
438 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
440 pub extern "C" fn ChannelDetails_set_funding_txo(this_ptr: &mut ChannelDetails, mut val: crate::lightning::chain::transaction::OutPoint) {
441 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
442 unsafe { &mut *this_ptr.inner }.funding_txo = local_val;
444 /// The position of the funding transaction in the chain. None if the funding transaction has
445 /// not yet been confirmed and the channel fully opened.
447 pub extern "C" fn ChannelDetails_get_short_channel_id(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u64Z {
448 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.short_channel_id;
449 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u64Z::None } else { { crate::c_types::derived::COption_u64Z::Some(inner_val.unwrap()) } };
452 /// The position of the funding transaction in the chain. None if the funding transaction has
453 /// not yet been confirmed and the channel fully opened.
455 pub extern "C" fn ChannelDetails_set_short_channel_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u64Z) {
456 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
457 unsafe { &mut *this_ptr.inner }.short_channel_id = local_val;
459 /// The value, in satoshis, of this channel as appears in the funding output
461 pub extern "C" fn ChannelDetails_get_channel_value_satoshis(this_ptr: &ChannelDetails) -> u64 {
462 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_value_satoshis;
465 /// The value, in satoshis, of this channel as appears in the funding output
467 pub extern "C" fn ChannelDetails_set_channel_value_satoshis(this_ptr: &mut ChannelDetails, mut val: u64) {
468 unsafe { &mut *this_ptr.inner }.channel_value_satoshis = val;
470 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
471 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
472 /// this value on chain.
474 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
476 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
478 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
480 pub extern "C" fn ChannelDetails_get_unspendable_punishment_reserve(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u64Z {
481 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.unspendable_punishment_reserve;
482 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u64Z::None } else { { crate::c_types::derived::COption_u64Z::Some(inner_val.unwrap()) } };
485 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
486 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
487 /// this value on chain.
489 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
491 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
493 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
495 pub extern "C" fn ChannelDetails_set_unspendable_punishment_reserve(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u64Z) {
496 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
497 unsafe { &mut *this_ptr.inner }.unspendable_punishment_reserve = local_val;
499 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
501 pub extern "C" fn ChannelDetails_get_user_id(this_ptr: &ChannelDetails) -> u64 {
502 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.user_id;
505 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
507 pub extern "C" fn ChannelDetails_set_user_id(this_ptr: &mut ChannelDetails, mut val: u64) {
508 unsafe { &mut *this_ptr.inner }.user_id = val;
510 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
511 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
512 /// available for inclusion in new outbound HTLCs). This further does not include any pending
513 /// outgoing HTLCs which are awaiting some other resolution to be sent.
515 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
516 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
517 /// should be able to spend nearly this amount.
519 pub extern "C" fn ChannelDetails_get_outbound_capacity_msat(this_ptr: &ChannelDetails) -> u64 {
520 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.outbound_capacity_msat;
523 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
524 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
525 /// available for inclusion in new outbound HTLCs). This further does not include any pending
526 /// outgoing HTLCs which are awaiting some other resolution to be sent.
528 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
529 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
530 /// should be able to spend nearly this amount.
532 pub extern "C" fn ChannelDetails_set_outbound_capacity_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
533 unsafe { &mut *this_ptr.inner }.outbound_capacity_msat = val;
535 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
536 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
537 /// available for inclusion in new inbound HTLCs).
538 /// Note that there are some corner cases not fully handled here, so the actual available
539 /// inbound capacity may be slightly higher than this.
541 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
542 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
543 /// However, our counterparty should be able to spend nearly this amount.
545 pub extern "C" fn ChannelDetails_get_inbound_capacity_msat(this_ptr: &ChannelDetails) -> u64 {
546 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.inbound_capacity_msat;
549 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
550 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
551 /// available for inclusion in new inbound HTLCs).
552 /// Note that there are some corner cases not fully handled here, so the actual available
553 /// inbound capacity may be slightly higher than this.
555 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
556 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
557 /// However, our counterparty should be able to spend nearly this amount.
559 pub extern "C" fn ChannelDetails_set_inbound_capacity_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
560 unsafe { &mut *this_ptr.inner }.inbound_capacity_msat = val;
562 /// The number of required confirmations on the funding transaction before the funding will be
563 /// considered \"locked\". This number is selected by the channel fundee (i.e. us if
564 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
565 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
566 /// [`ChannelHandshakeLimits::max_minimum_depth`].
568 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
570 /// [`is_outbound`]: ChannelDetails::is_outbound
571 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
572 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
574 pub extern "C" fn ChannelDetails_get_confirmations_required(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u32Z {
575 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.confirmations_required;
576 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u32Z::None } else { { crate::c_types::derived::COption_u32Z::Some(inner_val.unwrap()) } };
579 /// The number of required confirmations on the funding transaction before the funding will be
580 /// considered \"locked\". This number is selected by the channel fundee (i.e. us if
581 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
582 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
583 /// [`ChannelHandshakeLimits::max_minimum_depth`].
585 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
587 /// [`is_outbound`]: ChannelDetails::is_outbound
588 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
589 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
591 pub extern "C" fn ChannelDetails_set_confirmations_required(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u32Z) {
592 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
593 unsafe { &mut *this_ptr.inner }.confirmations_required = local_val;
595 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
596 /// until we can claim our funds after we force-close the channel. During this time our
597 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
598 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
599 /// time to claim our non-HTLC-encumbered funds.
601 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
603 pub extern "C" fn ChannelDetails_get_force_close_spend_delay(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u16Z {
604 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.force_close_spend_delay;
605 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u16Z::None } else { { crate::c_types::derived::COption_u16Z::Some(inner_val.unwrap()) } };
608 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
609 /// until we can claim our funds after we force-close the channel. During this time our
610 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
611 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
612 /// time to claim our non-HTLC-encumbered funds.
614 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
616 pub extern "C" fn ChannelDetails_set_force_close_spend_delay(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u16Z) {
617 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
618 unsafe { &mut *this_ptr.inner }.force_close_spend_delay = local_val;
620 /// True if the channel was initiated (and thus funded) by us.
622 pub extern "C" fn ChannelDetails_get_is_outbound(this_ptr: &ChannelDetails) -> bool {
623 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.is_outbound;
626 /// True if the channel was initiated (and thus funded) by us.
628 pub extern "C" fn ChannelDetails_set_is_outbound(this_ptr: &mut ChannelDetails, mut val: bool) {
629 unsafe { &mut *this_ptr.inner }.is_outbound = val;
631 /// True if the channel is confirmed, funding_locked messages have been exchanged, and the
632 /// channel is not currently being shut down. `funding_locked` message exchange implies the
633 /// required confirmation count has been reached (and we were connected to the peer at some
634 /// point after the funding transaction received enough confirmations). The required
635 /// confirmation count is provided in [`confirmations_required`].
637 /// [`confirmations_required`]: ChannelDetails::confirmations_required
639 pub extern "C" fn ChannelDetails_get_is_funding_locked(this_ptr: &ChannelDetails) -> bool {
640 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.is_funding_locked;
643 /// True if the channel is confirmed, funding_locked messages have been exchanged, and the
644 /// channel is not currently being shut down. `funding_locked` message exchange implies the
645 /// required confirmation count has been reached (and we were connected to the peer at some
646 /// point after the funding transaction received enough confirmations). The required
647 /// confirmation count is provided in [`confirmations_required`].
649 /// [`confirmations_required`]: ChannelDetails::confirmations_required
651 pub extern "C" fn ChannelDetails_set_is_funding_locked(this_ptr: &mut ChannelDetails, mut val: bool) {
652 unsafe { &mut *this_ptr.inner }.is_funding_locked = val;
654 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
655 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
657 /// This is a strict superset of `is_funding_locked`.
659 pub extern "C" fn ChannelDetails_get_is_usable(this_ptr: &ChannelDetails) -> bool {
660 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.is_usable;
663 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
664 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
666 /// This is a strict superset of `is_funding_locked`.
668 pub extern "C" fn ChannelDetails_set_is_usable(this_ptr: &mut ChannelDetails, mut val: bool) {
669 unsafe { &mut *this_ptr.inner }.is_usable = val;
671 /// True if this channel is (or will be) publicly-announced.
673 pub extern "C" fn ChannelDetails_get_is_public(this_ptr: &ChannelDetails) -> bool {
674 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.is_public;
677 /// True if this channel is (or will be) publicly-announced.
679 pub extern "C" fn ChannelDetails_set_is_public(this_ptr: &mut ChannelDetails, mut val: bool) {
680 unsafe { &mut *this_ptr.inner }.is_public = val;
682 /// Constructs a new ChannelDetails given each field
685 pub extern "C" fn ChannelDetails_new(mut channel_id_arg: crate::c_types::ThirtyTwoBytes, mut counterparty_arg: crate::lightning::ln::channelmanager::ChannelCounterparty, mut funding_txo_arg: crate::lightning::chain::transaction::OutPoint, mut short_channel_id_arg: crate::c_types::derived::COption_u64Z, mut channel_value_satoshis_arg: u64, mut unspendable_punishment_reserve_arg: crate::c_types::derived::COption_u64Z, mut user_id_arg: u64, mut outbound_capacity_msat_arg: u64, mut inbound_capacity_msat_arg: u64, mut confirmations_required_arg: crate::c_types::derived::COption_u32Z, mut force_close_spend_delay_arg: crate::c_types::derived::COption_u16Z, mut is_outbound_arg: bool, mut is_funding_locked_arg: bool, mut is_usable_arg: bool, mut is_public_arg: bool) -> ChannelDetails {
686 let mut local_funding_txo_arg = if funding_txo_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(funding_txo_arg.take_inner()) } }) };
687 let mut local_short_channel_id_arg = if short_channel_id_arg.is_some() { Some( { short_channel_id_arg.take() }) } else { None };
688 let mut local_unspendable_punishment_reserve_arg = if unspendable_punishment_reserve_arg.is_some() { Some( { unspendable_punishment_reserve_arg.take() }) } else { None };
689 let mut local_confirmations_required_arg = if confirmations_required_arg.is_some() { Some( { confirmations_required_arg.take() }) } else { None };
690 let mut local_force_close_spend_delay_arg = if force_close_spend_delay_arg.is_some() { Some( { force_close_spend_delay_arg.take() }) } else { None };
691 ChannelDetails { inner: Box::into_raw(Box::new(nativeChannelDetails {
692 channel_id: channel_id_arg.data,
693 counterparty: *unsafe { Box::from_raw(counterparty_arg.take_inner()) },
694 funding_txo: local_funding_txo_arg,
695 short_channel_id: local_short_channel_id_arg,
696 channel_value_satoshis: channel_value_satoshis_arg,
697 unspendable_punishment_reserve: local_unspendable_punishment_reserve_arg,
698 user_id: user_id_arg,
699 outbound_capacity_msat: outbound_capacity_msat_arg,
700 inbound_capacity_msat: inbound_capacity_msat_arg,
701 confirmations_required: local_confirmations_required_arg,
702 force_close_spend_delay: local_force_close_spend_delay_arg,
703 is_outbound: is_outbound_arg,
704 is_funding_locked: is_funding_locked_arg,
705 is_usable: is_usable_arg,
706 is_public: is_public_arg,
707 })), is_owned: true }
709 impl Clone for ChannelDetails {
710 fn clone(&self) -> Self {
712 inner: if <*mut nativeChannelDetails>::is_null(self.inner) { std::ptr::null_mut() } else {
713 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
719 /// Used only if an object of this type is returned as a trait impl by a method
720 pub(crate) extern "C" fn ChannelDetails_clone_void(this_ptr: *const c_void) -> *mut c_void {
721 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelDetails)).clone() })) as *mut c_void
724 /// Creates a copy of the ChannelDetails
725 pub extern "C" fn ChannelDetails_clone(orig: &ChannelDetails) -> ChannelDetails {
728 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
729 /// Err() type describing which state the payment is in, see the description of individual enum
734 pub enum PaymentSendFailure {
735 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
736 /// send the payment at all. No channel state has been changed or messages sent to peers, and
737 /// once you've changed the parameter at error, you can freely retry the payment in full.
738 ParameterError(crate::lightning::util::errors::APIError),
739 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
740 /// from attempting to send the payment at all. No channel state has been changed or messages
741 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
744 /// The results here are ordered the same as the paths in the route object which was passed to
746 PathParameterError(crate::c_types::derived::CVec_CResult_NoneAPIErrorZZ),
747 /// All paths which were attempted failed to send, with no channel state change taking place.
748 /// You can freely retry the payment in full (though you probably want to do so over different
749 /// paths than the ones selected).
750 AllFailedRetrySafe(crate::c_types::derived::CVec_APIErrorZ),
751 /// Some paths which were attempted failed to send, though possibly not all. At least some
752 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
753 /// in over-/re-payment.
755 /// The results here are ordered the same as the paths in the route object which was passed to
756 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
757 /// retried (though there is currently no API with which to do so).
759 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
760 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
761 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
762 /// with the latest update_id.
763 PartialFailure(crate::c_types::derived::CVec_CResult_NoneAPIErrorZZ),
765 use lightning::ln::channelmanager::PaymentSendFailure as nativePaymentSendFailure;
766 impl PaymentSendFailure {
768 pub(crate) fn to_native(&self) -> nativePaymentSendFailure {
770 PaymentSendFailure::ParameterError (ref a, ) => {
771 let mut a_nonref = (*a).clone();
772 nativePaymentSendFailure::ParameterError (
773 a_nonref.into_native(),
776 PaymentSendFailure::PathParameterError (ref a, ) => {
777 let mut a_nonref = (*a).clone();
778 let mut local_a_nonref = Vec::new(); for mut item in a_nonref.into_rust().drain(..) { local_a_nonref.push( { let mut local_a_nonref_0 = match item.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut item.contents.result)) })*/ }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut item.contents.err)) }).into_native() })}; local_a_nonref_0 }); };
779 nativePaymentSendFailure::PathParameterError (
783 PaymentSendFailure::AllFailedRetrySafe (ref a, ) => {
784 let mut a_nonref = (*a).clone();
785 let mut local_a_nonref = Vec::new(); for mut item in a_nonref.into_rust().drain(..) { local_a_nonref.push( { item.into_native() }); };
786 nativePaymentSendFailure::AllFailedRetrySafe (
790 PaymentSendFailure::PartialFailure (ref a, ) => {
791 let mut a_nonref = (*a).clone();
792 let mut local_a_nonref = Vec::new(); for mut item in a_nonref.into_rust().drain(..) { local_a_nonref.push( { let mut local_a_nonref_0 = match item.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut item.contents.result)) })*/ }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut item.contents.err)) }).into_native() })}; local_a_nonref_0 }); };
793 nativePaymentSendFailure::PartialFailure (
800 pub(crate) fn into_native(self) -> nativePaymentSendFailure {
802 PaymentSendFailure::ParameterError (mut a, ) => {
803 nativePaymentSendFailure::ParameterError (
807 PaymentSendFailure::PathParameterError (mut a, ) => {
808 let mut local_a = Vec::new(); for mut item in a.into_rust().drain(..) { local_a.push( { let mut local_a_0 = match item.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut item.contents.result)) })*/ }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut item.contents.err)) }).into_native() })}; local_a_0 }); };
809 nativePaymentSendFailure::PathParameterError (
813 PaymentSendFailure::AllFailedRetrySafe (mut a, ) => {
814 let mut local_a = Vec::new(); for mut item in a.into_rust().drain(..) { local_a.push( { item.into_native() }); };
815 nativePaymentSendFailure::AllFailedRetrySafe (
819 PaymentSendFailure::PartialFailure (mut a, ) => {
820 let mut local_a = Vec::new(); for mut item in a.into_rust().drain(..) { local_a.push( { let mut local_a_0 = match item.result_ok { true => Ok( { () /*(*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut item.contents.result)) })*/ }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut item.contents.err)) }).into_native() })}; local_a_0 }); };
821 nativePaymentSendFailure::PartialFailure (
828 pub(crate) fn from_native(native: &nativePaymentSendFailure) -> Self {
830 nativePaymentSendFailure::ParameterError (ref a, ) => {
831 let mut a_nonref = (*a).clone();
832 PaymentSendFailure::ParameterError (
833 crate::lightning::util::errors::APIError::native_into(a_nonref),
836 nativePaymentSendFailure::PathParameterError (ref a, ) => {
837 let mut a_nonref = (*a).clone();
838 let mut local_a_nonref = Vec::new(); for mut item in a_nonref.drain(..) { local_a_nonref.push( { let mut local_a_nonref_0 = match item { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() }; local_a_nonref_0 }); };
839 PaymentSendFailure::PathParameterError (
840 local_a_nonref.into(),
843 nativePaymentSendFailure::AllFailedRetrySafe (ref a, ) => {
844 let mut a_nonref = (*a).clone();
845 let mut local_a_nonref = Vec::new(); for mut item in a_nonref.drain(..) { local_a_nonref.push( { crate::lightning::util::errors::APIError::native_into(item) }); };
846 PaymentSendFailure::AllFailedRetrySafe (
847 local_a_nonref.into(),
850 nativePaymentSendFailure::PartialFailure (ref a, ) => {
851 let mut a_nonref = (*a).clone();
852 let mut local_a_nonref = Vec::new(); for mut item in a_nonref.drain(..) { local_a_nonref.push( { let mut local_a_nonref_0 = match item { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() }; local_a_nonref_0 }); };
853 PaymentSendFailure::PartialFailure (
854 local_a_nonref.into(),
860 pub(crate) fn native_into(native: nativePaymentSendFailure) -> Self {
862 nativePaymentSendFailure::ParameterError (mut a, ) => {
863 PaymentSendFailure::ParameterError (
864 crate::lightning::util::errors::APIError::native_into(a),
867 nativePaymentSendFailure::PathParameterError (mut a, ) => {
868 let mut local_a = Vec::new(); for mut item in a.drain(..) { local_a.push( { let mut local_a_0 = match item { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() }; local_a_0 }); };
869 PaymentSendFailure::PathParameterError (
873 nativePaymentSendFailure::AllFailedRetrySafe (mut a, ) => {
874 let mut local_a = Vec::new(); for mut item in a.drain(..) { local_a.push( { crate::lightning::util::errors::APIError::native_into(item) }); };
875 PaymentSendFailure::AllFailedRetrySafe (
879 nativePaymentSendFailure::PartialFailure (mut a, ) => {
880 let mut local_a = Vec::new(); for mut item in a.drain(..) { local_a.push( { let mut local_a_0 = match item { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() }; local_a_0 }); };
881 PaymentSendFailure::PartialFailure (
888 /// Frees any resources used by the PaymentSendFailure
890 pub extern "C" fn PaymentSendFailure_free(this_ptr: PaymentSendFailure) { }
891 /// Creates a copy of the PaymentSendFailure
893 pub extern "C" fn PaymentSendFailure_clone(orig: &PaymentSendFailure) -> PaymentSendFailure {
897 /// Utility method to constructs a new ParameterError-variant PaymentSendFailure
898 pub extern "C" fn PaymentSendFailure_parameter_error(a: crate::lightning::util::errors::APIError) -> PaymentSendFailure {
899 PaymentSendFailure::ParameterError(a, )
902 /// Utility method to constructs a new PathParameterError-variant PaymentSendFailure
903 pub extern "C" fn PaymentSendFailure_path_parameter_error(a: crate::c_types::derived::CVec_CResult_NoneAPIErrorZZ) -> PaymentSendFailure {
904 PaymentSendFailure::PathParameterError(a, )
907 /// Utility method to constructs a new AllFailedRetrySafe-variant PaymentSendFailure
908 pub extern "C" fn PaymentSendFailure_all_failed_retry_safe(a: crate::c_types::derived::CVec_APIErrorZ) -> PaymentSendFailure {
909 PaymentSendFailure::AllFailedRetrySafe(a, )
912 /// Utility method to constructs a new PartialFailure-variant PaymentSendFailure
913 pub extern "C" fn PaymentSendFailure_partial_failure(a: crate::c_types::derived::CVec_CResult_NoneAPIErrorZZ) -> PaymentSendFailure {
914 PaymentSendFailure::PartialFailure(a, )
916 /// Constructs a new ChannelManager to hold several channels and route between them.
918 /// This is the main \"logic hub\" for all channel-related actions, and implements
919 /// ChannelMessageHandler.
921 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
923 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
925 /// Users need to notify the new ChannelManager when a new block is connected or
926 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
927 /// from after `params.latest_hash`.
930 pub extern "C" fn ChannelManager_new(mut fee_est: crate::lightning::chain::chaininterface::FeeEstimator, mut chain_monitor: crate::lightning::chain::Watch, mut tx_broadcaster: crate::lightning::chain::chaininterface::BroadcasterInterface, mut logger: crate::lightning::util::logger::Logger, mut keys_manager: crate::lightning::chain::keysinterface::KeysInterface, mut config: crate::lightning::util::config::UserConfig, mut params: crate::lightning::ln::channelmanager::ChainParameters) -> ChannelManager {
931 let mut ret = lightning::ln::channelmanager::ChannelManager::new(fee_est, chain_monitor, tx_broadcaster, logger, keys_manager, *unsafe { Box::from_raw(config.take_inner()) }, *unsafe { Box::from_raw(params.take_inner()) });
932 ChannelManager { inner: Box::into_raw(Box::new(ret)), is_owned: true }
935 /// Gets the current configuration applied to all new channels, as
938 pub extern "C" fn ChannelManager_get_current_default_configuration(this_arg: &ChannelManager) -> crate::lightning::util::config::UserConfig {
939 let mut ret = unsafe { &*this_arg.inner }.get_current_default_configuration();
940 crate::lightning::util::config::UserConfig { inner: unsafe { ( (&(*ret) as *const _) as *mut _) }, is_owned: false }
943 /// Creates a new outbound channel to the given remote node and with the given value.
945 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
946 /// tracking of which events correspond with which create_channel call. Note that the
947 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
948 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
949 /// otherwise ignored.
951 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
952 /// PeerManager::process_events afterwards.
954 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
955 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
957 /// Note that we do not check if you are currently connected to the given peer. If no
958 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
959 /// the channel eventually being silently forgotten.
961 /// Note that override_config (or a relevant inner pointer) may be NULL or all-0s to represent None
964 pub extern "C" fn ChannelManager_create_channel(this_arg: &ChannelManager, mut their_network_key: crate::c_types::PublicKey, mut channel_value_satoshis: u64, mut push_msat: u64, mut user_id: u64, mut override_config: crate::lightning::util::config::UserConfig) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
965 let mut local_override_config = if override_config.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(override_config.take_inner()) } }) };
966 let mut ret = unsafe { &*this_arg.inner }.create_channel(their_network_key.into_rust(), channel_value_satoshis, push_msat, user_id, local_override_config);
967 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() };
971 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
972 /// more information.
975 pub extern "C" fn ChannelManager_list_channels(this_arg: &ChannelManager) -> crate::c_types::derived::CVec_ChannelDetailsZ {
976 let mut ret = unsafe { &*this_arg.inner }.list_channels();
977 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::ln::channelmanager::ChannelDetails { inner: Box::into_raw(Box::new(item)), is_owned: true } }); };
981 /// Gets the list of usable channels, in random order. Useful as an argument to
982 /// get_route to ensure non-announced channels are used.
984 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
985 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
989 pub extern "C" fn ChannelManager_list_usable_channels(this_arg: &ChannelManager) -> crate::c_types::derived::CVec_ChannelDetailsZ {
990 let mut ret = unsafe { &*this_arg.inner }.list_usable_channels();
991 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::ln::channelmanager::ChannelDetails { inner: Box::into_raw(Box::new(item)), is_owned: true } }); };
995 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
996 /// will be accepted on the given channel, and after additional timeout/the closing of all
997 /// pending HTLCs, the channel will be closed on chain.
999 /// May generate a SendShutdown message event on success, which should be relayed.
1002 pub extern "C" fn ChannelManager_close_channel(this_arg: &ChannelManager, channel_id: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
1003 let mut ret = unsafe { &*this_arg.inner }.close_channel(unsafe { &*channel_id});
1004 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() };
1008 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
1009 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
1012 pub extern "C" fn ChannelManager_force_close_channel(this_arg: &ChannelManager, channel_id: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
1013 let mut ret = unsafe { &*this_arg.inner }.force_close_channel(unsafe { &*channel_id});
1014 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() };
1018 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1019 /// for each to the chain and rejecting new HTLCs on each.
1021 pub extern "C" fn ChannelManager_force_close_all_channels(this_arg: &ChannelManager) {
1022 unsafe { &*this_arg.inner }.force_close_all_channels()
1025 /// Sends a payment along a given route.
1027 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1028 /// fields for more info.
1030 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1031 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1032 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1033 /// specified in the last hop in the route! Thus, you should probably do your own
1034 /// payment_preimage tracking (which you should already be doing as they represent \"proof of
1035 /// payment\") and prevent double-sends yourself.
1037 /// May generate SendHTLCs message(s) event on success, which should be relayed.
1039 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
1040 /// each entry matching the corresponding-index entry in the route paths, see
1041 /// PaymentSendFailure for more info.
1043 /// In general, a path may raise:
1044 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
1045 /// node public key) is specified.
1046 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
1047 /// (including due to previous monitor update failure or new permanent monitor update
1049 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1050 /// relevant updates.
1052 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
1053 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
1054 /// different route unless you intend to pay twice!
1056 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
1057 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
1058 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
1059 /// must not contain multiple paths as multi-path payments require a recipient-provided
1061 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
1062 /// bit set (either as required or as available). If multiple paths are present in the Route,
1063 /// we assume the invoice had the basic_mpp feature set.
1065 /// Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
1068 pub extern "C" fn ChannelManager_send_payment(this_arg: &ChannelManager, route: &crate::lightning::routing::router::Route, mut payment_hash: crate::c_types::ThirtyTwoBytes, mut payment_secret: crate::c_types::ThirtyTwoBytes) -> crate::c_types::derived::CResult_NonePaymentSendFailureZ {
1069 let mut local_payment_secret = if payment_secret.data == [0; 32] { None } else { Some( { ::lightning::ln::PaymentSecret(payment_secret.data) }) };
1070 let mut ret = unsafe { &*this_arg.inner }.send_payment(unsafe { &*route.inner }, ::lightning::ln::PaymentHash(payment_hash.data), &local_payment_secret);
1071 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::channelmanager::PaymentSendFailure::native_into(e) }).into() };
1075 /// Call this upon creation of a funding transaction for the given channel.
1077 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
1078 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
1080 /// Panics if a funding transaction has already been provided for this channel.
1082 /// May panic if the output found in the funding transaction is duplicative with some other
1083 /// channel (note that this should be trivially prevented by using unique funding transaction
1084 /// keys per-channel).
1086 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
1087 /// counterparty's signature the funding transaction will automatically be broadcast via the
1088 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
1090 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
1091 /// not currently support replacing a funding transaction on an existing channel. Instead,
1092 /// create a new channel with a conflicting funding transaction.
1094 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
1097 pub extern "C" fn ChannelManager_funding_transaction_generated(this_arg: &ChannelManager, temporary_channel_id: *const [u8; 32], mut funding_transaction: crate::c_types::Transaction) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
1098 let mut ret = unsafe { &*this_arg.inner }.funding_transaction_generated(unsafe { &*temporary_channel_id}, funding_transaction.into_bitcoin());
1099 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() };
1103 /// Regenerates channel_announcements and generates a signed node_announcement from the given
1104 /// arguments, providing them in corresponding events via
1105 /// [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
1106 /// on-chain. This effectively re-broadcasts all channel announcements and sends our node
1107 /// announcement to ensure that the lightning P2P network is aware of the channels we have and
1108 /// our network addresses.
1110 /// `rgb` is a node \"color\" and `alias` is a printable human-readable string to describe this
1111 /// node to humans. They carry no in-protocol meaning.
1113 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
1114 /// accepts incoming connections. These will be included in the node_announcement, publicly
1115 /// tying these addresses together and to this node. If you wish to preserve user privacy,
1116 /// addresses should likely contain only Tor Onion addresses.
1118 /// Panics if `addresses` is absurdly large (more than 500).
1120 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
1122 pub extern "C" fn ChannelManager_broadcast_node_announcement(this_arg: &ChannelManager, mut rgb: crate::c_types::ThreeBytes, mut alias: crate::c_types::ThirtyTwoBytes, mut addresses: crate::c_types::derived::CVec_NetAddressZ) {
1123 let mut local_addresses = Vec::new(); for mut item in addresses.into_rust().drain(..) { local_addresses.push( { item.into_native() }); };
1124 unsafe { &*this_arg.inner }.broadcast_node_announcement(rgb.data, alias.data, local_addresses)
1127 /// Processes HTLCs which are pending waiting on random forward delay.
1129 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1130 /// Will likely generate further events.
1132 pub extern "C" fn ChannelManager_process_pending_htlc_forwards(this_arg: &ChannelManager) {
1133 unsafe { &*this_arg.inner }.process_pending_htlc_forwards()
1136 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
1137 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
1138 /// to inform the network about the uselessness of these channels.
1140 /// This method handles all the details, and must be called roughly once per minute.
1142 /// Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
1144 pub extern "C" fn ChannelManager_timer_tick_occurred(this_arg: &ChannelManager) {
1145 unsafe { &*this_arg.inner }.timer_tick_occurred()
1148 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
1149 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
1150 /// along the path (including in our own channel on which we received it).
1151 /// Returns false if no payment was found to fail backwards, true if the process of failing the
1152 /// HTLC backwards has been started.
1155 pub extern "C" fn ChannelManager_fail_htlc_backwards(this_arg: &ChannelManager, payment_hash: *const [u8; 32]) -> bool {
1156 let mut ret = unsafe { &*this_arg.inner }.fail_htlc_backwards(&::lightning::ln::PaymentHash(unsafe { *payment_hash }));
1160 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1161 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1162 /// should probably kick the net layer to go send messages if this returns true!
1164 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
1165 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
1166 /// event matches your expectation. If you fail to do so and call this method, you may provide
1167 /// the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
1169 /// May panic if called except in response to a PaymentReceived event.
1171 /// [`create_inbound_payment`]: Self::create_inbound_payment
1172 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
1175 pub extern "C" fn ChannelManager_claim_funds(this_arg: &ChannelManager, mut payment_preimage: crate::c_types::ThirtyTwoBytes) -> bool {
1176 let mut ret = unsafe { &*this_arg.inner }.claim_funds(::lightning::ln::PaymentPreimage(payment_preimage.data));
1180 /// Gets the node_id held by this ChannelManager
1183 pub extern "C" fn ChannelManager_get_our_node_id(this_arg: &ChannelManager) -> crate::c_types::PublicKey {
1184 let mut ret = unsafe { &*this_arg.inner }.get_our_node_id();
1185 crate::c_types::PublicKey::from_rust(&ret)
1188 /// Restores a single, given channel to normal operation after a
1189 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1192 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
1193 /// fully committed in every copy of the given channels' ChannelMonitors.
1195 /// Note that there is no effect to calling with a highest_applied_update_id other than the
1196 /// current latest ChannelMonitorUpdate and one call to this function after multiple
1197 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
1198 /// exists largely only to prevent races between this and concurrent update_monitor calls.
1200 /// Thus, the anticipated use is, at a high level:
1201 /// 1) You register a chain::Watch with this ChannelManager,
1202 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
1203 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
1204 /// any time it cannot do so instantly,
1205 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
1206 /// 4) once all remote copies are updated, you call this function with the update_id that
1207 /// completed, and once it is the latest the Channel will be re-enabled.
1209 pub extern "C" fn ChannelManager_channel_monitor_updated(this_arg: &ChannelManager, funding_txo: &crate::lightning::chain::transaction::OutPoint, mut highest_applied_update_id: u64) {
1210 unsafe { &*this_arg.inner }.channel_monitor_updated(unsafe { &*funding_txo.inner }, highest_applied_update_id)
1213 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
1216 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
1217 /// [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
1219 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
1220 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
1221 /// passed directly to [`claim_funds`].
1223 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
1225 /// [`claim_funds`]: Self::claim_funds
1226 /// [`PaymentReceived`]: events::Event::PaymentReceived
1227 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
1228 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
1231 pub extern "C" fn ChannelManager_create_inbound_payment(this_arg: &ChannelManager, mut min_value_msat: crate::c_types::derived::COption_u64Z, mut invoice_expiry_delta_secs: u32, mut user_payment_id: u64) -> crate::c_types::derived::C2Tuple_PaymentHashPaymentSecretZ {
1232 let mut local_min_value_msat = if min_value_msat.is_some() { Some( { min_value_msat.take() }) } else { None };
1233 let mut ret = unsafe { &*this_arg.inner }.create_inbound_payment(local_min_value_msat, invoice_expiry_delta_secs, user_payment_id);
1234 let (mut orig_ret_0, mut orig_ret_1) = ret; let mut local_ret = (crate::c_types::ThirtyTwoBytes { data: orig_ret_0.0 }, crate::c_types::ThirtyTwoBytes { data: orig_ret_1.0 }).into();
1238 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
1239 /// stored external to LDK.
1241 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
1242 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
1243 /// the `min_value_msat` provided here, if one is provided.
1245 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
1246 /// method may return an Err if another payment with the same payment_hash is still pending.
1248 /// `user_payment_id` will be provided back in [`PaymentReceived::user_payment_id`] events to
1249 /// allow tracking of which events correspond with which calls to this and
1250 /// [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
1251 /// copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
1252 /// with invoice metadata stored elsewhere.
1254 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
1255 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
1256 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
1257 /// sender \"proof-of-payment\" unless they have paid the required amount.
1259 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
1260 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
1261 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
1262 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
1263 /// invoices when no timeout is set.
1265 /// Note that we use block header time to time-out pending inbound payments (with some margin
1266 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
1267 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
1268 /// If you need exact expiry semantics, you should enforce them upon receipt of
1269 /// [`PaymentReceived`].
1271 /// Pending inbound payments are stored in memory and in serialized versions of this
1272 /// [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
1273 /// space is limited, you may wish to rate-limit inbound payment creation.
1275 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
1277 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
1278 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
1280 /// [`create_inbound_payment`]: Self::create_inbound_payment
1281 /// [`PaymentReceived`]: events::Event::PaymentReceived
1282 /// [`PaymentReceived::user_payment_id`]: events::Event::PaymentReceived::user_payment_id
1285 pub extern "C" fn ChannelManager_create_inbound_payment_for_hash(this_arg: &ChannelManager, mut payment_hash: crate::c_types::ThirtyTwoBytes, mut min_value_msat: crate::c_types::derived::COption_u64Z, mut invoice_expiry_delta_secs: u32, mut user_payment_id: u64) -> crate::c_types::derived::CResult_PaymentSecretAPIErrorZ {
1286 let mut local_min_value_msat = if min_value_msat.is_some() { Some( { min_value_msat.take() }) } else { None };
1287 let mut ret = unsafe { &*this_arg.inner }.create_inbound_payment_for_hash(::lightning::ln::PaymentHash(payment_hash.data), local_min_value_msat, invoice_expiry_delta_secs, user_payment_id);
1288 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::c_types::ThirtyTwoBytes { data: o.0 } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() };
1292 impl From<nativeChannelManager> for crate::lightning::util::events::MessageSendEventsProvider {
1293 fn from(obj: nativeChannelManager) -> Self {
1294 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1295 let mut ret = ChannelManager_as_MessageSendEventsProvider(&rust_obj);
1296 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
1297 rust_obj.inner = std::ptr::null_mut();
1298 ret.free = Some(ChannelManager_free_void);
1302 /// Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
1303 /// This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
1305 pub extern "C" fn ChannelManager_as_MessageSendEventsProvider(this_arg: &ChannelManager) -> crate::lightning::util::events::MessageSendEventsProvider {
1306 crate::lightning::util::events::MessageSendEventsProvider {
1307 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1309 get_and_clear_pending_msg_events: ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events,
1314 extern "C" fn ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_MessageSendEventZ {
1315 let mut ret = <nativeChannelManager as lightning::util::events::MessageSendEventsProvider<>>::get_and_clear_pending_msg_events(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
1316 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::util::events::MessageSendEvent::native_into(item) }); };
1320 impl From<nativeChannelManager> for crate::lightning::util::events::EventsProvider {
1321 fn from(obj: nativeChannelManager) -> Self {
1322 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1323 let mut ret = ChannelManager_as_EventsProvider(&rust_obj);
1324 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
1325 rust_obj.inner = std::ptr::null_mut();
1326 ret.free = Some(ChannelManager_free_void);
1330 /// Constructs a new EventsProvider which calls the relevant methods on this_arg.
1331 /// This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
1333 pub extern "C" fn ChannelManager_as_EventsProvider(this_arg: &ChannelManager) -> crate::lightning::util::events::EventsProvider {
1334 crate::lightning::util::events::EventsProvider {
1335 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1337 process_pending_events: ChannelManager_EventsProvider_process_pending_events,
1341 extern "C" fn ChannelManager_EventsProvider_process_pending_events(this_arg: *const c_void, mut handler: crate::lightning::util::events::EventHandler) {
1342 <nativeChannelManager as lightning::util::events::EventsProvider<>>::process_pending_events(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, handler)
1345 impl From<nativeChannelManager> for crate::lightning::chain::Listen {
1346 fn from(obj: nativeChannelManager) -> Self {
1347 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1348 let mut ret = ChannelManager_as_Listen(&rust_obj);
1349 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
1350 rust_obj.inner = std::ptr::null_mut();
1351 ret.free = Some(ChannelManager_free_void);
1355 /// Constructs a new Listen which calls the relevant methods on this_arg.
1356 /// This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
1358 pub extern "C" fn ChannelManager_as_Listen(this_arg: &ChannelManager) -> crate::lightning::chain::Listen {
1359 crate::lightning::chain::Listen {
1360 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1362 block_connected: ChannelManager_Listen_block_connected,
1363 block_disconnected: ChannelManager_Listen_block_disconnected,
1367 extern "C" fn ChannelManager_Listen_block_connected(this_arg: *const c_void, mut block: crate::c_types::u8slice, mut height: u32) {
1368 <nativeChannelManager as lightning::chain::Listen<>>::block_connected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(block.to_slice()).unwrap(), height)
1370 extern "C" fn ChannelManager_Listen_block_disconnected(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
1371 <nativeChannelManager as lightning::chain::Listen<>>::block_disconnected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
1374 impl From<nativeChannelManager> for crate::lightning::chain::Confirm {
1375 fn from(obj: nativeChannelManager) -> Self {
1376 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1377 let mut ret = ChannelManager_as_Confirm(&rust_obj);
1378 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
1379 rust_obj.inner = std::ptr::null_mut();
1380 ret.free = Some(ChannelManager_free_void);
1384 /// Constructs a new Confirm which calls the relevant methods on this_arg.
1385 /// This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
1387 pub extern "C" fn ChannelManager_as_Confirm(this_arg: &ChannelManager) -> crate::lightning::chain::Confirm {
1388 crate::lightning::chain::Confirm {
1389 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1391 transactions_confirmed: ChannelManager_Confirm_transactions_confirmed,
1392 transaction_unconfirmed: ChannelManager_Confirm_transaction_unconfirmed,
1393 best_block_updated: ChannelManager_Confirm_best_block_updated,
1394 get_relevant_txids: ChannelManager_Confirm_get_relevant_txids,
1398 extern "C" fn ChannelManager_Confirm_transactions_confirmed(this_arg: *const c_void, header: *const [u8; 80], mut txdata: crate::c_types::derived::CVec_C2Tuple_usizeTransactionZZ, mut height: u32) {
1399 let mut local_txdata = Vec::new(); for mut item in txdata.into_rust().drain(..) { local_txdata.push( { let (mut orig_txdata_0_0, mut orig_txdata_0_1) = item.to_rust(); let mut local_txdata_0 = (orig_txdata_0_0, orig_txdata_0_1.into_bitcoin()); local_txdata_0 }); };
1400 <nativeChannelManager as lightning::chain::Confirm<>>::transactions_confirmed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), &local_txdata.iter().map(|(a, b)| (*a, b)).collect::<Vec<_>>()[..], height)
1402 extern "C" fn ChannelManager_Confirm_best_block_updated(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
1403 <nativeChannelManager as lightning::chain::Confirm<>>::best_block_updated(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
1406 extern "C" fn ChannelManager_Confirm_get_relevant_txids(this_arg: *const c_void) -> crate::c_types::derived::CVec_TxidZ {
1407 let mut ret = <nativeChannelManager as lightning::chain::Confirm<>>::get_relevant_txids(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
1408 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::c_types::ThirtyTwoBytes { data: item.into_inner() } }); };
1411 extern "C" fn ChannelManager_Confirm_transaction_unconfirmed(this_arg: *const c_void, txid: *const [u8; 32]) {
1412 <nativeChannelManager as lightning::chain::Confirm<>>::transaction_unconfirmed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::hash_types::Txid::from_slice(&unsafe { &*txid }[..]).unwrap())
1415 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
1416 /// indicating whether persistence is necessary. Only one listener on
1417 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
1419 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
1422 pub extern "C" fn ChannelManager_await_persistable_update_timeout(this_arg: &ChannelManager, mut max_wait: u64) -> bool {
1423 let mut ret = unsafe { &*this_arg.inner }.await_persistable_update_timeout(std::time::Duration::from_secs(max_wait));
1427 /// Blocks until ChannelManager needs to be persisted. Only one listener on
1428 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
1431 pub extern "C" fn ChannelManager_await_persistable_update(this_arg: &ChannelManager) {
1432 unsafe { &*this_arg.inner }.await_persistable_update()
1435 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1436 /// [`chain::Confirm`] interfaces.
1439 pub extern "C" fn ChannelManager_current_best_block(this_arg: &ChannelManager) -> crate::lightning::chain::BestBlock {
1440 let mut ret = unsafe { &*this_arg.inner }.current_best_block();
1441 crate::lightning::chain::BestBlock { inner: Box::into_raw(Box::new(ret)), is_owned: true }
1444 impl From<nativeChannelManager> for crate::lightning::ln::msgs::ChannelMessageHandler {
1445 fn from(obj: nativeChannelManager) -> Self {
1446 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1447 let mut ret = ChannelManager_as_ChannelMessageHandler(&rust_obj);
1448 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so wipe rust_obj's pointer and set ret's free() fn
1449 rust_obj.inner = std::ptr::null_mut();
1450 ret.free = Some(ChannelManager_free_void);
1454 /// Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
1455 /// This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
1457 pub extern "C" fn ChannelManager_as_ChannelMessageHandler(this_arg: &ChannelManager) -> crate::lightning::ln::msgs::ChannelMessageHandler {
1458 crate::lightning::ln::msgs::ChannelMessageHandler {
1459 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1461 handle_open_channel: ChannelManager_ChannelMessageHandler_handle_open_channel,
1462 handle_accept_channel: ChannelManager_ChannelMessageHandler_handle_accept_channel,
1463 handle_funding_created: ChannelManager_ChannelMessageHandler_handle_funding_created,
1464 handle_funding_signed: ChannelManager_ChannelMessageHandler_handle_funding_signed,
1465 handle_funding_locked: ChannelManager_ChannelMessageHandler_handle_funding_locked,
1466 handle_shutdown: ChannelManager_ChannelMessageHandler_handle_shutdown,
1467 handle_closing_signed: ChannelManager_ChannelMessageHandler_handle_closing_signed,
1468 handle_update_add_htlc: ChannelManager_ChannelMessageHandler_handle_update_add_htlc,
1469 handle_update_fulfill_htlc: ChannelManager_ChannelMessageHandler_handle_update_fulfill_htlc,
1470 handle_update_fail_htlc: ChannelManager_ChannelMessageHandler_handle_update_fail_htlc,
1471 handle_update_fail_malformed_htlc: ChannelManager_ChannelMessageHandler_handle_update_fail_malformed_htlc,
1472 handle_commitment_signed: ChannelManager_ChannelMessageHandler_handle_commitment_signed,
1473 handle_revoke_and_ack: ChannelManager_ChannelMessageHandler_handle_revoke_and_ack,
1474 handle_update_fee: ChannelManager_ChannelMessageHandler_handle_update_fee,
1475 handle_announcement_signatures: ChannelManager_ChannelMessageHandler_handle_announcement_signatures,
1476 peer_disconnected: ChannelManager_ChannelMessageHandler_peer_disconnected,
1477 peer_connected: ChannelManager_ChannelMessageHandler_peer_connected,
1478 handle_channel_reestablish: ChannelManager_ChannelMessageHandler_handle_channel_reestablish,
1479 handle_channel_update: ChannelManager_ChannelMessageHandler_handle_channel_update,
1480 handle_error: ChannelManager_ChannelMessageHandler_handle_error,
1481 MessageSendEventsProvider: crate::lightning::util::events::MessageSendEventsProvider {
1482 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1484 get_and_clear_pending_msg_events: ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events,
1489 extern "C" fn ChannelManager_ChannelMessageHandler_handle_open_channel(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, mut their_features: crate::lightning::ln::features::InitFeatures, msg: &crate::lightning::ln::msgs::OpenChannel) {
1490 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_open_channel(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), *unsafe { Box::from_raw(their_features.take_inner()) }, unsafe { &*msg.inner })
1492 extern "C" fn ChannelManager_ChannelMessageHandler_handle_accept_channel(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, mut their_features: crate::lightning::ln::features::InitFeatures, msg: &crate::lightning::ln::msgs::AcceptChannel) {
1493 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_accept_channel(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), *unsafe { Box::from_raw(their_features.take_inner()) }, unsafe { &*msg.inner })
1495 extern "C" fn ChannelManager_ChannelMessageHandler_handle_funding_created(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::FundingCreated) {
1496 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_created(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1498 extern "C" fn ChannelManager_ChannelMessageHandler_handle_funding_signed(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::FundingSigned) {
1499 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1501 extern "C" fn ChannelManager_ChannelMessageHandler_handle_funding_locked(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::FundingLocked) {
1502 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_locked(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1504 extern "C" fn ChannelManager_ChannelMessageHandler_handle_shutdown(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, their_features: &crate::lightning::ln::features::InitFeatures, msg: &crate::lightning::ln::msgs::Shutdown) {
1505 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_shutdown(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*their_features.inner }, unsafe { &*msg.inner })
1507 extern "C" fn ChannelManager_ChannelMessageHandler_handle_closing_signed(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::ClosingSigned) {
1508 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_closing_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1510 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_add_htlc(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::UpdateAddHTLC) {
1511 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_add_htlc(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1513 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fulfill_htlc(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::UpdateFulfillHTLC) {
1514 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_fulfill_htlc(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1516 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fail_htlc(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::UpdateFailHTLC) {
1517 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_fail_htlc(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1519 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fail_malformed_htlc(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::UpdateFailMalformedHTLC) {
1520 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_fail_malformed_htlc(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1522 extern "C" fn ChannelManager_ChannelMessageHandler_handle_commitment_signed(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::CommitmentSigned) {
1523 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_commitment_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1525 extern "C" fn ChannelManager_ChannelMessageHandler_handle_revoke_and_ack(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::RevokeAndACK) {
1526 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_revoke_and_ack(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1528 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fee(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::UpdateFee) {
1529 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_fee(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1531 extern "C" fn ChannelManager_ChannelMessageHandler_handle_announcement_signatures(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::AnnouncementSignatures) {
1532 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_announcement_signatures(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1534 extern "C" fn ChannelManager_ChannelMessageHandler_handle_channel_update(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::ChannelUpdate) {
1535 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_channel_update(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1537 extern "C" fn ChannelManager_ChannelMessageHandler_handle_channel_reestablish(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::ChannelReestablish) {
1538 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_channel_reestablish(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1540 extern "C" fn ChannelManager_ChannelMessageHandler_peer_disconnected(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, mut no_connection_possible: bool) {
1541 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::peer_disconnected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), no_connection_possible)
1543 extern "C" fn ChannelManager_ChannelMessageHandler_peer_connected(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, init_msg: &crate::lightning::ln::msgs::Init) {
1544 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::peer_connected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*init_msg.inner })
1546 extern "C" fn ChannelManager_ChannelMessageHandler_handle_error(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::ErrorMessage) {
1547 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_error(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1551 /// Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
1552 pub extern "C" fn ChannelManager_write(obj: &ChannelManager) -> crate::c_types::derived::CVec_u8Z {
1553 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
1556 pub(crate) extern "C" fn ChannelManager_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1557 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelManager) })
1560 use lightning::ln::channelmanager::ChannelManagerReadArgs as nativeChannelManagerReadArgsImport;
1561 type nativeChannelManagerReadArgs = nativeChannelManagerReadArgsImport<'static, crate::lightning::chain::keysinterface::Sign, crate::lightning::chain::Watch, crate::lightning::chain::chaininterface::BroadcasterInterface, crate::lightning::chain::keysinterface::KeysInterface, crate::lightning::chain::chaininterface::FeeEstimator, crate::lightning::util::logger::Logger>;
1563 /// Arguments for the creation of a ChannelManager that are not deserialized.
1565 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
1567 /// 1) Deserialize all stored ChannelMonitors.
1568 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
1569 /// <(BlockHash, ChannelManager)>::read(reader, args)
1570 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
1571 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
1572 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
1573 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
1574 /// ChannelMonitor::get_funding_txo().
1575 /// 4) Reconnect blocks on your ChannelMonitors.
1576 /// 5) Disconnect/connect blocks on the ChannelManager.
1577 /// 6) Move the ChannelMonitors into your local chain::Watch.
1579 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
1580 /// call any other methods on the newly-deserialized ChannelManager.
1582 /// Note that because some channels may be closed during deserialization, it is critical that you
1583 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
1584 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
1585 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
1586 /// not force-close the same channels but consider them live), you may end up revoking a state for
1587 /// which you've already broadcasted the transaction.
1590 pub struct ChannelManagerReadArgs {
1591 /// A pointer to the opaque Rust object.
1593 /// Nearly everywhere, inner must be non-null, however in places where
1594 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1595 pub inner: *mut nativeChannelManagerReadArgs,
1596 /// Indicates that this is the only struct which contains the same pointer.
1598 /// Rust functions which take ownership of an object provided via an argument require
1599 /// this to be true and invalidate the object pointed to by inner.
1603 impl Drop for ChannelManagerReadArgs {
1604 fn drop(&mut self) {
1605 if self.is_owned && !<*mut nativeChannelManagerReadArgs>::is_null(self.inner) {
1606 let _ = unsafe { Box::from_raw(self.inner) };
1610 /// Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL.
1612 pub extern "C" fn ChannelManagerReadArgs_free(this_obj: ChannelManagerReadArgs) { }
1614 /// Used only if an object of this type is returned as a trait impl by a method
1615 extern "C" fn ChannelManagerReadArgs_free_void(this_ptr: *mut c_void) {
1616 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelManagerReadArgs); }
1619 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1620 impl ChannelManagerReadArgs {
1621 pub(crate) fn take_inner(mut self) -> *mut nativeChannelManagerReadArgs {
1622 assert!(self.is_owned);
1623 let ret = self.inner;
1624 self.inner = std::ptr::null_mut();
1628 /// The keys provider which will give us relevant keys. Some keys will be loaded during
1629 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
1632 pub extern "C" fn ChannelManagerReadArgs_get_keys_manager(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::keysinterface::KeysInterface {
1633 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.keys_manager;
1636 /// The keys provider which will give us relevant keys. Some keys will be loaded during
1637 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
1640 pub extern "C" fn ChannelManagerReadArgs_set_keys_manager(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::keysinterface::KeysInterface) {
1641 unsafe { &mut *this_ptr.inner }.keys_manager = val;
1643 /// The fee_estimator for use in the ChannelManager in the future.
1645 /// No calls to the FeeEstimator will be made during deserialization.
1647 pub extern "C" fn ChannelManagerReadArgs_get_fee_estimator(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::chaininterface::FeeEstimator {
1648 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fee_estimator;
1651 /// The fee_estimator for use in the ChannelManager in the future.
1653 /// No calls to the FeeEstimator will be made during deserialization.
1655 pub extern "C" fn ChannelManagerReadArgs_set_fee_estimator(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::chaininterface::FeeEstimator) {
1656 unsafe { &mut *this_ptr.inner }.fee_estimator = val;
1658 /// The chain::Watch for use in the ChannelManager in the future.
1660 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
1661 /// you have deserialized ChannelMonitors separately and will add them to your
1662 /// chain::Watch after deserializing this ChannelManager.
1664 pub extern "C" fn ChannelManagerReadArgs_get_chain_monitor(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::Watch {
1665 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.chain_monitor;
1668 /// The chain::Watch for use in the ChannelManager in the future.
1670 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
1671 /// you have deserialized ChannelMonitors separately and will add them to your
1672 /// chain::Watch after deserializing this ChannelManager.
1674 pub extern "C" fn ChannelManagerReadArgs_set_chain_monitor(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::Watch) {
1675 unsafe { &mut *this_ptr.inner }.chain_monitor = val;
1677 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
1678 /// used to broadcast the latest local commitment transactions of channels which must be
1679 /// force-closed during deserialization.
1681 pub extern "C" fn ChannelManagerReadArgs_get_tx_broadcaster(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::chaininterface::BroadcasterInterface {
1682 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.tx_broadcaster;
1685 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
1686 /// used to broadcast the latest local commitment transactions of channels which must be
1687 /// force-closed during deserialization.
1689 pub extern "C" fn ChannelManagerReadArgs_set_tx_broadcaster(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::chaininterface::BroadcasterInterface) {
1690 unsafe { &mut *this_ptr.inner }.tx_broadcaster = val;
1692 /// The Logger for use in the ChannelManager and which may be used to log information during
1693 /// deserialization.
1695 pub extern "C" fn ChannelManagerReadArgs_get_logger(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::util::logger::Logger {
1696 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.logger;
1699 /// The Logger for use in the ChannelManager and which may be used to log information during
1700 /// deserialization.
1702 pub extern "C" fn ChannelManagerReadArgs_set_logger(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::util::logger::Logger) {
1703 unsafe { &mut *this_ptr.inner }.logger = val;
1705 /// Default settings used for new channels. Any existing channels will continue to use the
1706 /// runtime settings which were stored when the ChannelManager was serialized.
1708 pub extern "C" fn ChannelManagerReadArgs_get_default_config(this_ptr: &ChannelManagerReadArgs) -> crate::lightning::util::config::UserConfig {
1709 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.default_config;
1710 crate::lightning::util::config::UserConfig { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
1712 /// Default settings used for new channels. Any existing channels will continue to use the
1713 /// runtime settings which were stored when the ChannelManager was serialized.
1715 pub extern "C" fn ChannelManagerReadArgs_set_default_config(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::util::config::UserConfig) {
1716 unsafe { &mut *this_ptr.inner }.default_config = *unsafe { Box::from_raw(val.take_inner()) };
1718 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
1719 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
1720 /// populate a HashMap directly from C.
1723 pub extern "C" fn ChannelManagerReadArgs_new(mut keys_manager: crate::lightning::chain::keysinterface::KeysInterface, mut fee_estimator: crate::lightning::chain::chaininterface::FeeEstimator, mut chain_monitor: crate::lightning::chain::Watch, mut tx_broadcaster: crate::lightning::chain::chaininterface::BroadcasterInterface, mut logger: crate::lightning::util::logger::Logger, mut default_config: crate::lightning::util::config::UserConfig, mut channel_monitors: crate::c_types::derived::CVec_ChannelMonitorZ) -> ChannelManagerReadArgs {
1724 let mut local_channel_monitors = Vec::new(); for mut item in channel_monitors.into_rust().drain(..) { local_channel_monitors.push( { unsafe { &mut *item.inner } }); };
1725 let mut ret = lightning::ln::channelmanager::ChannelManagerReadArgs::new(keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, *unsafe { Box::from_raw(default_config.take_inner()) }, local_channel_monitors);
1726 ChannelManagerReadArgs { inner: Box::into_raw(Box::new(ret)), is_owned: true }
1730 /// Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
1731 pub extern "C" fn C2Tuple_BlockHashChannelManagerZ_read(ser: crate::c_types::u8slice, arg: crate::lightning::ln::channelmanager::ChannelManagerReadArgs) -> crate::c_types::derived::CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ {
1732 let arg_conv = *unsafe { Box::from_raw(arg.take_inner()) };
1733 let res: Result<(bitcoin::hash_types::BlockHash, lightning::ln::channelmanager::ChannelManager<crate::lightning::chain::keysinterface::Sign, crate::lightning::chain::Watch, crate::lightning::chain::chaininterface::BroadcasterInterface, crate::lightning::chain::keysinterface::KeysInterface, crate::lightning::chain::chaininterface::FeeEstimator, crate::lightning::util::logger::Logger>), lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv);
1734 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { let (mut orig_res_0_0, mut orig_res_0_1) = o; let mut local_res_0 = (crate::c_types::ThirtyTwoBytes { data: orig_res_0_0.into_inner() }, crate::lightning::ln::channelmanager::ChannelManager { inner: Box::into_raw(Box::new(orig_res_0_1)), is_owned: true }).into(); local_res_0 }).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() };