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::ln::channelmanager::BestBlock {
170 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.best_block;
171 crate::lightning::ln::channelmanager::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::ln::channelmanager::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::ln::channelmanager::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 }
190 use lightning::ln::channelmanager::BestBlock as nativeBestBlockImport;
191 type nativeBestBlock = nativeBestBlockImport;
193 /// The best known block as identified by its hash and height.
196 pub struct BestBlock {
197 /// A pointer to the opaque Rust object.
199 /// Nearly everywhere, inner must be non-null, however in places where
200 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
201 pub inner: *mut nativeBestBlock,
202 /// Indicates that this is the only struct which contains the same pointer.
204 /// Rust functions which take ownership of an object provided via an argument require
205 /// this to be true and invalidate the object pointed to by inner.
209 impl Drop for BestBlock {
211 if self.is_owned && !<*mut nativeBestBlock>::is_null(self.inner) {
212 let _ = unsafe { Box::from_raw(self.inner) };
216 /// Frees any resources used by the BestBlock, if is_owned is set and inner is non-NULL.
218 pub extern "C" fn BestBlock_free(this_obj: BestBlock) { }
220 /// Used only if an object of this type is returned as a trait impl by a method
221 extern "C" fn BestBlock_free_void(this_ptr: *mut c_void) {
222 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeBestBlock); }
225 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
227 pub(crate) fn take_inner(mut self) -> *mut nativeBestBlock {
228 assert!(self.is_owned);
229 let ret = self.inner;
230 self.inner = std::ptr::null_mut();
234 impl Clone for BestBlock {
235 fn clone(&self) -> Self {
237 inner: if <*mut nativeBestBlock>::is_null(self.inner) { std::ptr::null_mut() } else {
238 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
244 /// Used only if an object of this type is returned as a trait impl by a method
245 pub(crate) extern "C" fn BestBlock_clone_void(this_ptr: *const c_void) -> *mut c_void {
246 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeBestBlock)).clone() })) as *mut c_void
249 /// Creates a copy of the BestBlock
250 pub extern "C" fn BestBlock_clone(orig: &BestBlock) -> BestBlock {
253 /// Returns the best block from the genesis of the given network.
256 pub extern "C" fn BestBlock_from_genesis(mut network: crate::bitcoin::network::Network) -> BestBlock {
257 let mut ret = lightning::ln::channelmanager::BestBlock::from_genesis(network.into_bitcoin());
258 BestBlock { inner: Box::into_raw(Box::new(ret)), is_owned: true }
261 /// Returns the best block as identified by the given block hash and height.
264 pub extern "C" fn BestBlock_new(mut block_hash: crate::c_types::ThirtyTwoBytes, mut height: u32) -> BestBlock {
265 let mut ret = lightning::ln::channelmanager::BestBlock::new(::bitcoin::hash_types::BlockHash::from_slice(&block_hash.data[..]).unwrap(), height);
266 BestBlock { inner: Box::into_raw(Box::new(ret)), is_owned: true }
269 /// Returns the best block hash.
272 pub extern "C" fn BestBlock_block_hash(this_arg: &BestBlock) -> crate::c_types::ThirtyTwoBytes {
273 let mut ret = unsafe { &*this_arg.inner }.block_hash();
274 crate::c_types::ThirtyTwoBytes { data: ret.into_inner() }
277 /// Returns the best block height.
280 pub extern "C" fn BestBlock_height(this_arg: &BestBlock) -> u32 {
281 let mut ret = unsafe { &*this_arg.inner }.height();
285 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
286 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
288 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
290 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
293 pub static BREAKDOWN_TIMEOUT: u16 = lightning::ln::channelmanager::BREAKDOWN_TIMEOUT;
294 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
295 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
297 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
299 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
302 pub static MIN_CLTV_EXPIRY_DELTA: u16 = lightning::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA;
303 /// Minimum CLTV difference between the current block height and received inbound payments.
304 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
308 pub static MIN_FINAL_CLTV_EXPIRY: u32 = lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY;
310 use lightning::ln::channelmanager::ChannelDetails as nativeChannelDetailsImport;
311 type nativeChannelDetails = nativeChannelDetailsImport;
313 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
316 pub struct ChannelDetails {
317 /// A pointer to the opaque Rust object.
319 /// Nearly everywhere, inner must be non-null, however in places where
320 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
321 pub inner: *mut nativeChannelDetails,
322 /// Indicates that this is the only struct which contains the same pointer.
324 /// Rust functions which take ownership of an object provided via an argument require
325 /// this to be true and invalidate the object pointed to by inner.
329 impl Drop for ChannelDetails {
331 if self.is_owned && !<*mut nativeChannelDetails>::is_null(self.inner) {
332 let _ = unsafe { Box::from_raw(self.inner) };
336 /// Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL.
338 pub extern "C" fn ChannelDetails_free(this_obj: ChannelDetails) { }
340 /// Used only if an object of this type is returned as a trait impl by a method
341 extern "C" fn ChannelDetails_free_void(this_ptr: *mut c_void) {
342 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelDetails); }
345 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
346 impl ChannelDetails {
347 pub(crate) fn take_inner(mut self) -> *mut nativeChannelDetails {
348 assert!(self.is_owned);
349 let ret = self.inner;
350 self.inner = std::ptr::null_mut();
354 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
355 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
356 /// Note that this means this value is *not* persistent - it can change once during the
357 /// lifetime of the channel.
359 pub extern "C" fn ChannelDetails_get_channel_id(this_ptr: &ChannelDetails) -> *const [u8; 32] {
360 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_id;
363 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
364 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
365 /// Note that this means this value is *not* persistent - it can change once during the
366 /// lifetime of the channel.
368 pub extern "C" fn ChannelDetails_set_channel_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::ThirtyTwoBytes) {
369 unsafe { &mut *this_ptr.inner }.channel_id = val.data;
371 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
372 /// our counterparty already.
374 /// Note that, if this has been set, `channel_id` will be equivalent to
375 /// `funding_txo.unwrap().to_channel_id()`.
377 pub extern "C" fn ChannelDetails_get_funding_txo(this_ptr: &ChannelDetails) -> crate::lightning::chain::transaction::OutPoint {
378 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.funding_txo;
379 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 };
382 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
383 /// our counterparty already.
385 /// Note that, if this has been set, `channel_id` will be equivalent to
386 /// `funding_txo.unwrap().to_channel_id()`.
388 pub extern "C" fn ChannelDetails_set_funding_txo(this_ptr: &mut ChannelDetails, mut val: crate::lightning::chain::transaction::OutPoint) {
389 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
390 unsafe { &mut *this_ptr.inner }.funding_txo = local_val;
392 /// The position of the funding transaction in the chain. None if the funding transaction has
393 /// not yet been confirmed and the channel fully opened.
395 pub extern "C" fn ChannelDetails_get_short_channel_id(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u64Z {
396 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.short_channel_id;
397 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()) } };
400 /// The position of the funding transaction in the chain. None if the funding transaction has
401 /// not yet been confirmed and the channel fully opened.
403 pub extern "C" fn ChannelDetails_set_short_channel_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u64Z) {
404 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
405 unsafe { &mut *this_ptr.inner }.short_channel_id = local_val;
407 /// The node_id of our counterparty
409 pub extern "C" fn ChannelDetails_get_remote_network_id(this_ptr: &ChannelDetails) -> crate::c_types::PublicKey {
410 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.remote_network_id;
411 crate::c_types::PublicKey::from_rust(&inner_val)
413 /// The node_id of our counterparty
415 pub extern "C" fn ChannelDetails_set_remote_network_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::PublicKey) {
416 unsafe { &mut *this_ptr.inner }.remote_network_id = val.into_rust();
418 /// The Features the channel counterparty provided upon last connection.
419 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
420 /// many routing-relevant features are present in the init context.
422 pub extern "C" fn ChannelDetails_get_counterparty_features(this_ptr: &ChannelDetails) -> crate::lightning::ln::features::InitFeatures {
423 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.counterparty_features;
424 crate::lightning::ln::features::InitFeatures { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
426 /// The Features the channel counterparty provided upon last connection.
427 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
428 /// many routing-relevant features are present in the init context.
430 pub extern "C" fn ChannelDetails_set_counterparty_features(this_ptr: &mut ChannelDetails, mut val: crate::lightning::ln::features::InitFeatures) {
431 unsafe { &mut *this_ptr.inner }.counterparty_features = *unsafe { Box::from_raw(val.take_inner()) };
433 /// The value, in satoshis, of this channel as appears in the funding output
435 pub extern "C" fn ChannelDetails_get_channel_value_satoshis(this_ptr: &ChannelDetails) -> u64 {
436 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_value_satoshis;
439 /// The value, in satoshis, of this channel as appears in the funding output
441 pub extern "C" fn ChannelDetails_set_channel_value_satoshis(this_ptr: &mut ChannelDetails, mut val: u64) {
442 unsafe { &mut *this_ptr.inner }.channel_value_satoshis = val;
444 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
446 pub extern "C" fn ChannelDetails_get_user_id(this_ptr: &ChannelDetails) -> u64 {
447 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.user_id;
450 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
452 pub extern "C" fn ChannelDetails_set_user_id(this_ptr: &mut ChannelDetails, mut val: u64) {
453 unsafe { &mut *this_ptr.inner }.user_id = val;
455 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
456 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
457 /// available for inclusion in new outbound HTLCs). This further does not include any pending
458 /// outgoing HTLCs which are awaiting some other resolution to be sent.
460 pub extern "C" fn ChannelDetails_get_outbound_capacity_msat(this_ptr: &ChannelDetails) -> u64 {
461 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.outbound_capacity_msat;
464 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
465 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
466 /// available for inclusion in new outbound HTLCs). This further does not include any pending
467 /// outgoing HTLCs which are awaiting some other resolution to be sent.
469 pub extern "C" fn ChannelDetails_set_outbound_capacity_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
470 unsafe { &mut *this_ptr.inner }.outbound_capacity_msat = val;
472 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
473 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
474 /// available for inclusion in new inbound HTLCs).
475 /// Note that there are some corner cases not fully handled here, so the actual available
476 /// inbound capacity may be slightly higher than this.
478 pub extern "C" fn ChannelDetails_get_inbound_capacity_msat(this_ptr: &ChannelDetails) -> u64 {
479 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.inbound_capacity_msat;
482 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
483 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
484 /// available for inclusion in new inbound HTLCs).
485 /// Note that there are some corner cases not fully handled here, so the actual available
486 /// inbound capacity may be slightly higher than this.
488 pub extern "C" fn ChannelDetails_set_inbound_capacity_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
489 unsafe { &mut *this_ptr.inner }.inbound_capacity_msat = val;
491 /// True if the channel was initiated (and thus funded) by us.
493 pub extern "C" fn ChannelDetails_get_is_outbound(this_ptr: &ChannelDetails) -> bool {
494 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.is_outbound;
497 /// True if the channel was initiated (and thus funded) by us.
499 pub extern "C" fn ChannelDetails_set_is_outbound(this_ptr: &mut ChannelDetails, mut val: bool) {
500 unsafe { &mut *this_ptr.inner }.is_outbound = val;
502 /// True if the channel is confirmed, funding_locked messages have been exchanged, and the
503 /// channel is not currently being shut down. `funding_locked` message exchange implies the
504 /// required confirmation count has been reached (and we were connected to the peer at some
505 /// point after the funding transaction received enough confirmations).
507 pub extern "C" fn ChannelDetails_get_is_funding_locked(this_ptr: &ChannelDetails) -> bool {
508 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.is_funding_locked;
511 /// True if the channel is confirmed, funding_locked messages have been exchanged, and the
512 /// channel is not currently being shut down. `funding_locked` message exchange implies the
513 /// required confirmation count has been reached (and we were connected to the peer at some
514 /// point after the funding transaction received enough confirmations).
516 pub extern "C" fn ChannelDetails_set_is_funding_locked(this_ptr: &mut ChannelDetails, mut val: bool) {
517 unsafe { &mut *this_ptr.inner }.is_funding_locked = val;
519 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
520 /// the peer is connected, (c) no monitor update failure is pending resolution, and (d) the
521 /// channel is not currently negotiating a shutdown.
523 /// This is a strict superset of `is_funding_locked`.
525 pub extern "C" fn ChannelDetails_get_is_usable(this_ptr: &ChannelDetails) -> bool {
526 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.is_usable;
529 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
530 /// the peer is connected, (c) no monitor update failure is pending resolution, and (d) the
531 /// channel is not currently negotiating a shutdown.
533 /// This is a strict superset of `is_funding_locked`.
535 pub extern "C" fn ChannelDetails_set_is_usable(this_ptr: &mut ChannelDetails, mut val: bool) {
536 unsafe { &mut *this_ptr.inner }.is_usable = val;
538 /// True if this channel is (or will be) publicly-announced.
540 pub extern "C" fn ChannelDetails_get_is_public(this_ptr: &ChannelDetails) -> bool {
541 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.is_public;
544 /// True if this channel is (or will be) publicly-announced.
546 pub extern "C" fn ChannelDetails_set_is_public(this_ptr: &mut ChannelDetails, mut val: bool) {
547 unsafe { &mut *this_ptr.inner }.is_public = val;
549 impl Clone for ChannelDetails {
550 fn clone(&self) -> Self {
552 inner: if <*mut nativeChannelDetails>::is_null(self.inner) { std::ptr::null_mut() } else {
553 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
559 /// Used only if an object of this type is returned as a trait impl by a method
560 pub(crate) extern "C" fn ChannelDetails_clone_void(this_ptr: *const c_void) -> *mut c_void {
561 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelDetails)).clone() })) as *mut c_void
564 /// Creates a copy of the ChannelDetails
565 pub extern "C" fn ChannelDetails_clone(orig: &ChannelDetails) -> ChannelDetails {
568 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
569 /// Err() type describing which state the payment is in, see the description of individual enum
574 pub enum PaymentSendFailure {
575 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
576 /// send the payment at all. No channel state has been changed or messages sent to peers, and
577 /// once you've changed the parameter at error, you can freely retry the payment in full.
578 ParameterError(crate::lightning::util::errors::APIError),
579 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
580 /// from attempting to send the payment at all. No channel state has been changed or messages
581 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
584 /// The results here are ordered the same as the paths in the route object which was passed to
586 PathParameterError(crate::c_types::derived::CVec_CResult_NoneAPIErrorZZ),
587 /// All paths which were attempted failed to send, with no channel state change taking place.
588 /// You can freely retry the payment in full (though you probably want to do so over different
589 /// paths than the ones selected).
590 AllFailedRetrySafe(crate::c_types::derived::CVec_APIErrorZ),
591 /// Some paths which were attempted failed to send, though possibly not all. At least some
592 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
593 /// in over-/re-payment.
595 /// The results here are ordered the same as the paths in the route object which was passed to
596 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
597 /// retried (though there is currently no API with which to do so).
599 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
600 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
601 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
602 /// with the latest update_id.
603 PartialFailure(crate::c_types::derived::CVec_CResult_NoneAPIErrorZZ),
605 use lightning::ln::channelmanager::PaymentSendFailure as nativePaymentSendFailure;
606 impl PaymentSendFailure {
608 pub(crate) fn to_native(&self) -> nativePaymentSendFailure {
610 PaymentSendFailure::ParameterError (ref a, ) => {
611 let mut a_nonref = (*a).clone();
612 nativePaymentSendFailure::ParameterError (
613 a_nonref.into_native(),
616 PaymentSendFailure::PathParameterError (ref a, ) => {
617 let mut a_nonref = (*a).clone();
618 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 }); };
619 nativePaymentSendFailure::PathParameterError (
623 PaymentSendFailure::AllFailedRetrySafe (ref a, ) => {
624 let mut a_nonref = (*a).clone();
625 let mut local_a_nonref = Vec::new(); for mut item in a_nonref.into_rust().drain(..) { local_a_nonref.push( { item.into_native() }); };
626 nativePaymentSendFailure::AllFailedRetrySafe (
630 PaymentSendFailure::PartialFailure (ref a, ) => {
631 let mut a_nonref = (*a).clone();
632 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 }); };
633 nativePaymentSendFailure::PartialFailure (
640 pub(crate) fn into_native(self) -> nativePaymentSendFailure {
642 PaymentSendFailure::ParameterError (mut a, ) => {
643 nativePaymentSendFailure::ParameterError (
647 PaymentSendFailure::PathParameterError (mut a, ) => {
648 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 }); };
649 nativePaymentSendFailure::PathParameterError (
653 PaymentSendFailure::AllFailedRetrySafe (mut a, ) => {
654 let mut local_a = Vec::new(); for mut item in a.into_rust().drain(..) { local_a.push( { item.into_native() }); };
655 nativePaymentSendFailure::AllFailedRetrySafe (
659 PaymentSendFailure::PartialFailure (mut a, ) => {
660 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 }); };
661 nativePaymentSendFailure::PartialFailure (
668 pub(crate) fn from_native(native: &nativePaymentSendFailure) -> Self {
670 nativePaymentSendFailure::ParameterError (ref a, ) => {
671 let mut a_nonref = (*a).clone();
672 PaymentSendFailure::ParameterError (
673 crate::lightning::util::errors::APIError::native_into(a_nonref),
676 nativePaymentSendFailure::PathParameterError (ref a, ) => {
677 let mut a_nonref = (*a).clone();
678 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 }); };
679 PaymentSendFailure::PathParameterError (
680 local_a_nonref.into(),
683 nativePaymentSendFailure::AllFailedRetrySafe (ref a, ) => {
684 let mut a_nonref = (*a).clone();
685 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) }); };
686 PaymentSendFailure::AllFailedRetrySafe (
687 local_a_nonref.into(),
690 nativePaymentSendFailure::PartialFailure (ref a, ) => {
691 let mut a_nonref = (*a).clone();
692 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 }); };
693 PaymentSendFailure::PartialFailure (
694 local_a_nonref.into(),
700 pub(crate) fn native_into(native: nativePaymentSendFailure) -> Self {
702 nativePaymentSendFailure::ParameterError (mut a, ) => {
703 PaymentSendFailure::ParameterError (
704 crate::lightning::util::errors::APIError::native_into(a),
707 nativePaymentSendFailure::PathParameterError (mut a, ) => {
708 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 }); };
709 PaymentSendFailure::PathParameterError (
713 nativePaymentSendFailure::AllFailedRetrySafe (mut a, ) => {
714 let mut local_a = Vec::new(); for mut item in a.drain(..) { local_a.push( { crate::lightning::util::errors::APIError::native_into(item) }); };
715 PaymentSendFailure::AllFailedRetrySafe (
719 nativePaymentSendFailure::PartialFailure (mut a, ) => {
720 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 }); };
721 PaymentSendFailure::PartialFailure (
728 /// Frees any resources used by the PaymentSendFailure
730 pub extern "C" fn PaymentSendFailure_free(this_ptr: PaymentSendFailure) { }
731 /// Creates a copy of the PaymentSendFailure
733 pub extern "C" fn PaymentSendFailure_clone(orig: &PaymentSendFailure) -> PaymentSendFailure {
736 /// Constructs a new ChannelManager to hold several channels and route between them.
738 /// This is the main \"logic hub\" for all channel-related actions, and implements
739 /// ChannelMessageHandler.
741 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
743 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
745 /// Users need to notify the new ChannelManager when a new block is connected or
746 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
747 /// from after `params.latest_hash`.
750 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 {
751 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()) });
752 ChannelManager { inner: Box::into_raw(Box::new(ret)), is_owned: true }
755 /// Gets the current configuration applied to all new channels, as
758 pub extern "C" fn ChannelManager_get_current_default_configuration(this_arg: &ChannelManager) -> crate::lightning::util::config::UserConfig {
759 let mut ret = unsafe { &*this_arg.inner }.get_current_default_configuration();
760 crate::lightning::util::config::UserConfig { inner: unsafe { ( (&(*ret) as *const _) as *mut _) }, is_owned: false }
763 /// Creates a new outbound channel to the given remote node and with the given value.
765 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
766 /// tracking of which events correspond with which create_channel call. Note that the
767 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
768 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
769 /// otherwise ignored.
771 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
772 /// PeerManager::process_events afterwards.
774 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
775 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
778 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 {
779 let mut local_override_config = if override_config.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(override_config.take_inner()) } }) };
780 let mut ret = unsafe { &*this_arg.inner }.create_channel(their_network_key.into_rust(), channel_value_satoshis, push_msat, user_id, local_override_config);
781 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() };
785 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
786 /// more information.
789 pub extern "C" fn ChannelManager_list_channels(this_arg: &ChannelManager) -> crate::c_types::derived::CVec_ChannelDetailsZ {
790 let mut ret = unsafe { &*this_arg.inner }.list_channels();
791 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 } }); };
795 /// Gets the list of usable channels, in random order. Useful as an argument to
796 /// get_route to ensure non-announced channels are used.
798 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
799 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
803 pub extern "C" fn ChannelManager_list_usable_channels(this_arg: &ChannelManager) -> crate::c_types::derived::CVec_ChannelDetailsZ {
804 let mut ret = unsafe { &*this_arg.inner }.list_usable_channels();
805 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 } }); };
809 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
810 /// will be accepted on the given channel, and after additional timeout/the closing of all
811 /// pending HTLCs, the channel will be closed on chain.
813 /// May generate a SendShutdown message event on success, which should be relayed.
816 pub extern "C" fn ChannelManager_close_channel(this_arg: &ChannelManager, channel_id: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
817 let mut ret = unsafe { &*this_arg.inner }.close_channel(unsafe { &*channel_id});
818 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() };
822 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
823 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
826 pub extern "C" fn ChannelManager_force_close_channel(this_arg: &ChannelManager, channel_id: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
827 let mut ret = unsafe { &*this_arg.inner }.force_close_channel(unsafe { &*channel_id});
828 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() };
832 /// Force close all channels, immediately broadcasting the latest local commitment transaction
833 /// for each to the chain and rejecting new HTLCs on each.
835 pub extern "C" fn ChannelManager_force_close_all_channels(this_arg: &ChannelManager) {
836 unsafe { &*this_arg.inner }.force_close_all_channels()
839 /// Sends a payment along a given route.
841 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
842 /// fields for more info.
844 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
845 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
846 /// next hop knows the preimage to payment_hash they can claim an additional amount as
847 /// specified in the last hop in the route! Thus, you should probably do your own
848 /// payment_preimage tracking (which you should already be doing as they represent \"proof of
849 /// payment\") and prevent double-sends yourself.
851 /// May generate SendHTLCs message(s) event on success, which should be relayed.
853 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
854 /// each entry matching the corresponding-index entry in the route paths, see
855 /// PaymentSendFailure for more info.
857 /// In general, a path may raise:
858 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
859 /// node public key) is specified.
860 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
861 /// (including due to previous monitor update failure or new permanent monitor update
863 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
864 /// relevant updates.
866 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
867 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
868 /// different route unless you intend to pay twice!
870 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
871 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
872 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
873 /// must not contain multiple paths as multi-path payments require a recipient-provided
875 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
876 /// bit set (either as required or as available). If multiple paths are present in the Route,
877 /// we assume the invoice had the basic_mpp feature set.
880 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 {
881 let mut local_payment_secret = if payment_secret.data == [0; 32] { None } else { Some( { ::lightning::ln::PaymentSecret(payment_secret.data) }) };
882 let mut ret = unsafe { &*this_arg.inner }.send_payment(unsafe { &*route.inner }, ::lightning::ln::PaymentHash(payment_hash.data), &local_payment_secret);
883 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() };
887 /// Call this upon creation of a funding transaction for the given channel.
889 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
890 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
892 /// Panics if a funding transaction has already been provided for this channel.
894 /// May panic if the output found in the funding transaction is duplicative with some other
895 /// channel (note that this should be trivially prevented by using unique funding transaction
896 /// keys per-channel).
898 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
899 /// counterparty's signature the funding transaction will automatically be broadcast via the
900 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
902 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
903 /// not currently support replacing a funding transaction on an existing channel. Instead,
904 /// create a new channel with a conflicting funding transaction.
906 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
909 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 {
910 let mut ret = unsafe { &*this_arg.inner }.funding_transaction_generated(unsafe { &*temporary_channel_id}, funding_transaction.into_bitcoin());
911 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() };
915 /// Regenerates channel_announcements and generates a signed node_announcement from the given
916 /// arguments, providing them in corresponding events via
917 /// [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
918 /// on-chain. This effectively re-broadcasts all channel announcements and sends our node
919 /// announcement to ensure that the lightning P2P network is aware of the channels we have and
920 /// our network addresses.
922 /// `rgb` is a node \"color\" and `alias` is a printable human-readable string to describe this
923 /// node to humans. They carry no in-protocol meaning.
925 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
926 /// accepts incoming connections. These will be included in the node_announcement, publicly
927 /// tying these addresses together and to this node. If you wish to preserve user privacy,
928 /// addresses should likely contain only Tor Onion addresses.
930 /// Panics if `addresses` is absurdly large (more than 500).
932 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
934 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) {
935 let mut local_addresses = Vec::new(); for mut item in addresses.into_rust().drain(..) { local_addresses.push( { item.into_native() }); };
936 unsafe { &*this_arg.inner }.broadcast_node_announcement(rgb.data, alias.data, local_addresses)
939 /// Processes HTLCs which are pending waiting on random forward delay.
941 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
942 /// Will likely generate further events.
944 pub extern "C" fn ChannelManager_process_pending_htlc_forwards(this_arg: &ChannelManager) {
945 unsafe { &*this_arg.inner }.process_pending_htlc_forwards()
948 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
949 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
950 /// to inform the network about the uselessness of these channels.
952 /// This method handles all the details, and must be called roughly once per minute.
954 /// Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
956 pub extern "C" fn ChannelManager_timer_tick_occurred(this_arg: &ChannelManager) {
957 unsafe { &*this_arg.inner }.timer_tick_occurred()
960 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
961 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
962 /// along the path (including in our own channel on which we received it).
963 /// Returns false if no payment was found to fail backwards, true if the process of failing the
964 /// HTLC backwards has been started.
967 pub extern "C" fn ChannelManager_fail_htlc_backwards(this_arg: &ChannelManager, payment_hash: *const [u8; 32]) -> bool {
968 let mut ret = unsafe { &*this_arg.inner }.fail_htlc_backwards(&::lightning::ln::PaymentHash(unsafe { *payment_hash }));
972 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
973 /// generating message events for the net layer to claim the payment, if possible. Thus, you
974 /// should probably kick the net layer to go send messages if this returns true!
976 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
977 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
978 /// event matches your expectation. If you fail to do so and call this method, you may provide
979 /// the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
981 /// May panic if called except in response to a PaymentReceived event.
983 /// [`create_inbound_payment`]: Self::create_inbound_payment
984 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
987 pub extern "C" fn ChannelManager_claim_funds(this_arg: &ChannelManager, mut payment_preimage: crate::c_types::ThirtyTwoBytes) -> bool {
988 let mut ret = unsafe { &*this_arg.inner }.claim_funds(::lightning::ln::PaymentPreimage(payment_preimage.data));
992 /// Gets the node_id held by this ChannelManager
995 pub extern "C" fn ChannelManager_get_our_node_id(this_arg: &ChannelManager) -> crate::c_types::PublicKey {
996 let mut ret = unsafe { &*this_arg.inner }.get_our_node_id();
997 crate::c_types::PublicKey::from_rust(&ret)
1000 /// Restores a single, given channel to normal operation after a
1001 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1004 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
1005 /// fully committed in every copy of the given channels' ChannelMonitors.
1007 /// Note that there is no effect to calling with a highest_applied_update_id other than the
1008 /// current latest ChannelMonitorUpdate and one call to this function after multiple
1009 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
1010 /// exists largely only to prevent races between this and concurrent update_monitor calls.
1012 /// Thus, the anticipated use is, at a high level:
1013 /// 1) You register a chain::Watch with this ChannelManager,
1014 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
1015 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
1016 /// any time it cannot do so instantly,
1017 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
1018 /// 4) once all remote copies are updated, you call this function with the update_id that
1019 /// completed, and once it is the latest the Channel will be re-enabled.
1021 pub extern "C" fn ChannelManager_channel_monitor_updated(this_arg: &ChannelManager, funding_txo: &crate::lightning::chain::transaction::OutPoint, mut highest_applied_update_id: u64) {
1022 unsafe { &*this_arg.inner }.channel_monitor_updated(unsafe { &*funding_txo.inner }, highest_applied_update_id)
1025 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
1028 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
1029 /// [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
1031 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
1032 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
1033 /// passed directly to [`claim_funds`].
1035 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
1037 /// [`claim_funds`]: Self::claim_funds
1038 /// [`PaymentReceived`]: events::Event::PaymentReceived
1039 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
1040 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
1043 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 {
1044 let mut local_min_value_msat = if min_value_msat.is_some() { Some( { min_value_msat.take() }) } else { None };
1045 let mut ret = unsafe { &*this_arg.inner }.create_inbound_payment(local_min_value_msat, invoice_expiry_delta_secs, user_payment_id);
1046 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();
1050 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
1051 /// stored external to LDK.
1053 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
1054 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
1055 /// the `min_value_msat` provided here, if one is provided.
1057 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
1058 /// method may return an Err if another payment with the same payment_hash is still pending.
1060 /// `user_payment_id` will be provided back in [`PaymentReceived::user_payment_id`] events to
1061 /// allow tracking of which events correspond with which calls to this and
1062 /// [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
1063 /// copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
1064 /// with invoice metadata stored elsewhere.
1066 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
1067 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
1068 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
1069 /// sender \"proof-of-payment\" unless they have paid the required amount.
1071 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
1072 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
1073 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
1074 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
1075 /// invoices when no timeout is set.
1077 /// Note that we use block header time to time-out pending inbound payments (with some margin
1078 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
1079 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
1080 /// If you need exact expiry semantics, you should enforce them upon receipt of
1081 /// [`PaymentReceived`].
1083 /// Pending inbound payments are stored in memory and in serialized versions of this
1084 /// [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
1085 /// space is limited, you may wish to rate-limit inbound payment creation.
1087 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
1089 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
1090 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
1092 /// [`create_inbound_payment`]: Self::create_inbound_payment
1093 /// [`PaymentReceived`]: events::Event::PaymentReceived
1094 /// [`PaymentReceived::user_payment_id`]: events::Event::PaymentReceived::user_payment_id
1097 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 {
1098 let mut local_min_value_msat = if min_value_msat.is_some() { Some( { min_value_msat.take() }) } else { None };
1099 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);
1100 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() };
1104 impl From<nativeChannelManager> for crate::lightning::util::events::MessageSendEventsProvider {
1105 fn from(obj: nativeChannelManager) -> Self {
1106 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1107 let mut ret = ChannelManager_as_MessageSendEventsProvider(&rust_obj);
1108 // 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
1109 rust_obj.inner = std::ptr::null_mut();
1110 ret.free = Some(ChannelManager_free_void);
1114 /// Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
1115 /// This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
1117 pub extern "C" fn ChannelManager_as_MessageSendEventsProvider(this_arg: &ChannelManager) -> crate::lightning::util::events::MessageSendEventsProvider {
1118 crate::lightning::util::events::MessageSendEventsProvider {
1119 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1121 get_and_clear_pending_msg_events: ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events,
1126 extern "C" fn ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_MessageSendEventZ {
1127 let mut ret = <nativeChannelManager as lightning::util::events::MessageSendEventsProvider<>>::get_and_clear_pending_msg_events(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
1128 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::util::events::MessageSendEvent::native_into(item) }); };
1132 impl From<nativeChannelManager> for crate::lightning::util::events::EventsProvider {
1133 fn from(obj: nativeChannelManager) -> Self {
1134 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1135 let mut ret = ChannelManager_as_EventsProvider(&rust_obj);
1136 // 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
1137 rust_obj.inner = std::ptr::null_mut();
1138 ret.free = Some(ChannelManager_free_void);
1142 /// Constructs a new EventsProvider which calls the relevant methods on this_arg.
1143 /// This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
1145 pub extern "C" fn ChannelManager_as_EventsProvider(this_arg: &ChannelManager) -> crate::lightning::util::events::EventsProvider {
1146 crate::lightning::util::events::EventsProvider {
1147 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1149 process_pending_events: ChannelManager_EventsProvider_process_pending_events,
1153 extern "C" fn ChannelManager_EventsProvider_process_pending_events(this_arg: *const c_void, mut handler: crate::lightning::util::events::EventHandler) {
1154 <nativeChannelManager as lightning::util::events::EventsProvider<>>::process_pending_events(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, handler)
1157 impl From<nativeChannelManager> for crate::lightning::chain::Listen {
1158 fn from(obj: nativeChannelManager) -> Self {
1159 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1160 let mut ret = ChannelManager_as_Listen(&rust_obj);
1161 // 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
1162 rust_obj.inner = std::ptr::null_mut();
1163 ret.free = Some(ChannelManager_free_void);
1167 /// Constructs a new Listen which calls the relevant methods on this_arg.
1168 /// This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
1170 pub extern "C" fn ChannelManager_as_Listen(this_arg: &ChannelManager) -> crate::lightning::chain::Listen {
1171 crate::lightning::chain::Listen {
1172 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1174 block_connected: ChannelManager_Listen_block_connected,
1175 block_disconnected: ChannelManager_Listen_block_disconnected,
1179 extern "C" fn ChannelManager_Listen_block_connected(this_arg: *const c_void, mut block: crate::c_types::u8slice, mut height: u32) {
1180 <nativeChannelManager as lightning::chain::Listen<>>::block_connected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(block.to_slice()).unwrap(), height)
1182 extern "C" fn ChannelManager_Listen_block_disconnected(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
1183 <nativeChannelManager as lightning::chain::Listen<>>::block_disconnected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
1186 impl From<nativeChannelManager> for crate::lightning::chain::Confirm {
1187 fn from(obj: nativeChannelManager) -> Self {
1188 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1189 let mut ret = ChannelManager_as_Confirm(&rust_obj);
1190 // 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
1191 rust_obj.inner = std::ptr::null_mut();
1192 ret.free = Some(ChannelManager_free_void);
1196 /// Constructs a new Confirm which calls the relevant methods on this_arg.
1197 /// This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
1199 pub extern "C" fn ChannelManager_as_Confirm(this_arg: &ChannelManager) -> crate::lightning::chain::Confirm {
1200 crate::lightning::chain::Confirm {
1201 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1203 transactions_confirmed: ChannelManager_Confirm_transactions_confirmed,
1204 transaction_unconfirmed: ChannelManager_Confirm_transaction_unconfirmed,
1205 best_block_updated: ChannelManager_Confirm_best_block_updated,
1206 get_relevant_txids: ChannelManager_Confirm_get_relevant_txids,
1210 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) {
1211 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 }); };
1212 <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)
1214 extern "C" fn ChannelManager_Confirm_best_block_updated(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
1215 <nativeChannelManager as lightning::chain::Confirm<>>::best_block_updated(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
1218 extern "C" fn ChannelManager_Confirm_get_relevant_txids(this_arg: *const c_void) -> crate::c_types::derived::CVec_TxidZ {
1219 let mut ret = <nativeChannelManager as lightning::chain::Confirm<>>::get_relevant_txids(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
1220 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::c_types::ThirtyTwoBytes { data: item.into_inner() } }); };
1223 extern "C" fn ChannelManager_Confirm_transaction_unconfirmed(this_arg: *const c_void, txid: *const [u8; 32]) {
1224 <nativeChannelManager as lightning::chain::Confirm<>>::transaction_unconfirmed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::hash_types::Txid::from_slice(&unsafe { &*txid }[..]).unwrap())
1227 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
1228 /// indicating whether persistence is necessary. Only one listener on
1229 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
1231 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
1234 pub extern "C" fn ChannelManager_await_persistable_update_timeout(this_arg: &ChannelManager, mut max_wait: u64) -> bool {
1235 let mut ret = unsafe { &*this_arg.inner }.await_persistable_update_timeout(std::time::Duration::from_secs(max_wait));
1239 /// Blocks until ChannelManager needs to be persisted. Only one listener on
1240 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
1243 pub extern "C" fn ChannelManager_await_persistable_update(this_arg: &ChannelManager) {
1244 unsafe { &*this_arg.inner }.await_persistable_update()
1247 impl From<nativeChannelManager> for crate::lightning::ln::msgs::ChannelMessageHandler {
1248 fn from(obj: nativeChannelManager) -> Self {
1249 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
1250 let mut ret = ChannelManager_as_ChannelMessageHandler(&rust_obj);
1251 // 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
1252 rust_obj.inner = std::ptr::null_mut();
1253 ret.free = Some(ChannelManager_free_void);
1257 /// Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
1258 /// This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
1260 pub extern "C" fn ChannelManager_as_ChannelMessageHandler(this_arg: &ChannelManager) -> crate::lightning::ln::msgs::ChannelMessageHandler {
1261 crate::lightning::ln::msgs::ChannelMessageHandler {
1262 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1264 handle_open_channel: ChannelManager_ChannelMessageHandler_handle_open_channel,
1265 handle_accept_channel: ChannelManager_ChannelMessageHandler_handle_accept_channel,
1266 handle_funding_created: ChannelManager_ChannelMessageHandler_handle_funding_created,
1267 handle_funding_signed: ChannelManager_ChannelMessageHandler_handle_funding_signed,
1268 handle_funding_locked: ChannelManager_ChannelMessageHandler_handle_funding_locked,
1269 handle_shutdown: ChannelManager_ChannelMessageHandler_handle_shutdown,
1270 handle_closing_signed: ChannelManager_ChannelMessageHandler_handle_closing_signed,
1271 handle_update_add_htlc: ChannelManager_ChannelMessageHandler_handle_update_add_htlc,
1272 handle_update_fulfill_htlc: ChannelManager_ChannelMessageHandler_handle_update_fulfill_htlc,
1273 handle_update_fail_htlc: ChannelManager_ChannelMessageHandler_handle_update_fail_htlc,
1274 handle_update_fail_malformed_htlc: ChannelManager_ChannelMessageHandler_handle_update_fail_malformed_htlc,
1275 handle_commitment_signed: ChannelManager_ChannelMessageHandler_handle_commitment_signed,
1276 handle_revoke_and_ack: ChannelManager_ChannelMessageHandler_handle_revoke_and_ack,
1277 handle_update_fee: ChannelManager_ChannelMessageHandler_handle_update_fee,
1278 handle_announcement_signatures: ChannelManager_ChannelMessageHandler_handle_announcement_signatures,
1279 peer_disconnected: ChannelManager_ChannelMessageHandler_peer_disconnected,
1280 peer_connected: ChannelManager_ChannelMessageHandler_peer_connected,
1281 handle_channel_reestablish: ChannelManager_ChannelMessageHandler_handle_channel_reestablish,
1282 handle_channel_update: ChannelManager_ChannelMessageHandler_handle_channel_update,
1283 handle_error: ChannelManager_ChannelMessageHandler_handle_error,
1284 MessageSendEventsProvider: crate::lightning::util::events::MessageSendEventsProvider {
1285 this_arg: unsafe { (*this_arg).inner as *mut c_void },
1287 get_and_clear_pending_msg_events: ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events,
1292 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) {
1293 <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 })
1295 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) {
1296 <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 })
1298 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) {
1299 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_created(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1301 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) {
1302 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1304 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) {
1305 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_locked(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1307 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) {
1308 <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 })
1310 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) {
1311 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_closing_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1313 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) {
1314 <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 })
1316 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) {
1317 <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 })
1319 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) {
1320 <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 })
1322 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) {
1323 <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 })
1325 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) {
1326 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_commitment_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1328 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) {
1329 <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 })
1331 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) {
1332 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_fee(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1334 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) {
1335 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_announcement_signatures(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1337 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) {
1338 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_channel_update(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1340 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) {
1341 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_channel_reestablish(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1343 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) {
1344 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::peer_disconnected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), no_connection_possible)
1346 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) {
1347 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::peer_connected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*init_msg.inner })
1349 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) {
1350 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_error(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &counterparty_node_id.into_rust(), unsafe { &*msg.inner })
1354 /// Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
1355 pub extern "C" fn ChannelManager_write(obj: &ChannelManager) -> crate::c_types::derived::CVec_u8Z {
1356 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
1359 pub(crate) extern "C" fn ChannelManager_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
1360 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelManager) })
1363 use lightning::ln::channelmanager::ChannelManagerReadArgs as nativeChannelManagerReadArgsImport;
1364 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>;
1366 /// Arguments for the creation of a ChannelManager that are not deserialized.
1368 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
1370 /// 1) Deserialize all stored ChannelMonitors.
1371 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
1372 /// <(BlockHash, ChannelManager)>::read(reader, args)
1373 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
1374 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
1375 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
1376 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
1377 /// ChannelMonitor::get_funding_txo().
1378 /// 4) Reconnect blocks on your ChannelMonitors.
1379 /// 5) Disconnect/connect blocks on the ChannelManager.
1380 /// 6) Move the ChannelMonitors into your local chain::Watch.
1382 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
1383 /// call any other methods on the newly-deserialized ChannelManager.
1385 /// Note that because some channels may be closed during deserialization, it is critical that you
1386 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
1387 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
1388 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
1389 /// not force-close the same channels but consider them live), you may end up revoking a state for
1390 /// which you've already broadcasted the transaction.
1393 pub struct ChannelManagerReadArgs {
1394 /// A pointer to the opaque Rust object.
1396 /// Nearly everywhere, inner must be non-null, however in places where
1397 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1398 pub inner: *mut nativeChannelManagerReadArgs,
1399 /// Indicates that this is the only struct which contains the same pointer.
1401 /// Rust functions which take ownership of an object provided via an argument require
1402 /// this to be true and invalidate the object pointed to by inner.
1406 impl Drop for ChannelManagerReadArgs {
1407 fn drop(&mut self) {
1408 if self.is_owned && !<*mut nativeChannelManagerReadArgs>::is_null(self.inner) {
1409 let _ = unsafe { Box::from_raw(self.inner) };
1413 /// Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL.
1415 pub extern "C" fn ChannelManagerReadArgs_free(this_obj: ChannelManagerReadArgs) { }
1417 /// Used only if an object of this type is returned as a trait impl by a method
1418 extern "C" fn ChannelManagerReadArgs_free_void(this_ptr: *mut c_void) {
1419 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelManagerReadArgs); }
1422 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1423 impl ChannelManagerReadArgs {
1424 pub(crate) fn take_inner(mut self) -> *mut nativeChannelManagerReadArgs {
1425 assert!(self.is_owned);
1426 let ret = self.inner;
1427 self.inner = std::ptr::null_mut();
1431 /// The keys provider which will give us relevant keys. Some keys will be loaded during
1432 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
1435 pub extern "C" fn ChannelManagerReadArgs_get_keys_manager(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::keysinterface::KeysInterface {
1436 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.keys_manager;
1439 /// The keys provider which will give us relevant keys. Some keys will be loaded during
1440 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
1443 pub extern "C" fn ChannelManagerReadArgs_set_keys_manager(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::keysinterface::KeysInterface) {
1444 unsafe { &mut *this_ptr.inner }.keys_manager = val;
1446 /// The fee_estimator for use in the ChannelManager in the future.
1448 /// No calls to the FeeEstimator will be made during deserialization.
1450 pub extern "C" fn ChannelManagerReadArgs_get_fee_estimator(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::chaininterface::FeeEstimator {
1451 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fee_estimator;
1454 /// The fee_estimator for use in the ChannelManager in the future.
1456 /// No calls to the FeeEstimator will be made during deserialization.
1458 pub extern "C" fn ChannelManagerReadArgs_set_fee_estimator(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::chaininterface::FeeEstimator) {
1459 unsafe { &mut *this_ptr.inner }.fee_estimator = val;
1461 /// The chain::Watch for use in the ChannelManager in the future.
1463 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
1464 /// you have deserialized ChannelMonitors separately and will add them to your
1465 /// chain::Watch after deserializing this ChannelManager.
1467 pub extern "C" fn ChannelManagerReadArgs_get_chain_monitor(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::Watch {
1468 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.chain_monitor;
1471 /// The chain::Watch for use in the ChannelManager in the future.
1473 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
1474 /// you have deserialized ChannelMonitors separately and will add them to your
1475 /// chain::Watch after deserializing this ChannelManager.
1477 pub extern "C" fn ChannelManagerReadArgs_set_chain_monitor(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::Watch) {
1478 unsafe { &mut *this_ptr.inner }.chain_monitor = val;
1480 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
1481 /// used to broadcast the latest local commitment transactions of channels which must be
1482 /// force-closed during deserialization.
1484 pub extern "C" fn ChannelManagerReadArgs_get_tx_broadcaster(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::chaininterface::BroadcasterInterface {
1485 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.tx_broadcaster;
1488 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
1489 /// used to broadcast the latest local commitment transactions of channels which must be
1490 /// force-closed during deserialization.
1492 pub extern "C" fn ChannelManagerReadArgs_set_tx_broadcaster(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::chaininterface::BroadcasterInterface) {
1493 unsafe { &mut *this_ptr.inner }.tx_broadcaster = val;
1495 /// The Logger for use in the ChannelManager and which may be used to log information during
1496 /// deserialization.
1498 pub extern "C" fn ChannelManagerReadArgs_get_logger(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::util::logger::Logger {
1499 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.logger;
1502 /// The Logger for use in the ChannelManager and which may be used to log information during
1503 /// deserialization.
1505 pub extern "C" fn ChannelManagerReadArgs_set_logger(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::util::logger::Logger) {
1506 unsafe { &mut *this_ptr.inner }.logger = val;
1508 /// Default settings used for new channels. Any existing channels will continue to use the
1509 /// runtime settings which were stored when the ChannelManager was serialized.
1511 pub extern "C" fn ChannelManagerReadArgs_get_default_config(this_ptr: &ChannelManagerReadArgs) -> crate::lightning::util::config::UserConfig {
1512 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.default_config;
1513 crate::lightning::util::config::UserConfig { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
1515 /// Default settings used for new channels. Any existing channels will continue to use the
1516 /// runtime settings which were stored when the ChannelManager was serialized.
1518 pub extern "C" fn ChannelManagerReadArgs_set_default_config(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::util::config::UserConfig) {
1519 unsafe { &mut *this_ptr.inner }.default_config = *unsafe { Box::from_raw(val.take_inner()) };
1521 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
1522 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
1523 /// populate a HashMap directly from C.
1526 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 {
1527 let mut local_channel_monitors = Vec::new(); for mut item in channel_monitors.into_rust().drain(..) { local_channel_monitors.push( { unsafe { &mut *item.inner } }); };
1528 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);
1529 ChannelManagerReadArgs { inner: Box::into_raw(Box::new(ret)), is_owned: true }
1533 /// Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
1534 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 {
1535 let arg_conv = *unsafe { Box::from_raw(arg.take_inner()) };
1536 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);
1537 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() };