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).
21 use bitcoin::hashes::Hash;
22 use crate::c_types::*;
25 use lightning::ln::channelmanager::ChannelManager as nativeChannelManagerImport;
26 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>;
28 /// Manager which keeps track of a number of channels and sends messages to the appropriate
29 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
31 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
32 /// to individual Channels.
34 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
35 /// all peers during write/read (though does not modify this instance, only the instance being
36 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
37 /// called funding_transaction_generated for outbound channels).
39 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
40 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
41 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
42 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
43 /// the serialization process). If the deserialized version is out-of-date compared to the
44 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
45 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
47 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
48 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
49 /// the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
50 /// block_connected() to step towards your best block) upon deserialization before using the
53 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
54 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
55 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
56 /// offline for a full minute. In order to track this, you must call
57 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
59 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
60 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
61 /// essentially you should default to using a SimpleRefChannelManager, and use a
62 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
63 /// you're using lightning-net-tokio.
66 pub struct ChannelManager {
67 /// A pointer to the opaque Rust object.
69 /// Nearly everywhere, inner must be non-null, however in places where
70 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
71 pub inner: *mut nativeChannelManager,
72 /// Indicates that this is the only struct which contains the same pointer.
74 /// Rust functions which take ownership of an object provided via an argument require
75 /// this to be true and invalidate the object pointed to by inner.
79 impl Drop for ChannelManager {
81 if self.is_owned && !<*mut nativeChannelManager>::is_null(self.inner) {
82 let _ = unsafe { Box::from_raw(self.inner) };
86 /// Frees any resources used by the ChannelManager, if is_owned is set and inner is non-NULL.
88 pub extern "C" fn ChannelManager_free(this_obj: ChannelManager) { }
90 /// Used only if an object of this type is returned as a trait impl by a method
91 extern "C" fn ChannelManager_free_void(this_ptr: *mut c_void) {
92 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelManager); }
95 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
97 pub(crate) fn take_inner(mut self) -> *mut nativeChannelManager {
98 assert!(self.is_owned);
100 self.inner = std::ptr::null_mut();
105 use lightning::ln::channelmanager::ChainParameters as nativeChainParametersImport;
106 type nativeChainParameters = nativeChainParametersImport;
108 /// Chain-related parameters used to construct a new `ChannelManager`.
110 /// Typically, the block-specific parameters are derived from the best block hash for the network,
111 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
112 /// are not needed when deserializing a previously constructed `ChannelManager`.
115 pub struct ChainParameters {
116 /// A pointer to the opaque Rust object.
118 /// Nearly everywhere, inner must be non-null, however in places where
119 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
120 pub inner: *mut nativeChainParameters,
121 /// Indicates that this is the only struct which contains the same pointer.
123 /// Rust functions which take ownership of an object provided via an argument require
124 /// this to be true and invalidate the object pointed to by inner.
128 impl Drop for ChainParameters {
130 if self.is_owned && !<*mut nativeChainParameters>::is_null(self.inner) {
131 let _ = unsafe { Box::from_raw(self.inner) };
135 /// Frees any resources used by the ChainParameters, if is_owned is set and inner is non-NULL.
137 pub extern "C" fn ChainParameters_free(this_obj: ChainParameters) { }
139 /// Used only if an object of this type is returned as a trait impl by a method
140 extern "C" fn ChainParameters_free_void(this_ptr: *mut c_void) {
141 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChainParameters); }
144 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
145 impl ChainParameters {
146 pub(crate) fn take_inner(mut self) -> *mut nativeChainParameters {
147 assert!(self.is_owned);
148 let ret = self.inner;
149 self.inner = std::ptr::null_mut();
153 /// The network for determining the `chain_hash` in Lightning messages.
155 pub extern "C" fn ChainParameters_get_network(this_ptr: &ChainParameters) -> crate::bitcoin::network::Network {
156 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.network;
157 crate::bitcoin::network::Network::from_bitcoin(inner_val)
159 /// The network for determining the `chain_hash` in Lightning messages.
161 pub extern "C" fn ChainParameters_set_network(this_ptr: &mut ChainParameters, mut val: crate::bitcoin::network::Network) {
162 unsafe { &mut *this_ptr.inner }.network = val.into_bitcoin();
164 /// The hash and height of the latest block successfully connected.
166 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
168 pub extern "C" fn ChainParameters_get_best_block(this_ptr: &ChainParameters) -> crate::lightning::ln::channelmanager::BestBlock {
169 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.best_block;
170 crate::lightning::ln::channelmanager::BestBlock { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
172 /// The hash and height of the latest block successfully connected.
174 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
176 pub extern "C" fn ChainParameters_set_best_block(this_ptr: &mut ChainParameters, mut val: crate::lightning::ln::channelmanager::BestBlock) {
177 unsafe { &mut *this_ptr.inner }.best_block = *unsafe { Box::from_raw(val.take_inner()) };
179 /// Constructs a new ChainParameters given each field
182 pub extern "C" fn ChainParameters_new(mut network_arg: crate::bitcoin::network::Network, mut best_block_arg: crate::lightning::ln::channelmanager::BestBlock) -> ChainParameters {
183 ChainParameters { inner: Box::into_raw(Box::new(nativeChainParameters {
184 network: network_arg.into_bitcoin(),
185 best_block: *unsafe { Box::from_raw(best_block_arg.take_inner()) },
186 })), is_owned: true }
189 use lightning::ln::channelmanager::BestBlock as nativeBestBlockImport;
190 type nativeBestBlock = nativeBestBlockImport;
192 /// The best known block as identified by its hash and height.
195 pub struct BestBlock {
196 /// A pointer to the opaque Rust object.
198 /// Nearly everywhere, inner must be non-null, however in places where
199 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
200 pub inner: *mut nativeBestBlock,
201 /// Indicates that this is the only struct which contains the same pointer.
203 /// Rust functions which take ownership of an object provided via an argument require
204 /// this to be true and invalidate the object pointed to by inner.
208 impl Drop for BestBlock {
210 if self.is_owned && !<*mut nativeBestBlock>::is_null(self.inner) {
211 let _ = unsafe { Box::from_raw(self.inner) };
215 /// Frees any resources used by the BestBlock, if is_owned is set and inner is non-NULL.
217 pub extern "C" fn BestBlock_free(this_obj: BestBlock) { }
219 /// Used only if an object of this type is returned as a trait impl by a method
220 extern "C" fn BestBlock_free_void(this_ptr: *mut c_void) {
221 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeBestBlock); }
224 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
226 pub(crate) fn take_inner(mut self) -> *mut nativeBestBlock {
227 assert!(self.is_owned);
228 let ret = self.inner;
229 self.inner = std::ptr::null_mut();
233 impl Clone for BestBlock {
234 fn clone(&self) -> Self {
236 inner: if <*mut nativeBestBlock>::is_null(self.inner) { std::ptr::null_mut() } else {
237 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
243 /// Used only if an object of this type is returned as a trait impl by a method
244 pub(crate) extern "C" fn BestBlock_clone_void(this_ptr: *const c_void) -> *mut c_void {
245 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeBestBlock)).clone() })) as *mut c_void
248 /// Creates a copy of the BestBlock
249 pub extern "C" fn BestBlock_clone(orig: &BestBlock) -> BestBlock {
252 /// Returns the best block from the genesis of the given network.
255 pub extern "C" fn BestBlock_from_genesis(mut network: crate::bitcoin::network::Network) -> BestBlock {
256 let mut ret = lightning::ln::channelmanager::BestBlock::from_genesis(network.into_bitcoin());
257 BestBlock { inner: Box::into_raw(Box::new(ret)), is_owned: true }
260 /// Returns the best block as identified by the given block hash and height.
263 pub extern "C" fn BestBlock_new(mut block_hash: crate::c_types::ThirtyTwoBytes, mut height: u32) -> BestBlock {
264 let mut ret = lightning::ln::channelmanager::BestBlock::new(::bitcoin::hash_types::BlockHash::from_slice(&block_hash.data[..]).unwrap(), height);
265 BestBlock { inner: Box::into_raw(Box::new(ret)), is_owned: true }
268 /// Returns the best block hash.
271 pub extern "C" fn BestBlock_block_hash(this_arg: &BestBlock) -> crate::c_types::ThirtyTwoBytes {
272 let mut ret = unsafe { &*this_arg.inner }.block_hash();
273 crate::c_types::ThirtyTwoBytes { data: ret.into_inner() }
276 /// Returns the best block height.
279 pub extern "C" fn BestBlock_height(this_arg: &BestBlock) -> u32 {
280 let mut ret = unsafe { &*this_arg.inner }.height();
284 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
285 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
287 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
289 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
292 pub static BREAKDOWN_TIMEOUT: u16 = lightning::ln::channelmanager::BREAKDOWN_TIMEOUT;
293 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
294 /// HTLC's CLTV. The current default represents roughly six hours of blocks at six blocks/hour.
296 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
298 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
301 pub static MIN_CLTV_EXPIRY_DELTA: u16 = lightning::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA;
303 use lightning::ln::channelmanager::ChannelDetails as nativeChannelDetailsImport;
304 type nativeChannelDetails = nativeChannelDetailsImport;
306 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
309 pub struct ChannelDetails {
310 /// A pointer to the opaque Rust object.
312 /// Nearly everywhere, inner must be non-null, however in places where
313 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
314 pub inner: *mut nativeChannelDetails,
315 /// Indicates that this is the only struct which contains the same pointer.
317 /// Rust functions which take ownership of an object provided via an argument require
318 /// this to be true and invalidate the object pointed to by inner.
322 impl Drop for ChannelDetails {
324 if self.is_owned && !<*mut nativeChannelDetails>::is_null(self.inner) {
325 let _ = unsafe { Box::from_raw(self.inner) };
329 /// Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL.
331 pub extern "C" fn ChannelDetails_free(this_obj: ChannelDetails) { }
333 /// Used only if an object of this type is returned as a trait impl by a method
334 extern "C" fn ChannelDetails_free_void(this_ptr: *mut c_void) {
335 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelDetails); }
338 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
339 impl ChannelDetails {
340 pub(crate) fn take_inner(mut self) -> *mut nativeChannelDetails {
341 assert!(self.is_owned);
342 let ret = self.inner;
343 self.inner = std::ptr::null_mut();
347 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
348 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
349 /// Note that this means this value is *not* persistent - it can change once during the
350 /// lifetime of the channel.
352 pub extern "C" fn ChannelDetails_get_channel_id(this_ptr: &ChannelDetails) -> *const [u8; 32] {
353 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_id;
356 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
357 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
358 /// Note that this means this value is *not* persistent - it can change once during the
359 /// lifetime of the channel.
361 pub extern "C" fn ChannelDetails_set_channel_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::ThirtyTwoBytes) {
362 unsafe { &mut *this_ptr.inner }.channel_id = val.data;
364 /// The position of the funding transaction in the chain. None if the funding transaction has
365 /// not yet been confirmed and the channel fully opened.
367 pub extern "C" fn ChannelDetails_get_short_channel_id(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u64Z {
368 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.short_channel_id;
369 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()) } };
372 /// The position of the funding transaction in the chain. None if the funding transaction has
373 /// not yet been confirmed and the channel fully opened.
375 pub extern "C" fn ChannelDetails_set_short_channel_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u64Z) {
376 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
377 unsafe { &mut *this_ptr.inner }.short_channel_id = local_val;
379 /// The node_id of our counterparty
381 pub extern "C" fn ChannelDetails_get_remote_network_id(this_ptr: &ChannelDetails) -> crate::c_types::PublicKey {
382 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.remote_network_id;
383 crate::c_types::PublicKey::from_rust(&inner_val)
385 /// The node_id of our counterparty
387 pub extern "C" fn ChannelDetails_set_remote_network_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::PublicKey) {
388 unsafe { &mut *this_ptr.inner }.remote_network_id = val.into_rust();
390 /// The Features the channel counterparty provided upon last connection.
391 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
392 /// many routing-relevant features are present in the init context.
394 pub extern "C" fn ChannelDetails_get_counterparty_features(this_ptr: &ChannelDetails) -> crate::lightning::ln::features::InitFeatures {
395 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.counterparty_features;
396 crate::lightning::ln::features::InitFeatures { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
398 /// The Features the channel counterparty provided upon last connection.
399 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
400 /// many routing-relevant features are present in the init context.
402 pub extern "C" fn ChannelDetails_set_counterparty_features(this_ptr: &mut ChannelDetails, mut val: crate::lightning::ln::features::InitFeatures) {
403 unsafe { &mut *this_ptr.inner }.counterparty_features = *unsafe { Box::from_raw(val.take_inner()) };
405 /// The value, in satoshis, of this channel as appears in the funding output
407 pub extern "C" fn ChannelDetails_get_channel_value_satoshis(this_ptr: &ChannelDetails) -> u64 {
408 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_value_satoshis;
411 /// The value, in satoshis, of this channel as appears in the funding output
413 pub extern "C" fn ChannelDetails_set_channel_value_satoshis(this_ptr: &mut ChannelDetails, mut val: u64) {
414 unsafe { &mut *this_ptr.inner }.channel_value_satoshis = val;
416 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
418 pub extern "C" fn ChannelDetails_get_user_id(this_ptr: &ChannelDetails) -> u64 {
419 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.user_id;
422 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
424 pub extern "C" fn ChannelDetails_set_user_id(this_ptr: &mut ChannelDetails, mut val: u64) {
425 unsafe { &mut *this_ptr.inner }.user_id = val;
427 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
428 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
429 /// available for inclusion in new outbound HTLCs). This further does not include any pending
430 /// outgoing HTLCs which are awaiting some other resolution to be sent.
432 pub extern "C" fn ChannelDetails_get_outbound_capacity_msat(this_ptr: &ChannelDetails) -> u64 {
433 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.outbound_capacity_msat;
436 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
437 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
438 /// available for inclusion in new outbound HTLCs). This further does not include any pending
439 /// outgoing HTLCs which are awaiting some other resolution to be sent.
441 pub extern "C" fn ChannelDetails_set_outbound_capacity_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
442 unsafe { &mut *this_ptr.inner }.outbound_capacity_msat = val;
444 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
445 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
446 /// available for inclusion in new inbound HTLCs).
447 /// Note that there are some corner cases not fully handled here, so the actual available
448 /// inbound capacity may be slightly higher than this.
450 pub extern "C" fn ChannelDetails_get_inbound_capacity_msat(this_ptr: &ChannelDetails) -> u64 {
451 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.inbound_capacity_msat;
454 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
455 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
456 /// available for inclusion in new inbound HTLCs).
457 /// Note that there are some corner cases not fully handled here, so the actual available
458 /// inbound capacity may be slightly higher than this.
460 pub extern "C" fn ChannelDetails_set_inbound_capacity_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
461 unsafe { &mut *this_ptr.inner }.inbound_capacity_msat = val;
463 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
464 /// the peer is connected, and (c) no monitor update failure is pending resolution.
466 pub extern "C" fn ChannelDetails_get_is_live(this_ptr: &ChannelDetails) -> bool {
467 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.is_live;
470 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
471 /// the peer is connected, and (c) no monitor update failure is pending resolution.
473 pub extern "C" fn ChannelDetails_set_is_live(this_ptr: &mut ChannelDetails, mut val: bool) {
474 unsafe { &mut *this_ptr.inner }.is_live = val;
476 impl Clone for ChannelDetails {
477 fn clone(&self) -> Self {
479 inner: if <*mut nativeChannelDetails>::is_null(self.inner) { std::ptr::null_mut() } else {
480 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
486 /// Used only if an object of this type is returned as a trait impl by a method
487 pub(crate) extern "C" fn ChannelDetails_clone_void(this_ptr: *const c_void) -> *mut c_void {
488 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelDetails)).clone() })) as *mut c_void
491 /// Creates a copy of the ChannelDetails
492 pub extern "C" fn ChannelDetails_clone(orig: &ChannelDetails) -> ChannelDetails {
495 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
496 /// Err() type describing which state the payment is in, see the description of individual enum
501 pub enum PaymentSendFailure {
502 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
503 /// send the payment at all. No channel state has been changed or messages sent to peers, and
504 /// once you've changed the parameter at error, you can freely retry the payment in full.
505 ParameterError(crate::lightning::util::errors::APIError),
506 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
507 /// from attempting to send the payment at all. No channel state has been changed or messages
508 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
511 /// The results here are ordered the same as the paths in the route object which was passed to
513 PathParameterError(crate::c_types::derived::CVec_CResult_NoneAPIErrorZZ),
514 /// All paths which were attempted failed to send, with no channel state change taking place.
515 /// You can freely retry the payment in full (though you probably want to do so over different
516 /// paths than the ones selected).
517 AllFailedRetrySafe(crate::c_types::derived::CVec_APIErrorZ),
518 /// Some paths which were attempted failed to send, though possibly not all. At least some
519 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
520 /// in over-/re-payment.
522 /// The results here are ordered the same as the paths in the route object which was passed to
523 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
524 /// retried (though there is currently no API with which to do so).
526 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
527 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
528 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
529 /// with the latest update_id.
530 PartialFailure(crate::c_types::derived::CVec_CResult_NoneAPIErrorZZ),
532 use lightning::ln::channelmanager::PaymentSendFailure as nativePaymentSendFailure;
533 impl PaymentSendFailure {
535 pub(crate) fn to_native(&self) -> nativePaymentSendFailure {
537 PaymentSendFailure::ParameterError (ref a, ) => {
538 let mut a_nonref = (*a).clone();
539 nativePaymentSendFailure::ParameterError (
540 a_nonref.into_native(),
543 PaymentSendFailure::PathParameterError (ref a, ) => {
544 let mut a_nonref = (*a).clone();
545 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 }); };
546 nativePaymentSendFailure::PathParameterError (
550 PaymentSendFailure::AllFailedRetrySafe (ref a, ) => {
551 let mut a_nonref = (*a).clone();
552 let mut local_a_nonref = Vec::new(); for mut item in a_nonref.into_rust().drain(..) { local_a_nonref.push( { item.into_native() }); };
553 nativePaymentSendFailure::AllFailedRetrySafe (
557 PaymentSendFailure::PartialFailure (ref a, ) => {
558 let mut a_nonref = (*a).clone();
559 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 }); };
560 nativePaymentSendFailure::PartialFailure (
567 pub(crate) fn into_native(self) -> nativePaymentSendFailure {
569 PaymentSendFailure::ParameterError (mut a, ) => {
570 nativePaymentSendFailure::ParameterError (
574 PaymentSendFailure::PathParameterError (mut a, ) => {
575 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 }); };
576 nativePaymentSendFailure::PathParameterError (
580 PaymentSendFailure::AllFailedRetrySafe (mut a, ) => {
581 let mut local_a = Vec::new(); for mut item in a.into_rust().drain(..) { local_a.push( { item.into_native() }); };
582 nativePaymentSendFailure::AllFailedRetrySafe (
586 PaymentSendFailure::PartialFailure (mut a, ) => {
587 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 }); };
588 nativePaymentSendFailure::PartialFailure (
595 pub(crate) fn from_native(native: &nativePaymentSendFailure) -> Self {
597 nativePaymentSendFailure::ParameterError (ref a, ) => {
598 let mut a_nonref = (*a).clone();
599 PaymentSendFailure::ParameterError (
600 crate::lightning::util::errors::APIError::native_into(a_nonref),
603 nativePaymentSendFailure::PathParameterError (ref a, ) => {
604 let mut a_nonref = (*a).clone();
605 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( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() }; local_a_nonref_0 }); };
606 PaymentSendFailure::PathParameterError (
607 local_a_nonref.into(),
610 nativePaymentSendFailure::AllFailedRetrySafe (ref a, ) => {
611 let mut a_nonref = (*a).clone();
612 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) }); };
613 PaymentSendFailure::AllFailedRetrySafe (
614 local_a_nonref.into(),
617 nativePaymentSendFailure::PartialFailure (ref a, ) => {
618 let mut a_nonref = (*a).clone();
619 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( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() }; local_a_nonref_0 }); };
620 PaymentSendFailure::PartialFailure (
621 local_a_nonref.into(),
627 pub(crate) fn native_into(native: nativePaymentSendFailure) -> Self {
629 nativePaymentSendFailure::ParameterError (mut a, ) => {
630 PaymentSendFailure::ParameterError (
631 crate::lightning::util::errors::APIError::native_into(a),
634 nativePaymentSendFailure::PathParameterError (mut a, ) => {
635 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( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() }; local_a_0 }); };
636 PaymentSendFailure::PathParameterError (
640 nativePaymentSendFailure::AllFailedRetrySafe (mut a, ) => {
641 let mut local_a = Vec::new(); for mut item in a.drain(..) { local_a.push( { crate::lightning::util::errors::APIError::native_into(item) }); };
642 PaymentSendFailure::AllFailedRetrySafe (
646 nativePaymentSendFailure::PartialFailure (mut a, ) => {
647 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( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() }; local_a_0 }); };
648 PaymentSendFailure::PartialFailure (
655 /// Frees any resources used by the PaymentSendFailure
657 pub extern "C" fn PaymentSendFailure_free(this_ptr: PaymentSendFailure) { }
658 /// Creates a copy of the PaymentSendFailure
660 pub extern "C" fn PaymentSendFailure_clone(orig: &PaymentSendFailure) -> PaymentSendFailure {
663 /// Constructs a new ChannelManager to hold several channels and route between them.
665 /// This is the main \"logic hub\" for all channel-related actions, and implements
666 /// ChannelMessageHandler.
668 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
670 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
672 /// Users need to notify the new ChannelManager when a new block is connected or
673 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
674 /// from after `params.latest_hash`.
677 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 {
678 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()) });
679 ChannelManager { inner: Box::into_raw(Box::new(ret)), is_owned: true }
682 /// Gets the current configuration applied to all new channels, as
685 pub extern "C" fn ChannelManager_get_current_default_configuration(this_arg: &ChannelManager) -> crate::lightning::util::config::UserConfig {
686 let mut ret = unsafe { &*this_arg.inner }.get_current_default_configuration();
687 crate::lightning::util::config::UserConfig { inner: unsafe { ( (&(*ret) as *const _) as *mut _) }, is_owned: false }
690 /// Creates a new outbound channel to the given remote node and with the given value.
692 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
693 /// tracking of which events correspond with which create_channel call. Note that the
694 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
695 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
696 /// otherwise ignored.
698 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
699 /// PeerManager::process_events afterwards.
701 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
702 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
705 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 {
706 let mut local_override_config = if override_config.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(override_config.take_inner()) } }) };
707 let mut ret = unsafe { &*this_arg.inner }.create_channel(their_network_key.into_rust(), channel_value_satoshis, push_msat, user_id, local_override_config);
708 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() };
712 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
713 /// more information.
716 pub extern "C" fn ChannelManager_list_channels(this_arg: &ChannelManager) -> crate::c_types::derived::CVec_ChannelDetailsZ {
717 let mut ret = unsafe { &*this_arg.inner }.list_channels();
718 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 } }); };
722 /// Gets the list of usable channels, in random order. Useful as an argument to
723 /// get_route to ensure non-announced channels are used.
725 /// These are guaranteed to have their is_live value set to true, see the documentation for
726 /// ChannelDetails::is_live for more info on exactly what the criteria are.
729 pub extern "C" fn ChannelManager_list_usable_channels(this_arg: &ChannelManager) -> crate::c_types::derived::CVec_ChannelDetailsZ {
730 let mut ret = unsafe { &*this_arg.inner }.list_usable_channels();
731 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 } }); };
735 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
736 /// will be accepted on the given channel, and after additional timeout/the closing of all
737 /// pending HTLCs, the channel will be closed on chain.
739 /// May generate a SendShutdown message event on success, which should be relayed.
742 pub extern "C" fn ChannelManager_close_channel(this_arg: &ChannelManager, channel_id: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
743 let mut ret = unsafe { &*this_arg.inner }.close_channel(unsafe { &*channel_id});
744 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() };
748 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
749 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
752 pub extern "C" fn ChannelManager_force_close_channel(this_arg: &ChannelManager, channel_id: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
753 let mut ret = unsafe { &*this_arg.inner }.force_close_channel(unsafe { &*channel_id});
754 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() };
758 /// Force close all channels, immediately broadcasting the latest local commitment transaction
759 /// for each to the chain and rejecting new HTLCs on each.
761 pub extern "C" fn ChannelManager_force_close_all_channels(this_arg: &ChannelManager) {
762 unsafe { &*this_arg.inner }.force_close_all_channels()
765 /// Sends a payment along a given route.
767 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
768 /// fields for more info.
770 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
771 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
772 /// next hop knows the preimage to payment_hash they can claim an additional amount as
773 /// specified in the last hop in the route! Thus, you should probably do your own
774 /// payment_preimage tracking (which you should already be doing as they represent \"proof of
775 /// payment\") and prevent double-sends yourself.
777 /// May generate SendHTLCs message(s) event on success, which should be relayed.
779 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
780 /// each entry matching the corresponding-index entry in the route paths, see
781 /// PaymentSendFailure for more info.
783 /// In general, a path may raise:
784 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
785 /// node public key) is specified.
786 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
787 /// (including due to previous monitor update failure or new permanent monitor update
789 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
790 /// relevant updates.
792 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
793 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
794 /// different route unless you intend to pay twice!
796 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
797 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
798 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
799 /// must not contain multiple paths as multi-path payments require a recipient-provided
801 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
802 /// bit set (either as required or as available). If multiple paths are present in the Route,
803 /// we assume the invoice had the basic_mpp feature set.
806 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 {
807 let mut local_payment_secret = if payment_secret.data == [0; 32] { None } else { Some( { ::lightning::ln::channelmanager::PaymentSecret(payment_secret.data) }) };
808 let mut ret = unsafe { &*this_arg.inner }.send_payment(unsafe { &*route.inner }, ::lightning::ln::channelmanager::PaymentHash(payment_hash.data), &local_payment_secret);
809 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::channelmanager::PaymentSendFailure::native_into(e) }).into() };
813 /// Call this upon creation of a funding transaction for the given channel.
815 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
816 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
818 /// Panics if a funding transaction has already been provided for this channel.
820 /// May panic if the output found in the funding transaction is duplicative with some other
821 /// channel (note that this should be trivially prevented by using unique funding transaction
822 /// keys per-channel).
824 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
825 /// counterparty's signature the funding transaction will automatically be broadcast via the
826 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
828 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
829 /// not currently support replacing a funding transaction on an existing channel. Instead,
830 /// create a new channel with a conflicting funding transaction.
833 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 {
834 let mut ret = unsafe { &*this_arg.inner }.funding_transaction_generated(unsafe { &*temporary_channel_id}, funding_transaction.into_bitcoin());
835 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::util::errors::APIError::native_into(e) }).into() };
839 /// Generates a signed node_announcement from the given arguments and creates a
840 /// BroadcastNodeAnnouncement event. Note that such messages will be ignored unless peers have
841 /// seen a channel_announcement from us (ie unless we have public channels open).
843 /// RGB is a node \"color\" and alias is a printable human-readable string to describe this node
844 /// to humans. They carry no in-protocol meaning.
846 /// addresses represent the set (possibly empty) of socket addresses on which this node accepts
847 /// incoming connections. These will be broadcast to the network, publicly tying these
848 /// addresses together. If you wish to preserve user privacy, addresses should likely contain
849 /// only Tor Onion addresses.
851 /// Panics if addresses is absurdly large (more than 500).
853 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) {
854 let mut local_addresses = Vec::new(); for mut item in addresses.into_rust().drain(..) { local_addresses.push( { item.into_native() }); };
855 unsafe { &*this_arg.inner }.broadcast_node_announcement(rgb.data, alias.data, local_addresses)
858 /// Processes HTLCs which are pending waiting on random forward delay.
860 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
861 /// Will likely generate further events.
863 pub extern "C" fn ChannelManager_process_pending_htlc_forwards(this_arg: &ChannelManager) {
864 unsafe { &*this_arg.inner }.process_pending_htlc_forwards()
867 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
868 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
869 /// to inform the network about the uselessness of these channels.
871 /// This method handles all the details, and must be called roughly once per minute.
873 /// Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
875 pub extern "C" fn ChannelManager_timer_tick_occurred(this_arg: &ChannelManager) {
876 unsafe { &*this_arg.inner }.timer_tick_occurred()
879 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
880 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
881 /// along the path (including in our own channel on which we received it).
882 /// Returns false if no payment was found to fail backwards, true if the process of failing the
883 /// HTLC backwards has been started.
886 pub extern "C" fn ChannelManager_fail_htlc_backwards(this_arg: &ChannelManager, payment_hash: *const [u8; 32], mut payment_secret: crate::c_types::ThirtyTwoBytes) -> bool {
887 let mut local_payment_secret = if payment_secret.data == [0; 32] { None } else { Some( { ::lightning::ln::channelmanager::PaymentSecret(payment_secret.data) }) };
888 let mut ret = unsafe { &*this_arg.inner }.fail_htlc_backwards(&::lightning::ln::channelmanager::PaymentHash(unsafe { *payment_hash }), &local_payment_secret);
892 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
893 /// generating message events for the net layer to claim the payment, if possible. Thus, you
894 /// should probably kick the net layer to go send messages if this returns true!
896 /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
897 /// available within a few percent of the expected amount. This is critical for several
898 /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
899 /// payment_preimage without having provided the full value and b) it avoids certain
900 /// privacy-breaking recipient-probing attacks which may reveal payment activity to
901 /// motivated attackers.
903 /// Note that the privacy concerns in (b) are not relevant in payments with a payment_secret
904 /// set. Thus, for such payments we will claim any payments which do not under-pay.
906 /// May panic if called except in response to a PaymentReceived event.
909 pub extern "C" fn ChannelManager_claim_funds(this_arg: &ChannelManager, mut payment_preimage: crate::c_types::ThirtyTwoBytes, mut payment_secret: crate::c_types::ThirtyTwoBytes, mut expected_amount: u64) -> bool {
910 let mut local_payment_secret = if payment_secret.data == [0; 32] { None } else { Some( { ::lightning::ln::channelmanager::PaymentSecret(payment_secret.data) }) };
911 let mut ret = unsafe { &*this_arg.inner }.claim_funds(::lightning::ln::channelmanager::PaymentPreimage(payment_preimage.data), &local_payment_secret, expected_amount);
915 /// Gets the node_id held by this ChannelManager
918 pub extern "C" fn ChannelManager_get_our_node_id(this_arg: &ChannelManager) -> crate::c_types::PublicKey {
919 let mut ret = unsafe { &*this_arg.inner }.get_our_node_id();
920 crate::c_types::PublicKey::from_rust(&ret)
923 /// Restores a single, given channel to normal operation after a
924 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
927 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
928 /// fully committed in every copy of the given channels' ChannelMonitors.
930 /// Note that there is no effect to calling with a highest_applied_update_id other than the
931 /// current latest ChannelMonitorUpdate and one call to this function after multiple
932 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
933 /// exists largely only to prevent races between this and concurrent update_monitor calls.
935 /// Thus, the anticipated use is, at a high level:
936 /// 1) You register a chain::Watch with this ChannelManager,
937 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
938 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
939 /// any time it cannot do so instantly,
940 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
941 /// 4) once all remote copies are updated, you call this function with the update_id that
942 /// completed, and once it is the latest the Channel will be re-enabled.
944 pub extern "C" fn ChannelManager_channel_monitor_updated(this_arg: &ChannelManager, funding_txo: &crate::lightning::chain::transaction::OutPoint, mut highest_applied_update_id: u64) {
945 unsafe { &*this_arg.inner }.channel_monitor_updated(unsafe { &*funding_txo.inner }, highest_applied_update_id)
948 impl From<nativeChannelManager> for crate::lightning::util::events::MessageSendEventsProvider {
949 fn from(obj: nativeChannelManager) -> Self {
950 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
951 let mut ret = ChannelManager_as_MessageSendEventsProvider(&rust_obj);
952 // 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
953 rust_obj.inner = std::ptr::null_mut();
954 ret.free = Some(ChannelManager_free_void);
958 /// Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
959 /// This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
961 pub extern "C" fn ChannelManager_as_MessageSendEventsProvider(this_arg: &ChannelManager) -> crate::lightning::util::events::MessageSendEventsProvider {
962 crate::lightning::util::events::MessageSendEventsProvider {
963 this_arg: unsafe { (*this_arg).inner as *mut c_void },
965 get_and_clear_pending_msg_events: ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events,
970 extern "C" fn ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_MessageSendEventZ {
971 let mut ret = <nativeChannelManager as lightning::util::events::MessageSendEventsProvider<>>::get_and_clear_pending_msg_events(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
972 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::util::events::MessageSendEvent::native_into(item) }); };
976 impl From<nativeChannelManager> for crate::lightning::util::events::EventsProvider {
977 fn from(obj: nativeChannelManager) -> Self {
978 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
979 let mut ret = ChannelManager_as_EventsProvider(&rust_obj);
980 // 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
981 rust_obj.inner = std::ptr::null_mut();
982 ret.free = Some(ChannelManager_free_void);
986 /// Constructs a new EventsProvider which calls the relevant methods on this_arg.
987 /// This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
989 pub extern "C" fn ChannelManager_as_EventsProvider(this_arg: &ChannelManager) -> crate::lightning::util::events::EventsProvider {
990 crate::lightning::util::events::EventsProvider {
991 this_arg: unsafe { (*this_arg).inner as *mut c_void },
993 get_and_clear_pending_events: ChannelManager_EventsProvider_get_and_clear_pending_events,
998 extern "C" fn ChannelManager_EventsProvider_get_and_clear_pending_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_EventZ {
999 let mut ret = <nativeChannelManager as lightning::util::events::EventsProvider<>>::get_and_clear_pending_events(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
1000 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::util::events::Event::native_into(item) }); };
1004 impl From<nativeChannelManager> for crate::lightning::chain::Listen {
1005 fn from(obj: nativeChannelManager) -> Self {
1006 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1007 let mut ret = ChannelManager_as_Listen(&rust_obj);
1008 // 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
1009 rust_obj.inner = std::ptr::null_mut();
1010 ret.free = Some(ChannelManager_free_void);
1014 /// Constructs a new Listen which calls the relevant methods on this_arg.
1015 /// This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
1017 pub extern "C" fn ChannelManager_as_Listen(this_arg: &ChannelManager) -> crate::lightning::chain::Listen {
1018 crate::lightning::chain::Listen {
1019 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1021 block_connected: ChannelManager_Listen_block_connected,
1022 block_disconnected: ChannelManager_Listen_block_disconnected,
1026 extern "C" fn ChannelManager_Listen_block_connected(this_arg: *const c_void, mut block: crate::c_types::u8slice, mut height: u32) {
1027 <nativeChannelManager as lightning::chain::Listen<>>::block_connected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(block.to_slice()).unwrap(), height)
1029 extern "C" fn ChannelManager_Listen_block_disconnected(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
1030 <nativeChannelManager as lightning::chain::Listen<>>::block_disconnected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
1033 impl From<nativeChannelManager> for crate::lightning::chain::Confirm {
1034 fn from(obj: nativeChannelManager) -> Self {
1035 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1036 let mut ret = ChannelManager_as_Confirm(&rust_obj);
1037 // 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
1038 rust_obj.inner = std::ptr::null_mut();
1039 ret.free = Some(ChannelManager_free_void);
1043 /// Constructs a new Confirm which calls the relevant methods on this_arg.
1044 /// This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
1046 pub extern "C" fn ChannelManager_as_Confirm(this_arg: &ChannelManager) -> crate::lightning::chain::Confirm {
1047 crate::lightning::chain::Confirm {
1048 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1050 transactions_confirmed: ChannelManager_Confirm_transactions_confirmed,
1051 transaction_unconfirmed: ChannelManager_Confirm_transaction_unconfirmed,
1052 best_block_updated: ChannelManager_Confirm_best_block_updated,
1053 get_relevant_txids: ChannelManager_Confirm_get_relevant_txids,
1057 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) {
1058 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 }); };
1059 <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)
1061 extern "C" fn ChannelManager_Confirm_best_block_updated(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
1062 <nativeChannelManager as lightning::chain::Confirm<>>::best_block_updated(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
1065 extern "C" fn ChannelManager_Confirm_get_relevant_txids(this_arg: *const c_void) -> crate::c_types::derived::CVec_TxidZ {
1066 let mut ret = <nativeChannelManager as lightning::chain::Confirm<>>::get_relevant_txids(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
1067 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::c_types::ThirtyTwoBytes { data: item.into_inner() } }); };
1070 extern "C" fn ChannelManager_Confirm_transaction_unconfirmed(this_arg: *const c_void, txid: *const [u8; 32]) {
1071 <nativeChannelManager as lightning::chain::Confirm<>>::transaction_unconfirmed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::hash_types::Txid::from_slice(&unsafe { &*txid }[..]).unwrap())
1074 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
1075 /// indicating whether persistence is necessary. Only one listener on
1076 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
1078 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
1081 pub extern "C" fn ChannelManager_await_persistable_update_timeout(this_arg: &ChannelManager, mut max_wait: u64) -> bool {
1082 let mut ret = unsafe { &*this_arg.inner }.await_persistable_update_timeout(std::time::Duration::from_secs(max_wait));
1086 /// Blocks until ChannelManager needs to be persisted. Only one listener on
1087 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
1090 pub extern "C" fn ChannelManager_await_persistable_update(this_arg: &ChannelManager) {
1091 unsafe { &*this_arg.inner }.await_persistable_update()
1094 impl From<nativeChannelManager> for crate::lightning::ln::msgs::ChannelMessageHandler {
1095 fn from(obj: nativeChannelManager) -> Self {
1096 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1097 let mut ret = ChannelManager_as_ChannelMessageHandler(&rust_obj);
1098 // 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
1099 rust_obj.inner = std::ptr::null_mut();
1100 ret.free = Some(ChannelManager_free_void);
1104 /// Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
1105 /// This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
1107 pub extern "C" fn ChannelManager_as_ChannelMessageHandler(this_arg: &ChannelManager) -> crate::lightning::ln::msgs::ChannelMessageHandler {
1108 crate::lightning::ln::msgs::ChannelMessageHandler {
1109 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1111 handle_open_channel: ChannelManager_ChannelMessageHandler_handle_open_channel,
1112 handle_accept_channel: ChannelManager_ChannelMessageHandler_handle_accept_channel,
1113 handle_funding_created: ChannelManager_ChannelMessageHandler_handle_funding_created,
1114 handle_funding_signed: ChannelManager_ChannelMessageHandler_handle_funding_signed,
1115 handle_funding_locked: ChannelManager_ChannelMessageHandler_handle_funding_locked,
1116 handle_shutdown: ChannelManager_ChannelMessageHandler_handle_shutdown,
1117 handle_closing_signed: ChannelManager_ChannelMessageHandler_handle_closing_signed,
1118 handle_update_add_htlc: ChannelManager_ChannelMessageHandler_handle_update_add_htlc,
1119 handle_update_fulfill_htlc: ChannelManager_ChannelMessageHandler_handle_update_fulfill_htlc,
1120 handle_update_fail_htlc: ChannelManager_ChannelMessageHandler_handle_update_fail_htlc,
1121 handle_update_fail_malformed_htlc: ChannelManager_ChannelMessageHandler_handle_update_fail_malformed_htlc,
1122 handle_commitment_signed: ChannelManager_ChannelMessageHandler_handle_commitment_signed,
1123 handle_revoke_and_ack: ChannelManager_ChannelMessageHandler_handle_revoke_and_ack,
1124 handle_update_fee: ChannelManager_ChannelMessageHandler_handle_update_fee,
1125 handle_announcement_signatures: ChannelManager_ChannelMessageHandler_handle_announcement_signatures,
1126 peer_disconnected: ChannelManager_ChannelMessageHandler_peer_disconnected,
1127 peer_connected: ChannelManager_ChannelMessageHandler_peer_connected,
1128 handle_channel_reestablish: ChannelManager_ChannelMessageHandler_handle_channel_reestablish,
1129 handle_channel_update: ChannelManager_ChannelMessageHandler_handle_channel_update,
1130 handle_error: ChannelManager_ChannelMessageHandler_handle_error,
1131 MessageSendEventsProvider: crate::lightning::util::events::MessageSendEventsProvider {
1132 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1134 get_and_clear_pending_msg_events: ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events,
1139 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) {
1140 <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 })
1142 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) {
1143 <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 })
1145 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) {
1146 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_created(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1148 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) {
1149 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1151 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) {
1152 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_locked(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1154 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) {
1155 <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 })
1157 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) {
1158 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_closing_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1160 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) {
1161 <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 })
1163 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) {
1164 <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 })
1166 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) {
1167 <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 })
1169 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) {
1170 <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 })
1172 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) {
1173 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_commitment_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1175 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) {
1176 <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 })
1178 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) {
1179 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_fee(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1181 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) {
1182 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_announcement_signatures(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1184 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) {
1185 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_channel_update(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1187 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) {
1188 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_channel_reestablish(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1190 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) {
1191 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::peer_disconnected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), no_connection_possible)
1193 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) {
1194 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::peer_connected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*init_msg.inner })
1196 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) {
1197 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_error(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1201 /// Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
1202 pub extern "C" fn ChannelManager_write(obj: &ChannelManager) -> crate::c_types::derived::CVec_u8Z {
1203 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
1206 pub(crate) extern "C" fn ChannelManager_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1207 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelManager) })
1210 use lightning::ln::channelmanager::ChannelManagerReadArgs as nativeChannelManagerReadArgsImport;
1211 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>;
1213 /// Arguments for the creation of a ChannelManager that are not deserialized.
1215 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
1217 /// 1) Deserialize all stored ChannelMonitors.
1218 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
1219 /// <(BlockHash, ChannelManager)>::read(reader, args)
1220 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
1221 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
1222 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
1223 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
1224 /// ChannelMonitor::get_funding_txo().
1225 /// 4) Reconnect blocks on your ChannelMonitors.
1226 /// 5) Disconnect/connect blocks on the ChannelManager.
1227 /// 6) Move the ChannelMonitors into your local chain::Watch.
1229 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
1230 /// call any other methods on the newly-deserialized ChannelManager.
1232 /// Note that because some channels may be closed during deserialization, it is critical that you
1233 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
1234 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
1235 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
1236 /// not force-close the same channels but consider them live), you may end up revoking a state for
1237 /// which you've already broadcasted the transaction.
1240 pub struct ChannelManagerReadArgs {
1241 /// A pointer to the opaque Rust object.
1243 /// Nearly everywhere, inner must be non-null, however in places where
1244 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1245 pub inner: *mut nativeChannelManagerReadArgs,
1246 /// Indicates that this is the only struct which contains the same pointer.
1248 /// Rust functions which take ownership of an object provided via an argument require
1249 /// this to be true and invalidate the object pointed to by inner.
1253 impl Drop for ChannelManagerReadArgs {
1254 fn drop(&mut self) {
1255 if self.is_owned && !<*mut nativeChannelManagerReadArgs>::is_null(self.inner) {
1256 let _ = unsafe { Box::from_raw(self.inner) };
1260 /// Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL.
1262 pub extern "C" fn ChannelManagerReadArgs_free(this_obj: ChannelManagerReadArgs) { }
1264 /// Used only if an object of this type is returned as a trait impl by a method
1265 extern "C" fn ChannelManagerReadArgs_free_void(this_ptr: *mut c_void) {
1266 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelManagerReadArgs); }
1269 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1270 impl ChannelManagerReadArgs {
1271 pub(crate) fn take_inner(mut self) -> *mut nativeChannelManagerReadArgs {
1272 assert!(self.is_owned);
1273 let ret = self.inner;
1274 self.inner = std::ptr::null_mut();
1278 /// The keys provider which will give us relevant keys. Some keys will be loaded during
1279 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
1282 pub extern "C" fn ChannelManagerReadArgs_get_keys_manager(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::keysinterface::KeysInterface {
1283 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.keys_manager;
1286 /// The keys provider which will give us relevant keys. Some keys will be loaded during
1287 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
1290 pub extern "C" fn ChannelManagerReadArgs_set_keys_manager(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::keysinterface::KeysInterface) {
1291 unsafe { &mut *this_ptr.inner }.keys_manager = val;
1293 /// The fee_estimator for use in the ChannelManager in the future.
1295 /// No calls to the FeeEstimator will be made during deserialization.
1297 pub extern "C" fn ChannelManagerReadArgs_get_fee_estimator(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::chaininterface::FeeEstimator {
1298 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fee_estimator;
1301 /// The fee_estimator for use in the ChannelManager in the future.
1303 /// No calls to the FeeEstimator will be made during deserialization.
1305 pub extern "C" fn ChannelManagerReadArgs_set_fee_estimator(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::chaininterface::FeeEstimator) {
1306 unsafe { &mut *this_ptr.inner }.fee_estimator = val;
1308 /// The chain::Watch for use in the ChannelManager in the future.
1310 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
1311 /// you have deserialized ChannelMonitors separately and will add them to your
1312 /// chain::Watch after deserializing this ChannelManager.
1314 pub extern "C" fn ChannelManagerReadArgs_get_chain_monitor(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::Watch {
1315 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.chain_monitor;
1318 /// The chain::Watch for use in the ChannelManager in the future.
1320 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
1321 /// you have deserialized ChannelMonitors separately and will add them to your
1322 /// chain::Watch after deserializing this ChannelManager.
1324 pub extern "C" fn ChannelManagerReadArgs_set_chain_monitor(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::Watch) {
1325 unsafe { &mut *this_ptr.inner }.chain_monitor = val;
1327 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
1328 /// used to broadcast the latest local commitment transactions of channels which must be
1329 /// force-closed during deserialization.
1331 pub extern "C" fn ChannelManagerReadArgs_get_tx_broadcaster(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::chaininterface::BroadcasterInterface {
1332 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.tx_broadcaster;
1335 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
1336 /// used to broadcast the latest local commitment transactions of channels which must be
1337 /// force-closed during deserialization.
1339 pub extern "C" fn ChannelManagerReadArgs_set_tx_broadcaster(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::chaininterface::BroadcasterInterface) {
1340 unsafe { &mut *this_ptr.inner }.tx_broadcaster = val;
1342 /// The Logger for use in the ChannelManager and which may be used to log information during
1343 /// deserialization.
1345 pub extern "C" fn ChannelManagerReadArgs_get_logger(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::util::logger::Logger {
1346 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.logger;
1349 /// The Logger for use in the ChannelManager and which may be used to log information during
1350 /// deserialization.
1352 pub extern "C" fn ChannelManagerReadArgs_set_logger(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::util::logger::Logger) {
1353 unsafe { &mut *this_ptr.inner }.logger = val;
1355 /// Default settings used for new channels. Any existing channels will continue to use the
1356 /// runtime settings which were stored when the ChannelManager was serialized.
1358 pub extern "C" fn ChannelManagerReadArgs_get_default_config(this_ptr: &ChannelManagerReadArgs) -> crate::lightning::util::config::UserConfig {
1359 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.default_config;
1360 crate::lightning::util::config::UserConfig { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
1362 /// Default settings used for new channels. Any existing channels will continue to use the
1363 /// runtime settings which were stored when the ChannelManager was serialized.
1365 pub extern "C" fn ChannelManagerReadArgs_set_default_config(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::util::config::UserConfig) {
1366 unsafe { &mut *this_ptr.inner }.default_config = *unsafe { Box::from_raw(val.take_inner()) };
1368 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
1369 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
1370 /// populate a HashMap directly from C.
1373 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 {
1374 let mut local_channel_monitors = Vec::new(); for mut item in channel_monitors.into_rust().drain(..) { local_channel_monitors.push( { unsafe { &mut *item.inner } }); };
1375 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);
1376 ChannelManagerReadArgs { inner: Box::into_raw(Box::new(ret)), is_owned: true }
1380 /// Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
1381 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 {
1382 let arg_conv = *unsafe { Box::from_raw(arg.take_inner()) };
1383 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);
1384 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() };