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::BlockHeader;
27 use bitcoin::hash_types::Txid;
30 use chain::{ChannelMonitorUpdateStatus, Filter, WatchedOutput};
31 use chain::chaininterface::{BroadcasterInterface, FeeEstimator};
32 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, Balance, MonitorEvent, TransactionOutputs, LATENCY_GRACE_PERIOD_BLOCKS};
33 use chain::transaction::{OutPoint, TransactionData};
34 use chain::keysinterface::Sign;
35 use util::atomic_counter::AtomicCounter;
36 use util::logger::Logger;
37 use util::errors::APIError;
39 use util::events::EventHandler;
40 use ln::channelmanager::ChannelDetails;
43 use sync::{RwLock, RwLockReadGuard, Mutex, MutexGuard};
45 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
46 use bitcoin::secp256k1::PublicKey;
48 #[derive(Clone, Copy, Hash, PartialEq, Eq)]
49 /// A specific update's ID stored in a `MonitorUpdateId`, separated out to make the contents
52 /// An update that was generated by the `ChannelManager` (via our `chain::Watch`
53 /// implementation). This corresponds to an actual [`ChannelMonitorUpdate::update_id`] field
54 /// and [`ChannelMonitor::get_latest_update_id`].
56 /// An update that was generated during blockchain processing. The ID here is specific to the
57 /// generating [`ChainMonitor`] and does *not* correspond to any on-disk IDs.
61 /// An opaque identifier describing a specific [`Persist`] method call.
62 #[derive(Clone, Copy, Hash, PartialEq, Eq)]
63 pub struct MonitorUpdateId {
64 contents: UpdateOrigin,
67 impl MonitorUpdateId {
68 pub(crate) fn from_monitor_update(update: &ChannelMonitorUpdate) -> Self {
69 Self { contents: UpdateOrigin::OffChain(update.update_id) }
71 pub(crate) fn from_new_monitor<ChannelSigner: Sign>(monitor: &ChannelMonitor<ChannelSigner>) -> Self {
72 Self { contents: UpdateOrigin::OffChain(monitor.get_latest_update_id()) }
76 /// `Persist` defines behavior for persisting channel monitors: this could mean
77 /// writing once to disk, and/or uploading to one or more backup services.
79 /// Each method can return three possible values:
80 /// * If persistence (including any relevant `fsync()` calls) happens immediately, the
81 /// implementation should return [`ChannelMonitorUpdateStatus::Completed`], indicating normal
82 /// channel operation should continue.
83 /// * If persistence happens asynchronously, implementations should first ensure the
84 /// [`ChannelMonitor`] or [`ChannelMonitorUpdate`] are written durably to disk, and then return
85 /// [`ChannelMonitorUpdateStatus::InProgress`] while the update continues in the background.
86 /// Once the update completes, [`ChainMonitor::channel_monitor_updated`] should be called with
87 /// the corresponding [`MonitorUpdateId`].
89 /// Note that unlike the direct [`chain::Watch`] interface,
90 /// [`ChainMonitor::channel_monitor_updated`] must be called once for *each* update which occurs.
92 /// * If persistence fails for some reason, implementations should return
93 /// [`ChannelMonitorUpdateStatus::PermanentFailure`], in which case the channel will likely be
94 /// closed without broadcasting the latest state. See
95 /// [`ChannelMonitorUpdateStatus::PermanentFailure`] for more details.
96 pub trait Persist<ChannelSigner: Sign> {
97 /// Persist a new channel's data in response to a [`chain::Watch::watch_channel`] call. This is
98 /// called by [`ChannelManager`] for new channels, or may be called directly, e.g. on startup.
100 /// The data can be stored any way you want, but the identifier provided by LDK is the
101 /// channel's outpoint (and it is up to you to maintain a correct mapping between the outpoint
102 /// and the stored channel data). Note that you **must** persist every new monitor to disk.
104 /// The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
105 /// if you return [`ChannelMonitorUpdateStatus::InProgress`].
107 /// See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`
108 /// and [`ChannelMonitorUpdateStatus`] for requirements when returning errors.
110 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
111 /// [`Writeable::write`]: crate::util::ser::Writeable::write
112 fn persist_new_channel(&self, channel_id: OutPoint, data: &ChannelMonitor<ChannelSigner>, update_id: MonitorUpdateId) -> ChannelMonitorUpdateStatus;
114 /// Update one channel's data. The provided [`ChannelMonitor`] has already applied the given
117 /// Note that on every update, you **must** persist either the [`ChannelMonitorUpdate`] or the
118 /// updated monitor itself to disk/backups. See the [`Persist`] trait documentation for more
121 /// During blockchain synchronization operations, this may be called with no
122 /// [`ChannelMonitorUpdate`], in which case the full [`ChannelMonitor`] needs to be persisted.
123 /// Note that after the full [`ChannelMonitor`] is persisted any previous
124 /// [`ChannelMonitorUpdate`]s which were persisted should be discarded - they can no longer be
125 /// applied to the persisted [`ChannelMonitor`] as they were already applied.
127 /// If an implementer chooses to persist the updates only, they need to make
128 /// sure that all the updates are applied to the `ChannelMonitors` *before*
129 /// the set of channel monitors is given to the `ChannelManager`
130 /// deserialization routine. See [`ChannelMonitor::update_monitor`] for
131 /// applying a monitor update to a monitor. If full `ChannelMonitors` are
132 /// persisted, then there is no need to persist individual updates.
134 /// Note that there could be a performance tradeoff between persisting complete
135 /// channel monitors on every update vs. persisting only updates and applying
136 /// them in batches. The size of each monitor grows `O(number of state updates)`
137 /// whereas updates are small and `O(1)`.
139 /// The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
140 /// if you return [`ChannelMonitorUpdateStatus::InProgress`].
142 /// See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`,
143 /// [`Writeable::write`] on [`ChannelMonitorUpdate`] for writing out an update, and
144 /// [`ChannelMonitorUpdateStatus`] for requirements when returning errors.
146 /// [`Writeable::write`]: crate::util::ser::Writeable::write
147 fn update_persisted_channel(&self, channel_id: OutPoint, update: &Option<ChannelMonitorUpdate>, data: &ChannelMonitor<ChannelSigner>, update_id: MonitorUpdateId) -> ChannelMonitorUpdateStatus;
150 struct MonitorHolder<ChannelSigner: Sign> {
151 monitor: ChannelMonitor<ChannelSigner>,
152 /// The full set of pending monitor updates for this Channel.
154 /// Note that this lock must be held during updates to prevent a race where we call
155 /// update_persisted_channel, the user returns a
156 /// [`ChannelMonitorUpdateStatus::InProgress`], and then calls channel_monitor_updated
157 /// immediately, racing our insertion of the pending update into the contained Vec.
159 /// Beyond the synchronization of updates themselves, we cannot handle user events until after
160 /// any chain updates have been stored on disk. Thus, we scan this list when returning updates
161 /// to the ChannelManager, refusing to return any updates for a ChannelMonitor which is still
162 /// being persisted fully to disk after a chain update.
164 /// This avoids the possibility of handling, e.g. an on-chain claim, generating a claim monitor
165 /// event, resulting in the relevant ChannelManager generating a PaymentSent event and dropping
166 /// the pending payment entry, and then reloading before the monitor is persisted, resulting in
167 /// the ChannelManager re-adding the same payment entry, before the same block is replayed,
168 /// resulting in a duplicate PaymentSent event.
169 pending_monitor_updates: Mutex<Vec<MonitorUpdateId>>,
170 /// When the user returns a PermanentFailure error from an update_persisted_channel call during
171 /// block processing, we inform the ChannelManager that the channel should be closed
172 /// asynchronously. In order to ensure no further changes happen before the ChannelManager has
173 /// processed the closure event, we set this to true and return PermanentFailure for any other
174 /// chain::Watch events.
175 channel_perm_failed: AtomicBool,
176 /// The last block height at which no [`UpdateOrigin::ChainSync`] monitor updates were present
177 /// in `pending_monitor_updates`.
178 /// If it's been more than [`LATENCY_GRACE_PERIOD_BLOCKS`] since we started waiting on a chain
179 /// sync event, we let monitor events return to `ChannelManager` because we cannot hold them up
180 /// forever or we'll end up with HTLC preimages waiting to feed back into an upstream channel
181 /// forever, risking funds loss.
182 last_chain_persist_height: AtomicUsize,
185 impl<ChannelSigner: Sign> MonitorHolder<ChannelSigner> {
186 fn has_pending_offchain_updates(&self, pending_monitor_updates_lock: &MutexGuard<Vec<MonitorUpdateId>>) -> bool {
187 pending_monitor_updates_lock.iter().any(|update_id|
188 if let UpdateOrigin::OffChain(_) = update_id.contents { true } else { false })
190 fn has_pending_chainsync_updates(&self, pending_monitor_updates_lock: &MutexGuard<Vec<MonitorUpdateId>>) -> bool {
191 pending_monitor_updates_lock.iter().any(|update_id|
192 if let UpdateOrigin::ChainSync(_) = update_id.contents { true } else { false })
196 /// A read-only reference to a current ChannelMonitor.
198 /// Note that this holds a mutex in [`ChainMonitor`] and may block other events until it is
200 pub struct LockedChannelMonitor<'a, ChannelSigner: Sign> {
201 lock: RwLockReadGuard<'a, HashMap<OutPoint, MonitorHolder<ChannelSigner>>>,
202 funding_txo: OutPoint,
205 impl<ChannelSigner: Sign> Deref for LockedChannelMonitor<'_, ChannelSigner> {
206 type Target = ChannelMonitor<ChannelSigner>;
207 fn deref(&self) -> &ChannelMonitor<ChannelSigner> {
208 &self.lock.get(&self.funding_txo).expect("Checked at construction").monitor
212 /// An implementation of [`chain::Watch`] for monitoring channels.
214 /// Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
215 /// [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
216 /// or used independently to monitor channels remotely. See the [module-level documentation] for
219 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
220 /// [module-level documentation]: crate::chain::chainmonitor
221 pub struct ChainMonitor<ChannelSigner: Sign, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref>
222 where C::Target: chain::Filter,
223 T::Target: BroadcasterInterface,
224 F::Target: FeeEstimator,
226 P::Target: Persist<ChannelSigner>,
228 monitors: RwLock<HashMap<OutPoint, MonitorHolder<ChannelSigner>>>,
229 /// When we generate a [`MonitorUpdateId`] for a chain-event monitor persistence, we need a
230 /// unique ID, which we calculate by simply getting the next value from this counter. Note that
231 /// the ID is never persisted so it's ok that they reset on restart.
232 sync_persistence_id: AtomicCounter,
233 chain_source: Option<C>,
238 /// "User-provided" (ie persistence-completion/-failed) [`MonitorEvent`]s. These came directly
239 /// from the user and not from a [`ChannelMonitor`].
240 pending_monitor_events: Mutex<Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)>>,
241 /// The best block height seen, used as a proxy for the passage of time.
242 highest_chain_height: AtomicUsize,
245 impl<ChannelSigner: Sign, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref> ChainMonitor<ChannelSigner, C, T, F, L, P>
246 where C::Target: chain::Filter,
247 T::Target: BroadcasterInterface,
248 F::Target: FeeEstimator,
250 P::Target: Persist<ChannelSigner>,
252 /// Dispatches to per-channel monitors, which are responsible for updating their on-chain view
253 /// of a channel and reacting accordingly based on transactions in the given chain data. See
254 /// [`ChannelMonitor::block_connected`] for details. Any HTLCs that were resolved on chain will
255 /// be returned by [`chain::Watch::release_pending_monitor_events`].
257 /// Calls back to [`chain::Filter`] if any monitor indicated new outputs to watch. Subsequent
258 /// calls must not exclude any transactions matching the new outputs nor any in-block
259 /// descendants of such transactions. It is not necessary to re-fetch the block to obtain
260 /// updated `txdata`.
262 /// Calls which represent a new blockchain tip height should set `best_height`.
263 fn process_chain_data<FN>(&self, header: &BlockHeader, best_height: Option<u32>, txdata: &TransactionData, process: FN)
265 FN: Fn(&ChannelMonitor<ChannelSigner>, &TransactionData) -> Vec<TransactionOutputs>
267 let monitor_states = self.monitors.write().unwrap();
268 if let Some(height) = best_height {
269 // If the best block height is being updated, update highest_chain_height under the
270 // monitors write lock.
271 let old_height = self.highest_chain_height.load(Ordering::Acquire);
272 let new_height = height as usize;
273 if new_height > old_height {
274 self.highest_chain_height.store(new_height, Ordering::Release);
278 for (funding_outpoint, monitor_state) in monitor_states.iter() {
279 let monitor = &monitor_state.monitor;
282 txn_outputs = process(monitor, txdata);
283 let update_id = MonitorUpdateId {
284 contents: UpdateOrigin::ChainSync(self.sync_persistence_id.get_increment()),
286 let mut pending_monitor_updates = monitor_state.pending_monitor_updates.lock().unwrap();
287 if let Some(height) = best_height {
288 if !monitor_state.has_pending_chainsync_updates(&pending_monitor_updates) {
289 // If there are not ChainSync persists awaiting completion, go ahead and
290 // set last_chain_persist_height here - we wouldn't want the first
291 // InProgress to always immediately be considered "overly delayed".
292 monitor_state.last_chain_persist_height.store(height as usize, Ordering::Release);
296 log_trace!(self.logger, "Syncing Channel Monitor for channel {}", log_funding_info!(monitor));
297 match self.persister.update_persisted_channel(*funding_outpoint, &None, monitor, update_id) {
298 ChannelMonitorUpdateStatus::Completed =>
299 log_trace!(self.logger, "Finished syncing Channel Monitor for channel {}", log_funding_info!(monitor)),
300 ChannelMonitorUpdateStatus::PermanentFailure => {
301 monitor_state.channel_perm_failed.store(true, Ordering::Release);
302 self.pending_monitor_events.lock().unwrap().push((*funding_outpoint, vec![MonitorEvent::UpdateFailed(*funding_outpoint)], monitor.get_counterparty_node_id()));
304 ChannelMonitorUpdateStatus::InProgress => {
305 log_debug!(self.logger, "Channel Monitor sync for channel {} in progress, holding events until completion!", log_funding_info!(monitor));
306 pending_monitor_updates.push(update_id);
311 // Register any new outputs with the chain source for filtering, storing any dependent
312 // transactions from within the block that previously had not been included in txdata.
313 if let Some(ref chain_source) = self.chain_source {
314 let block_hash = header.block_hash();
315 for (txid, mut outputs) in txn_outputs.drain(..) {
316 for (idx, output) in outputs.drain(..) {
317 // Register any new outputs with the chain source for filtering
318 let output = WatchedOutput {
319 block_hash: Some(block_hash),
320 outpoint: OutPoint { txid, index: idx as u16 },
321 script_pubkey: output.script_pubkey,
323 chain_source.register_output(output)
330 /// Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
332 /// When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
333 /// will call back to it indicating transactions and outputs of interest. This allows clients to
334 /// pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
335 /// always need to fetch full blocks absent another means for determining which blocks contain
336 /// transactions relevant to the watched channels.
337 pub fn new(chain_source: Option<C>, broadcaster: T, logger: L, feeest: F, persister: P) -> Self {
339 monitors: RwLock::new(HashMap::new()),
340 sync_persistence_id: AtomicCounter::new(),
344 fee_estimator: feeest,
346 pending_monitor_events: Mutex::new(Vec::new()),
347 highest_chain_height: AtomicUsize::new(0),
351 /// Gets the balances in the contained [`ChannelMonitor`]s which are claimable on-chain or
352 /// claims which are awaiting confirmation.
354 /// Includes the balances from each [`ChannelMonitor`] *except* those included in
355 /// `ignored_channels`, allowing you to filter out balances from channels which are still open
356 /// (and whose balance should likely be pulled from the [`ChannelDetails`]).
358 /// See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for
359 /// inclusion in the return value.
360 pub fn get_claimable_balances(&self, ignored_channels: &[&ChannelDetails]) -> Vec<Balance> {
361 let mut ret = Vec::new();
362 let monitor_states = self.monitors.read().unwrap();
363 for (_, monitor_state) in monitor_states.iter().filter(|(funding_outpoint, _)| {
364 for chan in ignored_channels {
365 if chan.funding_txo.as_ref() == Some(funding_outpoint) {
371 ret.append(&mut monitor_state.monitor.get_claimable_balances());
376 /// Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
377 /// such [`ChannelMonitor`] is currently being monitored for.
379 /// Note that the result holds a mutex over our monitor set, and should not be held
381 pub fn get_monitor(&self, funding_txo: OutPoint) -> Result<LockedChannelMonitor<'_, ChannelSigner>, ()> {
382 let lock = self.monitors.read().unwrap();
383 if lock.get(&funding_txo).is_some() {
384 Ok(LockedChannelMonitor { lock, funding_txo })
390 /// Lists the funding outpoint of each [`ChannelMonitor`] being monitored.
392 /// Note that [`ChannelMonitor`]s are not removed when a channel is closed as they are always
393 /// monitoring for on-chain state resolutions.
394 pub fn list_monitors(&self) -> Vec<OutPoint> {
395 self.monitors.read().unwrap().keys().map(|outpoint| *outpoint).collect()
399 pub fn remove_monitor(&self, funding_txo: &OutPoint) -> ChannelMonitor<ChannelSigner> {
400 self.monitors.write().unwrap().remove(funding_txo).unwrap().monitor
403 /// Indicates the persistence of a [`ChannelMonitor`] has completed after
404 /// [`ChannelMonitorUpdateStatus::InProgress`] was returned from an update operation.
406 /// Thus, the anticipated use is, at a high level:
407 /// 1) This [`ChainMonitor`] calls [`Persist::update_persisted_channel`] which stores the
408 /// update to disk and begins updating any remote (e.g. watchtower/backup) copies,
409 /// returning [`ChannelMonitorUpdateStatus::InProgress`],
410 /// 2) once all remote copies are updated, you call this function with the
411 /// `completed_update_id` that completed, and once all pending updates have completed the
412 /// channel will be re-enabled.
413 // Note that we re-enable only after `UpdateOrigin::OffChain` updates complete, we don't
414 // care about `UpdateOrigin::ChainSync` updates for the channel state being updated. We
415 // only care about `UpdateOrigin::ChainSync` for returning `MonitorEvent`s.
417 /// Returns an [`APIError::APIMisuseError`] if `funding_txo` does not match any currently
418 /// registered [`ChannelMonitor`]s.
419 pub fn channel_monitor_updated(&self, funding_txo: OutPoint, completed_update_id: MonitorUpdateId) -> Result<(), APIError> {
420 let monitors = self.monitors.read().unwrap();
421 let monitor_data = if let Some(mon) = monitors.get(&funding_txo) { mon } else {
422 return Err(APIError::APIMisuseError { err: format!("No ChannelMonitor matching funding outpoint {:?} found", funding_txo) });
424 let mut pending_monitor_updates = monitor_data.pending_monitor_updates.lock().unwrap();
425 pending_monitor_updates.retain(|update_id| *update_id != completed_update_id);
427 match completed_update_id {
428 MonitorUpdateId { contents: UpdateOrigin::OffChain(_) } => {
429 // Note that we only check for `UpdateOrigin::OffChain` failures here - if
430 // we're being told that a `UpdateOrigin::OffChain` monitor update completed,
431 // we only care about ensuring we don't tell the `ChannelManager` to restore
432 // the channel to normal operation until all `UpdateOrigin::OffChain` updates
434 // If there's some `UpdateOrigin::ChainSync` update still pending that's okay
435 // - we can still update our channel state, just as long as we don't return
436 // `MonitorEvent`s from the monitor back to the `ChannelManager` until they
438 let monitor_is_pending_updates = monitor_data.has_pending_offchain_updates(&pending_monitor_updates);
439 if monitor_is_pending_updates || monitor_data.channel_perm_failed.load(Ordering::Acquire) {
440 // If there are still monitor updates pending (or an old monitor update
441 // finished after a later one perm-failed), we cannot yet construct an
445 self.pending_monitor_events.lock().unwrap().push((funding_txo, vec![MonitorEvent::Completed {
447 monitor_update_id: monitor_data.monitor.get_latest_update_id(),
448 }], monitor_data.monitor.get_counterparty_node_id()));
450 MonitorUpdateId { contents: UpdateOrigin::ChainSync(_) } => {
451 if !monitor_data.has_pending_chainsync_updates(&pending_monitor_updates) {
452 monitor_data.last_chain_persist_height.store(self.highest_chain_height.load(Ordering::Acquire), Ordering::Release);
453 // The next time release_pending_monitor_events is called, any events for this
454 // ChannelMonitor will be returned.
461 /// This wrapper avoids having to update some of our tests for now as they assume the direct
462 /// chain::Watch API wherein we mark a monitor fully-updated by just calling
463 /// channel_monitor_updated once with the highest ID.
464 #[cfg(any(test, fuzzing))]
465 pub fn force_channel_monitor_updated(&self, funding_txo: OutPoint, monitor_update_id: u64) {
466 let monitors = self.monitors.read().unwrap();
467 let counterparty_node_id = monitors.get(&funding_txo).and_then(|m| m.monitor.get_counterparty_node_id());
468 self.pending_monitor_events.lock().unwrap().push((funding_txo, vec![MonitorEvent::Completed {
471 }], counterparty_node_id));
474 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
475 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
476 use util::events::EventsProvider;
477 let events = core::cell::RefCell::new(Vec::new());
478 let event_handler = |event: &events::Event| events.borrow_mut().push(event.clone());
479 self.process_pending_events(&event_handler);
484 impl<ChannelSigner: Sign, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref>
485 chain::Listen for ChainMonitor<ChannelSigner, C, T, F, L, P>
487 C::Target: chain::Filter,
488 T::Target: BroadcasterInterface,
489 F::Target: FeeEstimator,
491 P::Target: Persist<ChannelSigner>,
493 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
494 log_debug!(self.logger, "New best block {} at height {} provided via block_connected", header.block_hash(), height);
495 self.process_chain_data(header, Some(height), &txdata, |monitor, txdata| {
496 monitor.block_connected(
497 header, txdata, height, &*self.broadcaster, &*self.fee_estimator, &*self.logger)
501 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
502 let monitor_states = self.monitors.read().unwrap();
503 log_debug!(self.logger, "Latest block {} at height {} removed via block_disconnected", header.block_hash(), height);
504 for monitor_state in monitor_states.values() {
505 monitor_state.monitor.block_disconnected(
506 header, height, &*self.broadcaster, &*self.fee_estimator, &*self.logger);
511 impl<ChannelSigner: Sign, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref>
512 chain::Confirm for ChainMonitor<ChannelSigner, C, T, F, L, P>
514 C::Target: chain::Filter,
515 T::Target: BroadcasterInterface,
516 F::Target: FeeEstimator,
518 P::Target: Persist<ChannelSigner>,
520 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
521 log_debug!(self.logger, "{} provided transactions confirmed at height {} in block {}", txdata.len(), height, header.block_hash());
522 self.process_chain_data(header, None, txdata, |monitor, txdata| {
523 monitor.transactions_confirmed(
524 header, txdata, height, &*self.broadcaster, &*self.fee_estimator, &*self.logger)
528 fn transaction_unconfirmed(&self, txid: &Txid) {
529 log_debug!(self.logger, "Transaction {} reorganized out of chain", txid);
530 let monitor_states = self.monitors.read().unwrap();
531 for monitor_state in monitor_states.values() {
532 monitor_state.monitor.transaction_unconfirmed(txid, &*self.broadcaster, &*self.fee_estimator, &*self.logger);
536 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
537 log_debug!(self.logger, "New best block {} at height {} provided via best_block_updated", header.block_hash(), height);
538 self.process_chain_data(header, Some(height), &[], |monitor, txdata| {
539 // While in practice there shouldn't be any recursive calls when given empty txdata,
540 // it's still possible if a chain::Filter implementation returns a transaction.
541 debug_assert!(txdata.is_empty());
542 monitor.best_block_updated(
543 header, height, &*self.broadcaster, &*self.fee_estimator, &*self.logger)
547 fn get_relevant_txids(&self) -> Vec<Txid> {
548 let mut txids = Vec::new();
549 let monitor_states = self.monitors.read().unwrap();
550 for monitor_state in monitor_states.values() {
551 txids.append(&mut monitor_state.monitor.get_relevant_txids());
554 txids.sort_unstable();
560 impl<ChannelSigner: Sign, C: Deref , T: Deref , F: Deref , L: Deref , P: Deref >
561 chain::Watch<ChannelSigner> for ChainMonitor<ChannelSigner, C, T, F, L, P>
562 where C::Target: chain::Filter,
563 T::Target: BroadcasterInterface,
564 F::Target: FeeEstimator,
566 P::Target: Persist<ChannelSigner>,
568 /// Adds the monitor that watches the channel referred to by the given outpoint.
570 /// Calls back to [`chain::Filter`] with the funding transaction and outputs to watch.
572 /// Note that we persist the given `ChannelMonitor` while holding the `ChainMonitor`
574 fn watch_channel(&self, funding_outpoint: OutPoint, monitor: ChannelMonitor<ChannelSigner>) -> ChannelMonitorUpdateStatus {
575 let mut monitors = self.monitors.write().unwrap();
576 let entry = match monitors.entry(funding_outpoint) {
577 hash_map::Entry::Occupied(_) => {
578 log_error!(self.logger, "Failed to add new channel data: channel monitor for given outpoint is already present");
579 return ChannelMonitorUpdateStatus::PermanentFailure
581 hash_map::Entry::Vacant(e) => e,
583 log_trace!(self.logger, "Got new ChannelMonitor for channel {}", log_funding_info!(monitor));
584 let update_id = MonitorUpdateId::from_new_monitor(&monitor);
585 let mut pending_monitor_updates = Vec::new();
586 let persist_res = self.persister.persist_new_channel(funding_outpoint, &monitor, update_id);
588 ChannelMonitorUpdateStatus::InProgress => {
589 log_info!(self.logger, "Persistence of new ChannelMonitor for channel {} in progress", log_funding_info!(monitor));
590 pending_monitor_updates.push(update_id);
592 ChannelMonitorUpdateStatus::PermanentFailure => {
593 log_error!(self.logger, "Persistence of new ChannelMonitor for channel {} failed", log_funding_info!(monitor));
596 ChannelMonitorUpdateStatus::Completed => {
597 log_info!(self.logger, "Persistence of new ChannelMonitor for channel {} completed", log_funding_info!(monitor));
600 if let Some(ref chain_source) = self.chain_source {
601 monitor.load_outputs_to_watch(chain_source);
603 entry.insert(MonitorHolder {
605 pending_monitor_updates: Mutex::new(pending_monitor_updates),
606 channel_perm_failed: AtomicBool::new(false),
607 last_chain_persist_height: AtomicUsize::new(self.highest_chain_height.load(Ordering::Acquire)),
612 /// Note that we persist the given `ChannelMonitor` update while holding the
613 /// `ChainMonitor` monitors lock.
614 fn update_channel(&self, funding_txo: OutPoint, update: ChannelMonitorUpdate) -> ChannelMonitorUpdateStatus {
615 // Update the monitor that watches the channel referred to by the given outpoint.
616 let monitors = self.monitors.read().unwrap();
617 match monitors.get(&funding_txo) {
619 log_error!(self.logger, "Failed to update channel monitor: no such monitor registered");
621 // We should never ever trigger this from within ChannelManager. Technically a
622 // user could use this object with some proxying in between which makes this
623 // possible, but in tests and fuzzing, this should be a panic.
624 #[cfg(any(test, fuzzing))]
625 panic!("ChannelManager generated a channel update for a channel that was not yet registered!");
626 #[cfg(not(any(test, fuzzing)))]
627 ChannelMonitorUpdateStatus::PermanentFailure
629 Some(monitor_state) => {
630 let monitor = &monitor_state.monitor;
631 log_trace!(self.logger, "Updating ChannelMonitor for channel {}", log_funding_info!(monitor));
632 let update_res = monitor.update_monitor(&update, &self.broadcaster, &*self.fee_estimator, &self.logger);
633 if update_res.is_err() {
634 log_error!(self.logger, "Failed to update ChannelMonitor for channel {}.", log_funding_info!(monitor));
636 // Even if updating the monitor returns an error, the monitor's state will
637 // still be changed. So, persist the updated monitor despite the error.
638 let update_id = MonitorUpdateId::from_monitor_update(&update);
639 let mut pending_monitor_updates = monitor_state.pending_monitor_updates.lock().unwrap();
640 let persist_res = self.persister.update_persisted_channel(funding_txo, &Some(update), monitor, update_id);
642 ChannelMonitorUpdateStatus::InProgress => {
643 pending_monitor_updates.push(update_id);
644 log_debug!(self.logger, "Persistence of ChannelMonitorUpdate for channel {} in progress", log_funding_info!(monitor));
646 ChannelMonitorUpdateStatus::PermanentFailure => {
647 monitor_state.channel_perm_failed.store(true, Ordering::Release);
648 log_error!(self.logger, "Persistence of ChannelMonitorUpdate for channel {} failed", log_funding_info!(monitor));
650 ChannelMonitorUpdateStatus::Completed => {
651 log_debug!(self.logger, "Persistence of ChannelMonitorUpdate for channel {} completed", log_funding_info!(monitor));
654 if update_res.is_err() {
655 ChannelMonitorUpdateStatus::PermanentFailure
656 } else if monitor_state.channel_perm_failed.load(Ordering::Acquire) {
657 ChannelMonitorUpdateStatus::PermanentFailure
665 fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
666 let mut pending_monitor_events = self.pending_monitor_events.lock().unwrap().split_off(0);
667 for monitor_state in self.monitors.read().unwrap().values() {
668 let is_pending_monitor_update = monitor_state.has_pending_chainsync_updates(&monitor_state.pending_monitor_updates.lock().unwrap());
669 if is_pending_monitor_update &&
670 monitor_state.last_chain_persist_height.load(Ordering::Acquire) + LATENCY_GRACE_PERIOD_BLOCKS as usize
671 > self.highest_chain_height.load(Ordering::Acquire)
673 log_info!(self.logger, "A Channel Monitor sync is still in progress, refusing to provide monitor events!");
675 if monitor_state.channel_perm_failed.load(Ordering::Acquire) {
676 // If a `UpdateOrigin::ChainSync` persistence failed with `PermanantFailure`,
677 // we don't really know if the latest `ChannelMonitor` state is on disk or not.
678 // We're supposed to hold monitor updates until the latest state is on disk to
679 // avoid duplicate events, but the user told us persistence is screw-y and may
680 // not complete. We can't hold events forever because we may learn some payment
681 // preimage, so instead we just log and hope the user complied with the
682 // `PermanentFailure` requirements of having at least the local-disk copy
684 log_info!(self.logger, "A Channel Monitor sync returned PermanentFailure. Returning monitor events but duplicate events may appear after reload!");
686 if is_pending_monitor_update {
687 log_error!(self.logger, "A ChannelMonitor sync took longer than {} blocks to complete.", LATENCY_GRACE_PERIOD_BLOCKS);
688 log_error!(self.logger, " To avoid funds-loss, we are allowing monitor updates to be released.");
689 log_error!(self.logger, " This may cause duplicate payment events to be generated.");
691 let monitor_events = monitor_state.monitor.get_and_clear_pending_monitor_events();
692 if monitor_events.len() > 0 {
693 let monitor_outpoint = monitor_state.monitor.get_funding_txo().0;
694 let counterparty_node_id = monitor_state.monitor.get_counterparty_node_id();
695 pending_monitor_events.push((monitor_outpoint, monitor_events, counterparty_node_id));
699 pending_monitor_events
703 impl<ChannelSigner: Sign, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref> events::EventsProvider for ChainMonitor<ChannelSigner, C, T, F, L, P>
704 where C::Target: chain::Filter,
705 T::Target: BroadcasterInterface,
706 F::Target: FeeEstimator,
708 P::Target: Persist<ChannelSigner>,
710 /// Processes [`SpendableOutputs`] events produced from each [`ChannelMonitor`] upon maturity.
712 /// An [`EventHandler`] may safely call back to the provider, though this shouldn't be needed in
713 /// order to handle these events.
715 /// [`SpendableOutputs`]: events::Event::SpendableOutputs
716 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
717 let mut pending_events = Vec::new();
718 for monitor_state in self.monitors.read().unwrap().values() {
719 pending_events.append(&mut monitor_state.monitor.get_and_clear_pending_events());
721 for event in pending_events.drain(..) {
722 handler.handle_event(&event);
729 use bitcoin::{BlockHeader, TxMerkleNode};
730 use bitcoin::hashes::Hash;
731 use ::{check_added_monitors, check_closed_broadcast, check_closed_event};
732 use ::{expect_payment_sent, expect_payment_claimed, expect_payment_sent_without_paths, expect_payment_path_successful, get_event_msg};
733 use ::{get_htlc_update_msgs, get_local_commitment_txn, get_revoke_commit_msgs, get_route_and_payment_hash, unwrap_send_err};
734 use chain::{ChannelMonitorUpdateStatus, Confirm, Watch};
735 use chain::channelmonitor::LATENCY_GRACE_PERIOD_BLOCKS;
736 use ln::channelmanager::{self, PaymentSendFailure};
737 use ln::functional_test_utils::*;
738 use ln::msgs::ChannelMessageHandler;
739 use util::errors::APIError;
740 use util::events::{ClosureReason, MessageSendEvent, MessageSendEventsProvider};
743 fn test_async_ooo_offchain_updates() {
744 // Test that if we have multiple offchain updates being persisted and they complete
745 // out-of-order, the ChainMonitor waits until all have completed before informing the
747 let chanmon_cfgs = create_chanmon_cfgs(2);
748 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
749 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
750 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
751 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
753 // Route two payments to be claimed at the same time.
754 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
755 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
757 chanmon_cfgs[1].persister.offchain_monitor_updates.lock().unwrap().clear();
758 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
760 nodes[1].node.claim_funds(payment_preimage_1);
761 check_added_monitors!(nodes[1], 1);
762 expect_payment_claimed!(nodes[1], payment_hash_1, 1_000_000);
763 nodes[1].node.claim_funds(payment_preimage_2);
764 check_added_monitors!(nodes[1], 1);
765 expect_payment_claimed!(nodes[1], payment_hash_2, 1_000_000);
767 chanmon_cfgs[1].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
769 let persistences = chanmon_cfgs[1].persister.offchain_monitor_updates.lock().unwrap().clone();
770 assert_eq!(persistences.len(), 1);
771 let (funding_txo, updates) = persistences.iter().next().unwrap();
772 assert_eq!(updates.len(), 2);
774 // Note that updates is a HashMap so the ordering here is actually random. This shouldn't
775 // fail either way but if it fails intermittently it's depending on the ordering of updates.
776 let mut update_iter = updates.iter();
777 nodes[1].chain_monitor.chain_monitor.channel_monitor_updated(*funding_txo, update_iter.next().unwrap().clone()).unwrap();
778 assert!(nodes[1].chain_monitor.release_pending_monitor_events().is_empty());
779 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
780 nodes[1].chain_monitor.chain_monitor.channel_monitor_updated(*funding_txo, update_iter.next().unwrap().clone()).unwrap();
782 // Now manually walk the commitment signed dance - because we claimed two payments
783 // back-to-back it doesn't fit into the neat walk commitment_signed_dance does.
785 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
786 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
787 expect_payment_sent_without_paths!(nodes[0], payment_preimage_1);
788 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
789 check_added_monitors!(nodes[0], 1);
790 let (as_first_raa, as_first_update) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
792 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
793 check_added_monitors!(nodes[1], 1);
794 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
795 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_update);
796 check_added_monitors!(nodes[1], 1);
797 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
799 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
800 expect_payment_sent_without_paths!(nodes[0], payment_preimage_2);
801 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
802 check_added_monitors!(nodes[0], 1);
803 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
804 expect_payment_path_successful!(nodes[0]);
805 check_added_monitors!(nodes[0], 1);
806 let (as_second_raa, as_second_update) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
808 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
809 check_added_monitors!(nodes[1], 1);
810 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update);
811 check_added_monitors!(nodes[1], 1);
812 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
814 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
815 expect_payment_path_successful!(nodes[0]);
816 check_added_monitors!(nodes[0], 1);
819 fn do_chainsync_pauses_events(block_timeout: bool) {
820 // When a chainsync monitor update occurs, any MonitorUpdates should be held before being
821 // passed upstream to a `ChannelManager` via `Watch::release_pending_monitor_events`. This
822 // tests that behavior, as well as some ways it might go wrong.
823 let chanmon_cfgs = create_chanmon_cfgs(2);
824 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
825 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
826 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
827 let channel = create_announced_chan_between_nodes(
828 &nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
830 // Get a route for later and rebalance the channel somewhat
831 send_payment(&nodes[0], &[&nodes[1]], 10_000_000);
832 let (route, second_payment_hash, _, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
834 // First route a payment that we will claim on chain and give the recipient the preimage.
835 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
836 nodes[1].node.claim_funds(payment_preimage);
837 expect_payment_claimed!(nodes[1], payment_hash, 1_000_000);
838 nodes[1].node.get_and_clear_pending_msg_events();
839 check_added_monitors!(nodes[1], 1);
840 let remote_txn = get_local_commitment_txn!(nodes[1], channel.2);
841 assert_eq!(remote_txn.len(), 2);
843 // Temp-fail the block connection which will hold the channel-closed event
844 chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
845 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
847 // Connect B's commitment transaction, but only to the ChainMonitor/ChannelMonitor. The
848 // channel is now closed, but the ChannelManager doesn't know that yet.
849 let new_header = BlockHeader {
850 version: 2, time: 0, bits: 0, nonce: 0,
851 prev_blockhash: nodes[0].best_block_info().0,
852 merkle_root: TxMerkleNode::all_zeros() };
853 nodes[0].chain_monitor.chain_monitor.transactions_confirmed(&new_header,
854 &[(0, &remote_txn[0]), (1, &remote_txn[1])], nodes[0].best_block_info().1 + 1);
855 assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
856 nodes[0].chain_monitor.chain_monitor.best_block_updated(&new_header, nodes[0].best_block_info().1 + 1);
857 assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
859 // If the ChannelManager tries to update the channel, however, the ChainMonitor will pass
860 // the update through to the ChannelMonitor which will refuse it (as the channel is closed).
861 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::Completed);
862 unwrap_send_err!(nodes[0].node.send_payment(&route, second_payment_hash, &Some(second_payment_secret)),
863 true, APIError::ChannelUnavailable { ref err },
864 assert!(err.contains("ChannelMonitor storage failure")));
865 check_added_monitors!(nodes[0], 2); // After the failure we generate a close-channel monitor update
866 check_closed_broadcast!(nodes[0], true);
867 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "ChannelMonitor storage failure".to_string() });
869 // However, as the ChainMonitor is still waiting for the original persistence to complete,
870 // it won't yet release the MonitorEvents.
871 assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
874 // After three blocks, pending MontiorEvents should be released either way.
875 let latest_header = BlockHeader {
876 version: 2, time: 0, bits: 0, nonce: 0,
877 prev_blockhash: nodes[0].best_block_info().0,
878 merkle_root: TxMerkleNode::all_zeros() };
879 nodes[0].chain_monitor.chain_monitor.best_block_updated(&latest_header, nodes[0].best_block_info().1 + LATENCY_GRACE_PERIOD_BLOCKS);
881 let persistences = chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clone();
882 for (funding_outpoint, update_ids) in persistences {
883 for update_id in update_ids {
884 nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(funding_outpoint, update_id).unwrap();
889 expect_payment_sent!(nodes[0], payment_preimage);
893 fn chainsync_pauses_events() {
894 do_chainsync_pauses_events(false);
895 do_chainsync_pauses_events(true);
899 fn update_during_chainsync_fails_channel() {
900 let chanmon_cfgs = create_chanmon_cfgs(2);
901 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
902 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
903 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
904 create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
906 chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
907 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::PermanentFailure);
909 connect_blocks(&nodes[0], 1);
910 // Before processing events, the ChannelManager will still think the Channel is open and
911 // there won't be any ChannelMonitorUpdates
912 assert_eq!(nodes[0].node.list_channels().len(), 1);
913 check_added_monitors!(nodes[0], 0);
914 // ... however once we get events once, the channel will close, creating a channel-closed
915 // ChannelMonitorUpdate.
916 check_closed_broadcast!(nodes[0], true);
917 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() });
918 check_added_monitors!(nodes[0], 1);