X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-c-bindings%2Fsrc%2Flightning%2Fchain%2Fchannelmonitor.rs;h=dbe2932b1668ad007404b38d1cddde44fb25bfa0;hb=82601052fe2cac04a6249f5930495e987923303b;hp=bfa80877d8a99300e39f91da585df67940566bfd;hpb=a21177846ed75d66f68a1603f768410f07a65791;p=ldk-c-bindings diff --git a/lightning-c-bindings/src/lightning/chain/channelmonitor.rs b/lightning-c-bindings/src/lightning/chain/channelmonitor.rs index bfa8087..dbe2932 100644 --- a/lightning-c-bindings/src/lightning/chain/channelmonitor.rs +++ b/lightning-c-bindings/src/lightning/chain/channelmonitor.rs @@ -66,7 +66,7 @@ pub extern "C" fn ChannelMonitorUpdate_free(this_obj: ChannelMonitorUpdate) { } #[allow(unused)] /// Used only if an object of this type is returned as a trait impl by a method pub(crate) extern "C" fn ChannelMonitorUpdate_free_void(this_ptr: *mut c_void) { - unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelMonitorUpdate); } + let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelMonitorUpdate) }; } #[allow(unused)] impl ChannelMonitorUpdate { @@ -86,15 +86,17 @@ impl ChannelMonitorUpdate { } /// The sequence number of this update. Updates *must* be replayed in-order according to this /// sequence number (and updates may panic if they are not). The update_id values are strictly -/// increasing and increase by one for each new update, with one exception specified below. +/// increasing and increase by one for each new update, with two exceptions specified below. /// /// This sequence number is also used to track up to which points updates which returned /// [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given /// ChannelMonitor when ChannelManager::channel_monitor_updated is called. /// -/// The only instance where update_id values are not strictly increasing is the case where we -/// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See -/// its docs for more details. +/// The only instances we allow where update_id values are not strictly increasing have a +/// special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that +/// will force close the channel by broadcasting the latest commitment transaction or +/// special post-force-close updates, like providing preimages necessary to claim outputs on the +/// broadcast commitment transaction. See its docs for more details. /// /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress #[no_mangle] @@ -104,15 +106,17 @@ pub extern "C" fn ChannelMonitorUpdate_get_update_id(this_ptr: &ChannelMonitorUp } /// The sequence number of this update. Updates *must* be replayed in-order according to this /// sequence number (and updates may panic if they are not). The update_id values are strictly -/// increasing and increase by one for each new update, with one exception specified below. +/// increasing and increase by one for each new update, with two exceptions specified below. /// /// This sequence number is also used to track up to which points updates which returned /// [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given /// ChannelMonitor when ChannelManager::channel_monitor_updated is called. /// -/// The only instance where update_id values are not strictly increasing is the case where we -/// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See -/// its docs for more details. +/// The only instances we allow where update_id values are not strictly increasing have a +/// special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. This update ID is used for updates that +/// will force close the channel by broadcasting the latest commitment transaction or +/// special post-force-close updates, like providing preimages necessary to claim outputs on the +/// broadcast commitment transaction. See its docs for more details. /// /// [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress #[no_mangle] @@ -138,13 +142,23 @@ pub(crate) extern "C" fn ChannelMonitorUpdate_clone_void(this_ptr: *const c_void pub extern "C" fn ChannelMonitorUpdate_clone(orig: &ChannelMonitorUpdate) -> ChannelMonitorUpdate { orig.clone() } -/// If: -/// (1) a channel has been force closed and -/// (2) we receive a preimage from a forward link that allows us to spend an HTLC output on -/// this channel's (the backward link's) broadcasted commitment transaction -/// then we allow the `ChannelManager` to send a `ChannelMonitorUpdate` with this update ID, -/// with the update providing said payment preimage. No other update types are allowed after -/// force-close. +/// Checks if two ChannelMonitorUpdates contain equal inner contents. +/// This ignores pointers and is_owned flags and looks at the values in fields. +/// Two objects with NULL inner values will be considered "equal" here. +#[no_mangle] +pub extern "C" fn ChannelMonitorUpdate_eq(a: &ChannelMonitorUpdate, b: &ChannelMonitorUpdate) -> bool { + if a.inner == b.inner { return true; } + if a.inner.is_null() || b.inner.is_null() { return false; } + if a.get_native_ref() == b.get_native_ref() { true } else { false } +} +/// The update ID used for a [`ChannelMonitorUpdate`] that is either: +/// +///\t(1) attempting to force close the channel by broadcasting our latest commitment transaction or +///\t(2) providing a preimage (after the channel has been force closed) from a forward link that +///\t\tallows us to spend an HTLC output on this channel's (the backward link's) broadcasted +///\t\tcommitment transaction. +/// +/// No other [`ChannelMonitorUpdate`]s are allowed after force-close. #[no_mangle] pub static CLOSED_CHANNEL_UPDATE_ID: u64 = lightning::chain::channelmonitor::CLOSED_CHANNEL_UPDATE_ID; @@ -204,27 +218,27 @@ impl MonitorEvent { pub(crate) fn to_native(&self) -> nativeMonitorEvent { match self { MonitorEvent::HTLCEvent (ref a, ) => { - let mut a_nonref = (*a).clone(); + let mut a_nonref = Clone::clone(a); nativeMonitorEvent::HTLCEvent ( *unsafe { Box::from_raw(a_nonref.take_inner()) }, ) }, MonitorEvent::CommitmentTxConfirmed (ref a, ) => { - let mut a_nonref = (*a).clone(); + let mut a_nonref = Clone::clone(a); nativeMonitorEvent::CommitmentTxConfirmed ( *unsafe { Box::from_raw(a_nonref.take_inner()) }, ) }, MonitorEvent::Completed {ref funding_txo, ref monitor_update_id, } => { - let mut funding_txo_nonref = (*funding_txo).clone(); - let mut monitor_update_id_nonref = (*monitor_update_id).clone(); + let mut funding_txo_nonref = Clone::clone(funding_txo); + let mut monitor_update_id_nonref = Clone::clone(monitor_update_id); nativeMonitorEvent::Completed { funding_txo: *unsafe { Box::from_raw(funding_txo_nonref.take_inner()) }, monitor_update_id: monitor_update_id_nonref, } }, MonitorEvent::UpdateFailed (ref a, ) => { - let mut a_nonref = (*a).clone(); + let mut a_nonref = Clone::clone(a); nativeMonitorEvent::UpdateFailed ( *unsafe { Box::from_raw(a_nonref.take_inner()) }, ) @@ -261,27 +275,27 @@ impl MonitorEvent { pub(crate) fn from_native(native: &nativeMonitorEvent) -> Self { match native { nativeMonitorEvent::HTLCEvent (ref a, ) => { - let mut a_nonref = (*a).clone(); + let mut a_nonref = Clone::clone(a); MonitorEvent::HTLCEvent ( crate::lightning::chain::channelmonitor::HTLCUpdate { inner: ObjOps::heap_alloc(a_nonref), is_owned: true }, ) }, nativeMonitorEvent::CommitmentTxConfirmed (ref a, ) => { - let mut a_nonref = (*a).clone(); + let mut a_nonref = Clone::clone(a); MonitorEvent::CommitmentTxConfirmed ( crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(a_nonref), is_owned: true }, ) }, nativeMonitorEvent::Completed {ref funding_txo, ref monitor_update_id, } => { - let mut funding_txo_nonref = (*funding_txo).clone(); - let mut monitor_update_id_nonref = (*monitor_update_id).clone(); + let mut funding_txo_nonref = Clone::clone(funding_txo); + let mut monitor_update_id_nonref = Clone::clone(monitor_update_id); MonitorEvent::Completed { funding_txo: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(funding_txo_nonref), is_owned: true }, monitor_update_id: monitor_update_id_nonref, } }, nativeMonitorEvent::UpdateFailed (ref a, ) => { - let mut a_nonref = (*a).clone(); + let mut a_nonref = Clone::clone(a); MonitorEvent::UpdateFailed ( crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(a_nonref), is_owned: true }, ) @@ -399,7 +413,7 @@ pub extern "C" fn HTLCUpdate_free(this_obj: HTLCUpdate) { } #[allow(unused)] /// Used only if an object of this type is returned as a trait impl by a method pub(crate) extern "C" fn HTLCUpdate_free_void(this_ptr: *mut c_void) { - unsafe { let _ = Box::from_raw(this_ptr as *mut nativeHTLCUpdate); } + let _ = unsafe { Box::from_raw(this_ptr as *mut nativeHTLCUpdate) }; } #[allow(unused)] impl HTLCUpdate { @@ -555,45 +569,45 @@ impl Balance { pub(crate) fn to_native(&self) -> nativeBalance { match self { Balance::ClaimableOnChannelClose {ref claimable_amount_satoshis, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); nativeBalance::ClaimableOnChannelClose { claimable_amount_satoshis: claimable_amount_satoshis_nonref, } }, Balance::ClaimableAwaitingConfirmations {ref claimable_amount_satoshis, ref confirmation_height, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); - let mut confirmation_height_nonref = (*confirmation_height).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); + let mut confirmation_height_nonref = Clone::clone(confirmation_height); nativeBalance::ClaimableAwaitingConfirmations { claimable_amount_satoshis: claimable_amount_satoshis_nonref, confirmation_height: confirmation_height_nonref, } }, Balance::ContentiousClaimable {ref claimable_amount_satoshis, ref timeout_height, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); - let mut timeout_height_nonref = (*timeout_height).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); + let mut timeout_height_nonref = Clone::clone(timeout_height); nativeBalance::ContentiousClaimable { claimable_amount_satoshis: claimable_amount_satoshis_nonref, timeout_height: timeout_height_nonref, } }, Balance::MaybeTimeoutClaimableHTLC {ref claimable_amount_satoshis, ref claimable_height, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); - let mut claimable_height_nonref = (*claimable_height).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); + let mut claimable_height_nonref = Clone::clone(claimable_height); nativeBalance::MaybeTimeoutClaimableHTLC { claimable_amount_satoshis: claimable_amount_satoshis_nonref, claimable_height: claimable_height_nonref, } }, Balance::MaybePreimageClaimableHTLC {ref claimable_amount_satoshis, ref expiry_height, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); - let mut expiry_height_nonref = (*expiry_height).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); + let mut expiry_height_nonref = Clone::clone(expiry_height); nativeBalance::MaybePreimageClaimableHTLC { claimable_amount_satoshis: claimable_amount_satoshis_nonref, expiry_height: expiry_height_nonref, } }, Balance::CounterpartyRevokedOutputClaimable {ref claimable_amount_satoshis, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); nativeBalance::CounterpartyRevokedOutputClaimable { claimable_amount_satoshis: claimable_amount_satoshis_nonref, } @@ -643,45 +657,45 @@ impl Balance { pub(crate) fn from_native(native: &nativeBalance) -> Self { match native { nativeBalance::ClaimableOnChannelClose {ref claimable_amount_satoshis, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); Balance::ClaimableOnChannelClose { claimable_amount_satoshis: claimable_amount_satoshis_nonref, } }, nativeBalance::ClaimableAwaitingConfirmations {ref claimable_amount_satoshis, ref confirmation_height, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); - let mut confirmation_height_nonref = (*confirmation_height).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); + let mut confirmation_height_nonref = Clone::clone(confirmation_height); Balance::ClaimableAwaitingConfirmations { claimable_amount_satoshis: claimable_amount_satoshis_nonref, confirmation_height: confirmation_height_nonref, } }, nativeBalance::ContentiousClaimable {ref claimable_amount_satoshis, ref timeout_height, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); - let mut timeout_height_nonref = (*timeout_height).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); + let mut timeout_height_nonref = Clone::clone(timeout_height); Balance::ContentiousClaimable { claimable_amount_satoshis: claimable_amount_satoshis_nonref, timeout_height: timeout_height_nonref, } }, nativeBalance::MaybeTimeoutClaimableHTLC {ref claimable_amount_satoshis, ref claimable_height, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); - let mut claimable_height_nonref = (*claimable_height).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); + let mut claimable_height_nonref = Clone::clone(claimable_height); Balance::MaybeTimeoutClaimableHTLC { claimable_amount_satoshis: claimable_amount_satoshis_nonref, claimable_height: claimable_height_nonref, } }, nativeBalance::MaybePreimageClaimableHTLC {ref claimable_amount_satoshis, ref expiry_height, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); - let mut expiry_height_nonref = (*expiry_height).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); + let mut expiry_height_nonref = Clone::clone(expiry_height); Balance::MaybePreimageClaimableHTLC { claimable_amount_satoshis: claimable_amount_satoshis_nonref, expiry_height: expiry_height_nonref, } }, nativeBalance::CounterpartyRevokedOutputClaimable {ref claimable_amount_satoshis, } => { - let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone(); + let mut claimable_amount_satoshis_nonref = Clone::clone(claimable_amount_satoshis); Balance::CounterpartyRevokedOutputClaimable { claimable_amount_satoshis: claimable_amount_satoshis_nonref, } @@ -790,7 +804,7 @@ pub extern "C" fn Balance_eq(a: &Balance, b: &Balance) -> bool { } use lightning::chain::channelmonitor::ChannelMonitor as nativeChannelMonitorImport; -pub(crate) type nativeChannelMonitor = nativeChannelMonitorImport; +pub(crate) type nativeChannelMonitor = nativeChannelMonitorImport; /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates /// on-chain transactions to ensure no loss of funds occurs. @@ -836,7 +850,7 @@ pub extern "C" fn ChannelMonitor_free(this_obj: ChannelMonitor) { } #[allow(unused)] /// Used only if an object of this type is returned as a trait impl by a method pub(crate) extern "C" fn ChannelMonitor_free_void(this_ptr: *mut c_void) { - unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelMonitor); } + let _ = unsafe { Box::from_raw(this_ptr as *mut nativeChannelMonitor) }; } #[allow(unused)] impl ChannelMonitor { @@ -924,14 +938,16 @@ pub extern "C" fn ChannelMonitor_get_and_clear_pending_monitor_events(this_arg: /// Gets the list of pending events which were generated by previous actions, clearing the list /// in the process. /// -/// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to -/// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do -/// no internal locking in ChannelMonitors. +/// This is called by the [`EventsProvider::process_pending_events`] implementation for +/// [`ChainMonitor`]. +/// +/// [`EventsProvider::process_pending_events`]: crate::events::EventsProvider::process_pending_events +/// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor #[must_use] #[no_mangle] pub extern "C" fn ChannelMonitor_get_and_clear_pending_events(this_arg: &crate::lightning::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CVec_EventZ { let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_and_clear_pending_events(); - let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::util::events::Event::native_into(item) }); }; + let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::events::Event::native_into(item) }); }; local_ret.into() } @@ -1044,9 +1060,9 @@ pub extern "C" fn ChannelMonitor_best_block_updated(this_arg: &crate::lightning: /// Returns the set of txids that should be monitored for re-organization out of the chain. #[must_use] #[no_mangle] -pub extern "C" fn ChannelMonitor_get_relevant_txids(this_arg: &crate::lightning::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CVec_TxidZ { +pub extern "C" fn ChannelMonitor_get_relevant_txids(this_arg: &crate::lightning::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CVec_C2Tuple_TxidBlockHashZZ { let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_relevant_txids(); - let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::c_types::ThirtyTwoBytes { data: item.into_inner() } }); }; + 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::ThirtyTwoBytes::null() } else { { 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 }); }; local_ret.into() } @@ -1059,6 +1075,16 @@ pub extern "C" fn ChannelMonitor_current_best_block(this_arg: &crate::lightning: crate::lightning::chain::BestBlock { inner: ObjOps::heap_alloc(ret), is_owned: true } } +/// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is +/// crucial in preventing certain classes of pinning attacks, detecting substantial mempool +/// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend +/// invoking this every 30 seconds, or lower if running in an environment with spotty +/// connections, like on mobile. +#[no_mangle] +pub extern "C" fn ChannelMonitor_rebroadcast_pending_claims(this_arg: &crate::lightning::chain::channelmonitor::ChannelMonitor, mut broadcaster: crate::lightning::chain::chaininterface::BroadcasterInterface, mut fee_estimator: crate::lightning::chain::chaininterface::FeeEstimator, mut logger: crate::lightning::util::logger::Logger) { + unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.rebroadcast_pending_claims(broadcaster, fee_estimator, logger) +} + /// Gets the balances in this channel which are either claimable by us if we were to /// force-close the channel now or which are claimable on-chain (possibly awaiting /// confirmation). @@ -1084,9 +1110,11 @@ pub extern "C" fn ChannelMonitor_get_claimable_balances(this_arg: &crate::lightn #[no_mangle] /// Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write -pub extern "C" fn C2Tuple_BlockHashChannelMonitorZ_read(ser: crate::c_types::u8slice, arg: &crate::lightning::chain::keysinterface::KeysInterface) -> crate::c_types::derived::CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ { - let arg_conv = arg; - let res: Result<(bitcoin::hash_types::BlockHash, lightning::chain::channelmonitor::ChannelMonitor), lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv); +pub extern "C" fn C2Tuple_BlockHashChannelMonitorZ_read(ser: crate::c_types::u8slice, arg_a: &crate::lightning::chain::keysinterface::EntropySource, arg_b: &crate::lightning::chain::keysinterface::SignerProvider) -> crate::c_types::derived::CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ { + let arg_a_conv = arg_a; + let arg_b_conv = arg_b; + let arg_conv = (arg_a_conv, arg_b_conv); + let res: Result<(bitcoin::hash_types::BlockHash, lightning::chain::channelmonitor::ChannelMonitor), lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj_arg(ser, arg_conv); 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::chain::channelmonitor::ChannelMonitor { 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() }; local_res }