1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Logic to connect off-chain channel management with on-chain transaction monitoring.
12 //! [`ChainMonitor`] is an implementation of [`chain::Watch`] used both to process blocks and to
13 //! update [`ChannelMonitor`]s accordingly. If any on-chain events need further processing, it will
14 //! make those available as [`MonitorEvent`]s to be consumed.
16 //! [`ChainMonitor`] is parameterized by an optional chain source, which must implement the
17 //! [`chain::Filter`] trait. This provides a mechanism to signal new relevant outputs back to light
18 //! clients, such that transactions spending those outputs are included in block data.
20 //! [`ChainMonitor`] may be used directly to monitor channels locally or as a part of a distributed
21 //! setup to monitor channels remotely. In the latter case, a custom [`chain::Watch`] implementation
22 //! would be responsible for routing each update to a remote server and for retrieving monitor
23 //! events. The remote server would make use of [`ChainMonitor`] for block processing and for
24 //! servicing [`ChannelMonitor`] updates from the client.
26 use bitcoin::blockdata::block::Header;
27 use bitcoin::hash_types::{Txid, BlockHash};
30 use crate::chain::{ChannelMonitorUpdateStatus, Filter, WatchedOutput};
31 use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
32 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, Balance, MonitorEvent, TransactionOutputs, WithChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
33 use crate::chain::transaction::{OutPoint, TransactionData};
34 use crate::ln::types::ChannelId;
35 use crate::sign::ecdsa::WriteableEcdsaChannelSigner;
37 use crate::events::{Event, EventHandler};
38 use crate::util::atomic_counter::AtomicCounter;
39 use crate::util::logger::{Logger, WithContext};
40 use crate::util::errors::APIError;
41 use crate::util::wakers::{Future, Notifier};
42 use crate::ln::channelmanager::ChannelDetails;
44 use crate::prelude::*;
45 use crate::sync::{RwLock, RwLockReadGuard, Mutex, MutexGuard};
47 use core::sync::atomic::{AtomicUsize, Ordering};
48 use bitcoin::secp256k1::PublicKey;
51 #[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
52 /// A specific update's ID stored in a `MonitorUpdateId`, separated out to make the contents
54 pub(crate) enum UpdateOrigin {
55 /// An update that was generated by the `ChannelManager` (via our [`crate::chain::Watch`]
56 /// implementation). This corresponds to an actual [ChannelMonitorUpdate::update_id] field
57 /// and [ChannelMonitor::get_latest_update_id].
59 /// [ChannelMonitor::get_latest_update_id]: crate::chain::channelmonitor::ChannelMonitor::get_latest_update_id
60 /// [ChannelMonitorUpdate::update_id]: crate::chain::channelmonitor::ChannelMonitorUpdate::update_id
62 /// An update that was generated during blockchain processing. The ID here is specific to the
63 /// generating [ChannelMonitor] and does *not* correspond to any on-disk IDs.
65 /// [ChannelMonitor]: crate::chain::channelmonitor::ChannelMonitor
70 #[cfg(any(feature = "_test_utils", test))]
71 pub(crate) use update_origin::UpdateOrigin;
72 #[cfg(not(any(feature = "_test_utils", test)))]
73 use update_origin::UpdateOrigin;
75 /// An opaque identifier describing a specific [`Persist`] method call.
76 #[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
77 pub struct MonitorUpdateId {
78 pub(crate) contents: UpdateOrigin,
81 impl MonitorUpdateId {
82 pub(crate) fn from_monitor_update(update: &ChannelMonitorUpdate) -> Self {
83 Self { contents: UpdateOrigin::OffChain(update.update_id) }
85 pub(crate) fn from_new_monitor<ChannelSigner: WriteableEcdsaChannelSigner>(monitor: &ChannelMonitor<ChannelSigner>) -> Self {
86 Self { contents: UpdateOrigin::OffChain(monitor.get_latest_update_id()) }
90 /// `Persist` defines behavior for persisting channel monitors: this could mean
91 /// writing once to disk, and/or uploading to one or more backup services.
93 /// Persistence can happen in one of two ways - synchronously completing before the trait method
94 /// calls return or asynchronously in the background.
96 /// # For those implementing synchronous persistence
98 /// * If persistence completes fully (including any relevant `fsync()` calls), the implementation
99 /// should return [`ChannelMonitorUpdateStatus::Completed`], indicating normal channel operation
102 /// * If persistence fails for some reason, implementations should consider returning
103 /// [`ChannelMonitorUpdateStatus::InProgress`] and retry all pending persistence operations in
104 /// the background with [`ChainMonitor::list_pending_monitor_updates`] and
105 /// [`ChainMonitor::get_monitor`].
107 /// Once a full [`ChannelMonitor`] has been persisted, all pending updates for that channel can
108 /// be marked as complete via [`ChainMonitor::channel_monitor_updated`].
110 /// If at some point no further progress can be made towards persisting the pending updates, the
111 /// node should simply shut down.
113 /// * If the persistence has failed and cannot be retried further (e.g. because of an outage),
114 /// [`ChannelMonitorUpdateStatus::UnrecoverableError`] can be used, though this will result in
115 /// an immediate panic and future operations in LDK generally failing.
117 /// # For those implementing asynchronous persistence
119 /// All calls should generally spawn a background task and immediately return
120 /// [`ChannelMonitorUpdateStatus::InProgress`]. Once the update completes,
121 /// [`ChainMonitor::channel_monitor_updated`] should be called with the corresponding
122 /// [`MonitorUpdateId`].
124 /// Note that unlike the direct [`chain::Watch`] interface,
125 /// [`ChainMonitor::channel_monitor_updated`] must be called once for *each* update which occurs.
127 /// If at some point no further progress can be made towards persisting a pending update, the node
128 /// should simply shut down. Until then, the background task should either loop indefinitely, or
129 /// persistence should be regularly retried with [`ChainMonitor::list_pending_monitor_updates`]
130 /// and [`ChainMonitor::get_monitor`] (note that if a full monitor is persisted all pending
131 /// monitor updates may be marked completed).
133 /// # Using remote watchtowers
135 /// Watchtowers may be updated as a part of an implementation of this trait, utilizing the async
136 /// update process described above while the watchtower is being updated. The following methods are
137 /// provided for bulding transactions for a watchtower:
138 /// [`ChannelMonitor::initial_counterparty_commitment_tx`],
139 /// [`ChannelMonitor::counterparty_commitment_txs_from_update`],
140 /// [`ChannelMonitor::sign_to_local_justice_tx`], [`TrustedCommitmentTransaction::revokeable_output_index`],
141 /// [`TrustedCommitmentTransaction::build_to_local_justice_tx`].
143 /// [`TrustedCommitmentTransaction::revokeable_output_index`]: crate::ln::chan_utils::TrustedCommitmentTransaction::revokeable_output_index
144 /// [`TrustedCommitmentTransaction::build_to_local_justice_tx`]: crate::ln::chan_utils::TrustedCommitmentTransaction::build_to_local_justice_tx
145 pub trait Persist<ChannelSigner: WriteableEcdsaChannelSigner> {
146 /// Persist a new channel's data in response to a [`chain::Watch::watch_channel`] call. This is
147 /// called by [`ChannelManager`] for new channels, or may be called directly, e.g. on startup.
149 /// The data can be stored any way you want, but the identifier provided by LDK is the
150 /// channel's outpoint (and it is up to you to maintain a correct mapping between the outpoint
151 /// and the stored channel data). Note that you **must** persist every new monitor to disk.
153 /// The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
154 /// if you return [`ChannelMonitorUpdateStatus::InProgress`].
156 /// See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`
157 /// and [`ChannelMonitorUpdateStatus`] for requirements when returning errors.
159 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
160 /// [`Writeable::write`]: crate::util::ser::Writeable::write
161 fn persist_new_channel(&self, channel_funding_outpoint: OutPoint, data: &ChannelMonitor<ChannelSigner>, update_id: MonitorUpdateId) -> ChannelMonitorUpdateStatus;
163 /// Update one channel's data. The provided [`ChannelMonitor`] has already applied the given
166 /// Note that on every update, you **must** persist either the [`ChannelMonitorUpdate`] or the
167 /// updated monitor itself to disk/backups. See the [`Persist`] trait documentation for more
170 /// During blockchain synchronization operations, and in some rare cases, this may be called with
171 /// no [`ChannelMonitorUpdate`], in which case the full [`ChannelMonitor`] needs to be persisted.
172 /// Note that after the full [`ChannelMonitor`] is persisted any previous
173 /// [`ChannelMonitorUpdate`]s which were persisted should be discarded - they can no longer be
174 /// applied to the persisted [`ChannelMonitor`] as they were already applied.
176 /// If an implementer chooses to persist the updates only, they need to make
177 /// sure that all the updates are applied to the `ChannelMonitors` *before*
178 /// the set of channel monitors is given to the `ChannelManager`
179 /// deserialization routine. See [`ChannelMonitor::update_monitor`] for
180 /// applying a monitor update to a monitor. If full `ChannelMonitors` are
181 /// persisted, then there is no need to persist individual updates.
183 /// Note that there could be a performance tradeoff between persisting complete
184 /// channel monitors on every update vs. persisting only updates and applying
185 /// them in batches. The size of each monitor grows `O(number of state updates)`
186 /// whereas updates are small and `O(1)`.
188 /// The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
189 /// if you return [`ChannelMonitorUpdateStatus::InProgress`].
191 /// See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`,
192 /// [`Writeable::write`] on [`ChannelMonitorUpdate`] for writing out an update, and
193 /// [`ChannelMonitorUpdateStatus`] for requirements when returning errors.
195 /// [`Writeable::write`]: crate::util::ser::Writeable::write
196 fn update_persisted_channel(&self, channel_funding_outpoint: OutPoint, update: Option<&ChannelMonitorUpdate>, data: &ChannelMonitor<ChannelSigner>, update_id: MonitorUpdateId) -> ChannelMonitorUpdateStatus;
197 /// Prevents the channel monitor from being loaded on startup.
199 /// Archiving the data in a backup location (rather than deleting it fully) is useful for
200 /// hedging against data loss in case of unexpected failure.
201 fn archive_persisted_channel(&self, channel_funding_outpoint: OutPoint);
204 struct MonitorHolder<ChannelSigner: WriteableEcdsaChannelSigner> {
205 monitor: ChannelMonitor<ChannelSigner>,
206 /// The full set of pending monitor updates for this Channel.
208 /// Note that this lock must be held during updates to prevent a race where we call
209 /// update_persisted_channel, the user returns a
210 /// [`ChannelMonitorUpdateStatus::InProgress`], and then calls channel_monitor_updated
211 /// immediately, racing our insertion of the pending update into the contained Vec.
213 /// Beyond the synchronization of updates themselves, we cannot handle user events until after
214 /// any chain updates have been stored on disk. Thus, we scan this list when returning updates
215 /// to the ChannelManager, refusing to return any updates for a ChannelMonitor which is still
216 /// being persisted fully to disk after a chain update.
218 /// This avoids the possibility of handling, e.g. an on-chain claim, generating a claim monitor
219 /// event, resulting in the relevant ChannelManager generating a PaymentSent event and dropping
220 /// the pending payment entry, and then reloading before the monitor is persisted, resulting in
221 /// the ChannelManager re-adding the same payment entry, before the same block is replayed,
222 /// resulting in a duplicate PaymentSent event.
223 pending_monitor_updates: Mutex<Vec<MonitorUpdateId>>,
224 /// The last block height at which no [`UpdateOrigin::ChainSync`] monitor updates were present
225 /// in `pending_monitor_updates`.
226 /// If it's been more than [`LATENCY_GRACE_PERIOD_BLOCKS`] since we started waiting on a chain
227 /// sync event, we let monitor events return to `ChannelManager` because we cannot hold them up
228 /// forever or we'll end up with HTLC preimages waiting to feed back into an upstream channel
229 /// forever, risking funds loss.
230 last_chain_persist_height: AtomicUsize,
233 impl<ChannelSigner: WriteableEcdsaChannelSigner> MonitorHolder<ChannelSigner> {
234 fn has_pending_offchain_updates(&self, pending_monitor_updates_lock: &MutexGuard<Vec<MonitorUpdateId>>) -> bool {
235 pending_monitor_updates_lock.iter().any(|update_id|
236 if let UpdateOrigin::OffChain(_) = update_id.contents { true } else { false })
238 fn has_pending_chainsync_updates(&self, pending_monitor_updates_lock: &MutexGuard<Vec<MonitorUpdateId>>) -> bool {
239 pending_monitor_updates_lock.iter().any(|update_id|
240 if let UpdateOrigin::ChainSync(_) = update_id.contents { true } else { false })
244 /// A read-only reference to a current ChannelMonitor.
246 /// Note that this holds a mutex in [`ChainMonitor`] and may block other events until it is
248 pub struct LockedChannelMonitor<'a, ChannelSigner: WriteableEcdsaChannelSigner> {
249 lock: RwLockReadGuard<'a, HashMap<OutPoint, MonitorHolder<ChannelSigner>>>,
250 funding_txo: OutPoint,
253 impl<ChannelSigner: WriteableEcdsaChannelSigner> Deref for LockedChannelMonitor<'_, ChannelSigner> {
254 type Target = ChannelMonitor<ChannelSigner>;
255 fn deref(&self) -> &ChannelMonitor<ChannelSigner> {
256 &self.lock.get(&self.funding_txo).expect("Checked at construction").monitor
260 /// An implementation of [`chain::Watch`] for monitoring channels.
262 /// Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
263 /// [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
264 /// or used independently to monitor channels remotely. See the [module-level documentation] for
267 /// Note that `ChainMonitor` should regularly trigger rebroadcasts/fee bumps of pending claims from
268 /// a force-closed channel. This is crucial in preventing certain classes of pinning attacks,
269 /// detecting substantial mempool feerate changes between blocks, and ensuring reliability if
270 /// broadcasting fails. We recommend invoking this every 30 seconds, or lower if running in an
271 /// environment with spotty connections, like on mobile.
273 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
274 /// [module-level documentation]: crate::chain::chainmonitor
275 /// [`rebroadcast_pending_claims`]: Self::rebroadcast_pending_claims
276 pub struct ChainMonitor<ChannelSigner: WriteableEcdsaChannelSigner, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref>
277 where C::Target: chain::Filter,
278 T::Target: BroadcasterInterface,
279 F::Target: FeeEstimator,
281 P::Target: Persist<ChannelSigner>,
283 monitors: RwLock<HashMap<OutPoint, MonitorHolder<ChannelSigner>>>,
284 /// When we generate a [`MonitorUpdateId`] for a chain-event monitor persistence, we need a
285 /// unique ID, which we calculate by simply getting the next value from this counter. Note that
286 /// the ID is never persisted so it's ok that they reset on restart.
287 sync_persistence_id: AtomicCounter,
288 chain_source: Option<C>,
293 /// "User-provided" (ie persistence-completion/-failed) [`MonitorEvent`]s. These came directly
294 /// from the user and not from a [`ChannelMonitor`].
295 pending_monitor_events: Mutex<Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, Option<PublicKey>)>>,
296 /// The best block height seen, used as a proxy for the passage of time.
297 highest_chain_height: AtomicUsize,
299 /// A [`Notifier`] used to wake up the background processor in case we have any [`Event`]s for
300 /// it to give to users (or [`MonitorEvent`]s for `ChannelManager` to process).
301 event_notifier: Notifier,
304 impl<ChannelSigner: WriteableEcdsaChannelSigner, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref> ChainMonitor<ChannelSigner, C, T, F, L, P>
305 where C::Target: chain::Filter,
306 T::Target: BroadcasterInterface,
307 F::Target: FeeEstimator,
309 P::Target: Persist<ChannelSigner>,
311 /// Dispatches to per-channel monitors, which are responsible for updating their on-chain view
312 /// of a channel and reacting accordingly based on transactions in the given chain data. See
313 /// [`ChannelMonitor::block_connected`] for details. Any HTLCs that were resolved on chain will
314 /// be returned by [`chain::Watch::release_pending_monitor_events`].
316 /// Calls back to [`chain::Filter`] if any monitor indicated new outputs to watch. Subsequent
317 /// calls must not exclude any transactions matching the new outputs nor any in-block
318 /// descendants of such transactions. It is not necessary to re-fetch the block to obtain
319 /// updated `txdata`.
321 /// Calls which represent a new blockchain tip height should set `best_height`.
322 fn process_chain_data<FN>(&self, header: &Header, best_height: Option<u32>, txdata: &TransactionData, process: FN)
324 FN: Fn(&ChannelMonitor<ChannelSigner>, &TransactionData) -> Vec<TransactionOutputs>
326 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
327 let funding_outpoints = hash_set_from_iter(self.monitors.read().unwrap().keys().cloned());
328 for funding_outpoint in funding_outpoints.iter() {
329 let monitor_lock = self.monitors.read().unwrap();
330 if let Some(monitor_state) = monitor_lock.get(funding_outpoint) {
331 if self.update_monitor_with_chain_data(header, best_height, txdata, &process, funding_outpoint, &monitor_state).is_err() {
332 // Take the monitors lock for writing so that we poison it and any future
333 // operations going forward fail immediately.
334 core::mem::drop(monitor_lock);
335 let _poison = self.monitors.write().unwrap();
336 log_error!(self.logger, "{}", err_str);
337 panic!("{}", err_str);
342 // do some followup cleanup if any funding outpoints were added in between iterations
343 let monitor_states = self.monitors.write().unwrap();
344 for (funding_outpoint, monitor_state) in monitor_states.iter() {
345 if !funding_outpoints.contains(funding_outpoint) {
346 if self.update_monitor_with_chain_data(header, best_height, txdata, &process, funding_outpoint, &monitor_state).is_err() {
347 log_error!(self.logger, "{}", err_str);
348 panic!("{}", err_str);
353 if let Some(height) = best_height {
354 // If the best block height is being updated, update highest_chain_height under the
355 // monitors write lock.
356 let old_height = self.highest_chain_height.load(Ordering::Acquire);
357 let new_height = height as usize;
358 if new_height > old_height {
359 self.highest_chain_height.store(new_height, Ordering::Release);
364 fn update_monitor_with_chain_data<FN>(
365 &self, header: &Header, best_height: Option<u32>, txdata: &TransactionData,
366 process: FN, funding_outpoint: &OutPoint, monitor_state: &MonitorHolder<ChannelSigner>
367 ) -> Result<(), ()> where FN: Fn(&ChannelMonitor<ChannelSigner>, &TransactionData) -> Vec<TransactionOutputs> {
368 let monitor = &monitor_state.monitor;
369 let logger = WithChannelMonitor::from(&self.logger, &monitor);
372 txn_outputs = process(monitor, txdata);
373 let chain_sync_update_id = self.sync_persistence_id.get_increment();
374 let update_id = MonitorUpdateId {
375 contents: UpdateOrigin::ChainSync(chain_sync_update_id),
377 let mut pending_monitor_updates = monitor_state.pending_monitor_updates.lock().unwrap();
378 if let Some(height) = best_height {
379 if !monitor_state.has_pending_chainsync_updates(&pending_monitor_updates) {
380 // If there are not ChainSync persists awaiting completion, go ahead and
381 // set last_chain_persist_height here - we wouldn't want the first
382 // InProgress to always immediately be considered "overly delayed".
383 monitor_state.last_chain_persist_height.store(height as usize, Ordering::Release);
387 log_trace!(logger, "Syncing Channel Monitor for channel {} for block-data update_id {}",
388 log_funding_info!(monitor),
391 match self.persister.update_persisted_channel(*funding_outpoint, None, monitor, update_id) {
392 ChannelMonitorUpdateStatus::Completed =>
393 log_trace!(logger, "Finished syncing Channel Monitor for channel {} for block-data update_id {}",
394 log_funding_info!(monitor),
397 ChannelMonitorUpdateStatus::InProgress => {
398 log_debug!(logger, "Channel Monitor sync for channel {} in progress, holding events until completion!", log_funding_info!(monitor));
399 pending_monitor_updates.push(update_id);
401 ChannelMonitorUpdateStatus::UnrecoverableError => {
407 // Register any new outputs with the chain source for filtering, storing any dependent
408 // transactions from within the block that previously had not been included in txdata.
409 if let Some(ref chain_source) = self.chain_source {
410 let block_hash = header.block_hash();
411 for (txid, mut outputs) in txn_outputs.drain(..) {
412 for (idx, output) in outputs.drain(..) {
413 // Register any new outputs with the chain source for filtering
414 let output = WatchedOutput {
415 block_hash: Some(block_hash),
416 outpoint: OutPoint { txid, index: idx as u16 },
417 script_pubkey: output.script_pubkey,
419 log_trace!(logger, "Adding monitoring for spends of outpoint {} to the filter", output.outpoint);
420 chain_source.register_output(output);
427 /// Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
429 /// When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
430 /// will call back to it indicating transactions and outputs of interest. This allows clients to
431 /// pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
432 /// always need to fetch full blocks absent another means for determining which blocks contain
433 /// transactions relevant to the watched channels.
434 pub fn new(chain_source: Option<C>, broadcaster: T, logger: L, feeest: F, persister: P) -> Self {
436 monitors: RwLock::new(new_hash_map()),
437 sync_persistence_id: AtomicCounter::new(),
441 fee_estimator: feeest,
443 pending_monitor_events: Mutex::new(Vec::new()),
444 highest_chain_height: AtomicUsize::new(0),
445 event_notifier: Notifier::new(),
449 /// Gets the balances in the contained [`ChannelMonitor`]s which are claimable on-chain or
450 /// claims which are awaiting confirmation.
452 /// Includes the balances from each [`ChannelMonitor`] *except* those included in
453 /// `ignored_channels`, allowing you to filter out balances from channels which are still open
454 /// (and whose balance should likely be pulled from the [`ChannelDetails`]).
456 /// See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for
457 /// inclusion in the return value.
458 pub fn get_claimable_balances(&self, ignored_channels: &[&ChannelDetails]) -> Vec<Balance> {
459 let mut ret = Vec::new();
460 let monitor_states = self.monitors.read().unwrap();
461 for (_, monitor_state) in monitor_states.iter().filter(|(funding_outpoint, _)| {
462 for chan in ignored_channels {
463 if chan.funding_txo.as_ref() == Some(funding_outpoint) {
469 ret.append(&mut monitor_state.monitor.get_claimable_balances());
474 /// Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
475 /// such [`ChannelMonitor`] is currently being monitored for.
477 /// Note that the result holds a mutex over our monitor set, and should not be held
479 pub fn get_monitor(&self, funding_txo: OutPoint) -> Result<LockedChannelMonitor<'_, ChannelSigner>, ()> {
480 let lock = self.monitors.read().unwrap();
481 if lock.get(&funding_txo).is_some() {
482 Ok(LockedChannelMonitor { lock, funding_txo })
488 /// Lists the funding outpoint and channel ID of each [`ChannelMonitor`] being monitored.
490 /// Note that [`ChannelMonitor`]s are not removed when a channel is closed as they are always
491 /// monitoring for on-chain state resolutions.
492 pub fn list_monitors(&self) -> Vec<(OutPoint, ChannelId)> {
493 self.monitors.read().unwrap().iter().map(|(outpoint, monitor_holder)| {
494 let channel_id = monitor_holder.monitor.channel_id();
495 (*outpoint, channel_id)
499 #[cfg(not(c_bindings))]
500 /// Lists the pending updates for each [`ChannelMonitor`] (by `OutPoint` being monitored).
501 pub fn list_pending_monitor_updates(&self) -> HashMap<OutPoint, Vec<MonitorUpdateId>> {
502 hash_map_from_iter(self.monitors.read().unwrap().iter().map(|(outpoint, holder)| {
503 (*outpoint, holder.pending_monitor_updates.lock().unwrap().clone())
508 /// Lists the pending updates for each [`ChannelMonitor`] (by `OutPoint` being monitored).
509 pub fn list_pending_monitor_updates(&self) -> Vec<(OutPoint, Vec<MonitorUpdateId>)> {
510 self.monitors.read().unwrap().iter().map(|(outpoint, holder)| {
511 (*outpoint, holder.pending_monitor_updates.lock().unwrap().clone())
517 pub fn remove_monitor(&self, funding_txo: &OutPoint) -> ChannelMonitor<ChannelSigner> {
518 self.monitors.write().unwrap().remove(funding_txo).unwrap().monitor
521 /// Indicates the persistence of a [`ChannelMonitor`] has completed after
522 /// [`ChannelMonitorUpdateStatus::InProgress`] was returned from an update operation.
524 /// Thus, the anticipated use is, at a high level:
525 /// 1) This [`ChainMonitor`] calls [`Persist::update_persisted_channel`] which stores the
526 /// update to disk and begins updating any remote (e.g. watchtower/backup) copies,
527 /// returning [`ChannelMonitorUpdateStatus::InProgress`],
528 /// 2) once all remote copies are updated, you call this function with the
529 /// `completed_update_id` that completed, and once all pending updates have completed the
530 /// channel will be re-enabled.
531 // Note that we re-enable only after `UpdateOrigin::OffChain` updates complete, we don't
532 // care about `UpdateOrigin::ChainSync` updates for the channel state being updated. We
533 // only care about `UpdateOrigin::ChainSync` for returning `MonitorEvent`s.
535 /// Returns an [`APIError::APIMisuseError`] if `funding_txo` does not match any currently
536 /// registered [`ChannelMonitor`]s.
537 pub fn channel_monitor_updated(&self, funding_txo: OutPoint, completed_update_id: MonitorUpdateId) -> Result<(), APIError> {
538 let monitors = self.monitors.read().unwrap();
539 let monitor_data = if let Some(mon) = monitors.get(&funding_txo) { mon } else {
540 return Err(APIError::APIMisuseError { err: format!("No ChannelMonitor matching funding outpoint {:?} found", funding_txo) });
542 let mut pending_monitor_updates = monitor_data.pending_monitor_updates.lock().unwrap();
543 pending_monitor_updates.retain(|update_id| *update_id != completed_update_id);
545 match completed_update_id {
546 MonitorUpdateId { contents: UpdateOrigin::OffChain(completed_update_id) } => {
547 // Note that we only check for `UpdateOrigin::OffChain` failures here - if
548 // we're being told that a `UpdateOrigin::OffChain` monitor update completed,
549 // we only care about ensuring we don't tell the `ChannelManager` to restore
550 // the channel to normal operation until all `UpdateOrigin::OffChain` updates
552 // If there's some `UpdateOrigin::ChainSync` update still pending that's okay
553 // - we can still update our channel state, just as long as we don't return
554 // `MonitorEvent`s from the monitor back to the `ChannelManager` until they
556 let monitor_is_pending_updates = monitor_data.has_pending_offchain_updates(&pending_monitor_updates);
557 log_debug!(self.logger, "Completed off-chain monitor update {} for channel with funding outpoint {:?}, {}",
560 if monitor_is_pending_updates {
561 "still have pending off-chain updates"
563 "all off-chain updates complete, returning a MonitorEvent"
565 if monitor_is_pending_updates {
566 // If there are still monitor updates pending, we cannot yet construct a
570 let channel_id = monitor_data.monitor.channel_id();
571 self.pending_monitor_events.lock().unwrap().push((funding_txo, channel_id, vec![MonitorEvent::Completed {
572 funding_txo, channel_id,
573 monitor_update_id: monitor_data.monitor.get_latest_update_id(),
574 }], monitor_data.monitor.get_counterparty_node_id()));
576 MonitorUpdateId { contents: UpdateOrigin::ChainSync(completed_update_id) } => {
577 let monitor_has_pending_updates =
578 monitor_data.has_pending_chainsync_updates(&pending_monitor_updates);
579 log_debug!(self.logger, "Completed chain sync monitor update {} for channel with funding outpoint {:?}, {}",
582 if monitor_has_pending_updates {
583 "still have pending chain sync updates"
585 "all chain sync updates complete, releasing pending MonitorEvents"
587 if !monitor_has_pending_updates {
588 monitor_data.last_chain_persist_height.store(self.highest_chain_height.load(Ordering::Acquire), Ordering::Release);
589 // The next time release_pending_monitor_events is called, any events for this
590 // ChannelMonitor will be returned.
594 self.event_notifier.notify();
598 /// This wrapper avoids having to update some of our tests for now as they assume the direct
599 /// chain::Watch API wherein we mark a monitor fully-updated by just calling
600 /// channel_monitor_updated once with the highest ID.
601 #[cfg(any(test, fuzzing))]
602 pub fn force_channel_monitor_updated(&self, funding_txo: OutPoint, monitor_update_id: u64) {
603 let monitors = self.monitors.read().unwrap();
604 let (counterparty_node_id, channel_id) = if let Some(m) = monitors.get(&funding_txo) {
605 (m.monitor.get_counterparty_node_id(), m.monitor.channel_id())
607 (None, ChannelId::v1_from_funding_outpoint(funding_txo))
609 self.pending_monitor_events.lock().unwrap().push((funding_txo, channel_id, vec![MonitorEvent::Completed {
613 }], counterparty_node_id));
614 self.event_notifier.notify();
617 #[cfg(any(test, feature = "_test_utils"))]
618 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
619 use crate::events::EventsProvider;
620 let events = core::cell::RefCell::new(Vec::new());
621 let event_handler = |event: events::Event| events.borrow_mut().push(event);
622 self.process_pending_events(&event_handler);
626 /// Processes any events asynchronously in the order they were generated since the last call
627 /// using the given event handler.
629 /// See the trait-level documentation of [`EventsProvider`] for requirements.
631 /// [`EventsProvider`]: crate::events::EventsProvider
632 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
635 // Sadly we can't hold the monitors read lock through an async call. Thus we have to do a
636 // crazy dance to process a monitor's events then only remove them once we've done so.
637 let mons_to_process = self.monitors.read().unwrap().keys().cloned().collect::<Vec<_>>();
638 for funding_txo in mons_to_process {
640 super::channelmonitor::process_events_body!(
641 self.monitors.read().unwrap().get(&funding_txo).map(|m| &m.monitor), ev, handler(ev).await);
645 /// Gets a [`Future`] that completes when an event is available either via
646 /// [`chain::Watch::release_pending_monitor_events`] or
647 /// [`EventsProvider::process_pending_events`].
649 /// Note that callbacks registered on the [`Future`] MUST NOT call back into this
650 /// [`ChainMonitor`] and should instead register actions to be taken later.
652 /// [`EventsProvider::process_pending_events`]: crate::events::EventsProvider::process_pending_events
653 pub fn get_update_future(&self) -> Future {
654 self.event_notifier.get_future()
657 /// Triggers rebroadcasts/fee-bumps of pending claims from a force-closed channel. This is
658 /// crucial in preventing certain classes of pinning attacks, detecting substantial mempool
659 /// feerate changes between blocks, and ensuring reliability if broadcasting fails. We recommend
660 /// invoking this every 30 seconds, or lower if running in an environment with spotty
661 /// connections, like on mobile.
662 pub fn rebroadcast_pending_claims(&self) {
663 let monitors = self.monitors.read().unwrap();
664 for (_, monitor_holder) in &*monitors {
665 monitor_holder.monitor.rebroadcast_pending_claims(
666 &*self.broadcaster, &*self.fee_estimator, &self.logger
671 /// Triggers rebroadcasts of pending claims from force-closed channels after a transaction
672 /// signature generation failure.
674 /// `monitor_opt` can be used as a filter to only trigger them for a specific channel monitor.
675 pub fn signer_unblocked(&self, monitor_opt: Option<OutPoint>) {
676 let monitors = self.monitors.read().unwrap();
677 if let Some(funding_txo) = monitor_opt {
678 if let Some(monitor_holder) = monitors.get(&funding_txo) {
679 monitor_holder.monitor.signer_unblocked(
680 &*self.broadcaster, &*self.fee_estimator, &self.logger
684 for (_, monitor_holder) in &*monitors {
685 monitor_holder.monitor.signer_unblocked(
686 &*self.broadcaster, &*self.fee_estimator, &self.logger
692 /// Archives fully resolved channel monitors by calling [`Persist::archive_persisted_channel`].
694 /// This is useful for pruning fully resolved monitors from the monitor set and primary
695 /// storage so they are not kept in memory and reloaded on restart.
697 /// Should be called occasionally (once every handful of blocks or on startup).
699 /// Depending on the implementation of [`Persist::archive_persisted_channel`] the monitor
700 /// data could be moved to an archive location or removed entirely.
701 pub fn archive_fully_resolved_channel_monitors(&self) {
702 let mut have_monitors_to_prune = false;
703 for (_, monitor_holder) in self.monitors.read().unwrap().iter() {
704 let logger = WithChannelMonitor::from(&self.logger, &monitor_holder.monitor);
705 if monitor_holder.monitor.is_fully_resolved(&logger) {
706 have_monitors_to_prune = true;
709 if have_monitors_to_prune {
710 let mut monitors = self.monitors.write().unwrap();
711 monitors.retain(|funding_txo, monitor_holder| {
712 let logger = WithChannelMonitor::from(&self.logger, &monitor_holder.monitor);
713 if monitor_holder.monitor.is_fully_resolved(&logger) {
715 "Archiving fully resolved ChannelMonitor for funding txo {}",
718 self.persister.archive_persisted_channel(*funding_txo);
728 impl<ChannelSigner: WriteableEcdsaChannelSigner, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref>
729 chain::Listen for ChainMonitor<ChannelSigner, C, T, F, L, P>
731 C::Target: chain::Filter,
732 T::Target: BroadcasterInterface,
733 F::Target: FeeEstimator,
735 P::Target: Persist<ChannelSigner>,
737 fn filtered_block_connected(&self, header: &Header, txdata: &TransactionData, height: u32) {
738 log_debug!(self.logger, "New best block {} at height {} provided via block_connected", header.block_hash(), height);
739 self.process_chain_data(header, Some(height), &txdata, |monitor, txdata| {
740 monitor.block_connected(
741 header, txdata, height, &*self.broadcaster, &*self.fee_estimator, &self.logger)
743 // Assume we may have some new events and wake the event processor
744 self.event_notifier.notify();
747 fn block_disconnected(&self, header: &Header, height: u32) {
748 let monitor_states = self.monitors.read().unwrap();
749 log_debug!(self.logger, "Latest block {} at height {} removed via block_disconnected", header.block_hash(), height);
750 for monitor_state in monitor_states.values() {
751 monitor_state.monitor.block_disconnected(
752 header, height, &*self.broadcaster, &*self.fee_estimator, &self.logger);
757 impl<ChannelSigner: WriteableEcdsaChannelSigner, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref>
758 chain::Confirm for ChainMonitor<ChannelSigner, C, T, F, L, P>
760 C::Target: chain::Filter,
761 T::Target: BroadcasterInterface,
762 F::Target: FeeEstimator,
764 P::Target: Persist<ChannelSigner>,
766 fn transactions_confirmed(&self, header: &Header, txdata: &TransactionData, height: u32) {
767 log_debug!(self.logger, "{} provided transactions confirmed at height {} in block {}", txdata.len(), height, header.block_hash());
768 self.process_chain_data(header, None, txdata, |monitor, txdata| {
769 monitor.transactions_confirmed(
770 header, txdata, height, &*self.broadcaster, &*self.fee_estimator, &self.logger)
772 // Assume we may have some new events and wake the event processor
773 self.event_notifier.notify();
776 fn transaction_unconfirmed(&self, txid: &Txid) {
777 log_debug!(self.logger, "Transaction {} reorganized out of chain", txid);
778 let monitor_states = self.monitors.read().unwrap();
779 for monitor_state in monitor_states.values() {
780 monitor_state.monitor.transaction_unconfirmed(txid, &*self.broadcaster, &*self.fee_estimator, &self.logger);
784 fn best_block_updated(&self, header: &Header, height: u32) {
785 log_debug!(self.logger, "New best block {} at height {} provided via best_block_updated", header.block_hash(), height);
786 self.process_chain_data(header, Some(height), &[], |monitor, txdata| {
787 // While in practice there shouldn't be any recursive calls when given empty txdata,
788 // it's still possible if a chain::Filter implementation returns a transaction.
789 debug_assert!(txdata.is_empty());
790 monitor.best_block_updated(
791 header, height, &*self.broadcaster, &*self.fee_estimator, &self.logger
794 // Assume we may have some new events and wake the event processor
795 self.event_notifier.notify();
798 fn get_relevant_txids(&self) -> Vec<(Txid, u32, Option<BlockHash>)> {
799 let mut txids = Vec::new();
800 let monitor_states = self.monitors.read().unwrap();
801 for monitor_state in monitor_states.values() {
802 txids.append(&mut monitor_state.monitor.get_relevant_txids());
805 txids.sort_unstable_by(|a, b| a.0.cmp(&b.0).then(b.1.cmp(&a.1)));
806 txids.dedup_by_key(|(txid, _, _)| *txid);
811 impl<ChannelSigner: WriteableEcdsaChannelSigner, C: Deref , T: Deref , F: Deref , L: Deref , P: Deref >
812 chain::Watch<ChannelSigner> for ChainMonitor<ChannelSigner, C, T, F, L, P>
813 where C::Target: chain::Filter,
814 T::Target: BroadcasterInterface,
815 F::Target: FeeEstimator,
817 P::Target: Persist<ChannelSigner>,
819 fn watch_channel(&self, funding_outpoint: OutPoint, monitor: ChannelMonitor<ChannelSigner>) -> Result<ChannelMonitorUpdateStatus, ()> {
820 let logger = WithChannelMonitor::from(&self.logger, &monitor);
821 let mut monitors = self.monitors.write().unwrap();
822 let entry = match monitors.entry(funding_outpoint) {
823 hash_map::Entry::Occupied(_) => {
824 log_error!(logger, "Failed to add new channel data: channel monitor for given outpoint is already present");
827 hash_map::Entry::Vacant(e) => e,
829 log_trace!(logger, "Got new ChannelMonitor for channel {}", log_funding_info!(monitor));
830 let update_id = MonitorUpdateId::from_new_monitor(&monitor);
831 let mut pending_monitor_updates = Vec::new();
832 let persist_res = self.persister.persist_new_channel(funding_outpoint, &monitor, update_id);
834 ChannelMonitorUpdateStatus::InProgress => {
835 log_info!(logger, "Persistence of new ChannelMonitor for channel {} in progress", log_funding_info!(monitor));
836 pending_monitor_updates.push(update_id);
838 ChannelMonitorUpdateStatus::Completed => {
839 log_info!(logger, "Persistence of new ChannelMonitor for channel {} completed", log_funding_info!(monitor));
841 ChannelMonitorUpdateStatus::UnrecoverableError => {
842 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
843 log_error!(logger, "{}", err_str);
844 panic!("{}", err_str);
847 if let Some(ref chain_source) = self.chain_source {
848 monitor.load_outputs_to_watch(chain_source , &self.logger);
850 entry.insert(MonitorHolder {
852 pending_monitor_updates: Mutex::new(pending_monitor_updates),
853 last_chain_persist_height: AtomicUsize::new(self.highest_chain_height.load(Ordering::Acquire)),
858 fn update_channel(&self, funding_txo: OutPoint, update: &ChannelMonitorUpdate) -> ChannelMonitorUpdateStatus {
859 // `ChannelMonitorUpdate`'s `channel_id` is `None` prior to 0.0.121 and all channels in those
860 // versions are V1-established. For 0.0.121+ the `channel_id` fields is always `Some`.
861 let channel_id = update.channel_id.unwrap_or(ChannelId::v1_from_funding_outpoint(funding_txo));
862 // Update the monitor that watches the channel referred to by the given outpoint.
863 let monitors = self.monitors.read().unwrap();
864 match monitors.get(&funding_txo) {
866 let logger = WithContext::from(&self.logger, update.counterparty_node_id, Some(channel_id));
867 log_error!(logger, "Failed to update channel monitor: no such monitor registered");
869 // We should never ever trigger this from within ChannelManager. Technically a
870 // user could use this object with some proxying in between which makes this
871 // possible, but in tests and fuzzing, this should be a panic.
872 #[cfg(debug_assertions)]
873 panic!("ChannelManager generated a channel update for a channel that was not yet registered!");
874 #[cfg(not(debug_assertions))]
875 ChannelMonitorUpdateStatus::InProgress
877 Some(monitor_state) => {
878 let monitor = &monitor_state.monitor;
879 let logger = WithChannelMonitor::from(&self.logger, &monitor);
880 log_trace!(logger, "Updating ChannelMonitor to id {} for channel {}", update.update_id, log_funding_info!(monitor));
881 let update_res = monitor.update_monitor(update, &self.broadcaster, &self.fee_estimator, &self.logger);
883 let update_id = MonitorUpdateId::from_monitor_update(update);
884 let mut pending_monitor_updates = monitor_state.pending_monitor_updates.lock().unwrap();
885 let persist_res = if update_res.is_err() {
886 // Even if updating the monitor returns an error, the monitor's state will
887 // still be changed. Therefore, we should persist the updated monitor despite the error.
888 // We don't want to persist a `monitor_update` which results in a failure to apply later
889 // while reading `channel_monitor` with updates from storage. Instead, we should persist
890 // the entire `channel_monitor` here.
891 log_warn!(logger, "Failed to update ChannelMonitor for channel {}. Going ahead and persisting the entire ChannelMonitor", log_funding_info!(monitor));
892 self.persister.update_persisted_channel(funding_txo, None, monitor, update_id)
894 self.persister.update_persisted_channel(funding_txo, Some(update), monitor, update_id)
897 ChannelMonitorUpdateStatus::InProgress => {
898 pending_monitor_updates.push(update_id);
900 "Persistence of ChannelMonitorUpdate id {:?} for channel {} in progress",
902 log_funding_info!(monitor)
905 ChannelMonitorUpdateStatus::Completed => {
907 "Persistence of ChannelMonitorUpdate id {:?} for channel {} completed",
909 log_funding_info!(monitor)
912 ChannelMonitorUpdateStatus::UnrecoverableError => {
913 // Take the monitors lock for writing so that we poison it and any future
914 // operations going forward fail immediately.
915 core::mem::drop(pending_monitor_updates);
916 core::mem::drop(monitors);
917 let _poison = self.monitors.write().unwrap();
918 let err_str = "ChannelMonitor[Update] persistence failed unrecoverably. This indicates we cannot continue normal operation and must shut down.";
919 log_error!(logger, "{}", err_str);
920 panic!("{}", err_str);
923 if update_res.is_err() {
924 ChannelMonitorUpdateStatus::InProgress
932 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, Option<PublicKey>)> {
933 let mut pending_monitor_events = self.pending_monitor_events.lock().unwrap().split_off(0);
934 for monitor_state in self.monitors.read().unwrap().values() {
935 let logger = WithChannelMonitor::from(&self.logger, &monitor_state.monitor);
936 let is_pending_monitor_update = monitor_state.has_pending_chainsync_updates(&monitor_state.pending_monitor_updates.lock().unwrap());
937 if !is_pending_monitor_update || monitor_state.last_chain_persist_height.load(Ordering::Acquire) + LATENCY_GRACE_PERIOD_BLOCKS as usize <= self.highest_chain_height.load(Ordering::Acquire) {
938 if is_pending_monitor_update {
939 log_error!(logger, "A ChannelMonitor sync took longer than {} blocks to complete.", LATENCY_GRACE_PERIOD_BLOCKS);
940 log_error!(logger, " To avoid funds-loss, we are allowing monitor updates to be released.");
941 log_error!(logger, " This may cause duplicate payment events to be generated.");
943 let monitor_events = monitor_state.monitor.get_and_clear_pending_monitor_events();
944 if monitor_events.len() > 0 {
945 let monitor_outpoint = monitor_state.monitor.get_funding_txo().0;
946 let monitor_channel_id = monitor_state.monitor.channel_id();
947 let counterparty_node_id = monitor_state.monitor.get_counterparty_node_id();
948 pending_monitor_events.push((monitor_outpoint, monitor_channel_id, monitor_events, counterparty_node_id));
952 pending_monitor_events
956 impl<ChannelSigner: WriteableEcdsaChannelSigner, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref> events::EventsProvider for ChainMonitor<ChannelSigner, C, T, F, L, P>
957 where C::Target: chain::Filter,
958 T::Target: BroadcasterInterface,
959 F::Target: FeeEstimator,
961 P::Target: Persist<ChannelSigner>,
963 /// Processes [`SpendableOutputs`] events produced from each [`ChannelMonitor`] upon maturity.
965 /// For channels featuring anchor outputs, this method will also process [`BumpTransaction`]
966 /// events produced from each [`ChannelMonitor`] while there is a balance to claim onchain
967 /// within each channel. As the confirmation of a commitment transaction may be critical to the
968 /// safety of funds, we recommend invoking this every 30 seconds, or lower if running in an
969 /// environment with spotty connections, like on mobile.
971 /// An [`EventHandler`] may safely call back to the provider, though this shouldn't be needed in
972 /// order to handle these events.
974 /// [`SpendableOutputs`]: events::Event::SpendableOutputs
975 /// [`BumpTransaction`]: events::Event::BumpTransaction
976 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
977 for monitor_state in self.monitors.read().unwrap().values() {
978 monitor_state.monitor.process_pending_events(&handler);
985 use crate::check_added_monitors;
986 use crate::{expect_payment_claimed, expect_payment_path_successful, get_event_msg};
987 use crate::{get_htlc_update_msgs, get_local_commitment_txn, get_revoke_commit_msgs, get_route_and_payment_hash, unwrap_send_err};
988 use crate::chain::{ChannelMonitorUpdateStatus, Confirm, Watch};
989 use crate::chain::channelmonitor::LATENCY_GRACE_PERIOD_BLOCKS;
990 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider};
991 use crate::ln::channelmanager::{PaymentSendFailure, PaymentId, RecipientOnionFields};
992 use crate::ln::functional_test_utils::*;
993 use crate::ln::msgs::ChannelMessageHandler;
994 use crate::util::errors::APIError;
997 fn test_async_ooo_offchain_updates() {
998 // Test that if we have multiple offchain updates being persisted and they complete
999 // out-of-order, the ChainMonitor waits until all have completed before informing the
1001 let chanmon_cfgs = create_chanmon_cfgs(2);
1002 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1003 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1004 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1005 create_announced_chan_between_nodes(&nodes, 0, 1);
1007 // Route two payments to be claimed at the same time.
1008 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1009 let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1011 chanmon_cfgs[1].persister.offchain_monitor_updates.lock().unwrap().clear();
1012 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1013 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1015 nodes[1].node.claim_funds(payment_preimage_1);
1016 check_added_monitors!(nodes[1], 1);
1017 nodes[1].node.claim_funds(payment_preimage_2);
1018 check_added_monitors!(nodes[1], 1);
1020 let persistences = chanmon_cfgs[1].persister.offchain_monitor_updates.lock().unwrap().clone();
1021 assert_eq!(persistences.len(), 1);
1022 let (funding_txo, updates) = persistences.iter().next().unwrap();
1023 assert_eq!(updates.len(), 2);
1025 // Note that updates is a HashMap so the ordering here is actually random. This shouldn't
1026 // fail either way but if it fails intermittently it's depending on the ordering of updates.
1027 let mut update_iter = updates.iter();
1028 let next_update = update_iter.next().unwrap().clone();
1029 // Should contain next_update when pending updates listed.
1030 #[cfg(not(c_bindings))]
1031 assert!(nodes[1].chain_monitor.chain_monitor.list_pending_monitor_updates().get(funding_txo)
1032 .unwrap().contains(&next_update));
1034 assert!(nodes[1].chain_monitor.chain_monitor.list_pending_monitor_updates().iter()
1035 .find(|(txo, _)| txo == funding_txo).unwrap().1.contains(&next_update));
1036 nodes[1].chain_monitor.chain_monitor.channel_monitor_updated(*funding_txo, next_update.clone()).unwrap();
1037 // Should not contain the previously pending next_update when pending updates listed.
1038 #[cfg(not(c_bindings))]
1039 assert!(!nodes[1].chain_monitor.chain_monitor.list_pending_monitor_updates().get(funding_txo)
1040 .unwrap().contains(&next_update));
1042 assert!(!nodes[1].chain_monitor.chain_monitor.list_pending_monitor_updates().iter()
1043 .find(|(txo, _)| txo == funding_txo).unwrap().1.contains(&next_update));
1044 assert!(nodes[1].chain_monitor.release_pending_monitor_events().is_empty());
1045 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1046 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
1047 nodes[1].chain_monitor.chain_monitor.channel_monitor_updated(*funding_txo, update_iter.next().unwrap().clone()).unwrap();
1049 let claim_events = nodes[1].node.get_and_clear_pending_events();
1050 assert_eq!(claim_events.len(), 2);
1051 match claim_events[0] {
1052 Event::PaymentClaimed { ref payment_hash, amount_msat: 1_000_000, .. } => {
1053 assert_eq!(payment_hash_1, *payment_hash);
1055 _ => panic!("Unexpected event"),
1057 match claim_events[1] {
1058 Event::PaymentClaimed { ref payment_hash, amount_msat: 1_000_000, .. } => {
1059 assert_eq!(payment_hash_2, *payment_hash);
1061 _ => panic!("Unexpected event"),
1064 // Now manually walk the commitment signed dance - because we claimed two payments
1065 // back-to-back it doesn't fit into the neat walk commitment_signed_dance does.
1067 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1068 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1069 expect_payment_sent(&nodes[0], payment_preimage_1, None, false, false);
1070 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
1071 check_added_monitors!(nodes[0], 1);
1072 let (as_first_raa, as_first_update) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1074 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
1075 check_added_monitors!(nodes[1], 1);
1076 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1077 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_update);
1078 check_added_monitors!(nodes[1], 1);
1079 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1081 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
1082 expect_payment_sent(&nodes[0], payment_preimage_2, None, false, false);
1083 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
1084 check_added_monitors!(nodes[0], 1);
1085 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
1086 expect_payment_path_successful!(nodes[0]);
1087 check_added_monitors!(nodes[0], 1);
1088 let (as_second_raa, as_second_update) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1090 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
1091 check_added_monitors!(nodes[1], 1);
1092 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update);
1093 check_added_monitors!(nodes[1], 1);
1094 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1096 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
1097 expect_payment_path_successful!(nodes[0]);
1098 check_added_monitors!(nodes[0], 1);
1101 fn do_chainsync_pauses_events(block_timeout: bool) {
1102 // When a chainsync monitor update occurs, any MonitorUpdates should be held before being
1103 // passed upstream to a `ChannelManager` via `Watch::release_pending_monitor_events`. This
1104 // tests that behavior, as well as some ways it might go wrong.
1105 let chanmon_cfgs = create_chanmon_cfgs(2);
1106 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1107 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1108 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1109 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1111 // Get a route for later and rebalance the channel somewhat
1112 send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
1113 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
1115 // First route a payment that we will claim on chain and give the recipient the preimage.
1116 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
1117 nodes[1].node.claim_funds(payment_preimage);
1118 expect_payment_claimed!(nodes[1], payment_hash, 1_000_000);
1119 nodes[1].node.get_and_clear_pending_msg_events();
1120 check_added_monitors!(nodes[1], 1);
1121 let remote_txn = get_local_commitment_txn!(nodes[1], channel.2);
1122 assert_eq!(remote_txn.len(), 2);
1124 // Temp-fail the block connection which will hold the channel-closed event
1125 chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
1126 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1128 // Connect B's commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
1129 // channel is now closed, but the ChannelManager doesn't know that yet.
1130 let new_header = create_dummy_header(nodes[0].best_block_info().0, 0);
1131 nodes[0].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
1132 &[(0, &remote_txn[0]), (1, &remote_txn[1])], nodes[0].best_block_info().1 + 1);
1133 assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
1134 nodes[0].chain_monitor.chain_monitor.best_block_updated(&new_header, nodes[0].best_block_info().1 + 1);
1135 assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
1137 // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
1138 // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
1139 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
1140 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, second_payment_hash,
1141 RecipientOnionFields::secret_only(second_payment_secret), PaymentId(second_payment_hash.0)
1142 ), false, APIError::MonitorUpdateInProgress, {});
1143 check_added_monitors!(nodes[0], 1);
1145 // However, as the ChainMonitor is still waiting for the original persistence to complete,
1146 // it won't yet release the MonitorEvents.
1147 assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
1150 // After three blocks, pending MontiorEvents should be released either way.
1151 let latest_header = create_dummy_header(nodes[0].best_block_info().0, 0);
1152 nodes[0].chain_monitor.chain_monitor.best_block_updated(&latest_header, nodes[0].best_block_info().1 + LATENCY_GRACE_PERIOD_BLOCKS);
1154 let persistences = chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clone();
1155 for (funding_outpoint, update_ids) in persistences {
1156 for update_id in update_ids {
1157 nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(funding_outpoint, update_id).unwrap();
1162 expect_payment_sent(&nodes[0], payment_preimage, None, true, false);
1166 fn chainsync_pauses_events() {
1167 do_chainsync_pauses_events(false);
1168 do_chainsync_pauses_events(true);
1172 #[cfg(feature = "std")]
1173 fn update_during_chainsync_poisons_channel() {
1174 let chanmon_cfgs = create_chanmon_cfgs(2);
1175 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1176 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1177 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1178 create_announced_chan_between_nodes(&nodes, 0, 1);
1180 chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
1181 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::UnrecoverableError);
1183 assert!(std::panic::catch_unwind(|| {
1184 // Returning an UnrecoverableError should always panic immediately
1185 connect_blocks(&nodes[0], 1);
1187 assert!(std::panic::catch_unwind(|| {
1188 // ...and also poison our locks causing later use to panic as well
1189 core::mem::drop(nodes);