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 [`Router`] 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).
19 use alloc::str::FromStr;
20 use alloc::string::String;
21 use core::ffi::c_void;
22 use core::convert::Infallible;
23 use bitcoin::hashes::Hash;
24 use crate::c_types::*;
25 #[cfg(feature="no-std")]
26 use alloc::{vec::Vec, boxed::Box};
28 /// This enum is used to specify which error data to send to peers when failing back an HTLC
29 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
31 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
35 pub enum FailureCode {
36 /// We had a temporary error processing the payment. Useful if no other error codes fit
37 /// and you want to indicate that the payer may want to retry.
39 /// We have a required feature which was not in this onion. For example, you may require
40 /// some additional metadata that was not provided with this payment.
41 RequiredNodeFeatureMissing,
42 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
43 /// the HTLC is too close to the current block height for safe handling.
44 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
45 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
46 IncorrectOrUnknownPaymentDetails,
47 /// We failed to process the payload after the onion was decrypted. You may wish to
48 /// use this when receiving custom HTLC TLVs with even type numbers that you don't recognize.
50 /// If available, the tuple data may include the type number and byte offset in the
51 /// decrypted byte stream where the failure occurred.
53 crate::c_types::derived::COption_C2Tuple_u64u16ZZ),
55 use lightning::ln::channelmanager::FailureCode as FailureCodeImport;
56 pub(crate) type nativeFailureCode = FailureCodeImport;
60 pub(crate) fn to_native(&self) -> nativeFailureCode {
62 FailureCode::TemporaryNodeFailure => nativeFailureCode::TemporaryNodeFailure,
63 FailureCode::RequiredNodeFeatureMissing => nativeFailureCode::RequiredNodeFeatureMissing,
64 FailureCode::IncorrectOrUnknownPaymentDetails => nativeFailureCode::IncorrectOrUnknownPaymentDetails,
65 FailureCode::InvalidOnionPayload (ref a, ) => {
66 let mut a_nonref = Clone::clone(a);
67 let mut local_a_nonref = if a_nonref.is_some() { Some( { let (mut orig_a_nonref_0_0, mut orig_a_nonref_0_1) = a_nonref.take().to_rust(); let mut local_a_nonref_0 = (orig_a_nonref_0_0, orig_a_nonref_0_1); local_a_nonref_0 }) } else { None };
68 nativeFailureCode::InvalidOnionPayload (
75 pub(crate) fn into_native(self) -> nativeFailureCode {
77 FailureCode::TemporaryNodeFailure => nativeFailureCode::TemporaryNodeFailure,
78 FailureCode::RequiredNodeFeatureMissing => nativeFailureCode::RequiredNodeFeatureMissing,
79 FailureCode::IncorrectOrUnknownPaymentDetails => nativeFailureCode::IncorrectOrUnknownPaymentDetails,
80 FailureCode::InvalidOnionPayload (mut a, ) => {
81 let mut local_a = if a.is_some() { Some( { let (mut orig_a_0_0, mut orig_a_0_1) = a.take().to_rust(); let mut local_a_0 = (orig_a_0_0, orig_a_0_1); local_a_0 }) } else { None };
82 nativeFailureCode::InvalidOnionPayload (
89 pub(crate) fn from_native(native: &nativeFailureCode) -> Self {
91 nativeFailureCode::TemporaryNodeFailure => FailureCode::TemporaryNodeFailure,
92 nativeFailureCode::RequiredNodeFeatureMissing => FailureCode::RequiredNodeFeatureMissing,
93 nativeFailureCode::IncorrectOrUnknownPaymentDetails => FailureCode::IncorrectOrUnknownPaymentDetails,
94 nativeFailureCode::InvalidOnionPayload (ref a, ) => {
95 let mut a_nonref = Clone::clone(a);
96 let mut local_a_nonref = if a_nonref.is_none() { crate::c_types::derived::COption_C2Tuple_u64u16ZZ::None } else { crate::c_types::derived::COption_C2Tuple_u64u16ZZ::Some( { let (mut orig_a_nonref_0_0, mut orig_a_nonref_0_1) = (a_nonref.unwrap()); let mut local_a_nonref_0 = (orig_a_nonref_0_0, orig_a_nonref_0_1).into(); local_a_nonref_0 }) };
97 FailureCode::InvalidOnionPayload (
104 pub(crate) fn native_into(native: nativeFailureCode) -> Self {
106 nativeFailureCode::TemporaryNodeFailure => FailureCode::TemporaryNodeFailure,
107 nativeFailureCode::RequiredNodeFeatureMissing => FailureCode::RequiredNodeFeatureMissing,
108 nativeFailureCode::IncorrectOrUnknownPaymentDetails => FailureCode::IncorrectOrUnknownPaymentDetails,
109 nativeFailureCode::InvalidOnionPayload (mut a, ) => {
110 let mut local_a = if a.is_none() { crate::c_types::derived::COption_C2Tuple_u64u16ZZ::None } else { crate::c_types::derived::COption_C2Tuple_u64u16ZZ::Some( { let (mut orig_a_0_0, mut orig_a_0_1) = (a.unwrap()); let mut local_a_0 = (orig_a_0_0, orig_a_0_1).into(); local_a_0 }) };
111 FailureCode::InvalidOnionPayload (
118 /// Frees any resources used by the FailureCode
120 pub extern "C" fn FailureCode_free(this_ptr: FailureCode) { }
121 /// Creates a copy of the FailureCode
123 pub extern "C" fn FailureCode_clone(orig: &FailureCode) -> FailureCode {
127 /// Utility method to constructs a new TemporaryNodeFailure-variant FailureCode
128 pub extern "C" fn FailureCode_temporary_node_failure() -> FailureCode {
129 FailureCode::TemporaryNodeFailure}
131 /// Utility method to constructs a new RequiredNodeFeatureMissing-variant FailureCode
132 pub extern "C" fn FailureCode_required_node_feature_missing() -> FailureCode {
133 FailureCode::RequiredNodeFeatureMissing}
135 /// Utility method to constructs a new IncorrectOrUnknownPaymentDetails-variant FailureCode
136 pub extern "C" fn FailureCode_incorrect_or_unknown_payment_details() -> FailureCode {
137 FailureCode::IncorrectOrUnknownPaymentDetails}
139 /// Utility method to constructs a new InvalidOnionPayload-variant FailureCode
140 pub extern "C" fn FailureCode_invalid_onion_payload(a: crate::c_types::derived::COption_C2Tuple_u64u16ZZ) -> FailureCode {
141 FailureCode::InvalidOnionPayload(a, )
144 use lightning::ln::channelmanager::ChannelManager as nativeChannelManagerImport;
145 pub(crate) type nativeChannelManager = nativeChannelManagerImport<crate::lightning::chain::Watch, crate::lightning::chain::chaininterface::BroadcasterInterface, crate::lightning::sign::EntropySource, crate::lightning::sign::NodeSigner, crate::lightning::sign::SignerProvider, crate::lightning::chain::chaininterface::FeeEstimator, crate::lightning::routing::router::Router, crate::lightning::util::logger::Logger>;
147 /// Manager which keeps track of a number of channels and sends messages to the appropriate
148 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
150 /// Implements [`ChannelMessageHandler`], handling the multi-channel parts and passing things through
151 /// to individual Channels.
153 /// Implements [`Writeable`] to write out all channel state to disk. Implies [`peer_disconnected`] for
154 /// all peers during write/read (though does not modify this instance, only the instance being
155 /// serialized). This will result in any channels which have not yet exchanged [`funding_created`] (i.e.,
156 /// called [`funding_transaction_generated`] for outbound channels) being closed.
158 /// Note that you can be a bit lazier about writing out `ChannelManager` than you can be with
159 /// [`ChannelMonitor`]. With [`ChannelMonitor`] you MUST durably write each
160 /// [`ChannelMonitorUpdate`] before returning from
161 /// [`chain::Watch::watch_channel`]/[`update_channel`] or before completing async writes. With
162 /// `ChannelManager`s, writing updates happens out-of-band (and will prevent any other
163 /// `ChannelManager` operations from occurring during the serialization process). If the
164 /// deserialized version is out-of-date compared to the [`ChannelMonitor`] passed by reference to
165 /// [`read`], those channels will be force-closed based on the `ChannelMonitor` state and no funds
166 /// will be lost (modulo on-chain transaction fees).
168 /// Note that the deserializer is only implemented for `(`[`BlockHash`]`, `[`ChannelManager`]`)`, which
169 /// tells you the last block hash which was connected. You should get the best block tip before using the manager.
170 /// See [`chain::Listen`] and [`chain::Confirm`] for more details.
172 /// Note that `ChannelManager` is responsible for tracking liveness of its channels and generating
173 /// [`ChannelUpdate`] messages informing peers that the channel is temporarily disabled. To avoid
174 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
175 /// offline for a full minute. In order to track this, you must call
176 /// [`timer_tick_occurred`] roughly once per minute, though it doesn't have to be perfect.
178 /// To avoid trivial DoS issues, `ChannelManager` limits the number of inbound connections and
179 /// inbound channels without confirmed funding transactions. This may result in nodes which we do
180 /// not have a channel with being unable to connect to us or open new channels with us if we have
181 /// many peers with unfunded channels.
183 /// Because it is an indication of trust, inbound channels which we've accepted as 0conf are
184 /// exempted from the count of unfunded channels. Similarly, outbound channels and connections are
185 /// never limited. Please ensure you limit the count of such channels yourself.
187 /// Rather than using a plain `ChannelManager`, it is preferable to use either a [`SimpleArcChannelManager`]
188 /// a [`SimpleRefChannelManager`], for conciseness. See their documentation for more details, but
189 /// essentially you should default to using a [`SimpleRefChannelManager`], and use a
190 /// [`SimpleArcChannelManager`] when you require a `ChannelManager` with a static lifetime, such as when
191 /// you're using lightning-net-tokio.
193 /// [`peer_disconnected`]: msgs::ChannelMessageHandler::peer_disconnected
194 /// [`funding_created`]: msgs::FundingCreated
195 /// [`funding_transaction_generated`]: Self::funding_transaction_generated
196 /// [`BlockHash`]: bitcoin::hash_types::BlockHash
197 /// [`update_channel`]: chain::Watch::update_channel
198 /// [`ChannelUpdate`]: msgs::ChannelUpdate
199 /// [`timer_tick_occurred`]: Self::timer_tick_occurred
200 /// [`read`]: ReadableArgs::read
203 pub struct ChannelManager {
204 /// A pointer to the opaque Rust object.
206 /// Nearly everywhere, inner must be non-null, however in places where
207 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
208 pub inner: *mut nativeChannelManager,
209 /// Indicates that this is the only struct which contains the same pointer.
211 /// Rust functions which take ownership of an object provided via an argument require
212 /// this to be true and invalidate the object pointed to by inner.
216 impl Drop for ChannelManager {
218 if self.is_owned && !<*mut nativeChannelManager>::is_null(self.inner) {
219 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
223 /// Frees any resources used by the ChannelManager, if is_owned is set and inner is non-NULL.
225 pub extern "C" fn ChannelManager_free(this_obj: ChannelManager) { }
227 /// Used only if an object of this type is returned as a trait impl by a method
228 pub(crate) extern "C" fn ChannelManager_free_void(this_ptr: *mut c_void) {
229 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelManager) };
232 impl ChannelManager {
233 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelManager {
234 unsafe { &*ObjOps::untweak_ptr(self.inner) }
236 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelManager {
237 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
239 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
240 pub(crate) fn take_inner(mut self) -> *mut nativeChannelManager {
241 assert!(self.is_owned);
242 let ret = ObjOps::untweak_ptr(self.inner);
243 self.inner = core::ptr::null_mut();
248 use lightning::ln::channelmanager::ChainParameters as nativeChainParametersImport;
249 pub(crate) type nativeChainParameters = nativeChainParametersImport;
251 /// Chain-related parameters used to construct a new `ChannelManager`.
253 /// Typically, the block-specific parameters are derived from the best block hash for the network,
254 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
255 /// are not needed when deserializing a previously constructed `ChannelManager`.
258 pub struct ChainParameters {
259 /// A pointer to the opaque Rust object.
261 /// Nearly everywhere, inner must be non-null, however in places where
262 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
263 pub inner: *mut nativeChainParameters,
264 /// Indicates that this is the only struct which contains the same pointer.
266 /// Rust functions which take ownership of an object provided via an argument require
267 /// this to be true and invalidate the object pointed to by inner.
271 impl Drop for ChainParameters {
273 if self.is_owned && !<*mut nativeChainParameters>::is_null(self.inner) {
274 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
278 /// Frees any resources used by the ChainParameters, if is_owned is set and inner is non-NULL.
280 pub extern "C" fn ChainParameters_free(this_obj: ChainParameters) { }
282 /// Used only if an object of this type is returned as a trait impl by a method
283 pub(crate) extern "C" fn ChainParameters_free_void(this_ptr: *mut c_void) {
284 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChainParameters) };
287 impl ChainParameters {
288 pub(crate) fn get_native_ref(&self) -> &'static nativeChainParameters {
289 unsafe { &*ObjOps::untweak_ptr(self.inner) }
291 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChainParameters {
292 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
294 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
295 pub(crate) fn take_inner(mut self) -> *mut nativeChainParameters {
296 assert!(self.is_owned);
297 let ret = ObjOps::untweak_ptr(self.inner);
298 self.inner = core::ptr::null_mut();
302 /// The network for determining the `chain_hash` in Lightning messages.
304 pub extern "C" fn ChainParameters_get_network(this_ptr: &ChainParameters) -> crate::bitcoin::network::Network {
305 let mut inner_val = &mut this_ptr.get_native_mut_ref().network;
306 crate::bitcoin::network::Network::from_bitcoin(inner_val)
308 /// The network for determining the `chain_hash` in Lightning messages.
310 pub extern "C" fn ChainParameters_set_network(this_ptr: &mut ChainParameters, mut val: crate::bitcoin::network::Network) {
311 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.network = val.into_bitcoin();
313 /// The hash and height of the latest block successfully connected.
315 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
317 pub extern "C" fn ChainParameters_get_best_block(this_ptr: &ChainParameters) -> crate::lightning::chain::BestBlock {
318 let mut inner_val = &mut this_ptr.get_native_mut_ref().best_block;
319 crate::lightning::chain::BestBlock { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::chain::BestBlock<>) as *mut _) }, is_owned: false }
321 /// The hash and height of the latest block successfully connected.
323 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
325 pub extern "C" fn ChainParameters_set_best_block(this_ptr: &mut ChainParameters, mut val: crate::lightning::chain::BestBlock) {
326 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.best_block = *unsafe { Box::from_raw(val.take_inner()) };
328 /// Constructs a new ChainParameters given each field
331 pub extern "C" fn ChainParameters_new(mut network_arg: crate::bitcoin::network::Network, mut best_block_arg: crate::lightning::chain::BestBlock) -> ChainParameters {
332 ChainParameters { inner: ObjOps::heap_alloc(nativeChainParameters {
333 network: network_arg.into_bitcoin(),
334 best_block: *unsafe { Box::from_raw(best_block_arg.take_inner()) },
337 impl Clone for ChainParameters {
338 fn clone(&self) -> Self {
340 inner: if <*mut nativeChainParameters>::is_null(self.inner) { core::ptr::null_mut() } else {
341 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
347 /// Used only if an object of this type is returned as a trait impl by a method
348 pub(crate) extern "C" fn ChainParameters_clone_void(this_ptr: *const c_void) -> *mut c_void {
349 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChainParameters)).clone() })) as *mut c_void
352 /// Creates a copy of the ChainParameters
353 pub extern "C" fn ChainParameters_clone(orig: &ChainParameters) -> ChainParameters {
356 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
357 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
359 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
361 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
364 pub static BREAKDOWN_TIMEOUT: u16 = lightning::ln::channelmanager::BREAKDOWN_TIMEOUT;
365 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
366 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
368 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
370 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
373 pub static MIN_CLTV_EXPIRY_DELTA: u16 = lightning::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA;
374 /// Minimum CLTV difference between the current block height and received inbound payments.
375 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
379 pub static MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA;
381 use lightning::ln::channelmanager::CounterpartyForwardingInfo as nativeCounterpartyForwardingInfoImport;
382 pub(crate) type nativeCounterpartyForwardingInfo = nativeCounterpartyForwardingInfoImport;
384 /// Information needed for constructing an invoice route hint for this channel.
387 pub struct CounterpartyForwardingInfo {
388 /// A pointer to the opaque Rust object.
390 /// Nearly everywhere, inner must be non-null, however in places where
391 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
392 pub inner: *mut nativeCounterpartyForwardingInfo,
393 /// Indicates that this is the only struct which contains the same pointer.
395 /// Rust functions which take ownership of an object provided via an argument require
396 /// this to be true and invalidate the object pointed to by inner.
400 impl Drop for CounterpartyForwardingInfo {
402 if self.is_owned && !<*mut nativeCounterpartyForwardingInfo>::is_null(self.inner) {
403 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
407 /// Frees any resources used by the CounterpartyForwardingInfo, if is_owned is set and inner is non-NULL.
409 pub extern "C" fn CounterpartyForwardingInfo_free(this_obj: CounterpartyForwardingInfo) { }
411 /// Used only if an object of this type is returned as a trait impl by a method
412 pub(crate) extern "C" fn CounterpartyForwardingInfo_free_void(this_ptr: *mut c_void) {
413 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeCounterpartyForwardingInfo) };
416 impl CounterpartyForwardingInfo {
417 pub(crate) fn get_native_ref(&self) -> &'static nativeCounterpartyForwardingInfo {
418 unsafe { &*ObjOps::untweak_ptr(self.inner) }
420 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeCounterpartyForwardingInfo {
421 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
423 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
424 pub(crate) fn take_inner(mut self) -> *mut nativeCounterpartyForwardingInfo {
425 assert!(self.is_owned);
426 let ret = ObjOps::untweak_ptr(self.inner);
427 self.inner = core::ptr::null_mut();
431 /// Base routing fee in millisatoshis.
433 pub extern "C" fn CounterpartyForwardingInfo_get_fee_base_msat(this_ptr: &CounterpartyForwardingInfo) -> u32 {
434 let mut inner_val = &mut this_ptr.get_native_mut_ref().fee_base_msat;
437 /// Base routing fee in millisatoshis.
439 pub extern "C" fn CounterpartyForwardingInfo_set_fee_base_msat(this_ptr: &mut CounterpartyForwardingInfo, mut val: u32) {
440 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.fee_base_msat = val;
442 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
444 pub extern "C" fn CounterpartyForwardingInfo_get_fee_proportional_millionths(this_ptr: &CounterpartyForwardingInfo) -> u32 {
445 let mut inner_val = &mut this_ptr.get_native_mut_ref().fee_proportional_millionths;
448 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
450 pub extern "C" fn CounterpartyForwardingInfo_set_fee_proportional_millionths(this_ptr: &mut CounterpartyForwardingInfo, mut val: u32) {
451 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.fee_proportional_millionths = val;
453 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
454 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
455 /// `cltv_expiry_delta` for more details.
457 pub extern "C" fn CounterpartyForwardingInfo_get_cltv_expiry_delta(this_ptr: &CounterpartyForwardingInfo) -> u16 {
458 let mut inner_val = &mut this_ptr.get_native_mut_ref().cltv_expiry_delta;
461 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
462 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
463 /// `cltv_expiry_delta` for more details.
465 pub extern "C" fn CounterpartyForwardingInfo_set_cltv_expiry_delta(this_ptr: &mut CounterpartyForwardingInfo, mut val: u16) {
466 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.cltv_expiry_delta = val;
468 /// Constructs a new CounterpartyForwardingInfo given each field
471 pub extern "C" fn CounterpartyForwardingInfo_new(mut fee_base_msat_arg: u32, mut fee_proportional_millionths_arg: u32, mut cltv_expiry_delta_arg: u16) -> CounterpartyForwardingInfo {
472 CounterpartyForwardingInfo { inner: ObjOps::heap_alloc(nativeCounterpartyForwardingInfo {
473 fee_base_msat: fee_base_msat_arg,
474 fee_proportional_millionths: fee_proportional_millionths_arg,
475 cltv_expiry_delta: cltv_expiry_delta_arg,
478 impl Clone for CounterpartyForwardingInfo {
479 fn clone(&self) -> Self {
481 inner: if <*mut nativeCounterpartyForwardingInfo>::is_null(self.inner) { core::ptr::null_mut() } else {
482 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
488 /// Used only if an object of this type is returned as a trait impl by a method
489 pub(crate) extern "C" fn CounterpartyForwardingInfo_clone_void(this_ptr: *const c_void) -> *mut c_void {
490 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeCounterpartyForwardingInfo)).clone() })) as *mut c_void
493 /// Creates a copy of the CounterpartyForwardingInfo
494 pub extern "C" fn CounterpartyForwardingInfo_clone(orig: &CounterpartyForwardingInfo) -> CounterpartyForwardingInfo {
498 use lightning::ln::channelmanager::ChannelCounterparty as nativeChannelCounterpartyImport;
499 pub(crate) type nativeChannelCounterparty = nativeChannelCounterpartyImport;
501 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
502 /// to better separate parameters.
505 pub struct ChannelCounterparty {
506 /// A pointer to the opaque Rust object.
508 /// Nearly everywhere, inner must be non-null, however in places where
509 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
510 pub inner: *mut nativeChannelCounterparty,
511 /// Indicates that this is the only struct which contains the same pointer.
513 /// Rust functions which take ownership of an object provided via an argument require
514 /// this to be true and invalidate the object pointed to by inner.
518 impl Drop for ChannelCounterparty {
520 if self.is_owned && !<*mut nativeChannelCounterparty>::is_null(self.inner) {
521 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
525 /// Frees any resources used by the ChannelCounterparty, if is_owned is set and inner is non-NULL.
527 pub extern "C" fn ChannelCounterparty_free(this_obj: ChannelCounterparty) { }
529 /// Used only if an object of this type is returned as a trait impl by a method
530 pub(crate) extern "C" fn ChannelCounterparty_free_void(this_ptr: *mut c_void) {
531 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelCounterparty) };
534 impl ChannelCounterparty {
535 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelCounterparty {
536 unsafe { &*ObjOps::untweak_ptr(self.inner) }
538 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelCounterparty {
539 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
541 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
542 pub(crate) fn take_inner(mut self) -> *mut nativeChannelCounterparty {
543 assert!(self.is_owned);
544 let ret = ObjOps::untweak_ptr(self.inner);
545 self.inner = core::ptr::null_mut();
549 /// The node_id of our counterparty
551 pub extern "C" fn ChannelCounterparty_get_node_id(this_ptr: &ChannelCounterparty) -> crate::c_types::PublicKey {
552 let mut inner_val = &mut this_ptr.get_native_mut_ref().node_id;
553 crate::c_types::PublicKey::from_rust(&inner_val)
555 /// The node_id of our counterparty
557 pub extern "C" fn ChannelCounterparty_set_node_id(this_ptr: &mut ChannelCounterparty, mut val: crate::c_types::PublicKey) {
558 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.node_id = val.into_rust();
560 /// The Features the channel counterparty provided upon last connection.
561 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
562 /// many routing-relevant features are present in the init context.
564 pub extern "C" fn ChannelCounterparty_get_features(this_ptr: &ChannelCounterparty) -> crate::lightning::ln::features::InitFeatures {
565 let mut inner_val = &mut this_ptr.get_native_mut_ref().features;
566 crate::lightning::ln::features::InitFeatures { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::features::InitFeatures<>) as *mut _) }, is_owned: false }
568 /// The Features the channel counterparty provided upon last connection.
569 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
570 /// many routing-relevant features are present in the init context.
572 pub extern "C" fn ChannelCounterparty_set_features(this_ptr: &mut ChannelCounterparty, mut val: crate::lightning::ln::features::InitFeatures) {
573 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.features = *unsafe { Box::from_raw(val.take_inner()) };
575 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
576 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
577 /// claiming at least this value on chain.
579 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
581 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
583 pub extern "C" fn ChannelCounterparty_get_unspendable_punishment_reserve(this_ptr: &ChannelCounterparty) -> u64 {
584 let mut inner_val = &mut this_ptr.get_native_mut_ref().unspendable_punishment_reserve;
587 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
588 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
589 /// claiming at least this value on chain.
591 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
593 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
595 pub extern "C" fn ChannelCounterparty_set_unspendable_punishment_reserve(this_ptr: &mut ChannelCounterparty, mut val: u64) {
596 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.unspendable_punishment_reserve = val;
598 /// Information on the fees and requirements that the counterparty requires when forwarding
599 /// payments to us through this channel.
601 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
603 pub extern "C" fn ChannelCounterparty_get_forwarding_info(this_ptr: &ChannelCounterparty) -> crate::lightning::ln::channelmanager::CounterpartyForwardingInfo {
604 let mut inner_val = &mut this_ptr.get_native_mut_ref().forwarding_info;
605 let mut local_inner_val = crate::lightning::ln::channelmanager::CounterpartyForwardingInfo { inner: unsafe { (if inner_val.is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner( { (inner_val.as_ref().unwrap()) }) } as *const lightning::ln::channelmanager::CounterpartyForwardingInfo<>) as *mut _ }, is_owned: false };
608 /// Information on the fees and requirements that the counterparty requires when forwarding
609 /// payments to us through this channel.
611 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
613 pub extern "C" fn ChannelCounterparty_set_forwarding_info(this_ptr: &mut ChannelCounterparty, mut val: crate::lightning::ln::channelmanager::CounterpartyForwardingInfo) {
614 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
615 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.forwarding_info = local_val;
617 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
618 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
619 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
621 pub extern "C" fn ChannelCounterparty_get_outbound_htlc_minimum_msat(this_ptr: &ChannelCounterparty) -> crate::c_types::derived::COption_u64Z {
622 let mut inner_val = &mut this_ptr.get_native_mut_ref().outbound_htlc_minimum_msat;
623 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() }) };
626 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
627 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
628 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
630 pub extern "C" fn ChannelCounterparty_set_outbound_htlc_minimum_msat(this_ptr: &mut ChannelCounterparty, mut val: crate::c_types::derived::COption_u64Z) {
631 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
632 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.outbound_htlc_minimum_msat = local_val;
634 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
636 pub extern "C" fn ChannelCounterparty_get_outbound_htlc_maximum_msat(this_ptr: &ChannelCounterparty) -> crate::c_types::derived::COption_u64Z {
637 let mut inner_val = &mut this_ptr.get_native_mut_ref().outbound_htlc_maximum_msat;
638 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() }) };
641 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
643 pub extern "C" fn ChannelCounterparty_set_outbound_htlc_maximum_msat(this_ptr: &mut ChannelCounterparty, mut val: crate::c_types::derived::COption_u64Z) {
644 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
645 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.outbound_htlc_maximum_msat = local_val;
647 /// Constructs a new ChannelCounterparty given each field
649 /// Note that forwarding_info_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
652 pub extern "C" fn ChannelCounterparty_new(mut node_id_arg: crate::c_types::PublicKey, mut features_arg: crate::lightning::ln::features::InitFeatures, mut unspendable_punishment_reserve_arg: u64, mut forwarding_info_arg: crate::lightning::ln::channelmanager::CounterpartyForwardingInfo, mut outbound_htlc_minimum_msat_arg: crate::c_types::derived::COption_u64Z, mut outbound_htlc_maximum_msat_arg: crate::c_types::derived::COption_u64Z) -> ChannelCounterparty {
653 let mut local_forwarding_info_arg = if forwarding_info_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(forwarding_info_arg.take_inner()) } }) };
654 let mut local_outbound_htlc_minimum_msat_arg = if outbound_htlc_minimum_msat_arg.is_some() { Some( { outbound_htlc_minimum_msat_arg.take() }) } else { None };
655 let mut local_outbound_htlc_maximum_msat_arg = if outbound_htlc_maximum_msat_arg.is_some() { Some( { outbound_htlc_maximum_msat_arg.take() }) } else { None };
656 ChannelCounterparty { inner: ObjOps::heap_alloc(nativeChannelCounterparty {
657 node_id: node_id_arg.into_rust(),
658 features: *unsafe { Box::from_raw(features_arg.take_inner()) },
659 unspendable_punishment_reserve: unspendable_punishment_reserve_arg,
660 forwarding_info: local_forwarding_info_arg,
661 outbound_htlc_minimum_msat: local_outbound_htlc_minimum_msat_arg,
662 outbound_htlc_maximum_msat: local_outbound_htlc_maximum_msat_arg,
665 impl Clone for ChannelCounterparty {
666 fn clone(&self) -> Self {
668 inner: if <*mut nativeChannelCounterparty>::is_null(self.inner) { core::ptr::null_mut() } else {
669 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
675 /// Used only if an object of this type is returned as a trait impl by a method
676 pub(crate) extern "C" fn ChannelCounterparty_clone_void(this_ptr: *const c_void) -> *mut c_void {
677 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelCounterparty)).clone() })) as *mut c_void
680 /// Creates a copy of the ChannelCounterparty
681 pub extern "C" fn ChannelCounterparty_clone(orig: &ChannelCounterparty) -> ChannelCounterparty {
685 use lightning::ln::channelmanager::ChannelDetails as nativeChannelDetailsImport;
686 pub(crate) type nativeChannelDetails = nativeChannelDetailsImport;
688 /// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
691 pub struct ChannelDetails {
692 /// A pointer to the opaque Rust object.
694 /// Nearly everywhere, inner must be non-null, however in places where
695 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
696 pub inner: *mut nativeChannelDetails,
697 /// Indicates that this is the only struct which contains the same pointer.
699 /// Rust functions which take ownership of an object provided via an argument require
700 /// this to be true and invalidate the object pointed to by inner.
704 impl Drop for ChannelDetails {
706 if self.is_owned && !<*mut nativeChannelDetails>::is_null(self.inner) {
707 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
711 /// Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL.
713 pub extern "C" fn ChannelDetails_free(this_obj: ChannelDetails) { }
715 /// Used only if an object of this type is returned as a trait impl by a method
716 pub(crate) extern "C" fn ChannelDetails_free_void(this_ptr: *mut c_void) {
717 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelDetails) };
720 impl ChannelDetails {
721 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelDetails {
722 unsafe { &*ObjOps::untweak_ptr(self.inner) }
724 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelDetails {
725 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
727 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
728 pub(crate) fn take_inner(mut self) -> *mut nativeChannelDetails {
729 assert!(self.is_owned);
730 let ret = ObjOps::untweak_ptr(self.inner);
731 self.inner = core::ptr::null_mut();
735 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
736 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
737 /// Note that this means this value is *not* persistent - it can change once during the
738 /// lifetime of the channel.
740 pub extern "C" fn ChannelDetails_get_channel_id(this_ptr: &ChannelDetails) -> *const [u8; 32] {
741 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_id;
744 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
745 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
746 /// Note that this means this value is *not* persistent - it can change once during the
747 /// lifetime of the channel.
749 pub extern "C" fn ChannelDetails_set_channel_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::ThirtyTwoBytes) {
750 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_id = ::lightning::ln::ChannelId(val.data);
752 /// Parameters which apply to our counterparty. See individual fields for more information.
754 pub extern "C" fn ChannelDetails_get_counterparty(this_ptr: &ChannelDetails) -> crate::lightning::ln::channelmanager::ChannelCounterparty {
755 let mut inner_val = &mut this_ptr.get_native_mut_ref().counterparty;
756 crate::lightning::ln::channelmanager::ChannelCounterparty { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::ln::channelmanager::ChannelCounterparty<>) as *mut _) }, is_owned: false }
758 /// Parameters which apply to our counterparty. See individual fields for more information.
760 pub extern "C" fn ChannelDetails_set_counterparty(this_ptr: &mut ChannelDetails, mut val: crate::lightning::ln::channelmanager::ChannelCounterparty) {
761 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.counterparty = *unsafe { Box::from_raw(val.take_inner()) };
763 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
764 /// our counterparty already.
766 /// Note that, if this has been set, `channel_id` will be equivalent to
767 /// `funding_txo.unwrap().to_channel_id()`.
769 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
771 pub extern "C" fn ChannelDetails_get_funding_txo(this_ptr: &ChannelDetails) -> crate::lightning::chain::transaction::OutPoint {
772 let mut inner_val = &mut this_ptr.get_native_mut_ref().funding_txo;
773 let mut local_inner_val = crate::lightning::chain::transaction::OutPoint { inner: unsafe { (if inner_val.is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner( { (inner_val.as_ref().unwrap()) }) } as *const lightning::chain::transaction::OutPoint<>) as *mut _ }, is_owned: false };
776 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
777 /// our counterparty already.
779 /// Note that, if this has been set, `channel_id` will be equivalent to
780 /// `funding_txo.unwrap().to_channel_id()`.
782 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
784 pub extern "C" fn ChannelDetails_set_funding_txo(this_ptr: &mut ChannelDetails, mut val: crate::lightning::chain::transaction::OutPoint) {
785 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
786 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.funding_txo = local_val;
788 /// The features which this channel operates with. See individual features for more info.
790 /// `None` until negotiation completes and the channel type is finalized.
792 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
794 pub extern "C" fn ChannelDetails_get_channel_type(this_ptr: &ChannelDetails) -> crate::lightning::ln::features::ChannelTypeFeatures {
795 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_type;
796 let mut local_inner_val = crate::lightning::ln::features::ChannelTypeFeatures { inner: unsafe { (if inner_val.is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner( { (inner_val.as_ref().unwrap()) }) } as *const lightning::ln::features::ChannelTypeFeatures<>) as *mut _ }, is_owned: false };
799 /// The features which this channel operates with. See individual features for more info.
801 /// `None` until negotiation completes and the channel type is finalized.
803 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
805 pub extern "C" fn ChannelDetails_set_channel_type(this_ptr: &mut ChannelDetails, mut val: crate::lightning::ln::features::ChannelTypeFeatures) {
806 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
807 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_type = local_val;
809 /// The position of the funding transaction in the chain. None if the funding transaction has
810 /// not yet been confirmed and the channel fully opened.
812 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
813 /// payments instead of this. See [`get_inbound_payment_scid`].
815 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
816 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
818 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
819 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
820 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
821 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
822 /// [`confirmations_required`]: Self::confirmations_required
824 pub extern "C" fn ChannelDetails_get_short_channel_id(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u64Z {
825 let mut inner_val = &mut this_ptr.get_native_mut_ref().short_channel_id;
826 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() }) };
829 /// The position of the funding transaction in the chain. None if the funding transaction has
830 /// not yet been confirmed and the channel fully opened.
832 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
833 /// payments instead of this. See [`get_inbound_payment_scid`].
835 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
836 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
838 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
839 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
840 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
841 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
842 /// [`confirmations_required`]: Self::confirmations_required
844 pub extern "C" fn ChannelDetails_set_short_channel_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u64Z) {
845 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
846 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.short_channel_id = local_val;
848 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
849 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
850 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
853 /// This will be `None` as long as the channel is not available for routing outbound payments.
855 /// [`short_channel_id`]: Self::short_channel_id
856 /// [`confirmations_required`]: Self::confirmations_required
858 pub extern "C" fn ChannelDetails_get_outbound_scid_alias(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u64Z {
859 let mut inner_val = &mut this_ptr.get_native_mut_ref().outbound_scid_alias;
860 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() }) };
863 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
864 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
865 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
868 /// This will be `None` as long as the channel is not available for routing outbound payments.
870 /// [`short_channel_id`]: Self::short_channel_id
871 /// [`confirmations_required`]: Self::confirmations_required
873 pub extern "C" fn ChannelDetails_set_outbound_scid_alias(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u64Z) {
874 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
875 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.outbound_scid_alias = local_val;
877 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
878 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
879 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
880 /// when they see a payment to be routed to us.
882 /// Our counterparty may choose to rotate this value at any time, though will always recognize
883 /// previous values for inbound payment forwarding.
885 /// [`short_channel_id`]: Self::short_channel_id
887 pub extern "C" fn ChannelDetails_get_inbound_scid_alias(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u64Z {
888 let mut inner_val = &mut this_ptr.get_native_mut_ref().inbound_scid_alias;
889 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() }) };
892 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
893 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
894 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
895 /// when they see a payment to be routed to us.
897 /// Our counterparty may choose to rotate this value at any time, though will always recognize
898 /// previous values for inbound payment forwarding.
900 /// [`short_channel_id`]: Self::short_channel_id
902 pub extern "C" fn ChannelDetails_set_inbound_scid_alias(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u64Z) {
903 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
904 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.inbound_scid_alias = local_val;
906 /// The value, in satoshis, of this channel as appears in the funding output
908 pub extern "C" fn ChannelDetails_get_channel_value_satoshis(this_ptr: &ChannelDetails) -> u64 {
909 let mut inner_val = &mut this_ptr.get_native_mut_ref().channel_value_satoshis;
912 /// The value, in satoshis, of this channel as appears in the funding output
914 pub extern "C" fn ChannelDetails_set_channel_value_satoshis(this_ptr: &mut ChannelDetails, mut val: u64) {
915 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_value_satoshis = val;
917 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
918 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
919 /// this value on chain.
921 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
923 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
925 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
927 pub extern "C" fn ChannelDetails_get_unspendable_punishment_reserve(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u64Z {
928 let mut inner_val = &mut this_ptr.get_native_mut_ref().unspendable_punishment_reserve;
929 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() }) };
932 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
933 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
934 /// this value on chain.
936 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
938 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
940 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
942 pub extern "C" fn ChannelDetails_set_unspendable_punishment_reserve(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u64Z) {
943 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
944 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.unspendable_punishment_reserve = local_val;
946 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
947 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
948 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
949 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
950 /// serialized with LDK versions prior to 0.0.113.
952 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
953 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
954 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
956 pub extern "C" fn ChannelDetails_get_user_channel_id(this_ptr: &ChannelDetails) -> crate::c_types::U128 {
957 let mut inner_val = &mut this_ptr.get_native_mut_ref().user_channel_id;
960 /// The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
961 /// channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
962 /// [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
963 /// `user_channel_id` will be randomized for an inbound channel. This may be zero for objects
964 /// serialized with LDK versions prior to 0.0.113.
966 /// [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
967 /// [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
968 /// [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
970 pub extern "C" fn ChannelDetails_set_user_channel_id(this_ptr: &mut ChannelDetails, mut val: crate::c_types::U128) {
971 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.user_channel_id = val.into();
973 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
974 /// which is applied to commitment and HTLC transactions.
976 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
978 pub extern "C" fn ChannelDetails_get_feerate_sat_per_1000_weight(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u32Z {
979 let mut inner_val = &mut this_ptr.get_native_mut_ref().feerate_sat_per_1000_weight;
980 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u32Z::None } else { crate::c_types::derived::COption_u32Z::Some( { inner_val.unwrap() }) };
983 /// The currently negotiated fee rate denominated in satoshi per 1000 weight units,
984 /// which is applied to commitment and HTLC transactions.
986 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.115.
988 pub extern "C" fn ChannelDetails_set_feerate_sat_per_1000_weight(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u32Z) {
989 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
990 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.feerate_sat_per_1000_weight = local_val;
992 /// Our total balance. This is the amount we would get if we close the channel.
993 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
994 /// amount is not likely to be recoverable on close.
996 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
997 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
998 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
999 /// This does not consider any on-chain fees.
1001 /// See also [`ChannelDetails::outbound_capacity_msat`]
1003 pub extern "C" fn ChannelDetails_get_balance_msat(this_ptr: &ChannelDetails) -> u64 {
1004 let mut inner_val = &mut this_ptr.get_native_mut_ref().balance_msat;
1007 /// Our total balance. This is the amount we would get if we close the channel.
1008 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1009 /// amount is not likely to be recoverable on close.
1011 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1012 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1013 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1014 /// This does not consider any on-chain fees.
1016 /// See also [`ChannelDetails::outbound_capacity_msat`]
1018 pub extern "C" fn ChannelDetails_set_balance_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
1019 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.balance_msat = val;
1021 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1022 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1023 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1024 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1026 /// See also [`ChannelDetails::balance_msat`]
1028 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1029 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1030 /// should be able to spend nearly this amount.
1032 pub extern "C" fn ChannelDetails_get_outbound_capacity_msat(this_ptr: &ChannelDetails) -> u64 {
1033 let mut inner_val = &mut this_ptr.get_native_mut_ref().outbound_capacity_msat;
1036 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1037 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1038 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1039 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1041 /// See also [`ChannelDetails::balance_msat`]
1043 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1044 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1045 /// should be able to spend nearly this amount.
1047 pub extern "C" fn ChannelDetails_set_outbound_capacity_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
1048 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.outbound_capacity_msat = val;
1050 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1051 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1052 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1053 /// to use a limit as close as possible to the HTLC limit we can currently send.
1055 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1056 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1058 pub extern "C" fn ChannelDetails_get_next_outbound_htlc_limit_msat(this_ptr: &ChannelDetails) -> u64 {
1059 let mut inner_val = &mut this_ptr.get_native_mut_ref().next_outbound_htlc_limit_msat;
1062 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1063 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1064 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1065 /// to use a limit as close as possible to the HTLC limit we can currently send.
1067 /// See also [`ChannelDetails::next_outbound_htlc_minimum_msat`],
1068 /// [`ChannelDetails::balance_msat`], and [`ChannelDetails::outbound_capacity_msat`].
1070 pub extern "C" fn ChannelDetails_set_next_outbound_htlc_limit_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
1071 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.next_outbound_htlc_limit_msat = val;
1073 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1074 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1075 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1076 /// route which is valid.
1078 pub extern "C" fn ChannelDetails_get_next_outbound_htlc_minimum_msat(this_ptr: &ChannelDetails) -> u64 {
1079 let mut inner_val = &mut this_ptr.get_native_mut_ref().next_outbound_htlc_minimum_msat;
1082 /// The minimum value for sending a single HTLC to the remote peer. This is the equivalent of
1083 /// [`ChannelDetails::next_outbound_htlc_limit_msat`] but represents a lower-bound, rather than
1084 /// an upper-bound. This is intended for use when routing, allowing us to ensure we pick a
1085 /// route which is valid.
1087 pub extern "C" fn ChannelDetails_set_next_outbound_htlc_minimum_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
1088 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.next_outbound_htlc_minimum_msat = val;
1090 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1091 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1092 /// available for inclusion in new inbound HTLCs).
1093 /// Note that there are some corner cases not fully handled here, so the actual available
1094 /// inbound capacity may be slightly higher than this.
1096 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1097 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1098 /// However, our counterparty should be able to spend nearly this amount.
1100 pub extern "C" fn ChannelDetails_get_inbound_capacity_msat(this_ptr: &ChannelDetails) -> u64 {
1101 let mut inner_val = &mut this_ptr.get_native_mut_ref().inbound_capacity_msat;
1104 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1105 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1106 /// available for inclusion in new inbound HTLCs).
1107 /// Note that there are some corner cases not fully handled here, so the actual available
1108 /// inbound capacity may be slightly higher than this.
1110 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1111 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1112 /// However, our counterparty should be able to spend nearly this amount.
1114 pub extern "C" fn ChannelDetails_set_inbound_capacity_msat(this_ptr: &mut ChannelDetails, mut val: u64) {
1115 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.inbound_capacity_msat = val;
1117 /// The number of required confirmations on the funding transaction before the funding will be
1118 /// considered \"locked\". This number is selected by the channel fundee (i.e. us if
1119 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1120 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1121 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1123 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1125 /// [`is_outbound`]: ChannelDetails::is_outbound
1126 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1127 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1129 pub extern "C" fn ChannelDetails_get_confirmations_required(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u32Z {
1130 let mut inner_val = &mut this_ptr.get_native_mut_ref().confirmations_required;
1131 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u32Z::None } else { crate::c_types::derived::COption_u32Z::Some( { inner_val.unwrap() }) };
1134 /// The number of required confirmations on the funding transaction before the funding will be
1135 /// considered \"locked\". This number is selected by the channel fundee (i.e. us if
1136 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1137 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1138 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1140 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1142 /// [`is_outbound`]: ChannelDetails::is_outbound
1143 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1144 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1146 pub extern "C" fn ChannelDetails_set_confirmations_required(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u32Z) {
1147 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1148 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.confirmations_required = local_val;
1150 /// The current number of confirmations on the funding transaction.
1152 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1154 pub extern "C" fn ChannelDetails_get_confirmations(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u32Z {
1155 let mut inner_val = &mut this_ptr.get_native_mut_ref().confirmations;
1156 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u32Z::None } else { crate::c_types::derived::COption_u32Z::Some( { inner_val.unwrap() }) };
1159 /// The current number of confirmations on the funding transaction.
1161 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1163 pub extern "C" fn ChannelDetails_set_confirmations(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u32Z) {
1164 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1165 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.confirmations = local_val;
1167 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1168 /// until we can claim our funds after we force-close the channel. During this time our
1169 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1170 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1171 /// time to claim our non-HTLC-encumbered funds.
1173 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1175 pub extern "C" fn ChannelDetails_get_force_close_spend_delay(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u16Z {
1176 let mut inner_val = &mut this_ptr.get_native_mut_ref().force_close_spend_delay;
1177 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_u16Z::None } else { crate::c_types::derived::COption_u16Z::Some( { inner_val.unwrap() }) };
1180 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1181 /// until we can claim our funds after we force-close the channel. During this time our
1182 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1183 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1184 /// time to claim our non-HTLC-encumbered funds.
1186 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1188 pub extern "C" fn ChannelDetails_set_force_close_spend_delay(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u16Z) {
1189 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1190 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.force_close_spend_delay = local_val;
1192 /// True if the channel was initiated (and thus funded) by us.
1194 pub extern "C" fn ChannelDetails_get_is_outbound(this_ptr: &ChannelDetails) -> bool {
1195 let mut inner_val = &mut this_ptr.get_native_mut_ref().is_outbound;
1198 /// True if the channel was initiated (and thus funded) by us.
1200 pub extern "C" fn ChannelDetails_set_is_outbound(this_ptr: &mut ChannelDetails, mut val: bool) {
1201 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.is_outbound = val;
1203 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1204 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1205 /// required confirmation count has been reached (and we were connected to the peer at some
1206 /// point after the funding transaction received enough confirmations). The required
1207 /// confirmation count is provided in [`confirmations_required`].
1209 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1211 pub extern "C" fn ChannelDetails_get_is_channel_ready(this_ptr: &ChannelDetails) -> bool {
1212 let mut inner_val = &mut this_ptr.get_native_mut_ref().is_channel_ready;
1215 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1216 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1217 /// required confirmation count has been reached (and we were connected to the peer at some
1218 /// point after the funding transaction received enough confirmations). The required
1219 /// confirmation count is provided in [`confirmations_required`].
1221 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1223 pub extern "C" fn ChannelDetails_set_is_channel_ready(this_ptr: &mut ChannelDetails, mut val: bool) {
1224 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.is_channel_ready = val;
1226 /// The stage of the channel's shutdown.
1227 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1229 /// Returns a copy of the field.
1231 pub extern "C" fn ChannelDetails_get_channel_shutdown_state(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_ChannelShutdownStateZ {
1232 let mut inner_val = this_ptr.get_native_mut_ref().channel_shutdown_state.clone();
1233 let mut local_inner_val = if inner_val.is_none() { crate::c_types::derived::COption_ChannelShutdownStateZ::None } else { crate::c_types::derived::COption_ChannelShutdownStateZ::Some( { crate::lightning::ln::channelmanager::ChannelShutdownState::native_into(inner_val.unwrap()) }) };
1236 /// The stage of the channel's shutdown.
1237 /// `None` for `ChannelDetails` serialized on LDK versions prior to 0.0.116.
1239 pub extern "C" fn ChannelDetails_set_channel_shutdown_state(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_ChannelShutdownStateZ) {
1240 let mut local_val = { /*val*/ let val_opt = val; if val_opt.is_none() { None } else { Some({ { { val_opt.take() }.into_native() }})} };
1241 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channel_shutdown_state = local_val;
1243 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1244 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1246 /// This is a strict superset of `is_channel_ready`.
1248 pub extern "C" fn ChannelDetails_get_is_usable(this_ptr: &ChannelDetails) -> bool {
1249 let mut inner_val = &mut this_ptr.get_native_mut_ref().is_usable;
1252 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1253 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1255 /// This is a strict superset of `is_channel_ready`.
1257 pub extern "C" fn ChannelDetails_set_is_usable(this_ptr: &mut ChannelDetails, mut val: bool) {
1258 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.is_usable = val;
1260 /// True if this channel is (or will be) publicly-announced.
1262 pub extern "C" fn ChannelDetails_get_is_public(this_ptr: &ChannelDetails) -> bool {
1263 let mut inner_val = &mut this_ptr.get_native_mut_ref().is_public;
1266 /// True if this channel is (or will be) publicly-announced.
1268 pub extern "C" fn ChannelDetails_set_is_public(this_ptr: &mut ChannelDetails, mut val: bool) {
1269 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.is_public = val;
1271 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1272 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1274 pub extern "C" fn ChannelDetails_get_inbound_htlc_minimum_msat(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u64Z {
1275 let mut inner_val = &mut this_ptr.get_native_mut_ref().inbound_htlc_minimum_msat;
1276 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() }) };
1279 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1280 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1282 pub extern "C" fn ChannelDetails_set_inbound_htlc_minimum_msat(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u64Z) {
1283 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1284 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.inbound_htlc_minimum_msat = local_val;
1286 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1288 pub extern "C" fn ChannelDetails_get_inbound_htlc_maximum_msat(this_ptr: &ChannelDetails) -> crate::c_types::derived::COption_u64Z {
1289 let mut inner_val = &mut this_ptr.get_native_mut_ref().inbound_htlc_maximum_msat;
1290 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() }) };
1293 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1295 pub extern "C" fn ChannelDetails_set_inbound_htlc_maximum_msat(this_ptr: &mut ChannelDetails, mut val: crate::c_types::derived::COption_u64Z) {
1296 let mut local_val = if val.is_some() { Some( { val.take() }) } else { None };
1297 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.inbound_htlc_maximum_msat = local_val;
1299 /// Set of configurable parameters that affect channel operation.
1301 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1303 /// Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
1305 pub extern "C" fn ChannelDetails_get_config(this_ptr: &ChannelDetails) -> crate::lightning::util::config::ChannelConfig {
1306 let mut inner_val = &mut this_ptr.get_native_mut_ref().config;
1307 let mut local_inner_val = crate::lightning::util::config::ChannelConfig { inner: unsafe { (if inner_val.is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner( { (inner_val.as_ref().unwrap()) }) } as *const lightning::util::config::ChannelConfig<>) as *mut _ }, is_owned: false };
1310 /// Set of configurable parameters that affect channel operation.
1312 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1314 /// Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
1316 pub extern "C" fn ChannelDetails_set_config(this_ptr: &mut ChannelDetails, mut val: crate::lightning::util::config::ChannelConfig) {
1317 let mut local_val = if val.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(val.take_inner()) } }) };
1318 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.config = local_val;
1320 /// Constructs a new ChannelDetails given each field
1322 /// Note that funding_txo_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
1323 /// Note that channel_type_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
1324 /// Note that config_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
1327 pub extern "C" fn ChannelDetails_new(mut channel_id_arg: crate::c_types::ThirtyTwoBytes, mut counterparty_arg: crate::lightning::ln::channelmanager::ChannelCounterparty, mut funding_txo_arg: crate::lightning::chain::transaction::OutPoint, mut channel_type_arg: crate::lightning::ln::features::ChannelTypeFeatures, mut short_channel_id_arg: crate::c_types::derived::COption_u64Z, mut outbound_scid_alias_arg: crate::c_types::derived::COption_u64Z, mut inbound_scid_alias_arg: crate::c_types::derived::COption_u64Z, mut channel_value_satoshis_arg: u64, mut unspendable_punishment_reserve_arg: crate::c_types::derived::COption_u64Z, mut user_channel_id_arg: crate::c_types::U128, mut feerate_sat_per_1000_weight_arg: crate::c_types::derived::COption_u32Z, mut balance_msat_arg: u64, mut outbound_capacity_msat_arg: u64, mut next_outbound_htlc_limit_msat_arg: u64, mut next_outbound_htlc_minimum_msat_arg: u64, mut inbound_capacity_msat_arg: u64, mut confirmations_required_arg: crate::c_types::derived::COption_u32Z, mut confirmations_arg: crate::c_types::derived::COption_u32Z, mut force_close_spend_delay_arg: crate::c_types::derived::COption_u16Z, mut is_outbound_arg: bool, mut is_channel_ready_arg: bool, mut channel_shutdown_state_arg: crate::c_types::derived::COption_ChannelShutdownStateZ, mut is_usable_arg: bool, mut is_public_arg: bool, mut inbound_htlc_minimum_msat_arg: crate::c_types::derived::COption_u64Z, mut inbound_htlc_maximum_msat_arg: crate::c_types::derived::COption_u64Z, mut config_arg: crate::lightning::util::config::ChannelConfig) -> ChannelDetails {
1328 let mut local_funding_txo_arg = if funding_txo_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(funding_txo_arg.take_inner()) } }) };
1329 let mut local_channel_type_arg = if channel_type_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(channel_type_arg.take_inner()) } }) };
1330 let mut local_short_channel_id_arg = if short_channel_id_arg.is_some() { Some( { short_channel_id_arg.take() }) } else { None };
1331 let mut local_outbound_scid_alias_arg = if outbound_scid_alias_arg.is_some() { Some( { outbound_scid_alias_arg.take() }) } else { None };
1332 let mut local_inbound_scid_alias_arg = if inbound_scid_alias_arg.is_some() { Some( { inbound_scid_alias_arg.take() }) } else { None };
1333 let mut local_unspendable_punishment_reserve_arg = if unspendable_punishment_reserve_arg.is_some() { Some( { unspendable_punishment_reserve_arg.take() }) } else { None };
1334 let mut local_feerate_sat_per_1000_weight_arg = if feerate_sat_per_1000_weight_arg.is_some() { Some( { feerate_sat_per_1000_weight_arg.take() }) } else { None };
1335 let mut local_confirmations_required_arg = if confirmations_required_arg.is_some() { Some( { confirmations_required_arg.take() }) } else { None };
1336 let mut local_confirmations_arg = if confirmations_arg.is_some() { Some( { confirmations_arg.take() }) } else { None };
1337 let mut local_force_close_spend_delay_arg = if force_close_spend_delay_arg.is_some() { Some( { force_close_spend_delay_arg.take() }) } else { None };
1338 let mut local_channel_shutdown_state_arg = { /*channel_shutdown_state_arg*/ let channel_shutdown_state_arg_opt = channel_shutdown_state_arg; if channel_shutdown_state_arg_opt.is_none() { None } else { Some({ { { channel_shutdown_state_arg_opt.take() }.into_native() }})} };
1339 let mut local_inbound_htlc_minimum_msat_arg = if inbound_htlc_minimum_msat_arg.is_some() { Some( { inbound_htlc_minimum_msat_arg.take() }) } else { None };
1340 let mut local_inbound_htlc_maximum_msat_arg = if inbound_htlc_maximum_msat_arg.is_some() { Some( { inbound_htlc_maximum_msat_arg.take() }) } else { None };
1341 let mut local_config_arg = if config_arg.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(config_arg.take_inner()) } }) };
1342 ChannelDetails { inner: ObjOps::heap_alloc(nativeChannelDetails {
1343 channel_id: ::lightning::ln::ChannelId(channel_id_arg.data),
1344 counterparty: *unsafe { Box::from_raw(counterparty_arg.take_inner()) },
1345 funding_txo: local_funding_txo_arg,
1346 channel_type: local_channel_type_arg,
1347 short_channel_id: local_short_channel_id_arg,
1348 outbound_scid_alias: local_outbound_scid_alias_arg,
1349 inbound_scid_alias: local_inbound_scid_alias_arg,
1350 channel_value_satoshis: channel_value_satoshis_arg,
1351 unspendable_punishment_reserve: local_unspendable_punishment_reserve_arg,
1352 user_channel_id: user_channel_id_arg.into(),
1353 feerate_sat_per_1000_weight: local_feerate_sat_per_1000_weight_arg,
1354 balance_msat: balance_msat_arg,
1355 outbound_capacity_msat: outbound_capacity_msat_arg,
1356 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat_arg,
1357 next_outbound_htlc_minimum_msat: next_outbound_htlc_minimum_msat_arg,
1358 inbound_capacity_msat: inbound_capacity_msat_arg,
1359 confirmations_required: local_confirmations_required_arg,
1360 confirmations: local_confirmations_arg,
1361 force_close_spend_delay: local_force_close_spend_delay_arg,
1362 is_outbound: is_outbound_arg,
1363 is_channel_ready: is_channel_ready_arg,
1364 channel_shutdown_state: local_channel_shutdown_state_arg,
1365 is_usable: is_usable_arg,
1366 is_public: is_public_arg,
1367 inbound_htlc_minimum_msat: local_inbound_htlc_minimum_msat_arg,
1368 inbound_htlc_maximum_msat: local_inbound_htlc_maximum_msat_arg,
1369 config: local_config_arg,
1370 }), is_owned: true }
1372 impl Clone for ChannelDetails {
1373 fn clone(&self) -> Self {
1375 inner: if <*mut nativeChannelDetails>::is_null(self.inner) { core::ptr::null_mut() } else {
1376 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1382 /// Used only if an object of this type is returned as a trait impl by a method
1383 pub(crate) extern "C" fn ChannelDetails_clone_void(this_ptr: *const c_void) -> *mut c_void {
1384 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelDetails)).clone() })) as *mut c_void
1387 /// Creates a copy of the ChannelDetails
1388 pub extern "C" fn ChannelDetails_clone(orig: &ChannelDetails) -> ChannelDetails {
1391 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1392 /// This should be used for providing invoice hints or in any other context where our
1393 /// counterparty will forward a payment to us.
1395 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1396 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1399 pub extern "C" fn ChannelDetails_get_inbound_payment_scid(this_arg: &crate::lightning::ln::channelmanager::ChannelDetails) -> crate::c_types::derived::COption_u64Z {
1400 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_inbound_payment_scid();
1401 let mut local_ret = if ret.is_none() { crate::c_types::derived::COption_u64Z::None } else { crate::c_types::derived::COption_u64Z::Some( { ret.unwrap() }) };
1405 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1406 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1407 /// we're sending or forwarding a payment outbound over this channel.
1409 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1410 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1413 pub extern "C" fn ChannelDetails_get_outbound_payment_scid(this_arg: &crate::lightning::ln::channelmanager::ChannelDetails) -> crate::c_types::derived::COption_u64Z {
1414 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_outbound_payment_scid();
1415 let mut local_ret = if ret.is_none() { crate::c_types::derived::COption_u64Z::None } else { crate::c_types::derived::COption_u64Z::Some( { ret.unwrap() }) };
1419 /// Further information on the details of the channel shutdown.
1420 /// Upon channels being forced closed (i.e. commitment transaction confirmation detected
1421 /// by `ChainMonitor`), ChannelShutdownState will be set to `ShutdownComplete` or
1422 /// the channel will be removed shortly.
1423 /// Also note, that in normal operation, peers could disconnect at any of these states
1424 /// and require peer re-connection before making progress onto other states
1428 pub enum ChannelShutdownState {
1429 /// Channel has not sent or received a shutdown message.
1431 /// Local node has sent a shutdown message for this channel.
1433 /// Shutdown message exchanges have concluded and the channels are in the midst of
1434 /// resolving all existing open HTLCs before closing can continue.
1436 /// All HTLCs have been resolved, nodes are currently negotiating channel close onchain fee rates.
1437 NegotiatingClosingFee,
1438 /// We've successfully negotiated a closing_signed dance. At this point `ChannelManager` is about
1439 /// to drop the channel.
1442 use lightning::ln::channelmanager::ChannelShutdownState as ChannelShutdownStateImport;
1443 pub(crate) type nativeChannelShutdownState = ChannelShutdownStateImport;
1445 impl ChannelShutdownState {
1447 pub(crate) fn to_native(&self) -> nativeChannelShutdownState {
1449 ChannelShutdownState::NotShuttingDown => nativeChannelShutdownState::NotShuttingDown,
1450 ChannelShutdownState::ShutdownInitiated => nativeChannelShutdownState::ShutdownInitiated,
1451 ChannelShutdownState::ResolvingHTLCs => nativeChannelShutdownState::ResolvingHTLCs,
1452 ChannelShutdownState::NegotiatingClosingFee => nativeChannelShutdownState::NegotiatingClosingFee,
1453 ChannelShutdownState::ShutdownComplete => nativeChannelShutdownState::ShutdownComplete,
1457 pub(crate) fn into_native(self) -> nativeChannelShutdownState {
1459 ChannelShutdownState::NotShuttingDown => nativeChannelShutdownState::NotShuttingDown,
1460 ChannelShutdownState::ShutdownInitiated => nativeChannelShutdownState::ShutdownInitiated,
1461 ChannelShutdownState::ResolvingHTLCs => nativeChannelShutdownState::ResolvingHTLCs,
1462 ChannelShutdownState::NegotiatingClosingFee => nativeChannelShutdownState::NegotiatingClosingFee,
1463 ChannelShutdownState::ShutdownComplete => nativeChannelShutdownState::ShutdownComplete,
1467 pub(crate) fn from_native(native: &nativeChannelShutdownState) -> Self {
1469 nativeChannelShutdownState::NotShuttingDown => ChannelShutdownState::NotShuttingDown,
1470 nativeChannelShutdownState::ShutdownInitiated => ChannelShutdownState::ShutdownInitiated,
1471 nativeChannelShutdownState::ResolvingHTLCs => ChannelShutdownState::ResolvingHTLCs,
1472 nativeChannelShutdownState::NegotiatingClosingFee => ChannelShutdownState::NegotiatingClosingFee,
1473 nativeChannelShutdownState::ShutdownComplete => ChannelShutdownState::ShutdownComplete,
1477 pub(crate) fn native_into(native: nativeChannelShutdownState) -> Self {
1479 nativeChannelShutdownState::NotShuttingDown => ChannelShutdownState::NotShuttingDown,
1480 nativeChannelShutdownState::ShutdownInitiated => ChannelShutdownState::ShutdownInitiated,
1481 nativeChannelShutdownState::ResolvingHTLCs => ChannelShutdownState::ResolvingHTLCs,
1482 nativeChannelShutdownState::NegotiatingClosingFee => ChannelShutdownState::NegotiatingClosingFee,
1483 nativeChannelShutdownState::ShutdownComplete => ChannelShutdownState::ShutdownComplete,
1487 /// Creates a copy of the ChannelShutdownState
1489 pub extern "C" fn ChannelShutdownState_clone(orig: &ChannelShutdownState) -> ChannelShutdownState {
1493 /// Utility method to constructs a new NotShuttingDown-variant ChannelShutdownState
1494 pub extern "C" fn ChannelShutdownState_not_shutting_down() -> ChannelShutdownState {
1495 ChannelShutdownState::NotShuttingDown}
1497 /// Utility method to constructs a new ShutdownInitiated-variant ChannelShutdownState
1498 pub extern "C" fn ChannelShutdownState_shutdown_initiated() -> ChannelShutdownState {
1499 ChannelShutdownState::ShutdownInitiated}
1501 /// Utility method to constructs a new ResolvingHTLCs-variant ChannelShutdownState
1502 pub extern "C" fn ChannelShutdownState_resolving_htlcs() -> ChannelShutdownState {
1503 ChannelShutdownState::ResolvingHTLCs}
1505 /// Utility method to constructs a new NegotiatingClosingFee-variant ChannelShutdownState
1506 pub extern "C" fn ChannelShutdownState_negotiating_closing_fee() -> ChannelShutdownState {
1507 ChannelShutdownState::NegotiatingClosingFee}
1509 /// Utility method to constructs a new ShutdownComplete-variant ChannelShutdownState
1510 pub extern "C" fn ChannelShutdownState_shutdown_complete() -> ChannelShutdownState {
1511 ChannelShutdownState::ShutdownComplete}
1512 /// Checks if two ChannelShutdownStates contain equal inner contents.
1513 /// This ignores pointers and is_owned flags and looks at the values in fields.
1515 pub extern "C" fn ChannelShutdownState_eq(a: &ChannelShutdownState, b: &ChannelShutdownState) -> bool {
1516 if &a.to_native() == &b.to_native() { true } else { false }
1518 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1519 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1523 pub enum RecentPaymentDetails {
1524 /// When an invoice was requested and thus a payment has not yet been sent.
1526 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1527 /// a payment and ensure idempotency in LDK.
1528 payment_id: crate::c_types::ThirtyTwoBytes,
1530 /// When a payment is still being sent and awaiting successful delivery.
1532 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1533 /// a payment and ensure idempotency in LDK.
1534 payment_id: crate::c_types::ThirtyTwoBytes,
1535 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1537 payment_hash: crate::c_types::ThirtyTwoBytes,
1538 /// Total amount (in msat, excluding fees) across all paths for this payment,
1539 /// not just the amount currently inflight.
1542 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1543 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1544 /// payment is removed from tracking.
1546 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1547 /// a payment and ensure idempotency in LDK.
1548 payment_id: crate::c_types::ThirtyTwoBytes,
1549 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1550 /// made before LDK version 0.0.104.
1551 payment_hash: crate::c_types::derived::COption_ThirtyTwoBytesZ,
1553 /// After a payment's retries are exhausted per the provided [`Retry`], or it is explicitly
1554 /// abandoned via [`ChannelManager::abandon_payment`], it is marked as abandoned until all
1555 /// pending HTLCs for this payment resolve and an [`Event::PaymentFailed`] is generated.
1557 /// A user-provided identifier in [`ChannelManager::send_payment`] used to uniquely identify
1558 /// a payment and ensure idempotency in LDK.
1559 payment_id: crate::c_types::ThirtyTwoBytes,
1560 /// Hash of the payment that we have given up trying to send.
1561 payment_hash: crate::c_types::ThirtyTwoBytes,
1564 use lightning::ln::channelmanager::RecentPaymentDetails as RecentPaymentDetailsImport;
1565 pub(crate) type nativeRecentPaymentDetails = RecentPaymentDetailsImport;
1567 impl RecentPaymentDetails {
1569 pub(crate) fn to_native(&self) -> nativeRecentPaymentDetails {
1571 RecentPaymentDetails::AwaitingInvoice {ref payment_id, } => {
1572 let mut payment_id_nonref = Clone::clone(payment_id);
1573 nativeRecentPaymentDetails::AwaitingInvoice {
1574 payment_id: ::lightning::ln::channelmanager::PaymentId(payment_id_nonref.data),
1577 RecentPaymentDetails::Pending {ref payment_id, ref payment_hash, ref total_msat, } => {
1578 let mut payment_id_nonref = Clone::clone(payment_id);
1579 let mut payment_hash_nonref = Clone::clone(payment_hash);
1580 let mut total_msat_nonref = Clone::clone(total_msat);
1581 nativeRecentPaymentDetails::Pending {
1582 payment_id: ::lightning::ln::channelmanager::PaymentId(payment_id_nonref.data),
1583 payment_hash: ::lightning::ln::PaymentHash(payment_hash_nonref.data),
1584 total_msat: total_msat_nonref,
1587 RecentPaymentDetails::Fulfilled {ref payment_id, ref payment_hash, } => {
1588 let mut payment_id_nonref = Clone::clone(payment_id);
1589 let mut payment_hash_nonref = Clone::clone(payment_hash);
1590 let mut local_payment_hash_nonref = { /*payment_hash_nonref*/ let payment_hash_nonref_opt = payment_hash_nonref; if payment_hash_nonref_opt.is_none() { None } else { Some({ { ::lightning::ln::PaymentHash({ payment_hash_nonref_opt.take() }.data) }})} };
1591 nativeRecentPaymentDetails::Fulfilled {
1592 payment_id: ::lightning::ln::channelmanager::PaymentId(payment_id_nonref.data),
1593 payment_hash: local_payment_hash_nonref,
1596 RecentPaymentDetails::Abandoned {ref payment_id, ref payment_hash, } => {
1597 let mut payment_id_nonref = Clone::clone(payment_id);
1598 let mut payment_hash_nonref = Clone::clone(payment_hash);
1599 nativeRecentPaymentDetails::Abandoned {
1600 payment_id: ::lightning::ln::channelmanager::PaymentId(payment_id_nonref.data),
1601 payment_hash: ::lightning::ln::PaymentHash(payment_hash_nonref.data),
1607 pub(crate) fn into_native(self) -> nativeRecentPaymentDetails {
1609 RecentPaymentDetails::AwaitingInvoice {mut payment_id, } => {
1610 nativeRecentPaymentDetails::AwaitingInvoice {
1611 payment_id: ::lightning::ln::channelmanager::PaymentId(payment_id.data),
1614 RecentPaymentDetails::Pending {mut payment_id, mut payment_hash, mut total_msat, } => {
1615 nativeRecentPaymentDetails::Pending {
1616 payment_id: ::lightning::ln::channelmanager::PaymentId(payment_id.data),
1617 payment_hash: ::lightning::ln::PaymentHash(payment_hash.data),
1618 total_msat: total_msat,
1621 RecentPaymentDetails::Fulfilled {mut payment_id, mut payment_hash, } => {
1622 let mut local_payment_hash = { /*payment_hash*/ let payment_hash_opt = payment_hash; if payment_hash_opt.is_none() { None } else { Some({ { ::lightning::ln::PaymentHash({ payment_hash_opt.take() }.data) }})} };
1623 nativeRecentPaymentDetails::Fulfilled {
1624 payment_id: ::lightning::ln::channelmanager::PaymentId(payment_id.data),
1625 payment_hash: local_payment_hash,
1628 RecentPaymentDetails::Abandoned {mut payment_id, mut payment_hash, } => {
1629 nativeRecentPaymentDetails::Abandoned {
1630 payment_id: ::lightning::ln::channelmanager::PaymentId(payment_id.data),
1631 payment_hash: ::lightning::ln::PaymentHash(payment_hash.data),
1637 pub(crate) fn from_native(native: &nativeRecentPaymentDetails) -> Self {
1639 nativeRecentPaymentDetails::AwaitingInvoice {ref payment_id, } => {
1640 let mut payment_id_nonref = Clone::clone(payment_id);
1641 RecentPaymentDetails::AwaitingInvoice {
1642 payment_id: crate::c_types::ThirtyTwoBytes { data: payment_id_nonref.0 },
1645 nativeRecentPaymentDetails::Pending {ref payment_id, ref payment_hash, ref total_msat, } => {
1646 let mut payment_id_nonref = Clone::clone(payment_id);
1647 let mut payment_hash_nonref = Clone::clone(payment_hash);
1648 let mut total_msat_nonref = Clone::clone(total_msat);
1649 RecentPaymentDetails::Pending {
1650 payment_id: crate::c_types::ThirtyTwoBytes { data: payment_id_nonref.0 },
1651 payment_hash: crate::c_types::ThirtyTwoBytes { data: payment_hash_nonref.0 },
1652 total_msat: total_msat_nonref,
1655 nativeRecentPaymentDetails::Fulfilled {ref payment_id, ref payment_hash, } => {
1656 let mut payment_id_nonref = Clone::clone(payment_id);
1657 let mut payment_hash_nonref = Clone::clone(payment_hash);
1658 let mut local_payment_hash_nonref = if payment_hash_nonref.is_none() { crate::c_types::derived::COption_ThirtyTwoBytesZ::None } else { crate::c_types::derived::COption_ThirtyTwoBytesZ::Some( { crate::c_types::ThirtyTwoBytes { data: payment_hash_nonref.unwrap().0 } }) };
1659 RecentPaymentDetails::Fulfilled {
1660 payment_id: crate::c_types::ThirtyTwoBytes { data: payment_id_nonref.0 },
1661 payment_hash: local_payment_hash_nonref,
1664 nativeRecentPaymentDetails::Abandoned {ref payment_id, ref payment_hash, } => {
1665 let mut payment_id_nonref = Clone::clone(payment_id);
1666 let mut payment_hash_nonref = Clone::clone(payment_hash);
1667 RecentPaymentDetails::Abandoned {
1668 payment_id: crate::c_types::ThirtyTwoBytes { data: payment_id_nonref.0 },
1669 payment_hash: crate::c_types::ThirtyTwoBytes { data: payment_hash_nonref.0 },
1675 pub(crate) fn native_into(native: nativeRecentPaymentDetails) -> Self {
1677 nativeRecentPaymentDetails::AwaitingInvoice {mut payment_id, } => {
1678 RecentPaymentDetails::AwaitingInvoice {
1679 payment_id: crate::c_types::ThirtyTwoBytes { data: payment_id.0 },
1682 nativeRecentPaymentDetails::Pending {mut payment_id, mut payment_hash, mut total_msat, } => {
1683 RecentPaymentDetails::Pending {
1684 payment_id: crate::c_types::ThirtyTwoBytes { data: payment_id.0 },
1685 payment_hash: crate::c_types::ThirtyTwoBytes { data: payment_hash.0 },
1686 total_msat: total_msat,
1689 nativeRecentPaymentDetails::Fulfilled {mut payment_id, mut payment_hash, } => {
1690 let mut local_payment_hash = if payment_hash.is_none() { crate::c_types::derived::COption_ThirtyTwoBytesZ::None } else { crate::c_types::derived::COption_ThirtyTwoBytesZ::Some( { crate::c_types::ThirtyTwoBytes { data: payment_hash.unwrap().0 } }) };
1691 RecentPaymentDetails::Fulfilled {
1692 payment_id: crate::c_types::ThirtyTwoBytes { data: payment_id.0 },
1693 payment_hash: local_payment_hash,
1696 nativeRecentPaymentDetails::Abandoned {mut payment_id, mut payment_hash, } => {
1697 RecentPaymentDetails::Abandoned {
1698 payment_id: crate::c_types::ThirtyTwoBytes { data: payment_id.0 },
1699 payment_hash: crate::c_types::ThirtyTwoBytes { data: payment_hash.0 },
1705 /// Frees any resources used by the RecentPaymentDetails
1707 pub extern "C" fn RecentPaymentDetails_free(this_ptr: RecentPaymentDetails) { }
1708 /// Creates a copy of the RecentPaymentDetails
1710 pub extern "C" fn RecentPaymentDetails_clone(orig: &RecentPaymentDetails) -> RecentPaymentDetails {
1714 /// Utility method to constructs a new AwaitingInvoice-variant RecentPaymentDetails
1715 pub extern "C" fn RecentPaymentDetails_awaiting_invoice(payment_id: crate::c_types::ThirtyTwoBytes) -> RecentPaymentDetails {
1716 RecentPaymentDetails::AwaitingInvoice {
1721 /// Utility method to constructs a new Pending-variant RecentPaymentDetails
1722 pub extern "C" fn RecentPaymentDetails_pending(payment_id: crate::c_types::ThirtyTwoBytes, payment_hash: crate::c_types::ThirtyTwoBytes, total_msat: u64) -> RecentPaymentDetails {
1723 RecentPaymentDetails::Pending {
1730 /// Utility method to constructs a new Fulfilled-variant RecentPaymentDetails
1731 pub extern "C" fn RecentPaymentDetails_fulfilled(payment_id: crate::c_types::ThirtyTwoBytes, payment_hash: crate::c_types::derived::COption_ThirtyTwoBytesZ) -> RecentPaymentDetails {
1732 RecentPaymentDetails::Fulfilled {
1738 /// Utility method to constructs a new Abandoned-variant RecentPaymentDetails
1739 pub extern "C" fn RecentPaymentDetails_abandoned(payment_id: crate::c_types::ThirtyTwoBytes, payment_hash: crate::c_types::ThirtyTwoBytes) -> RecentPaymentDetails {
1740 RecentPaymentDetails::Abandoned {
1746 use lightning::ln::channelmanager::PhantomRouteHints as nativePhantomRouteHintsImport;
1747 pub(crate) type nativePhantomRouteHints = nativePhantomRouteHintsImport;
1749 /// Route hints used in constructing invoices for [phantom node payents].
1751 /// [phantom node payments]: crate::sign::PhantomKeysManager
1754 pub struct PhantomRouteHints {
1755 /// A pointer to the opaque Rust object.
1757 /// Nearly everywhere, inner must be non-null, however in places where
1758 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
1759 pub inner: *mut nativePhantomRouteHints,
1760 /// Indicates that this is the only struct which contains the same pointer.
1762 /// Rust functions which take ownership of an object provided via an argument require
1763 /// this to be true and invalidate the object pointed to by inner.
1767 impl Drop for PhantomRouteHints {
1768 fn drop(&mut self) {
1769 if self.is_owned && !<*mut nativePhantomRouteHints>::is_null(self.inner) {
1770 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
1774 /// Frees any resources used by the PhantomRouteHints, if is_owned is set and inner is non-NULL.
1776 pub extern "C" fn PhantomRouteHints_free(this_obj: PhantomRouteHints) { }
1778 /// Used only if an object of this type is returned as a trait impl by a method
1779 pub(crate) extern "C" fn PhantomRouteHints_free_void(this_ptr: *mut c_void) {
1780 let _ = unsafe { Box::from_raw(this_ptr as *mut nativePhantomRouteHints) };
1783 impl PhantomRouteHints {
1784 pub(crate) fn get_native_ref(&self) -> &'static nativePhantomRouteHints {
1785 unsafe { &*ObjOps::untweak_ptr(self.inner) }
1787 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativePhantomRouteHints {
1788 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
1790 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
1791 pub(crate) fn take_inner(mut self) -> *mut nativePhantomRouteHints {
1792 assert!(self.is_owned);
1793 let ret = ObjOps::untweak_ptr(self.inner);
1794 self.inner = core::ptr::null_mut();
1798 /// The list of channels to be included in the invoice route hints.
1800 pub extern "C" fn PhantomRouteHints_get_channels(this_ptr: &PhantomRouteHints) -> crate::c_types::derived::CVec_ChannelDetailsZ {
1801 let mut inner_val = &mut this_ptr.get_native_mut_ref().channels;
1802 let mut local_inner_val = Vec::new(); for item in inner_val.iter() { local_inner_val.push( { crate::lightning::ln::channelmanager::ChannelDetails { inner: unsafe { ObjOps::nonnull_ptr_to_inner((item as *const lightning::ln::channelmanager::ChannelDetails<>) as *mut _) }, is_owned: false } }); };
1803 local_inner_val.into()
1805 /// The list of channels to be included in the invoice route hints.
1807 pub extern "C" fn PhantomRouteHints_set_channels(this_ptr: &mut PhantomRouteHints, mut val: crate::c_types::derived::CVec_ChannelDetailsZ) {
1808 let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { *unsafe { Box::from_raw(item.take_inner()) } }); };
1809 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.channels = local_val;
1811 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1814 pub extern "C" fn PhantomRouteHints_get_phantom_scid(this_ptr: &PhantomRouteHints) -> u64 {
1815 let mut inner_val = &mut this_ptr.get_native_mut_ref().phantom_scid;
1818 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1821 pub extern "C" fn PhantomRouteHints_set_phantom_scid(this_ptr: &mut PhantomRouteHints, mut val: u64) {
1822 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.phantom_scid = val;
1824 /// The pubkey of the real backing node that would ultimately receive the payment.
1826 pub extern "C" fn PhantomRouteHints_get_real_node_pubkey(this_ptr: &PhantomRouteHints) -> crate::c_types::PublicKey {
1827 let mut inner_val = &mut this_ptr.get_native_mut_ref().real_node_pubkey;
1828 crate::c_types::PublicKey::from_rust(&inner_val)
1830 /// The pubkey of the real backing node that would ultimately receive the payment.
1832 pub extern "C" fn PhantomRouteHints_set_real_node_pubkey(this_ptr: &mut PhantomRouteHints, mut val: crate::c_types::PublicKey) {
1833 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.real_node_pubkey = val.into_rust();
1835 /// Constructs a new PhantomRouteHints given each field
1838 pub extern "C" fn PhantomRouteHints_new(mut channels_arg: crate::c_types::derived::CVec_ChannelDetailsZ, mut phantom_scid_arg: u64, mut real_node_pubkey_arg: crate::c_types::PublicKey) -> PhantomRouteHints {
1839 let mut local_channels_arg = Vec::new(); for mut item in channels_arg.into_rust().drain(..) { local_channels_arg.push( { *unsafe { Box::from_raw(item.take_inner()) } }); };
1840 PhantomRouteHints { inner: ObjOps::heap_alloc(nativePhantomRouteHints {
1841 channels: local_channels_arg,
1842 phantom_scid: phantom_scid_arg,
1843 real_node_pubkey: real_node_pubkey_arg.into_rust(),
1844 }), is_owned: true }
1846 impl Clone for PhantomRouteHints {
1847 fn clone(&self) -> Self {
1849 inner: if <*mut nativePhantomRouteHints>::is_null(self.inner) { core::ptr::null_mut() } else {
1850 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
1856 /// Used only if an object of this type is returned as a trait impl by a method
1857 pub(crate) extern "C" fn PhantomRouteHints_clone_void(this_ptr: *const c_void) -> *mut c_void {
1858 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativePhantomRouteHints)).clone() })) as *mut c_void
1861 /// Creates a copy of the PhantomRouteHints
1862 pub extern "C" fn PhantomRouteHints_clone(orig: &PhantomRouteHints) -> PhantomRouteHints {
1865 /// Constructs a new `ChannelManager` to hold several channels and route between them.
1867 /// The current time or latest block header time can be provided as the `current_timestamp`.
1869 /// This is the main \"logic hub\" for all channel-related actions, and implements
1870 /// [`ChannelMessageHandler`].
1872 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1874 /// Users need to notify the new `ChannelManager` when a new block is connected or
1875 /// disconnected using its [`block_connected`] and [`block_disconnected`] methods, starting
1876 /// from after [`params.best_block.block_hash`]. See [`chain::Listen`] and [`chain::Confirm`] for
1879 /// [`block_connected`]: chain::Listen::block_connected
1880 /// [`block_disconnected`]: chain::Listen::block_disconnected
1881 /// [`params.best_block.block_hash`]: chain::BestBlock::block_hash
1884 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 router: crate::lightning::routing::router::Router, mut logger: crate::lightning::util::logger::Logger, mut entropy_source: crate::lightning::sign::EntropySource, mut node_signer: crate::lightning::sign::NodeSigner, mut signer_provider: crate::lightning::sign::SignerProvider, mut config: crate::lightning::util::config::UserConfig, mut params: crate::lightning::ln::channelmanager::ChainParameters, mut current_timestamp: u32) -> crate::lightning::ln::channelmanager::ChannelManager {
1885 let mut ret = lightning::ln::channelmanager::ChannelManager::new(fee_est, chain_monitor, tx_broadcaster, router, logger, entropy_source, node_signer, signer_provider, *unsafe { Box::from_raw(config.take_inner()) }, *unsafe { Box::from_raw(params.take_inner()) }, current_timestamp);
1886 crate::lightning::ln::channelmanager::ChannelManager { inner: ObjOps::heap_alloc(ret), is_owned: true }
1889 /// Gets the current configuration applied to all new channels.
1892 pub extern "C" fn ChannelManager_get_current_default_configuration(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::lightning::util::config::UserConfig {
1893 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_current_default_configuration();
1894 crate::lightning::util::config::UserConfig { inner: unsafe { ObjOps::nonnull_ptr_to_inner((ret as *const lightning::util::config::UserConfig<>) as *mut _) }, is_owned: false }
1897 /// Creates a new outbound channel to the given remote node and with the given value.
1899 /// `user_channel_id` will be provided back as in
1900 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1901 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
1902 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
1903 /// is simply copied to events and otherwise ignored.
1905 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1906 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1908 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be opened due to failing to
1909 /// generate a shutdown scriptpubkey or destination script set by
1910 /// [`SignerProvider::get_shutdown_scriptpubkey`] or [`SignerProvider::get_destination_script`].
1912 /// Note that we do not check if you are currently connected to the given peer. If no
1913 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1914 /// the channel eventually being silently forgotten (dropped on reload).
1916 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1917 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1918 /// [`ChannelDetails::channel_id`] until after
1919 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1920 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1921 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1923 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1924 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1925 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1927 /// Note that override_config (or a relevant inner pointer) may be NULL or all-0s to represent None
1930 pub extern "C" fn ChannelManager_create_channel(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut their_network_key: crate::c_types::PublicKey, mut channel_value_satoshis: u64, mut push_msat: u64, mut user_channel_id: crate::c_types::U128, mut override_config: crate::lightning::util::config::UserConfig) -> crate::c_types::derived::CResult_ThirtyTwoBytesAPIErrorZ {
1931 let mut local_override_config = if override_config.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(override_config.take_inner()) } }) };
1932 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.create_channel(their_network_key.into_rust(), channel_value_satoshis, push_msat, user_channel_id.into(), local_override_config);
1933 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() };
1937 /// Gets the list of open channels, in random order. See [`ChannelDetails`] field documentation for
1938 /// more information.
1941 pub extern "C" fn ChannelManager_list_channels(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::c_types::derived::CVec_ChannelDetailsZ {
1942 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.list_channels();
1943 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::ln::channelmanager::ChannelDetails { inner: ObjOps::heap_alloc(item), is_owned: true } }); };
1947 /// Gets the list of usable channels, in random order. Useful as an argument to
1948 /// [`Router::find_route`] to ensure non-announced channels are used.
1950 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1951 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1955 pub extern "C" fn ChannelManager_list_usable_channels(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::c_types::derived::CVec_ChannelDetailsZ {
1956 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.list_usable_channels();
1957 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::ln::channelmanager::ChannelDetails { inner: ObjOps::heap_alloc(item), is_owned: true } }); };
1961 /// Gets the list of channels we have with a given counterparty, in random order.
1964 pub extern "C" fn ChannelManager_list_channels_with_counterparty(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut counterparty_node_id: crate::c_types::PublicKey) -> crate::c_types::derived::CVec_ChannelDetailsZ {
1965 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.list_channels_with_counterparty(&counterparty_node_id.into_rust());
1966 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::ln::channelmanager::ChannelDetails { inner: ObjOps::heap_alloc(item), is_owned: true } }); };
1970 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
1971 /// successful path, or have unresolved HTLCs.
1973 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
1974 /// result of a crash. If such a payment exists, is not listed here, and an
1975 /// [`Event::PaymentSent`] has not been received, you may consider resending the payment.
1977 /// [`Event::PaymentSent`]: events::Event::PaymentSent
1980 pub extern "C" fn ChannelManager_list_recent_payments(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::c_types::derived::CVec_RecentPaymentDetailsZ {
1981 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.list_recent_payments();
1982 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::ln::channelmanager::RecentPaymentDetails::native_into(item) }); };
1986 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1987 /// will be accepted on the given channel, and after additional timeout/the closing of all
1988 /// pending HTLCs, the channel will be closed on chain.
1990 /// * If we are the channel initiator, we will pay between our [`Background`] and
1991 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1993 /// * If our counterparty is the channel initiator, we will require a channel closing
1994 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1995 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1996 /// counterparty to pay as much fee as they'd like, however.
1998 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2000 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2001 /// generate a shutdown scriptpubkey or destination script set by
2002 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2005 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2006 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2007 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2008 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2011 pub extern "C" fn ChannelManager_close_channel(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, channel_id: *const [u8; 32], mut counterparty_node_id: crate::c_types::PublicKey) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2012 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.close_channel(&::lightning::ln::ChannelId(unsafe { *channel_id }), &counterparty_node_id.into_rust());
2013 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() };
2017 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
2018 /// will be accepted on the given channel, and after additional timeout/the closing of all
2019 /// pending HTLCs, the channel will be closed on chain.
2021 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
2022 /// the channel being closed or not:
2023 /// * If we are the channel initiator, we will pay at least this feerate on the closing
2024 /// transaction. The upper-bound is set by
2025 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
2026 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
2027 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
2028 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
2029 /// will appear on a force-closure transaction, whichever is lower).
2031 /// The `shutdown_script` provided will be used as the `scriptPubKey` for the closing transaction.
2032 /// Will fail if a shutdown script has already been set for this channel by
2033 /// ['ChannelHandshakeConfig::commit_upfront_shutdown_pubkey`]. The given shutdown script must
2034 /// also be compatible with our and the counterparty's features.
2036 /// May generate a [`SendShutdown`] message event on success, which should be relayed.
2038 /// Raises [`APIError::ChannelUnavailable`] if the channel cannot be closed due to failing to
2039 /// generate a shutdown scriptpubkey or destination script set by
2040 /// [`SignerProvider::get_shutdown_scriptpubkey`]. A force-closure may be needed to close the
2043 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
2044 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
2045 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
2046 /// [`SendShutdown`]: crate::events::MessageSendEvent::SendShutdown
2048 /// Note that shutdown_script (or a relevant inner pointer) may be NULL or all-0s to represent None
2051 pub extern "C" fn ChannelManager_close_channel_with_feerate_and_script(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, channel_id: *const [u8; 32], mut counterparty_node_id: crate::c_types::PublicKey, mut target_feerate_sats_per_1000_weight: crate::c_types::derived::COption_u32Z, mut shutdown_script: crate::lightning::ln::script::ShutdownScript) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2052 let mut local_target_feerate_sats_per_1000_weight = if target_feerate_sats_per_1000_weight.is_some() { Some( { target_feerate_sats_per_1000_weight.take() }) } else { None };
2053 let mut local_shutdown_script = if shutdown_script.inner.is_null() { None } else { Some( { *unsafe { Box::from_raw(shutdown_script.take_inner()) } }) };
2054 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.close_channel_with_feerate_and_script(&::lightning::ln::ChannelId(unsafe { *channel_id }), &counterparty_node_id.into_rust(), local_target_feerate_sats_per_1000_weight, local_shutdown_script);
2055 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() };
2059 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2060 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2061 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2065 pub extern "C" fn ChannelManager_force_close_broadcasting_latest_txn(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, channel_id: *const [u8; 32], mut counterparty_node_id: crate::c_types::PublicKey) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2066 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.force_close_broadcasting_latest_txn(&::lightning::ln::ChannelId(unsafe { *channel_id }), &counterparty_node_id.into_rust());
2067 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() };
2071 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2072 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2073 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2075 /// You can always get the latest local transaction(s) to broadcast from
2076 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2079 pub extern "C" fn ChannelManager_force_close_without_broadcasting_txn(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, channel_id: *const [u8; 32], mut counterparty_node_id: crate::c_types::PublicKey) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2080 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.force_close_without_broadcasting_txn(&::lightning::ln::ChannelId(unsafe { *channel_id }), &counterparty_node_id.into_rust());
2081 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() };
2085 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2086 /// for each to the chain and rejecting new HTLCs on each.
2088 pub extern "C" fn ChannelManager_force_close_all_channels_broadcasting_latest_txn(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) {
2089 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.force_close_all_channels_broadcasting_latest_txn()
2092 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2093 /// local transaction(s).
2095 pub extern "C" fn ChannelManager_force_close_all_channels_without_broadcasting_txn(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) {
2096 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.force_close_all_channels_without_broadcasting_txn()
2099 /// Sends a payment along a given route.
2101 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
2102 /// fields for more info.
2104 /// May generate [`UpdateHTLCs`] message(s) event on success, which should be relayed (e.g. via
2105 /// [`PeerManager::process_events`]).
2107 /// # Avoiding Duplicate Payments
2109 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2110 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
2111 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2112 /// [`Event::PaymentSent`] or [`Event::PaymentFailed`]) LDK will not stop you from sending a
2113 /// second payment with the same [`PaymentId`].
2115 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2116 /// tracking of payments, including state to indicate once a payment has completed. Because you
2117 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2118 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2119 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2121 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
2122 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
2123 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
2124 /// [`ChannelManager::list_recent_payments`] for more information.
2126 /// # Possible Error States on [`PaymentSendFailure`]
2128 /// Each path may have a different return value, and [`PaymentSendFailure`] may return a `Vec` with
2129 /// each entry matching the corresponding-index entry in the route paths, see
2130 /// [`PaymentSendFailure`] for more info.
2132 /// In general, a path may raise:
2133 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
2134 /// node public key) is specified.
2135 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available as it has been
2136 /// closed, doesn't exist, or the peer is currently disconnected.
2137 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2138 /// relevant updates.
2140 /// Note that depending on the type of the [`PaymentSendFailure`] the HTLC may have been
2141 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2142 /// different route unless you intend to pay twice!
2144 /// [`RouteHop`]: crate::routing::router::RouteHop
2145 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2146 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2147 /// [`UpdateHTLCs`]: events::MessageSendEvent::UpdateHTLCs
2148 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2149 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
2152 pub extern "C" fn ChannelManager_send_payment_with_route(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, route: &crate::lightning::routing::router::Route, mut payment_hash: crate::c_types::ThirtyTwoBytes, mut recipient_onion: crate::lightning::ln::outbound_payment::RecipientOnionFields, mut payment_id: crate::c_types::ThirtyTwoBytes) -> crate::c_types::derived::CResult_NonePaymentSendFailureZ {
2153 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.send_payment_with_route(route.get_native_ref(), ::lightning::ln::PaymentHash(payment_hash.data), *unsafe { Box::from_raw(recipient_onion.take_inner()) }, ::lightning::ln::channelmanager::PaymentId(payment_id.data));
2154 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::outbound_payment::PaymentSendFailure::native_into(e) }).into() };
2158 /// Similar to [`ChannelManager::send_payment_with_route`], but will automatically find a route based on
2159 /// `route_params` and retry failed payment paths based on `retry_strategy`.
2162 pub extern "C" fn ChannelManager_send_payment(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut payment_hash: crate::c_types::ThirtyTwoBytes, mut recipient_onion: crate::lightning::ln::outbound_payment::RecipientOnionFields, mut payment_id: crate::c_types::ThirtyTwoBytes, mut route_params: crate::lightning::routing::router::RouteParameters, mut retry_strategy: crate::lightning::ln::outbound_payment::Retry) -> crate::c_types::derived::CResult_NoneRetryableSendFailureZ {
2163 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.send_payment(::lightning::ln::PaymentHash(payment_hash.data), *unsafe { Box::from_raw(recipient_onion.take_inner()) }, ::lightning::ln::channelmanager::PaymentId(payment_id.data), *unsafe { Box::from_raw(route_params.take_inner()) }, retry_strategy.into_native());
2164 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::outbound_payment::RetryableSendFailure::native_into(e) }).into() };
2168 /// Signals that no further attempts for the given payment should occur. Useful if you have a
2169 /// pending outbound payment with retries remaining, but wish to stop retrying the payment before
2170 /// retries are exhausted.
2172 /// # Event Generation
2174 /// If no [`Event::PaymentFailed`] event had been generated before, one will be generated as soon
2175 /// as there are no remaining pending HTLCs for this payment.
2177 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2178 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2179 /// determine the ultimate status of a payment.
2181 /// # Restart Behavior
2183 /// If an [`Event::PaymentFailed`] is generated and we restart without first persisting the
2184 /// [`ChannelManager`], another [`Event::PaymentFailed`] may be generated.
2186 pub extern "C" fn ChannelManager_abandon_payment(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut payment_id: crate::c_types::ThirtyTwoBytes) {
2187 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.abandon_payment(::lightning::ln::channelmanager::PaymentId(payment_id.data))
2190 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2191 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2192 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2193 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2194 /// never reach the recipient.
2196 /// See [`send_payment`] documentation for more details on the return value of this function
2197 /// and idempotency guarantees provided by the [`PaymentId`] key.
2199 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2200 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2202 /// [`send_payment`]: Self::send_payment
2205 pub extern "C" fn ChannelManager_send_spontaneous_payment(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, route: &crate::lightning::routing::router::Route, mut payment_preimage: crate::c_types::derived::COption_ThirtyTwoBytesZ, mut recipient_onion: crate::lightning::ln::outbound_payment::RecipientOnionFields, mut payment_id: crate::c_types::ThirtyTwoBytes) -> crate::c_types::derived::CResult_ThirtyTwoBytesPaymentSendFailureZ {
2206 let mut local_payment_preimage = { /*payment_preimage*/ let payment_preimage_opt = payment_preimage; if payment_preimage_opt.is_none() { None } else { Some({ { ::lightning::ln::PaymentPreimage({ payment_preimage_opt.take() }.data) }})} };
2207 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.send_spontaneous_payment(route.get_native_ref(), local_payment_preimage, *unsafe { Box::from_raw(recipient_onion.take_inner()) }, ::lightning::ln::channelmanager::PaymentId(payment_id.data));
2208 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::ln::outbound_payment::PaymentSendFailure::native_into(e) }).into() };
2212 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
2213 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
2215 /// See [`PaymentParameters::for_keysend`] for help in constructing `route_params` for spontaneous
2218 /// [`PaymentParameters::for_keysend`]: crate::routing::router::PaymentParameters::for_keysend
2221 pub extern "C" fn ChannelManager_send_spontaneous_payment_with_retry(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut payment_preimage: crate::c_types::derived::COption_ThirtyTwoBytesZ, mut recipient_onion: crate::lightning::ln::outbound_payment::RecipientOnionFields, mut payment_id: crate::c_types::ThirtyTwoBytes, mut route_params: crate::lightning::routing::router::RouteParameters, mut retry_strategy: crate::lightning::ln::outbound_payment::Retry) -> crate::c_types::derived::CResult_ThirtyTwoBytesRetryableSendFailureZ {
2222 let mut local_payment_preimage = { /*payment_preimage*/ let payment_preimage_opt = payment_preimage; if payment_preimage_opt.is_none() { None } else { Some({ { ::lightning::ln::PaymentPreimage({ payment_preimage_opt.take() }.data) }})} };
2223 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.send_spontaneous_payment_with_retry(local_payment_preimage, *unsafe { Box::from_raw(recipient_onion.take_inner()) }, ::lightning::ln::channelmanager::PaymentId(payment_id.data), *unsafe { Box::from_raw(route_params.take_inner()) }, retry_strategy.into_native());
2224 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::ln::outbound_payment::RetryableSendFailure::native_into(e) }).into() };
2228 /// Send a payment that is probing the given route for liquidity. We calculate the
2229 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2230 /// us to easily discern them from real payments.
2233 pub extern "C" fn ChannelManager_send_probe(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut path: crate::lightning::routing::router::Path) -> crate::c_types::derived::CResult_C2Tuple_ThirtyTwoBytesThirtyTwoBytesZPaymentSendFailureZ {
2234 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.send_probe(*unsafe { Box::from_raw(path.take_inner()) });
2235 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = o; let mut local_ret_0 = (crate::c_types::ThirtyTwoBytes { data: orig_ret_0_0.0 }, crate::c_types::ThirtyTwoBytes { data: orig_ret_0_1.0 }).into(); local_ret_0 }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::outbound_payment::PaymentSendFailure::native_into(e) }).into() };
2239 /// Sends payment probes over all paths of a route that would be used to pay the given
2240 /// amount to the given `node_id`.
2242 /// See [`ChannelManager::send_preflight_probes`] for more information.
2245 pub extern "C" fn ChannelManager_send_spontaneous_preflight_probes(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut node_id: crate::c_types::PublicKey, mut amount_msat: u64, mut final_cltv_expiry_delta: u32, mut liquidity_limit_multiplier: crate::c_types::derived::COption_u64Z) -> crate::c_types::derived::CResult_CVec_C2Tuple_ThirtyTwoBytesThirtyTwoBytesZZProbeSendFailureZ {
2246 let mut local_liquidity_limit_multiplier = if liquidity_limit_multiplier.is_some() { Some( { liquidity_limit_multiplier.take() }) } else { None };
2247 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.send_spontaneous_preflight_probes(node_id.into_rust(), amount_msat, final_cltv_expiry_delta, local_liquidity_limit_multiplier);
2248 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { let mut local_ret_0 = Vec::new(); for mut item in o.drain(..) { local_ret_0.push( { let (mut orig_ret_0_0_0, mut orig_ret_0_0_1) = item; let mut local_ret_0_0 = (crate::c_types::ThirtyTwoBytes { data: orig_ret_0_0_0.0 }, crate::c_types::ThirtyTwoBytes { data: orig_ret_0_0_1.0 }).into(); local_ret_0_0 }); }; local_ret_0.into() }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::outbound_payment::ProbeSendFailure::native_into(e) }).into() };
2252 /// Sends payment probes over all paths of a route that would be used to pay a route found
2253 /// according to the given [`RouteParameters`].
2255 /// This may be used to send \"pre-flight\" probes, i.e., to train our scorer before conducting
2256 /// the actual payment. Note this is only useful if there likely is sufficient time for the
2257 /// probe to settle before sending out the actual payment, e.g., when waiting for user
2258 /// confirmation in a wallet UI.
2260 /// Otherwise, there is a chance the probe could take up some liquidity needed to complete the
2261 /// actual payment. Users should therefore be cautious and might avoid sending probes if
2262 /// liquidity is scarce and/or they don't expect the probe to return before they send the
2263 /// payment. To mitigate this issue, channels with available liquidity less than the required
2264 /// amount times the given `liquidity_limit_multiplier` won't be used to send pre-flight
2265 /// probes. If `None` is given as `liquidity_limit_multiplier`, it defaults to `3`.
2268 pub extern "C" fn ChannelManager_send_preflight_probes(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut route_params: crate::lightning::routing::router::RouteParameters, mut liquidity_limit_multiplier: crate::c_types::derived::COption_u64Z) -> crate::c_types::derived::CResult_CVec_C2Tuple_ThirtyTwoBytesThirtyTwoBytesZZProbeSendFailureZ {
2269 let mut local_liquidity_limit_multiplier = if liquidity_limit_multiplier.is_some() { Some( { liquidity_limit_multiplier.take() }) } else { None };
2270 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.send_preflight_probes(*unsafe { Box::from_raw(route_params.take_inner()) }, local_liquidity_limit_multiplier);
2271 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { let mut local_ret_0 = Vec::new(); for mut item in o.drain(..) { local_ret_0.push( { let (mut orig_ret_0_0_0, mut orig_ret_0_0_1) = item; let mut local_ret_0_0 = (crate::c_types::ThirtyTwoBytes { data: orig_ret_0_0_0.0 }, crate::c_types::ThirtyTwoBytes { data: orig_ret_0_0_1.0 }).into(); local_ret_0_0 }); }; local_ret_0.into() }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::outbound_payment::ProbeSendFailure::native_into(e) }).into() };
2275 /// Call this upon creation of a funding transaction for the given channel.
2277 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2278 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2280 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2281 /// across the p2p network.
2283 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2284 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2286 /// May panic if the output found in the funding transaction is duplicative with some other
2287 /// channel (note that this should be trivially prevented by using unique funding transaction
2288 /// keys per-channel).
2290 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2291 /// counterparty's signature the funding transaction will automatically be broadcast via the
2292 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2294 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2295 /// not currently support replacing a funding transaction on an existing channel. Instead,
2296 /// create a new channel with a conflicting funding transaction.
2298 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2299 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2300 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2301 /// for more details.
2303 /// [`Event::FundingGenerationReady`]: crate::events::Event::FundingGenerationReady
2304 /// [`Event::ChannelClosed`]: crate::events::Event::ChannelClosed
2307 pub extern "C" fn ChannelManager_funding_transaction_generated(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, temporary_channel_id: *const [u8; 32], mut counterparty_node_id: crate::c_types::PublicKey, mut funding_transaction: crate::c_types::Transaction) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2308 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.funding_transaction_generated(&::lightning::ln::ChannelId(unsafe { *temporary_channel_id }), &counterparty_node_id.into_rust(), funding_transaction.into_bitcoin());
2309 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() };
2313 /// Call this upon creation of a batch funding transaction for the given channels.
2315 /// Return values are identical to [`Self::funding_transaction_generated`], respective to
2316 /// each individual channel and transaction output.
2318 /// Do NOT broadcast the funding transaction yourself. This batch funding transcaction
2319 /// will only be broadcast when we have safely received and persisted the counterparty's
2320 /// signature for each channel.
2322 /// If there is an error, all channels in the batch are to be considered closed.
2325 pub extern "C" fn ChannelManager_batch_funding_transaction_generated(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut temporary_channels: crate::c_types::derived::CVec_C2Tuple_ThirtyTwoBytesPublicKeyZZ, mut funding_transaction: crate::c_types::Transaction) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2326 let mut local_temporary_channels = Vec::new(); for mut item in temporary_channels.into_rust().drain(..) { local_temporary_channels.push( { let (mut orig_temporary_channels_0_0, mut orig_temporary_channels_0_1) = item.to_rust(); let mut local_temporary_channels_0 = (::lightning::ln::ChannelId(orig_temporary_channels_0_0.data), orig_temporary_channels_0_1.into_rust()); local_temporary_channels_0 }); };
2327 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.batch_funding_transaction_generated(&local_temporary_channels.iter().map(|(a, b)| (a, b)).collect::<Vec<_>>()[..], funding_transaction.into_bitcoin());
2328 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() };
2332 /// Atomically applies partial updates to the [`ChannelConfig`] of the given channels.
2334 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2335 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2336 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2337 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2339 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2340 /// `counterparty_node_id` is provided.
2342 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2343 /// below [`MIN_CLTV_EXPIRY_DELTA`].
2345 /// If an error is returned, none of the updates should be considered applied.
2347 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
2348 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
2349 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
2350 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
2351 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2352 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
2353 /// [`APIMisuseError`]: APIError::APIMisuseError
2356 pub extern "C" fn ChannelManager_update_partial_channel_config(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut counterparty_node_id: crate::c_types::PublicKey, mut channel_ids: crate::c_types::derived::CVec_ThirtyTwoBytesZ, config_update: &crate::lightning::util::config::ChannelConfigUpdate) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2357 let mut local_channel_ids = Vec::new(); for mut item in channel_ids.into_rust().drain(..) { local_channel_ids.push( { ::lightning::ln::ChannelId(item.data) }); };
2358 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.update_partial_channel_config(&counterparty_node_id.into_rust(), local_channel_ids, config_update.get_native_ref());
2359 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() };
2363 /// Atomically updates the [`ChannelConfig`] for the given channels.
2365 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2366 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2367 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2368 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2370 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2371 /// `counterparty_node_id` is provided.
2373 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2374 /// below [`MIN_CLTV_EXPIRY_DELTA`].
2376 /// If an error is returned, none of the updates should be considered applied.
2378 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
2379 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
2380 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
2381 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
2382 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2383 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
2384 /// [`APIMisuseError`]: APIError::APIMisuseError
2387 pub extern "C" fn ChannelManager_update_channel_config(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut counterparty_node_id: crate::c_types::PublicKey, mut channel_ids: crate::c_types::derived::CVec_ThirtyTwoBytesZ, config: &crate::lightning::util::config::ChannelConfig) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2388 let mut local_channel_ids = Vec::new(); for mut item in channel_ids.into_rust().drain(..) { local_channel_ids.push( { ::lightning::ln::ChannelId(item.data) }); };
2389 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.update_channel_config(&counterparty_node_id.into_rust(), local_channel_ids, config.get_native_ref());
2390 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() };
2394 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
2395 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
2397 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
2398 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
2400 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
2401 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
2402 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
2403 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
2404 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
2406 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
2407 /// you from forwarding more than you received. See
2408 /// [`HTLCIntercepted::expected_outbound_amount_msat`] for more on forwarding a different amount
2411 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2414 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
2415 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2416 /// [`HTLCIntercepted::expected_outbound_amount_msat`]: events::Event::HTLCIntercepted::expected_outbound_amount_msat
2419 pub extern "C" fn ChannelManager_forward_intercepted_htlc(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut intercept_id: crate::c_types::ThirtyTwoBytes, next_hop_channel_id: *const [u8; 32], mut next_node_id: crate::c_types::PublicKey, mut amt_to_forward_msat: u64) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2420 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.forward_intercepted_htlc(::lightning::ln::channelmanager::InterceptId(intercept_id.data), &::lightning::ln::ChannelId(unsafe { *next_hop_channel_id }), next_node_id.into_rust(), amt_to_forward_msat);
2421 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() };
2425 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
2426 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
2428 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2431 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2434 pub extern "C" fn ChannelManager_fail_intercepted_htlc(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut intercept_id: crate::c_types::ThirtyTwoBytes) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2435 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.fail_intercepted_htlc(::lightning::ln::channelmanager::InterceptId(intercept_id.data));
2436 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() };
2440 /// Processes HTLCs which are pending waiting on random forward delay.
2442 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2443 /// Will likely generate further events.
2445 pub extern "C" fn ChannelManager_process_pending_htlc_forwards(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) {
2446 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.process_pending_htlc_forwards()
2449 /// Performs actions which should happen on startup and roughly once per minute thereafter.
2451 /// This currently includes:
2452 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
2453 /// * Broadcasting [`ChannelUpdate`] messages if we've been disconnected from our peer for more
2454 /// than a minute, informing the network that they should no longer attempt to route over
2456 /// * Expiring a channel's previous [`ChannelConfig`] if necessary to only allow forwarding HTLCs
2457 /// with the current [`ChannelConfig`].
2458 /// * Removing peers which have disconnected but and no longer have any channels.
2459 /// * Force-closing and removing channels which have not completed establishment in a timely manner.
2461 /// Note that this may cause reentrancy through [`chain::Watch::update_channel`] calls or feerate
2462 /// estimate fetches.
2464 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2465 /// [`ChannelConfig`]: crate::util::config::ChannelConfig
2467 pub extern "C" fn ChannelManager_timer_tick_occurred(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) {
2468 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.timer_tick_occurred()
2471 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
2472 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
2473 /// along the path (including in our own channel on which we received it).
2475 /// Note that in some cases around unclean shutdown, it is possible the payment may have
2476 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
2477 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
2478 /// may have already been failed automatically by LDK if it was nearing its expiration time.
2480 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
2481 /// [`ChannelManager::claim_funds`]), you should still monitor for
2482 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
2483 /// startup during which time claims that were in-progress at shutdown may be replayed.
2485 pub extern "C" fn ChannelManager_fail_htlc_backwards(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, payment_hash: *const [u8; 32]) {
2486 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.fail_htlc_backwards(&::lightning::ln::PaymentHash(unsafe { *payment_hash }))
2489 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
2490 /// reason for the failure.
2492 /// See [`FailureCode`] for valid failure codes.
2494 pub extern "C" fn ChannelManager_fail_htlc_backwards_with_reason(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, payment_hash: *const [u8; 32], mut failure_code: crate::lightning::ln::channelmanager::FailureCode) {
2495 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.fail_htlc_backwards_with_reason(&::lightning::ln::PaymentHash(unsafe { *payment_hash }), failure_code.into_native())
2498 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
2499 /// [`MessageSendEvent`]s needed to claim the payment.
2501 /// This method is guaranteed to ensure the payment has been claimed but only if the current
2502 /// height is strictly below [`Event::PaymentClaimable::claim_deadline`]. To avoid race
2503 /// conditions, you should wait for an [`Event::PaymentClaimed`] before considering the payment
2504 /// successful. It will generally be available in the next [`process_pending_events`] call.
2506 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
2507 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
2508 /// event matches your expectation. If you fail to do so and call this method, you may provide
2509 /// the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
2511 /// This function will fail the payment if it has custom TLVs with even type numbers, as we
2512 /// will assume they are unknown. If you intend to accept even custom TLVs, you should use
2513 /// [`claim_funds_with_known_custom_tlvs`].
2515 /// [`Event::PaymentClaimable`]: crate::events::Event::PaymentClaimable
2516 /// [`Event::PaymentClaimable::claim_deadline`]: crate::events::Event::PaymentClaimable::claim_deadline
2517 /// [`Event::PaymentClaimed`]: crate::events::Event::PaymentClaimed
2518 /// [`process_pending_events`]: EventsProvider::process_pending_events
2519 /// [`create_inbound_payment`]: Self::create_inbound_payment
2520 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
2521 /// [`claim_funds_with_known_custom_tlvs`]: Self::claim_funds_with_known_custom_tlvs
2523 pub extern "C" fn ChannelManager_claim_funds(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut payment_preimage: crate::c_types::ThirtyTwoBytes) {
2524 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.claim_funds(::lightning::ln::PaymentPreimage(payment_preimage.data))
2527 /// This is a variant of [`claim_funds`] that allows accepting a payment with custom TLVs with
2528 /// even type numbers.
2532 /// You MUST check you've understood all even TLVs before using this to
2533 /// claim, otherwise you may unintentionally agree to some protocol you do not understand.
2535 /// [`claim_funds`]: Self::claim_funds
2537 pub extern "C" fn ChannelManager_claim_funds_with_known_custom_tlvs(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut payment_preimage: crate::c_types::ThirtyTwoBytes) {
2538 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.claim_funds_with_known_custom_tlvs(::lightning::ln::PaymentPreimage(payment_preimage.data))
2541 /// Gets the node_id held by this ChannelManager
2544 pub extern "C" fn ChannelManager_get_our_node_id(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::c_types::PublicKey {
2545 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_our_node_id();
2546 crate::c_types::PublicKey::from_rust(&ret)
2549 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
2551 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
2552 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
2555 /// The `user_channel_id` parameter will be provided back in
2556 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
2557 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
2559 /// Note that this method will return an error and reject the channel, if it requires support
2560 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
2561 /// used to accept such channels.
2563 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
2564 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
2567 pub extern "C" fn ChannelManager_accept_inbound_channel(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, temporary_channel_id: *const [u8; 32], mut counterparty_node_id: crate::c_types::PublicKey, mut user_channel_id: crate::c_types::U128) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2568 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.accept_inbound_channel(&::lightning::ln::ChannelId(unsafe { *temporary_channel_id }), &counterparty_node_id.into_rust(), user_channel_id.into());
2569 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() };
2573 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
2574 /// it as confirmed immediately.
2576 /// The `user_channel_id` parameter will be provided back in
2577 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
2578 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
2580 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
2581 /// and (if the counterparty agrees), enables forwarding of payments immediately.
2583 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
2584 /// transaction and blindly assumes that it will eventually confirm.
2586 /// If it does not confirm before we decide to close the channel, or if the funding transaction
2587 /// does not pay to the correct script the correct amount, *you will lose funds*.
2589 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
2590 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
2593 pub extern "C" fn ChannelManager_accept_inbound_channel_from_trusted_peer_0conf(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, temporary_channel_id: *const [u8; 32], mut counterparty_node_id: crate::c_types::PublicKey, mut user_channel_id: crate::c_types::U128) -> crate::c_types::derived::CResult_NoneAPIErrorZ {
2594 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.accept_inbound_channel_from_trusted_peer_0conf(&::lightning::ln::ChannelId(unsafe { *temporary_channel_id }), &counterparty_node_id.into_rust(), user_channel_id.into());
2595 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() };
2599 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
2602 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
2603 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
2605 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
2606 /// will have the [`PaymentClaimable::purpose`] be [`PaymentPurpose::InvoicePayment`] with
2607 /// its [`PaymentPurpose::InvoicePayment::payment_preimage`] field filled in. That should then be
2608 /// passed directly to [`claim_funds`].
2610 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
2612 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
2613 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
2617 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
2618 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
2620 /// Errors if `min_value_msat` is greater than total bitcoin supply.
2622 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
2623 /// on versions of LDK prior to 0.0.114.
2625 /// [`claim_funds`]: Self::claim_funds
2626 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
2627 /// [`PaymentClaimable::purpose`]: events::Event::PaymentClaimable::purpose
2628 /// [`PaymentPurpose::InvoicePayment`]: events::PaymentPurpose::InvoicePayment
2629 /// [`PaymentPurpose::InvoicePayment::payment_preimage`]: events::PaymentPurpose::InvoicePayment::payment_preimage
2630 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
2633 pub extern "C" fn ChannelManager_create_inbound_payment(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut min_value_msat: crate::c_types::derived::COption_u64Z, mut invoice_expiry_delta_secs: u32, mut min_final_cltv_expiry_delta: crate::c_types::derived::COption_u16Z) -> crate::c_types::derived::CResult_C2Tuple_ThirtyTwoBytesThirtyTwoBytesZNoneZ {
2634 let mut local_min_value_msat = if min_value_msat.is_some() { Some( { min_value_msat.take() }) } else { None };
2635 let mut local_min_final_cltv_expiry_delta = if min_final_cltv_expiry_delta.is_some() { Some( { min_final_cltv_expiry_delta.take() }) } else { None };
2636 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.create_inbound_payment(local_min_value_msat, invoice_expiry_delta_secs, local_min_final_cltv_expiry_delta);
2637 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { let (mut orig_ret_0_0, mut orig_ret_0_1) = o; let mut local_ret_0 = (crate::c_types::ThirtyTwoBytes { data: orig_ret_0_0.0 }, crate::c_types::ThirtyTwoBytes { data: orig_ret_0_1.0 }).into(); local_ret_0 }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
2641 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
2642 /// stored external to LDK.
2644 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
2645 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
2646 /// the `min_value_msat` provided here, if one is provided.
2648 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
2649 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
2652 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
2653 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
2654 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
2655 /// sender \"proof-of-payment\" unless they have paid the required amount.
2657 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
2658 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
2659 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
2660 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
2661 /// invoices when no timeout is set.
2663 /// Note that we use block header time to time-out pending inbound payments (with some margin
2664 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
2665 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
2666 /// If you need exact expiry semantics, you should enforce them upon receipt of
2667 /// [`PaymentClaimable`].
2669 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
2670 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
2672 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
2673 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
2677 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
2678 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
2680 /// Errors if `min_value_msat` is greater than total bitcoin supply.
2682 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
2683 /// on versions of LDK prior to 0.0.114.
2685 /// [`create_inbound_payment`]: Self::create_inbound_payment
2686 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
2689 pub extern "C" fn ChannelManager_create_inbound_payment_for_hash(this_arg: &crate::lightning::ln::channelmanager::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 min_final_cltv_expiry: crate::c_types::derived::COption_u16Z) -> crate::c_types::derived::CResult_ThirtyTwoBytesNoneZ {
2690 let mut local_min_value_msat = if min_value_msat.is_some() { Some( { min_value_msat.take() }) } else { None };
2691 let mut local_min_final_cltv_expiry = if min_final_cltv_expiry.is_some() { Some( { min_final_cltv_expiry.take() }) } else { None };
2692 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.create_inbound_payment_for_hash(::lightning::ln::PaymentHash(payment_hash.data), local_min_value_msat, invoice_expiry_delta_secs, local_min_final_cltv_expiry);
2693 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( { () /*e*/ }).into() };
2697 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
2698 /// previously returned from [`create_inbound_payment`].
2700 /// [`create_inbound_payment`]: Self::create_inbound_payment
2703 pub extern "C" fn ChannelManager_get_payment_preimage(this_arg: &crate::lightning::ln::channelmanager::ChannelManager, mut payment_hash: crate::c_types::ThirtyTwoBytes, mut payment_secret: crate::c_types::ThirtyTwoBytes) -> crate::c_types::derived::CResult_ThirtyTwoBytesAPIErrorZ {
2704 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_payment_preimage(::lightning::ln::PaymentHash(payment_hash.data), ::lightning::ln::PaymentSecret(payment_secret.data));
2705 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() };
2709 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
2710 /// are used when constructing the phantom invoice's route hints.
2712 /// [phantom node payments]: crate::sign::PhantomKeysManager
2715 pub extern "C" fn ChannelManager_get_phantom_scid(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> u64 {
2716 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_phantom_scid();
2720 /// Gets route hints for use in receiving [phantom node payments].
2722 /// [phantom node payments]: crate::sign::PhantomKeysManager
2725 pub extern "C" fn ChannelManager_get_phantom_route_hints(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::lightning::ln::channelmanager::PhantomRouteHints {
2726 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_phantom_route_hints();
2727 crate::lightning::ln::channelmanager::PhantomRouteHints { inner: ObjOps::heap_alloc(ret), is_owned: true }
2730 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
2731 /// used when constructing the route hints for HTLCs intended to be intercepted. See
2732 /// [`ChannelManager::forward_intercepted_htlc`].
2734 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
2735 /// times to get a unique scid.
2738 pub extern "C" fn ChannelManager_get_intercept_scid(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> u64 {
2739 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_intercept_scid();
2743 /// Gets inflight HTLC information by processing pending outbound payments that are in
2744 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
2747 pub extern "C" fn ChannelManager_compute_inflight_htlcs(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::lightning::routing::router::InFlightHtlcs {
2748 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.compute_inflight_htlcs();
2749 crate::lightning::routing::router::InFlightHtlcs { inner: ObjOps::heap_alloc(ret), is_owned: true }
2752 impl From<nativeChannelManager> for crate::lightning::events::MessageSendEventsProvider {
2753 fn from(obj: nativeChannelManager) -> Self {
2754 let mut rust_obj = ChannelManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
2755 let mut ret = ChannelManager_as_MessageSendEventsProvider(&rust_obj);
2756 // 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
2757 rust_obj.inner = core::ptr::null_mut();
2758 ret.free = Some(ChannelManager_free_void);
2762 /// Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
2763 /// This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
2765 pub extern "C" fn ChannelManager_as_MessageSendEventsProvider(this_arg: &ChannelManager) -> crate::lightning::events::MessageSendEventsProvider {
2766 crate::lightning::events::MessageSendEventsProvider {
2767 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
2769 get_and_clear_pending_msg_events: ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events,
2774 extern "C" fn ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events(this_arg: *const c_void) -> crate::c_types::derived::CVec_MessageSendEventZ {
2775 let mut ret = <nativeChannelManager as lightning::events::MessageSendEventsProvider<>>::get_and_clear_pending_msg_events(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
2776 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::events::MessageSendEvent::native_into(item) }); };
2780 impl From<nativeChannelManager> for crate::lightning::events::EventsProvider {
2781 fn from(obj: nativeChannelManager) -> Self {
2782 let mut rust_obj = ChannelManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
2783 let mut ret = ChannelManager_as_EventsProvider(&rust_obj);
2784 // 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
2785 rust_obj.inner = core::ptr::null_mut();
2786 ret.free = Some(ChannelManager_free_void);
2790 /// Constructs a new EventsProvider which calls the relevant methods on this_arg.
2791 /// This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
2793 pub extern "C" fn ChannelManager_as_EventsProvider(this_arg: &ChannelManager) -> crate::lightning::events::EventsProvider {
2794 crate::lightning::events::EventsProvider {
2795 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
2797 process_pending_events: ChannelManager_EventsProvider_process_pending_events,
2801 extern "C" fn ChannelManager_EventsProvider_process_pending_events(this_arg: *const c_void, mut handler: crate::lightning::events::EventHandler) {
2802 <nativeChannelManager as lightning::events::EventsProvider<>>::process_pending_events(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, handler)
2805 impl From<nativeChannelManager> for crate::lightning::chain::Listen {
2806 fn from(obj: nativeChannelManager) -> Self {
2807 let mut rust_obj = ChannelManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
2808 let mut ret = ChannelManager_as_Listen(&rust_obj);
2809 // 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
2810 rust_obj.inner = core::ptr::null_mut();
2811 ret.free = Some(ChannelManager_free_void);
2815 /// Constructs a new Listen which calls the relevant methods on this_arg.
2816 /// This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
2818 pub extern "C" fn ChannelManager_as_Listen(this_arg: &ChannelManager) -> crate::lightning::chain::Listen {
2819 crate::lightning::chain::Listen {
2820 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
2822 filtered_block_connected: ChannelManager_Listen_filtered_block_connected,
2823 block_connected: ChannelManager_Listen_block_connected,
2824 block_disconnected: ChannelManager_Listen_block_disconnected,
2828 extern "C" fn ChannelManager_Listen_filtered_block_connected(this_arg: *const c_void, header: *const [u8; 80], mut txdata: crate::c_types::derived::CVec_C2Tuple_usizeTransactionZZ, mut height: u32) {
2829 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 }); };
2830 <nativeChannelManager as lightning::chain::Listen<>>::filtered_block_connected(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)
2832 extern "C" fn ChannelManager_Listen_block_connected(this_arg: *const c_void, mut block: crate::c_types::u8slice, mut height: u32) {
2833 <nativeChannelManager as lightning::chain::Listen<>>::block_connected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(block.to_slice()).unwrap(), height)
2835 extern "C" fn ChannelManager_Listen_block_disconnected(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
2836 <nativeChannelManager as lightning::chain::Listen<>>::block_disconnected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
2839 impl From<nativeChannelManager> for crate::lightning::chain::Confirm {
2840 fn from(obj: nativeChannelManager) -> Self {
2841 let mut rust_obj = ChannelManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
2842 let mut ret = ChannelManager_as_Confirm(&rust_obj);
2843 // 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
2844 rust_obj.inner = core::ptr::null_mut();
2845 ret.free = Some(ChannelManager_free_void);
2849 /// Constructs a new Confirm which calls the relevant methods on this_arg.
2850 /// This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
2852 pub extern "C" fn ChannelManager_as_Confirm(this_arg: &ChannelManager) -> crate::lightning::chain::Confirm {
2853 crate::lightning::chain::Confirm {
2854 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
2856 transactions_confirmed: ChannelManager_Confirm_transactions_confirmed,
2857 transaction_unconfirmed: ChannelManager_Confirm_transaction_unconfirmed,
2858 best_block_updated: ChannelManager_Confirm_best_block_updated,
2859 get_relevant_txids: ChannelManager_Confirm_get_relevant_txids,
2863 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) {
2864 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 }); };
2865 <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)
2867 extern "C" fn ChannelManager_Confirm_transaction_unconfirmed(this_arg: *const c_void, txid: *const [u8; 32]) {
2868 <nativeChannelManager as lightning::chain::Confirm<>>::transaction_unconfirmed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::hash_types::Txid::from_slice(&unsafe { &*txid }[..]).unwrap())
2870 extern "C" fn ChannelManager_Confirm_best_block_updated(this_arg: *const c_void, header: *const [u8; 80], mut height: u32) {
2871 <nativeChannelManager as lightning::chain::Confirm<>>::best_block_updated(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height)
2874 extern "C" fn ChannelManager_Confirm_get_relevant_txids(this_arg: *const c_void) -> crate::c_types::derived::CVec_C2Tuple_ThirtyTwoBytesCOption_ThirtyTwoBytesZZZ {
2875 let mut ret = <nativeChannelManager as lightning::chain::Confirm<>>::get_relevant_txids(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
2876 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { let (mut orig_ret_0_0, mut orig_ret_0_1) = item; let mut local_orig_ret_0_1 = if orig_ret_0_1.is_none() { crate::c_types::derived::COption_ThirtyTwoBytesZ::None } else { crate::c_types::derived::COption_ThirtyTwoBytesZ::Some( { crate::c_types::ThirtyTwoBytes { data: orig_ret_0_1.unwrap().into_inner() } }) }; let mut local_ret_0 = (crate::c_types::ThirtyTwoBytes { data: orig_ret_0_0.into_inner() }, local_orig_ret_0_1).into(); local_ret_0 }); };
2880 /// Gets a [`Future`] that completes when this [`ChannelManager`] may need to be persisted or
2881 /// may have events that need processing.
2883 /// In order to check if this [`ChannelManager`] needs persisting, call
2884 /// [`Self::get_and_clear_needs_persistence`].
2886 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
2887 /// [`ChannelManager`] and should instead register actions to be taken later.
2890 pub extern "C" fn ChannelManager_get_event_or_persistence_needed_future(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::lightning::util::wakers::Future {
2891 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_event_or_persistence_needed_future();
2892 crate::lightning::util::wakers::Future { inner: ObjOps::heap_alloc(ret), is_owned: true }
2895 /// Returns true if this [`ChannelManager`] needs to be persisted.
2898 pub extern "C" fn ChannelManager_get_and_clear_needs_persistence(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> bool {
2899 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_and_clear_needs_persistence();
2903 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
2904 /// [`chain::Confirm`] interfaces.
2907 pub extern "C" fn ChannelManager_current_best_block(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::lightning::chain::BestBlock {
2908 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.current_best_block();
2909 crate::lightning::chain::BestBlock { inner: ObjOps::heap_alloc(ret), is_owned: true }
2912 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
2913 /// [`ChannelManager`].
2916 pub extern "C" fn ChannelManager_node_features(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::lightning::ln::features::NodeFeatures {
2917 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.node_features();
2918 crate::lightning::ln::features::NodeFeatures { inner: ObjOps::heap_alloc(ret), is_owned: true }
2921 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
2922 /// [`ChannelManager`].
2925 pub extern "C" fn ChannelManager_channel_features(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::lightning::ln::features::ChannelFeatures {
2926 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.channel_features();
2927 crate::lightning::ln::features::ChannelFeatures { inner: ObjOps::heap_alloc(ret), is_owned: true }
2930 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
2931 /// [`ChannelManager`].
2934 pub extern "C" fn ChannelManager_channel_type_features(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::lightning::ln::features::ChannelTypeFeatures {
2935 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.channel_type_features();
2936 crate::lightning::ln::features::ChannelTypeFeatures { inner: ObjOps::heap_alloc(ret), is_owned: true }
2939 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
2940 /// [`ChannelManager`].
2943 pub extern "C" fn ChannelManager_init_features(this_arg: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::lightning::ln::features::InitFeatures {
2944 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.init_features();
2945 crate::lightning::ln::features::InitFeatures { inner: ObjOps::heap_alloc(ret), is_owned: true }
2948 impl From<nativeChannelManager> for crate::lightning::ln::msgs::ChannelMessageHandler {
2949 fn from(obj: nativeChannelManager) -> Self {
2950 let mut rust_obj = ChannelManager { inner: ObjOps::heap_alloc(obj), is_owned: true };
2951 let mut ret = ChannelManager_as_ChannelMessageHandler(&rust_obj);
2952 // 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
2953 rust_obj.inner = core::ptr::null_mut();
2954 ret.free = Some(ChannelManager_free_void);
2958 /// Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
2959 /// This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
2961 pub extern "C" fn ChannelManager_as_ChannelMessageHandler(this_arg: &ChannelManager) -> crate::lightning::ln::msgs::ChannelMessageHandler {
2962 crate::lightning::ln::msgs::ChannelMessageHandler {
2963 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
2965 handle_open_channel: ChannelManager_ChannelMessageHandler_handle_open_channel,
2966 handle_open_channel_v2: ChannelManager_ChannelMessageHandler_handle_open_channel_v2,
2967 handle_accept_channel: ChannelManager_ChannelMessageHandler_handle_accept_channel,
2968 handle_accept_channel_v2: ChannelManager_ChannelMessageHandler_handle_accept_channel_v2,
2969 handle_funding_created: ChannelManager_ChannelMessageHandler_handle_funding_created,
2970 handle_funding_signed: ChannelManager_ChannelMessageHandler_handle_funding_signed,
2971 handle_channel_ready: ChannelManager_ChannelMessageHandler_handle_channel_ready,
2972 handle_shutdown: ChannelManager_ChannelMessageHandler_handle_shutdown,
2973 handle_closing_signed: ChannelManager_ChannelMessageHandler_handle_closing_signed,
2974 handle_tx_add_input: ChannelManager_ChannelMessageHandler_handle_tx_add_input,
2975 handle_tx_add_output: ChannelManager_ChannelMessageHandler_handle_tx_add_output,
2976 handle_tx_remove_input: ChannelManager_ChannelMessageHandler_handle_tx_remove_input,
2977 handle_tx_remove_output: ChannelManager_ChannelMessageHandler_handle_tx_remove_output,
2978 handle_tx_complete: ChannelManager_ChannelMessageHandler_handle_tx_complete,
2979 handle_tx_signatures: ChannelManager_ChannelMessageHandler_handle_tx_signatures,
2980 handle_tx_init_rbf: ChannelManager_ChannelMessageHandler_handle_tx_init_rbf,
2981 handle_tx_ack_rbf: ChannelManager_ChannelMessageHandler_handle_tx_ack_rbf,
2982 handle_tx_abort: ChannelManager_ChannelMessageHandler_handle_tx_abort,
2983 handle_update_add_htlc: ChannelManager_ChannelMessageHandler_handle_update_add_htlc,
2984 handle_update_fulfill_htlc: ChannelManager_ChannelMessageHandler_handle_update_fulfill_htlc,
2985 handle_update_fail_htlc: ChannelManager_ChannelMessageHandler_handle_update_fail_htlc,
2986 handle_update_fail_malformed_htlc: ChannelManager_ChannelMessageHandler_handle_update_fail_malformed_htlc,
2987 handle_commitment_signed: ChannelManager_ChannelMessageHandler_handle_commitment_signed,
2988 handle_revoke_and_ack: ChannelManager_ChannelMessageHandler_handle_revoke_and_ack,
2989 handle_update_fee: ChannelManager_ChannelMessageHandler_handle_update_fee,
2990 handle_announcement_signatures: ChannelManager_ChannelMessageHandler_handle_announcement_signatures,
2991 peer_disconnected: ChannelManager_ChannelMessageHandler_peer_disconnected,
2992 peer_connected: ChannelManager_ChannelMessageHandler_peer_connected,
2993 handle_channel_reestablish: ChannelManager_ChannelMessageHandler_handle_channel_reestablish,
2994 handle_channel_update: ChannelManager_ChannelMessageHandler_handle_channel_update,
2995 handle_error: ChannelManager_ChannelMessageHandler_handle_error,
2996 provided_node_features: ChannelManager_ChannelMessageHandler_provided_node_features,
2997 provided_init_features: ChannelManager_ChannelMessageHandler_provided_init_features,
2998 get_genesis_hashes: ChannelManager_ChannelMessageHandler_get_genesis_hashes,
2999 MessageSendEventsProvider: crate::lightning::events::MessageSendEventsProvider {
3000 this_arg: unsafe { ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void },
3002 get_and_clear_pending_msg_events: ChannelManager_MessageSendEventsProvider_get_and_clear_pending_msg_events,
3007 extern "C" fn ChannelManager_ChannelMessageHandler_handle_open_channel(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::OpenChannel) {
3008 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_open_channel(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3010 extern "C" fn ChannelManager_ChannelMessageHandler_handle_open_channel_v2(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::OpenChannelV2) {
3011 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_open_channel_v2(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3013 extern "C" fn ChannelManager_ChannelMessageHandler_handle_accept_channel(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::AcceptChannel) {
3014 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_accept_channel(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3016 extern "C" fn ChannelManager_ChannelMessageHandler_handle_accept_channel_v2(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::AcceptChannelV2) {
3017 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_accept_channel_v2(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3019 extern "C" fn ChannelManager_ChannelMessageHandler_handle_funding_created(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::FundingCreated) {
3020 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_created(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3022 extern "C" fn ChannelManager_ChannelMessageHandler_handle_funding_signed(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::FundingSigned) {
3023 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_funding_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3025 extern "C" fn ChannelManager_ChannelMessageHandler_handle_channel_ready(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::ChannelReady) {
3026 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_channel_ready(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3028 extern "C" fn ChannelManager_ChannelMessageHandler_handle_shutdown(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::Shutdown) {
3029 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_shutdown(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3031 extern "C" fn ChannelManager_ChannelMessageHandler_handle_closing_signed(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::ClosingSigned) {
3032 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_closing_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3034 extern "C" fn ChannelManager_ChannelMessageHandler_handle_tx_add_input(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::TxAddInput) {
3035 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_tx_add_input(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3037 extern "C" fn ChannelManager_ChannelMessageHandler_handle_tx_add_output(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::TxAddOutput) {
3038 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_tx_add_output(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3040 extern "C" fn ChannelManager_ChannelMessageHandler_handle_tx_remove_input(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::TxRemoveInput) {
3041 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_tx_remove_input(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3043 extern "C" fn ChannelManager_ChannelMessageHandler_handle_tx_remove_output(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::TxRemoveOutput) {
3044 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_tx_remove_output(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3046 extern "C" fn ChannelManager_ChannelMessageHandler_handle_tx_complete(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::TxComplete) {
3047 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_tx_complete(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3049 extern "C" fn ChannelManager_ChannelMessageHandler_handle_tx_signatures(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::TxSignatures) {
3050 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_tx_signatures(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3052 extern "C" fn ChannelManager_ChannelMessageHandler_handle_tx_init_rbf(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::TxInitRbf) {
3053 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_tx_init_rbf(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3055 extern "C" fn ChannelManager_ChannelMessageHandler_handle_tx_ack_rbf(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::TxAckRbf) {
3056 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_tx_ack_rbf(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3058 extern "C" fn ChannelManager_ChannelMessageHandler_handle_tx_abort(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::TxAbort) {
3059 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_tx_abort(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3061 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_add_htlc(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::UpdateAddHTLC) {
3062 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_add_htlc(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3064 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fulfill_htlc(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::UpdateFulfillHTLC) {
3065 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_fulfill_htlc(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3067 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fail_htlc(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::UpdateFailHTLC) {
3068 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_fail_htlc(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3070 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fail_malformed_htlc(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::UpdateFailMalformedHTLC) {
3071 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_fail_malformed_htlc(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3073 extern "C" fn ChannelManager_ChannelMessageHandler_handle_commitment_signed(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::CommitmentSigned) {
3074 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_commitment_signed(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3076 extern "C" fn ChannelManager_ChannelMessageHandler_handle_revoke_and_ack(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::RevokeAndACK) {
3077 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_revoke_and_ack(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3079 extern "C" fn ChannelManager_ChannelMessageHandler_handle_update_fee(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::UpdateFee) {
3080 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_update_fee(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3082 extern "C" fn ChannelManager_ChannelMessageHandler_handle_announcement_signatures(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::AnnouncementSignatures) {
3083 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_announcement_signatures(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3085 extern "C" fn ChannelManager_ChannelMessageHandler_peer_disconnected(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey) {
3086 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::peer_disconnected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust())
3089 extern "C" fn ChannelManager_ChannelMessageHandler_peer_connected(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::Init, mut inbound: bool) -> crate::c_types::derived::CResult_NoneNoneZ {
3090 let mut ret = <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::peer_connected(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref(), inbound);
3091 let mut local_ret = match ret { Ok(mut o) => crate::c_types::CResultTempl::ok( { () /*o*/ }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { () /*e*/ }).into() };
3094 extern "C" fn ChannelManager_ChannelMessageHandler_handle_channel_reestablish(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::ChannelReestablish) {
3095 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_channel_reestablish(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3097 extern "C" fn ChannelManager_ChannelMessageHandler_handle_channel_update(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::ChannelUpdate) {
3098 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_channel_update(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3100 extern "C" fn ChannelManager_ChannelMessageHandler_handle_error(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey, msg: &crate::lightning::ln::msgs::ErrorMessage) {
3101 <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::handle_error(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust(), msg.get_native_ref())
3104 extern "C" fn ChannelManager_ChannelMessageHandler_provided_node_features(this_arg: *const c_void) -> crate::lightning::ln::features::NodeFeatures {
3105 let mut ret = <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::provided_node_features(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
3106 crate::lightning::ln::features::NodeFeatures { inner: ObjOps::heap_alloc(ret), is_owned: true }
3109 extern "C" fn ChannelManager_ChannelMessageHandler_provided_init_features(this_arg: *const c_void, mut their_node_id: crate::c_types::PublicKey) -> crate::lightning::ln::features::InitFeatures {
3110 let mut ret = <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::provided_init_features(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, &their_node_id.into_rust());
3111 crate::lightning::ln::features::InitFeatures { inner: ObjOps::heap_alloc(ret), is_owned: true }
3114 extern "C" fn ChannelManager_ChannelMessageHandler_get_genesis_hashes(this_arg: *const c_void) -> crate::c_types::derived::COption_CVec_ThirtyTwoBytesZZ {
3115 let mut ret = <nativeChannelManager as lightning::ln::msgs::ChannelMessageHandler<>>::get_genesis_hashes(unsafe { &mut *(this_arg as *mut nativeChannelManager) }, );
3116 let mut local_ret = if ret.is_none() { crate::c_types::derived::COption_CVec_ThirtyTwoBytesZZ::None } else { crate::c_types::derived::COption_CVec_ThirtyTwoBytesZZ::Some( { let mut local_ret_0 = Vec::new(); for mut item in ret.unwrap().drain(..) { local_ret_0.push( { crate::c_types::ThirtyTwoBytes { data: item.to_bytes() } }); }; local_ret_0.into() }) };
3120 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
3121 /// [`ChannelManager`].
3123 pub extern "C" fn provided_init_features(config: &crate::lightning::util::config::UserConfig) -> crate::lightning::ln::features::InitFeatures {
3124 let mut ret = lightning::ln::channelmanager::provided_init_features(config.get_native_ref());
3125 crate::lightning::ln::features::InitFeatures { inner: ObjOps::heap_alloc(ret), is_owned: true }
3129 /// Serialize the CounterpartyForwardingInfo object into a byte array which can be read by CounterpartyForwardingInfo_read
3130 pub extern "C" fn CounterpartyForwardingInfo_write(obj: &crate::lightning::ln::channelmanager::CounterpartyForwardingInfo) -> crate::c_types::derived::CVec_u8Z {
3131 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
3134 pub(crate) extern "C" fn CounterpartyForwardingInfo_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
3135 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeCounterpartyForwardingInfo) })
3138 /// Read a CounterpartyForwardingInfo from a byte array, created by CounterpartyForwardingInfo_write
3139 pub extern "C" fn CounterpartyForwardingInfo_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_CounterpartyForwardingInfoDecodeErrorZ {
3140 let res: Result<lightning::ln::channelmanager::CounterpartyForwardingInfo, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
3141 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::channelmanager::CounterpartyForwardingInfo { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
3145 /// Serialize the ChannelCounterparty object into a byte array which can be read by ChannelCounterparty_read
3146 pub extern "C" fn ChannelCounterparty_write(obj: &crate::lightning::ln::channelmanager::ChannelCounterparty) -> crate::c_types::derived::CVec_u8Z {
3147 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
3150 pub(crate) extern "C" fn ChannelCounterparty_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
3151 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelCounterparty) })
3154 /// Read a ChannelCounterparty from a byte array, created by ChannelCounterparty_write
3155 pub extern "C" fn ChannelCounterparty_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelCounterpartyDecodeErrorZ {
3156 let res: Result<lightning::ln::channelmanager::ChannelCounterparty, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
3157 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::channelmanager::ChannelCounterparty { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
3161 /// Serialize the ChannelDetails object into a byte array which can be read by ChannelDetails_read
3162 pub extern "C" fn ChannelDetails_write(obj: &crate::lightning::ln::channelmanager::ChannelDetails) -> crate::c_types::derived::CVec_u8Z {
3163 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
3166 pub(crate) extern "C" fn ChannelDetails_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
3167 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelDetails) })
3170 /// Read a ChannelDetails from a byte array, created by ChannelDetails_write
3171 pub extern "C" fn ChannelDetails_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelDetailsDecodeErrorZ {
3172 let res: Result<lightning::ln::channelmanager::ChannelDetails, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
3173 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::channelmanager::ChannelDetails { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
3177 /// Serialize the PhantomRouteHints object into a byte array which can be read by PhantomRouteHints_read
3178 pub extern "C" fn PhantomRouteHints_write(obj: &crate::lightning::ln::channelmanager::PhantomRouteHints) -> crate::c_types::derived::CVec_u8Z {
3179 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
3182 pub(crate) extern "C" fn PhantomRouteHints_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
3183 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativePhantomRouteHints) })
3186 /// Read a PhantomRouteHints from a byte array, created by PhantomRouteHints_write
3187 pub extern "C" fn PhantomRouteHints_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_PhantomRouteHintsDecodeErrorZ {
3188 let res: Result<lightning::ln::channelmanager::PhantomRouteHints, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
3189 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::channelmanager::PhantomRouteHints { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
3193 /// Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
3194 pub extern "C" fn ChannelManager_write(obj: &crate::lightning::ln::channelmanager::ChannelManager) -> crate::c_types::derived::CVec_u8Z {
3195 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
3198 pub(crate) extern "C" fn ChannelManager_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
3199 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelManager) })
3202 /// Serialize the ChannelShutdownState object into a byte array which can be read by ChannelShutdownState_read
3203 pub extern "C" fn ChannelShutdownState_write(obj: &crate::lightning::ln::channelmanager::ChannelShutdownState) -> crate::c_types::derived::CVec_u8Z {
3204 crate::c_types::serialize_obj(&unsafe { &*obj }.to_native())
3207 /// Read a ChannelShutdownState from a byte array, created by ChannelShutdownState_write
3208 pub extern "C" fn ChannelShutdownState_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelShutdownStateDecodeErrorZ {
3209 let res: Result<lightning::ln::channelmanager::ChannelShutdownState, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
3210 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::ln::channelmanager::ChannelShutdownState::native_into(o) }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };
3214 use lightning::ln::channelmanager::ChannelManagerReadArgs as nativeChannelManagerReadArgsImport;
3215 pub(crate) type nativeChannelManagerReadArgs = nativeChannelManagerReadArgsImport<'static, crate::lightning::chain::Watch, crate::lightning::chain::chaininterface::BroadcasterInterface, crate::lightning::sign::EntropySource, crate::lightning::sign::NodeSigner, crate::lightning::sign::SignerProvider, crate::lightning::chain::chaininterface::FeeEstimator, crate::lightning::routing::router::Router, crate::lightning::util::logger::Logger>;
3217 /// Arguments for the creation of a ChannelManager that are not deserialized.
3219 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3221 /// 1) Deserialize all stored [`ChannelMonitor`]s.
3222 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
3223 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
3224 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
3225 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
3226 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
3227 /// same way you would handle a [`chain::Filter`] call using
3228 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
3229 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
3230 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
3231 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
3232 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
3233 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
3235 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
3236 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
3238 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
3239 /// call any other methods on the newly-deserialized [`ChannelManager`].
3241 /// Note that because some channels may be closed during deserialization, it is critical that you
3242 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
3243 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
3244 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
3245 /// not force-close the same channels but consider them live), you may end up revoking a state for
3246 /// which you've already broadcasted the transaction.
3248 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
3251 pub struct ChannelManagerReadArgs {
3252 /// A pointer to the opaque Rust object.
3254 /// Nearly everywhere, inner must be non-null, however in places where
3255 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
3256 pub inner: *mut nativeChannelManagerReadArgs,
3257 /// Indicates that this is the only struct which contains the same pointer.
3259 /// Rust functions which take ownership of an object provided via an argument require
3260 /// this to be true and invalidate the object pointed to by inner.
3264 impl Drop for ChannelManagerReadArgs {
3265 fn drop(&mut self) {
3266 if self.is_owned && !<*mut nativeChannelManagerReadArgs>::is_null(self.inner) {
3267 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
3271 /// Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL.
3273 pub extern "C" fn ChannelManagerReadArgs_free(this_obj: ChannelManagerReadArgs) { }
3275 /// Used only if an object of this type is returned as a trait impl by a method
3276 pub(crate) extern "C" fn ChannelManagerReadArgs_free_void(this_ptr: *mut c_void) {
3277 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelManagerReadArgs) };
3280 impl ChannelManagerReadArgs {
3281 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelManagerReadArgs {
3282 unsafe { &*ObjOps::untweak_ptr(self.inner) }
3284 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelManagerReadArgs {
3285 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
3287 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
3288 pub(crate) fn take_inner(mut self) -> *mut nativeChannelManagerReadArgs {
3289 assert!(self.is_owned);
3290 let ret = ObjOps::untweak_ptr(self.inner);
3291 self.inner = core::ptr::null_mut();
3295 /// A cryptographically secure source of entropy.
3297 pub extern "C" fn ChannelManagerReadArgs_get_entropy_source(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::sign::EntropySource {
3298 let mut inner_val = &mut this_ptr.get_native_mut_ref().entropy_source;
3301 /// A cryptographically secure source of entropy.
3303 pub extern "C" fn ChannelManagerReadArgs_set_entropy_source(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::sign::EntropySource) {
3304 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.entropy_source = val;
3306 /// A signer that is able to perform node-scoped cryptographic operations.
3308 pub extern "C" fn ChannelManagerReadArgs_get_node_signer(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::sign::NodeSigner {
3309 let mut inner_val = &mut this_ptr.get_native_mut_ref().node_signer;
3312 /// A signer that is able to perform node-scoped cryptographic operations.
3314 pub extern "C" fn ChannelManagerReadArgs_set_node_signer(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::sign::NodeSigner) {
3315 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.node_signer = val;
3317 /// The keys provider which will give us relevant keys. Some keys will be loaded during
3318 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
3321 pub extern "C" fn ChannelManagerReadArgs_get_signer_provider(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::sign::SignerProvider {
3322 let mut inner_val = &mut this_ptr.get_native_mut_ref().signer_provider;
3325 /// The keys provider which will give us relevant keys. Some keys will be loaded during
3326 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
3329 pub extern "C" fn ChannelManagerReadArgs_set_signer_provider(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::sign::SignerProvider) {
3330 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.signer_provider = val;
3332 /// The fee_estimator for use in the ChannelManager in the future.
3334 /// No calls to the FeeEstimator will be made during deserialization.
3336 pub extern "C" fn ChannelManagerReadArgs_get_fee_estimator(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::chaininterface::FeeEstimator {
3337 let mut inner_val = &mut this_ptr.get_native_mut_ref().fee_estimator;
3340 /// The fee_estimator for use in the ChannelManager in the future.
3342 /// No calls to the FeeEstimator will be made during deserialization.
3344 pub extern "C" fn ChannelManagerReadArgs_set_fee_estimator(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::chaininterface::FeeEstimator) {
3345 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.fee_estimator = val;
3347 /// The chain::Watch for use in the ChannelManager in the future.
3349 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
3350 /// you have deserialized ChannelMonitors separately and will add them to your
3351 /// chain::Watch after deserializing this ChannelManager.
3353 pub extern "C" fn ChannelManagerReadArgs_get_chain_monitor(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::Watch {
3354 let mut inner_val = &mut this_ptr.get_native_mut_ref().chain_monitor;
3357 /// The chain::Watch for use in the ChannelManager in the future.
3359 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
3360 /// you have deserialized ChannelMonitors separately and will add them to your
3361 /// chain::Watch after deserializing this ChannelManager.
3363 pub extern "C" fn ChannelManagerReadArgs_set_chain_monitor(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::Watch) {
3364 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.chain_monitor = val;
3366 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3367 /// used to broadcast the latest local commitment transactions of channels which must be
3368 /// force-closed during deserialization.
3370 pub extern "C" fn ChannelManagerReadArgs_get_tx_broadcaster(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::chain::chaininterface::BroadcasterInterface {
3371 let mut inner_val = &mut this_ptr.get_native_mut_ref().tx_broadcaster;
3374 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3375 /// used to broadcast the latest local commitment transactions of channels which must be
3376 /// force-closed during deserialization.
3378 pub extern "C" fn ChannelManagerReadArgs_set_tx_broadcaster(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::chain::chaininterface::BroadcasterInterface) {
3379 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.tx_broadcaster = val;
3381 /// The router which will be used in the ChannelManager in the future for finding routes
3382 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
3384 /// No calls to the router will be made during deserialization.
3386 pub extern "C" fn ChannelManagerReadArgs_get_router(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::routing::router::Router {
3387 let mut inner_val = &mut this_ptr.get_native_mut_ref().router;
3390 /// The router which will be used in the ChannelManager in the future for finding routes
3391 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
3393 /// No calls to the router will be made during deserialization.
3395 pub extern "C" fn ChannelManagerReadArgs_set_router(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::routing::router::Router) {
3396 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.router = val;
3398 /// The Logger for use in the ChannelManager and which may be used to log information during
3399 /// deserialization.
3401 pub extern "C" fn ChannelManagerReadArgs_get_logger(this_ptr: &ChannelManagerReadArgs) -> *const crate::lightning::util::logger::Logger {
3402 let mut inner_val = &mut this_ptr.get_native_mut_ref().logger;
3405 /// The Logger for use in the ChannelManager and which may be used to log information during
3406 /// deserialization.
3408 pub extern "C" fn ChannelManagerReadArgs_set_logger(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::util::logger::Logger) {
3409 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.logger = val;
3411 /// Default settings used for new channels. Any existing channels will continue to use the
3412 /// runtime settings which were stored when the ChannelManager was serialized.
3414 pub extern "C" fn ChannelManagerReadArgs_get_default_config(this_ptr: &ChannelManagerReadArgs) -> crate::lightning::util::config::UserConfig {
3415 let mut inner_val = &mut this_ptr.get_native_mut_ref().default_config;
3416 crate::lightning::util::config::UserConfig { inner: unsafe { ObjOps::nonnull_ptr_to_inner((inner_val as *const lightning::util::config::UserConfig<>) as *mut _) }, is_owned: false }
3418 /// Default settings used for new channels. Any existing channels will continue to use the
3419 /// runtime settings which were stored when the ChannelManager was serialized.
3421 pub extern "C" fn ChannelManagerReadArgs_set_default_config(this_ptr: &mut ChannelManagerReadArgs, mut val: crate::lightning::util::config::UserConfig) {
3422 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.default_config = *unsafe { Box::from_raw(val.take_inner()) };
3424 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
3425 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
3426 /// populate a HashMap directly from C.
3429 pub extern "C" fn ChannelManagerReadArgs_new(mut entropy_source: crate::lightning::sign::EntropySource, mut node_signer: crate::lightning::sign::NodeSigner, mut signer_provider: crate::lightning::sign::SignerProvider, mut fee_estimator: crate::lightning::chain::chaininterface::FeeEstimator, mut chain_monitor: crate::lightning::chain::Watch, mut tx_broadcaster: crate::lightning::chain::chaininterface::BroadcasterInterface, mut router: crate::lightning::routing::router::Router, mut logger: crate::lightning::util::logger::Logger, mut default_config: crate::lightning::util::config::UserConfig, mut channel_monitors: crate::c_types::derived::CVec_ChannelMonitorZ) -> crate::lightning::ln::channelmanager::ChannelManagerReadArgs {
3430 let mut local_channel_monitors = Vec::new(); for mut item in channel_monitors.into_rust().drain(..) { local_channel_monitors.push( { item.get_native_mut_ref() }); };
3431 let mut ret = lightning::ln::channelmanager::ChannelManagerReadArgs::new(entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, *unsafe { Box::from_raw(default_config.take_inner()) }, local_channel_monitors);
3432 crate::lightning::ln::channelmanager::ChannelManagerReadArgs { inner: ObjOps::heap_alloc(ret), is_owned: true }
3436 /// Read a C2Tuple_ThirtyTwoBytesChannelManagerZ from a byte array, created by C2Tuple_ThirtyTwoBytesChannelManagerZ_write
3437 pub extern "C" fn C2Tuple_ThirtyTwoBytesChannelManagerZ_read(ser: crate::c_types::u8slice, arg: crate::lightning::ln::channelmanager::ChannelManagerReadArgs) -> crate::c_types::derived::CResult_C2Tuple_ThirtyTwoBytesChannelManagerZDecodeErrorZ {
3438 let arg_conv = *unsafe { Box::from_raw(arg.take_inner()) };
3439 let res: Result<(bitcoin::hash_types::BlockHash, lightning::ln::channelmanager::ChannelManager<crate::lightning::chain::Watch, crate::lightning::chain::chaininterface::BroadcasterInterface, crate::lightning::sign::EntropySource, crate::lightning::sign::NodeSigner, crate::lightning::sign::SignerProvider, crate::lightning::chain::chaininterface::FeeEstimator, crate::lightning::routing::router::Router, crate::lightning::util::logger::Logger>), lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv);
3440 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: ObjOps::heap_alloc(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::native_into(e) }).into() };