1 //! The top-level channel management and payment tracking stuff lives here.
3 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
4 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
5 //! upon reconnect to the relevant peer(s).
7 //! It does not manage routing logic (see routing::router::get_route for that) nor does it manage constructing
8 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
9 //! imply it needs to fail HTLCs/payments/channels it manages).
13 use bitcoin::hashes::Hash;
14 use crate::c_types::*;
17 use lightning::ln::channelmanager::ChannelManager as nativeChannelManagerImport;
18 type nativeChannelManager = nativeChannelManagerImport<crate::chain::keysinterface::ChannelKeys, crate::chain::Watch, crate::chain::chaininterface::BroadcasterInterface, crate::chain::keysinterface::KeysInterface, crate::chain::chaininterface::FeeEstimator, crate::util::logger::Logger>;
20 /// Manager which keeps track of a number of channels and sends messages to the appropriate
21 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
23 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
24 /// to individual Channels.
26 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
27 /// all peers during write/read (though does not modify this instance, only the instance being
28 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
29 /// called funding_transaction_generated for outbound channels).
31 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
32 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
33 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
34 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
35 /// the serialization process). If the deserialized version is out-of-date compared to the
36 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
37 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
39 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
40 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
41 /// the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
42 /// block_connected() to step towards your best block) upon deserialization before using the
45 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
46 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
47 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
48 /// offline for a full minute. In order to track this, you must call
49 /// timer_chan_freshness_every_min roughly once per minute, though it doesn't have to be perfect.
51 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
52 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
53 /// essentially you should default to using a SimpleRefChannelManager, and use a
54 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
55 /// you're using lightning-net-tokio.
58 pub struct ChannelManager {
59 /// Nearly everywhere, inner must be non-null, however in places where
60 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
61 pub inner: *mut nativeChannelManager,
65 impl Drop for ChannelManager {
67 if self.is_owned && !self.inner.is_null() {
68 let _ = unsafe { Box::from_raw(self.inner) };
73 pub extern "C" fn ChannelManager_free(this_ptr: ChannelManager) { }
75 /// Used only if an object of this type is returned as a trait impl by a method
76 extern "C" fn ChannelManager_free_void(this_ptr: *mut c_void) {
77 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelManager); }
80 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
82 pub(crate) fn take_inner(mut self) -> *mut nativeChannelManager {
83 assert!(self.is_owned);
85 self.inner = std::ptr::null_mut();
90 use lightning::ln::channelmanager::ChannelDetails as nativeChannelDetailsImport;
91 type nativeChannelDetails = nativeChannelDetailsImport;
93 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
96 pub struct ChannelDetails {
97 /// Nearly everywhere, inner must be non-null, however in places where
98 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
99 pub inner: *mut nativeChannelDetails,
103 impl Drop for ChannelDetails {
105 if self.is_owned && !self.inner.is_null() {
106 let _ = unsafe { Box::from_raw(self.inner) };
111 pub extern "C" fn ChannelDetails_free(this_ptr: ChannelDetails) { }
113 /// Used only if an object of this type is returned as a trait impl by a method
114 extern "C" fn ChannelDetails_free_void(this_ptr: *mut c_void) {
115 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelDetails); }
118 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
119 impl ChannelDetails {
120 pub(crate) fn take_inner(mut self) -> *mut nativeChannelDetails {
121 assert!(self.is_owned);
122 let ret = self.inner;
123 self.inner = std::ptr::null_mut();
127 impl Clone for ChannelDetails {
128 fn clone(&self) -> Self {
130 inner: Box::into_raw(Box::new(unsafe { &*self.inner }.clone())),
136 /// Used only if an object of this type is returned as a trait impl by a method
137 pub(crate) extern "C" fn ChannelDetails_clone_void(this_ptr: *const c_void) -> *mut c_void {
138 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelDetails)).clone() })) as *mut c_void
141 pub extern "C" fn ChannelDetails_clone(orig: &ChannelDetails) -> ChannelDetails {
142 ChannelDetails { inner: Box::into_raw(Box::new(unsafe { &*orig.inner }.clone())), is_owned: true }
144 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
145 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
146 /// Note that this means this value is *not* persistent - it can change once during the
147 /// lifetime of the channel.
149 pub extern "C" fn ChannelDetails_get_channel_id(this_ptr: &ChannelDetails) -> *const [u8; 32] {
150 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_id;
153 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
154 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
155 /// Note that this means this value is *not* persistent - it can change once during the
156 /// lifetime of the channel.
158 pub extern "C" fn ChannelDetails_set_channel_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::ThirtyTwoBytes) {
159 unsafe { &mut *this_ptr.inner }.channel_id = val.data;
161 /// The node_id of our counterparty
163 pub extern "C" fn ChannelDetails_get_remote_network_id(this_ptr: &ChannelDetails) -> crate::c_types::PublicKey {
164 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.remote_network_id;
165 crate::c_types::PublicKey::from_rust(&(*inner_val))
167 /// The node_id of our counterparty
169 pub extern "C" fn ChannelDetails_set_remote_network_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::PublicKey) {
170 unsafe { &mut *this_ptr.inner }.remote_network_id = val.into_rust();
172 /// The Features the channel counterparty provided upon last connection.
173 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
174 /// many routing-relevant features are present in the init context.
176 pub extern "C" fn ChannelDetails_get_counterparty_features(this_ptr: &ChannelDetails) -> crate::ln::features::InitFeatures {
177 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.counterparty_features;
178 crate::ln::features::InitFeatures { inner: &mut (*inner_val), is_owned: false }
180 /// The Features the channel counterparty provided upon last connection.
181 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
182 /// many routing-relevant features are present in the init context.
184 pub extern "C" fn ChannelDetails_set_counterparty_features(this_ptr: &mut ChannelDetails, mut val: crate::ln::features::InitFeatures) {
185 unsafe { &mut *this_ptr.inner }.counterparty_features = *unsafe { Box::from_raw(val.take_inner()) };
187 /// The value, in satoshis, of this channel as appears in the funding output
189 pub extern "C" fn ChannelDetails_get_channel_value_satoshis(this_ptr: &ChannelDetails) -> u64 {
190 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.channel_value_satoshis;
193 /// The value, in satoshis, of this channel as appears in the funding output
195 pub extern "C" fn ChannelDetails_set_channel_value_satoshis(this_ptr: &mut ChannelDetails, mut val: u64) {
196 unsafe { &mut *this_ptr.inner }.channel_value_satoshis = val;
198 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
200 pub extern "C" fn ChannelDetails_get_user_id(this_ptr: &ChannelDetails) -> u64 {
201 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.user_id;
204 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
206 pub extern "C" fn ChannelDetails_set_user_id(this_ptr: &mut ChannelDetails, mut val: u64) {
207 unsafe { &mut *this_ptr.inner }.user_id = val;
209 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
210 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
211 /// available for inclusion in new outbound HTLCs). This further does not include any pending
212 /// outgoing HTLCs which are awaiting some other resolution to be sent.
214 pub extern "C" fn ChannelDetails_get_outbound_capacity_msat(this_ptr: &ChannelDetails) -> u64 {
215 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.outbound_capacity_msat;
218 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
219 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
220 /// available for inclusion in new outbound HTLCs). This further does not include any pending
221 /// outgoing HTLCs which are awaiting some other resolution to be sent.
223 pub extern "C" fn ChannelDetails_set_outbound_capacity_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
224 unsafe { &mut *this_ptr.inner }.outbound_capacity_msat = val;
226 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
227 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
228 /// available for inclusion in new inbound HTLCs).
229 /// Note that there are some corner cases not fully handled here, so the actual available
230 /// inbound capacity may be slightly higher than this.
232 pub extern "C" fn ChannelDetails_get_inbound_capacity_msat(this_ptr: &ChannelDetails) -> u64 {
233 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.inbound_capacity_msat;
236 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
237 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
238 /// available for inclusion in new inbound HTLCs).
239 /// Note that there are some corner cases not fully handled here, so the actual available
240 /// inbound capacity may be slightly higher than this.
242 pub extern "C" fn ChannelDetails_set_inbound_capacity_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
243 unsafe { &mut *this_ptr.inner }.inbound_capacity_msat = val;
245 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
246 /// the peer is connected, and (c) no monitor update failure is pending resolution.
248 pub extern "C" fn ChannelDetails_get_is_live(this_ptr: &ChannelDetails) -> bool {
249 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.is_live;
252 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
253 /// the peer is connected, and (c) no monitor update failure is pending resolution.
255 pub extern "C" fn ChannelDetails_set_is_live(this_ptr: &mut ChannelDetails, mut val: bool) {
256 unsafe { &mut *this_ptr.inner }.is_live = val;
259 use lightning::ln::channelmanager::PaymentSendFailure as nativePaymentSendFailureImport;
260 type nativePaymentSendFailure = nativePaymentSendFailureImport;
262 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
263 /// Err() type describing which state the payment is in, see the description of individual enum
267 pub struct PaymentSendFailure {
268 /// Nearly everywhere, inner must be non-null, however in places where
269 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
270 pub inner: *mut nativePaymentSendFailure,
274 impl Drop for PaymentSendFailure {
276 if self.is_owned && !self.inner.is_null() {
277 let _ = unsafe { Box::from_raw(self.inner) };
282 pub extern "C" fn PaymentSendFailure_free(this_ptr: PaymentSendFailure) { }
284 /// Used only if an object of this type is returned as a trait impl by a method
285 extern "C" fn PaymentSendFailure_free_void(this_ptr: *mut c_void) {
286 unsafe { let _ = Box::from_raw(this_ptr as *mut nativePaymentSendFailure); }
289 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
290 impl PaymentSendFailure {
291 pub(crate) fn take_inner(mut self) -> *mut nativePaymentSendFailure {
292 assert!(self.is_owned);
293 let ret = self.inner;
294 self.inner = std::ptr::null_mut();
298 /// Constructs a new ChannelManager to hold several channels and route between them.
300 /// This is the main \"logic hub\" for all channel-related actions, and implements
301 /// ChannelMessageHandler.
303 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
305 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
307 /// Users must provide the current blockchain height from which to track onchain channel
308 /// funding outpoints and send payments with reliable timelocks.
310 /// Users need to notify the new ChannelManager when a new block is connected or
311 /// disconnected using its `block_connected` and `block_disconnected` methods.
314 pub extern "C" fn ChannelManager_new(mut network: crate::bitcoin::network::Network, mut fee_est: crate::chain::chaininterface::FeeEstimator, mut chain_monitor: crate::chain::Watch, mut tx_broadcaster: crate::chain::chaininterface::BroadcasterInterface, mut logger: crate::util::logger::Logger, mut keys_manager: crate::chain::keysinterface::KeysInterface, mut config: crate::util::config::UserConfig, mut current_blockchain_height: usize) -> ChannelManager {
315 let mut ret = lightning::ln::channelmanager::ChannelManager::new(network.into_bitcoin(), fee_est, chain_monitor, tx_broadcaster, logger, keys_manager, *unsafe { Box::from_raw(config.take_inner()) }, current_blockchain_height);
316 ChannelManager { inner: Box::into_raw(Box::new(ret)), is_owned: true }
319 /// Creates a new outbound channel to the given remote node and with the given value.
321 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
322 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
323 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
324 /// may wish to avoid using 0 for user_id here.
326 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
327 /// PeerManager::process_events afterwards.
329 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
330 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
333 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::util::config::UserConfig) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
334 let mut local_override_config = if override_config.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(override_config.take_inner()) } }) };
335 let mut ret = unsafe { &*this_arg.inner }.create_channel(their_network_key.into_rust(), channel_value_satoshis, push_msat, user_id, local_override_config);
336 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }), Err(mut e) => crate::c_types::CResultTempl::err( { crate::util::errors::APIError::native_into(e) }) };
340 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
341 /// more information.
344 pub extern "C" fn ChannelManager_list_channels(this_arg: &ChannelManager) -> crate::c_types::derived::CVec_ChannelDetailsZ {
345 let mut ret = unsafe { &*this_arg.inner }.list_channels();
346 let mut local_ret = Vec::new(); for item in ret.drain(..) { local_ret.push( { crate::ln::channelmanager::ChannelDetails { inner: Box::into_raw(Box::new(item)), is_owned: true } }); };
350 /// Gets the list of usable channels, in random order. Useful as an argument to
351 /// get_route to ensure non-announced channels are used.
353 /// These are guaranteed to have their is_live value set to true, see the documentation for
354 /// ChannelDetails::is_live for more info on exactly what the criteria are.
357 pub extern "C" fn ChannelManager_list_usable_channels(this_arg: &ChannelManager) -> crate::c_types::derived::CVec_ChannelDetailsZ {
358 let mut ret = unsafe { &*this_arg.inner }.list_usable_channels();
359 let mut local_ret = Vec::new(); for item in ret.drain(..) { local_ret.push( { crate::ln::channelmanager::ChannelDetails { inner: Box::into_raw(Box::new(item)), is_owned: true } }); };
363 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
364 /// will be accepted on the given channel, and after additional timeout/the closing of all
365 /// pending HTLCs, the channel will be closed on chain.
367 /// May generate a SendShutdown message event on success, which should be relayed.
370 pub extern "C" fn ChannelManager_close_channel(this_arg: &ChannelManager, channel_id: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
371 let mut ret = unsafe { &*this_arg.inner }.close_channel(unsafe { &*channel_id});
372 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }), Err(mut e) => crate::c_types::CResultTempl::err( { crate::util::errors::APIError::native_into(e) }) };
376 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
377 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
380 pub extern "C" fn ChannelManager_force_close_channel(this_arg: &ChannelManager, channel_id: *const [u8; 32]) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
381 let mut ret = unsafe { &*this_arg.inner }.force_close_channel(unsafe { &*channel_id});
382 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }), Err(mut e) => crate::c_types::CResultTempl::err( { crate::util::errors::APIError::native_into(e) }) };
386 /// Force close all channels, immediately broadcasting the latest local commitment transaction
387 /// for each to the chain and rejecting new HTLCs on each.
389 pub extern "C" fn ChannelManager_force_close_all_channels(this_arg: &ChannelManager) {
390 unsafe { &*this_arg.inner }.force_close_all_channels()
393 /// Sends a payment along a given route.
395 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
396 /// fields for more info.
398 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
399 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
400 /// next hop knows the preimage to payment_hash they can claim an additional amount as
401 /// specified in the last hop in the route! Thus, you should probably do your own
402 /// payment_preimage tracking (which you should already be doing as they represent \"proof of
403 /// payment\") and prevent double-sends yourself.
405 /// May generate SendHTLCs message(s) event on success, which should be relayed.
407 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
408 /// each entry matching the corresponding-index entry in the route paths, see
409 /// PaymentSendFailure for more info.
411 /// In general, a path may raise:
412 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
413 /// node public key) is specified.
414 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
415 /// (including due to previous monitor update failure or new permanent monitor update
417 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
418 /// relevant updates.
420 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
421 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
422 /// different route unless you intend to pay twice!
424 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
425 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
426 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
427 /// must not contain multiple paths as multi-path payments require a recipient-provided
429 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
430 /// bit set (either as required or as available). If multiple paths are present in the Route,
431 /// we assume the invoice had the basic_mpp feature set.
434 pub extern "C" fn ChannelManager_send_payment(this_arg: &ChannelManager, route: &crate::routing::router::Route, mut payment_hash: crate::c_types::ThirtyTwoBytes, mut payment_secret: crate::c_types::ThirtyTwoBytes) -> crate::c_types::derived::CResult_NonePaymentSendFailureZ {
435 let mut local_payment_secret = if payment_secret.data == [0; 32] { None } else { Some( { ::lightning::ln::channelmanager::PaymentSecret(payment_secret.data) }) };
436 let mut ret = unsafe { &*this_arg.inner }.send_payment(unsafe { &*route.inner }, ::lightning::ln::channelmanager::PaymentHash(payment_hash.data), &local_payment_secret);
437 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { 0u8 /*o*/ }), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::channelmanager::PaymentSendFailure { inner: Box::into_raw(Box::new(e)), is_owned: true } }) };
441 /// Call this upon creation of a funding transaction for the given channel.
443 /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
444 /// or your counterparty can steal your funds!
446 /// Panics if a funding transaction has already been provided for this channel.
448 /// May panic if the funding_txo is duplicative with some other channel (note that this should
449 /// be trivially prevented by using unique funding transaction keys per-channel).
451 pub extern "C" fn ChannelManager_funding_transaction_generated(this_arg: &ChannelManager, temporary_channel_id: *const [u8; 32], mut funding_txo: crate::chain::transaction::OutPoint) {
452 unsafe { &*this_arg.inner }.funding_transaction_generated(unsafe { &*temporary_channel_id}, *unsafe { Box::from_raw(funding_txo.take_inner()) })
455 /// Generates a signed node_announcement from the given arguments and creates a
456 /// BroadcastNodeAnnouncement event. Note that such messages will be ignored unless peers have
457 /// seen a channel_announcement from us (ie unless we have public channels open).
459 /// RGB is a node \"color\" and alias is a printable human-readable string to describe this node
460 /// to humans. They carry no in-protocol meaning.
462 /// addresses represent the set (possibly empty) of socket addresses on which this node accepts
463 /// incoming connections. These will be broadcast to the network, publicly tying these
464 /// addresses together. If you wish to preserve user privacy, addresses should likely contain
465 /// only Tor Onion addresses.
467 /// Panics if addresses is absurdly large (more than 500).
469 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) {
470 let mut local_addresses = Vec::new(); for mut item in addresses.into_rust().drain(..) { local_addresses.push( { item.into_native() }); };
471 unsafe { &*this_arg.inner }.broadcast_node_announcement(rgb.data, alias.data, local_addresses)
474 /// Processes HTLCs which are pending waiting on random forward delay.
476 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
477 /// Will likely generate further events.
479 pub extern "C" fn ChannelManager_process_pending_htlc_forwards(this_arg: &ChannelManager) {
480 unsafe { &*this_arg.inner }.process_pending_htlc_forwards()
483 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
484 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
485 /// to inform the network about the uselessness of these channels.
487 /// This method handles all the details, and must be called roughly once per minute.
489 pub extern "C" fn ChannelManager_timer_chan_freshness_every_min(this_arg: &ChannelManager) {
490 unsafe { &*this_arg.inner }.timer_chan_freshness_every_min()
493 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
494 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
495 /// along the path (including in our own channel on which we received it).
496 /// Returns false if no payment was found to fail backwards, true if the process of failing the
497 /// HTLC backwards has been started.
500 pub extern "C" fn ChannelManager_fail_htlc_backwards(this_arg: &ChannelManager, payment_hash: *const [u8; 32], mut payment_secret: crate::c_types::ThirtyTwoBytes) -> bool {
501 let mut local_payment_secret = if payment_secret.data == [0; 32] { None } else { Some( { ::lightning::ln::channelmanager::PaymentSecret(payment_secret.data) }) };
502 let mut ret = unsafe { &*this_arg.inner }.fail_htlc_backwards(&::lightning::ln::channelmanager::PaymentHash(unsafe { *payment_hash }), &local_payment_secret);
506 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
507 /// generating message events for the net layer to claim the payment, if possible. Thus, you
508 /// should probably kick the net layer to go send messages if this returns true!
510 /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
511 /// available within a few percent of the expected amount. This is critical for several
512 /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
513 /// payment_preimage without having provided the full value and b) it avoids certain
514 /// privacy-breaking recipient-probing attacks which may reveal payment activity to
515 /// motivated attackers.
517 /// Note that the privacy concerns in (b) are not relevant in payments with a payment_secret
518 /// set. Thus, for such payments we will claim any payments which do not under-pay.
520 /// May panic if called except in response to a PaymentReceived event.
523 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 {
524 let mut local_payment_secret = if payment_secret.data == [0; 32] { None } else { Some( { ::lightning::ln::channelmanager::PaymentSecret(payment_secret.data) }) };
525 let mut ret = unsafe { &*this_arg.inner }.claim_funds(::lightning::ln::channelmanager::PaymentPreimage(payment_preimage.data), &local_payment_secret, expected_amount);
529 /// Gets the node_id held by this ChannelManager
532 pub extern "C" fn ChannelManager_get_our_node_id(this_arg: &ChannelManager) -> crate::c_types::PublicKey {
533 let mut ret = unsafe { &*this_arg.inner }.get_our_node_id();
534 crate::c_types::PublicKey::from_rust(&ret)
537 /// Restores a single, given channel to normal operation after a
538 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
541 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
542 /// fully committed in every copy of the given channels' ChannelMonitors.
544 /// Note that there is no effect to calling with a highest_applied_update_id other than the
545 /// current latest ChannelMonitorUpdate and one call to this function after multiple
546 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
547 /// exists largely only to prevent races between this and concurrent update_monitor calls.
549 /// Thus, the anticipated use is, at a high level:
550 /// 1) You register a chain::Watch with this ChannelManager,
551 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
552 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
553 /// any time it cannot do so instantly,
554 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
555 /// 4) once all remote copies are updated, you call this function with the update_id that
556 /// completed, and once it is the latest the Channel will be re-enabled.
558 pub extern "C" fn ChannelManager_channel_monitor_updated(this_arg: &ChannelManager, funding_txo: &crate::chain::transaction::OutPoint, mut highest_applied_update_id: u64) {
559 unsafe { &*this_arg.inner }.channel_monitor_updated(unsafe { &*funding_txo.inner }, highest_applied_update_id)
562 impl From<nativeChannelManager> for crate::util::events::MessageSendEventsProvider {
563 fn from(obj: nativeChannelManager) -> Self {
564 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
565 let mut ret = ChannelManager_as_MessageSendEventsProvider(&rust_obj);
566 // 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
567 rust_obj.inner = std::ptr::null_mut();
568 ret.free = Some(ChannelManager_free_void);
573 pub extern "C" fn ChannelManager_as_MessageSendEventsProvider(this_arg: &ChannelManager) -> crate::util::events::MessageSendEventsProvider {
574 crate::util::events::MessageSendEventsProvider {
575 this_arg: unsafe { (*this_arg).inner as *mut c_void },
577 get_and_clear_pending_msg_events: ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events,
580 use lightning::util::events::MessageSendEventsProvider as MessageSendEventsProviderTraitImport;
582 extern "C" fn ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_MessageSendEventZ {
583 let mut ret = unsafe { &mut *(this_arg as *mut nativeChannelManager) }.get_and_clear_pending_msg_events();
584 let mut local_ret = Vec::new(); for item in ret.drain(..) { local_ret.push( { crate::util::events::MessageSendEvent::native_into(item) }); };
588 impl From<nativeChannelManager> for crate::util::events::EventsProvider {
589 fn from(obj: nativeChannelManager) -> Self {
590 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
591 let mut ret = ChannelManager_as_EventsProvider(&rust_obj);
592 // 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
593 rust_obj.inner = std::ptr::null_mut();
594 ret.free = Some(ChannelManager_free_void);
599 pub extern "C" fn ChannelManager_as_EventsProvider(this_arg: &ChannelManager) -> crate::util::events::EventsProvider {
600 crate::util::events::EventsProvider {
601 this_arg: unsafe { (*this_arg).inner as *mut c_void },
603 get_and_clear_pending_events: ChannelManager_EventsProvider_get_and_clear_pending_events,
606 use lightning::util::events::EventsProvider as EventsProviderTraitImport;
608 extern "C" fn ChannelManager_EventsProvider_get_and_clear_pending_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_EventZ {
609 let mut ret = unsafe { &mut *(this_arg as *mut nativeChannelManager) }.get_and_clear_pending_events();
610 let mut local_ret = Vec::new(); for item in ret.drain(..) { local_ret.push( { crate::util::events::Event::native_into(item) }); };
614 /// Updates channel state based on transactions seen in a connected block.
616 pub extern "C" fn ChannelManager_block_connected(this_arg: &ChannelManager, header: *const [u8; 80], mut txdata: crate::c_types::derived::CVec_C2Tuple_usizeTransactionZZ, mut height: u32) {
617 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 }); };
618 unsafe { &*this_arg.inner }.block_connected(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), &local_txdata.iter().map(|(a, b)| (*a, b)).collect::<Vec<_>>()[..], height)
621 /// Updates channel state based on a disconnected block.
623 /// If necessary, the channel may be force-closed without letting the counterparty participate
626 pub extern "C" fn ChannelManager_block_disconnected(this_arg: &ChannelManager, header: *const [u8; 80]) {
627 unsafe { &*this_arg.inner }.block_disconnected(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap())
630 impl From<nativeChannelManager> for crate::ln::msgs::ChannelMessageHandler {
631 fn from(obj: nativeChannelManager) -> Self {
632 let mut rust_obj = ChannelManager { inner: Box::into_raw(Box::new(obj)), is_owned: true };
633 let mut ret = ChannelManager_as_ChannelMessageHandler(&rust_obj);
634 // 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
635 rust_obj.inner = std::ptr::null_mut();
636 ret.free = Some(ChannelManager_free_void);
641 pub extern "C" fn ChannelManager_as_ChannelMessageHandler(this_arg: &ChannelManager) -> crate::ln::msgs::ChannelMessageHandler {
642 crate::ln::msgs::ChannelMessageHandler {
643 this_arg: unsafe { (*this_arg).inner as *mut c_void },
645 handle_open_channel: ChannelManager_ChannelMessageHandler_handle_open_channel,
646 handle_accept_channel: ChannelManager_ChannelMessageHandler_handle_accept_channel,
647 handle_funding_created: ChannelManager_ChannelMessageHandler_handle_funding_created,
648 handle_funding_signed: ChannelManager_ChannelMessageHandler_handle_funding_signed,
649 handle_funding_locked: ChannelManager_ChannelMessageHandler_handle_funding_locked,
650 handle_shutdown: ChannelManager_ChannelMessageHandler_handle_shutdown,
651 handle_closing_signed: ChannelManager_ChannelMessageHandler_handle_closing_signed,
652 handle_update_add_htlc: ChannelManager_ChannelMessageHandler_handle_update_add_htlc,
653 handle_update_fulfill_htlc: ChannelManager_ChannelMessageHandler_handle_update_fulfill_htlc,
654 handle_update_fail_htlc: ChannelManager_ChannelMessageHandler_handle_update_fail_htlc,
655 handle_update_fail_malformed_htlc: ChannelManager_ChannelMessageHandler_handle_update_fail_malformed_htlc,
656 handle_commitment_signed: ChannelManager_ChannelMessageHandler_handle_commitment_signed,
657 handle_revoke_and_ack: ChannelManager_ChannelMessageHandler_handle_revoke_and_ack,
658 handle_update_fee: ChannelManager_ChannelMessageHandler_handle_update_fee,
659 handle_announcement_signatures: ChannelManager_ChannelMessageHandler_handle_announcement_signatures,
660 peer_disconnected: ChannelManager_ChannelMessageHandler_peer_disconnected,
661 peer_connected: ChannelManager_ChannelMessageHandler_peer_connected,
662 handle_channel_reestablish: ChannelManager_ChannelMessageHandler_handle_channel_reestablish,
663 handle_error: ChannelManager_ChannelMessageHandler_handle_error,
664 MessageSendEventsProvider: crate::util::events::MessageSendEventsProvider {
665 this_arg: unsafe { (*this_arg).inner as *mut c_void },
667 get_and_clear_pending_msg_events: ChannelManager_ChannelMessageHandler_get_and_clear_pending_msg_events,
671 use lightning::ln::msgs::ChannelMessageHandler as ChannelMessageHandlerTraitImport;
672 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::ln::features::InitFeatures, msg: &crate::ln::msgs::OpenChannel) {
673 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_open_channel(&counterparty_node_id.into_rust(), *unsafe { Box::from_raw(their_features.take_inner()) }, unsafe { &*msg.inner })
675 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::ln::features::InitFeatures, msg: &crate::ln::msgs::AcceptChannel) {
676 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_accept_channel(&counterparty_node_id.into_rust(), *unsafe { Box::from_raw(their_features.take_inner()) }, unsafe { &*msg.inner })
678 extern "C" fn ChannelManager_ChannelMessageHandler_handle_funding_created(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::FundingCreated) {
679 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_funding_created(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
681 extern "C" fn ChannelManager_ChannelMessageHandler_handle_funding_signed(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::FundingSigned) {
682 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_funding_signed(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
684 extern "C" fn ChannelManager_ChannelMessageHandler_handle_funding_locked(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::FundingLocked) {
685 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_funding_locked(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
687 extern "C" fn ChannelManager_ChannelMessageHandler_handle_shutdown(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::Shutdown) {
688 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_shutdown(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
690 extern "C" fn ChannelManager_ChannelMessageHandler_handle_closing_signed(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::ClosingSigned) {
691 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_closing_signed(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
693 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_add_htlc(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::UpdateAddHTLC) {
694 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_update_add_htlc(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
696 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fulfill_htlc(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::UpdateFulfillHTLC) {
697 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_update_fulfill_htlc(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
699 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fail_htlc(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::UpdateFailHTLC) {
700 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_update_fail_htlc(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
702 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::ln::msgs::UpdateFailMalformedHTLC) {
703 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_update_fail_malformed_htlc(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
705 extern "C" fn ChannelManager_ChannelMessageHandler_handle_commitment_signed(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::CommitmentSigned) {
706 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_commitment_signed(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
708 extern "C" fn ChannelManager_ChannelMessageHandler_handle_revoke_and_ack(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::RevokeAndACK) {
709 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_revoke_and_ack(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
711 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fee(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::UpdateFee) {
712 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_update_fee(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
714 extern "C" fn ChannelManager_ChannelMessageHandler_handle_announcement_signatures(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::AnnouncementSignatures) {
715 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_announcement_signatures(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
717 extern "C" fn ChannelManager_ChannelMessageHandler_handle_channel_reestablish(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::ChannelReestablish) {
718 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_channel_reestablish(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
720 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) {
721 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.peer_disconnected(&counterparty_node_id.into_rust(), no_connection_possible)
723 extern "C" fn ChannelManager_ChannelMessageHandler_peer_connected(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, init_msg: &crate::ln::msgs::Init) {
724 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.peer_connected(&counterparty_node_id.into_rust(), unsafe { &*init_msg.inner })
726 extern "C" fn ChannelManager_ChannelMessageHandler_handle_error(this_arg: *const c_void, mut counterparty_node_id: crate::c_types::PublicKey, msg: &crate::ln::msgs::ErrorMessage) {
727 unsafe { &mut *(this_arg as *mut nativeChannelManager) }.handle_error(&counterparty_node_id.into_rust(), unsafe { &*msg.inner })
729 use lightning::util::events::MessageSendEventsProvider as nativeMessageSendEventsProviderTrait;
731 extern "C" fn ChannelManager_ChannelMessageHandler_get_and_clear_pending_msg_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_MessageSendEventZ {
732 let mut ret = unsafe { &mut *(this_arg as *mut nativeChannelManager) }.get_and_clear_pending_msg_events();
733 let mut local_ret = Vec::new(); for item in ret.drain(..) { local_ret.push( { crate::util::events::MessageSendEvent::native_into(item) }); };
738 pub extern "C" fn ChannelManager_write(obj: &ChannelManager) -> crate::c_types::derived::CVec_u8Z {
739 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
742 pub(crate) extern "C" fn ChannelManager_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
743 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelManager) })
746 use lightning::ln::channelmanager::ChannelManagerReadArgs as nativeChannelManagerReadArgsImport;
747 type nativeChannelManagerReadArgs = nativeChannelManagerReadArgsImport<'static, crate::chain::keysinterface::ChannelKeys, crate::chain::Watch, crate::chain::chaininterface::BroadcasterInterface, crate::chain::keysinterface::KeysInterface, crate::chain::chaininterface::FeeEstimator, crate::util::logger::Logger>;
749 /// Arguments for the creation of a ChannelManager that are not deserialized.
751 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
753 /// 1) Deserialize all stored ChannelMonitors.
754 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
755 /// ChannelManager)>::read(reader, args).
756 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
757 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
758 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
759 /// ChannelMonitor::get_outputs_to_watch() and ChannelMonitor::get_funding_txo().
760 /// 4) Reconnect blocks on your ChannelMonitors.
761 /// 5) Move the ChannelMonitors into your local chain::Watch.
762 /// 6) Disconnect/connect blocks on the ChannelManager.
765 pub struct ChannelManagerReadArgs {
766 /// Nearly everywhere, inner must be non-null, however in places where
767 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
768 pub inner: *mut nativeChannelManagerReadArgs,
772 impl Drop for ChannelManagerReadArgs {
774 if self.is_owned && !self.inner.is_null() {
775 let _ = unsafe { Box::from_raw(self.inner) };
780 pub extern "C" fn ChannelManagerReadArgs_free(this_ptr: ChannelManagerReadArgs) { }
782 /// Used only if an object of this type is returned as a trait impl by a method
783 extern "C" fn ChannelManagerReadArgs_free_void(this_ptr: *mut c_void) {
784 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelManagerReadArgs); }
787 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
788 impl ChannelManagerReadArgs {
789 pub(crate) fn take_inner(mut self) -> *mut nativeChannelManagerReadArgs {
790 assert!(self.is_owned);
791 let ret = self.inner;
792 self.inner = std::ptr::null_mut();
796 /// The keys provider which will give us relevant keys. Some keys will be loaded during
797 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
800 pub extern "C" fn ChannelManagerReadArgs_get_keys_manager(this_ptr: &ChannelManagerReadArgs) -> *const crate::chain::keysinterface::KeysInterface {
801 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.keys_manager;
804 /// The keys provider which will give us relevant keys. Some keys will be loaded during
805 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
808 pub extern "C" fn ChannelManagerReadArgs_set_keys_manager(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::chain::keysinterface::KeysInterface) {
809 unsafe { &mut *this_ptr.inner }.keys_manager = val;
811 /// The fee_estimator for use in the ChannelManager in the future.
813 /// No calls to the FeeEstimator will be made during deserialization.
815 pub extern "C" fn ChannelManagerReadArgs_get_fee_estimator(this_ptr: &ChannelManagerReadArgs) -> *const crate::chain::chaininterface::FeeEstimator {
816 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.fee_estimator;
819 /// The fee_estimator for use in the ChannelManager in the future.
821 /// No calls to the FeeEstimator will be made during deserialization.
823 pub extern "C" fn ChannelManagerReadArgs_set_fee_estimator(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::chain::chaininterface::FeeEstimator) {
824 unsafe { &mut *this_ptr.inner }.fee_estimator = val;
826 /// The chain::Watch for use in the ChannelManager in the future.
828 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
829 /// you have deserialized ChannelMonitors separately and will add them to your
830 /// chain::Watch after deserializing this ChannelManager.
832 pub extern "C" fn ChannelManagerReadArgs_get_chain_monitor(this_ptr: &ChannelManagerReadArgs) -> *const crate::chain::Watch {
833 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.chain_monitor;
836 /// The chain::Watch for use in the ChannelManager in the future.
838 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
839 /// you have deserialized ChannelMonitors separately and will add them to your
840 /// chain::Watch after deserializing this ChannelManager.
842 pub extern "C" fn ChannelManagerReadArgs_set_chain_monitor(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::chain::Watch) {
843 unsafe { &mut *this_ptr.inner }.chain_monitor = val;
845 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
846 /// used to broadcast the latest local commitment transactions of channels which must be
847 /// force-closed during deserialization.
849 pub extern "C" fn ChannelManagerReadArgs_get_tx_broadcaster(this_ptr: &ChannelManagerReadArgs) -> *const crate::chain::chaininterface::BroadcasterInterface {
850 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.tx_broadcaster;
853 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
854 /// used to broadcast the latest local commitment transactions of channels which must be
855 /// force-closed during deserialization.
857 pub extern "C" fn ChannelManagerReadArgs_set_tx_broadcaster(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::chain::chaininterface::BroadcasterInterface) {
858 unsafe { &mut *this_ptr.inner }.tx_broadcaster = val;
860 /// The Logger for use in the ChannelManager and which may be used to log information during
863 pub extern "C" fn ChannelManagerReadArgs_get_logger(this_ptr: &ChannelManagerReadArgs) -> *const crate::util::logger::Logger {
864 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.logger;
867 /// The Logger for use in the ChannelManager and which may be used to log information during
870 pub extern "C" fn ChannelManagerReadArgs_set_logger(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::util::logger::Logger) {
871 unsafe { &mut *this_ptr.inner }.logger = val;
873 /// Default settings used for new channels. Any existing channels will continue to use the
874 /// runtime settings which were stored when the ChannelManager was serialized.
876 pub extern "C" fn ChannelManagerReadArgs_get_default_config(this_ptr: &ChannelManagerReadArgs) -> crate::util::config::UserConfig {
877 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.default_config;
878 crate::util::config::UserConfig { inner: unsafe { ( (&((*inner_val)) as *const _) as *mut _) }, is_owned: false }
880 /// Default settings used for new channels. Any existing channels will continue to use the
881 /// runtime settings which were stored when the ChannelManager was serialized.
883 pub extern "C" fn ChannelManagerReadArgs_set_default_config(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::util::config::UserConfig) {
884 unsafe { &mut *this_ptr.inner }.default_config = *unsafe { Box::from_raw(val.take_inner()) };
886 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
887 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
888 /// populate a HashMap directly from C.
891 pub extern "C" fn ChannelManagerReadArgs_new(mut keys_manager: crate::chain::keysinterface::KeysInterface, mut fee_estimator: crate::chain::chaininterface::FeeEstimator, mut chain_monitor: crate::chain::Watch, mut tx_broadcaster: crate::chain::chaininterface::BroadcasterInterface, mut logger: crate::util::logger::Logger, mut default_config: crate::util::config::UserConfig, mut channel_monitors: crate::c_types::derived::CVec_ChannelMonitorZ) -> ChannelManagerReadArgs {
892 let mut local_channel_monitors = Vec::new(); for mut item in channel_monitors.into_rust().drain(..) { local_channel_monitors.push( { unsafe { &mut *item.inner } }); };
893 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);
894 ChannelManagerReadArgs { inner: Box::into_raw(Box::new(ret)), is_owned: true }
898 pub extern "C" fn C2Tuple_BlockHashChannelManagerZ_read(ser: crate::c_types::u8slice, arg: crate::ln::channelmanager::ChannelManagerReadArgs) -> crate::c_types::derived::CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ {
899 let arg_conv = *unsafe { Box::from_raw(arg.take_inner()) };
900 let res: Result<(bitcoin::hash_types::BlockHash, lightning::ln::channelmanager::ChannelManager<crate::chain::keysinterface::ChannelKeys, crate::chain::Watch, crate::chain::chaininterface::BroadcasterInterface, crate::chain::keysinterface::KeysInterface, crate::chain::chaininterface::FeeEstimator, crate::util::logger::Logger>), lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv);
901 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::ln::channelmanager::ChannelManager { inner: Box::into_raw(Box::new(orig_res_0_1)), is_owned: true }).into(); local_res_0 }), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }) };