1 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
2 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
3 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
4 // You may not use this file except in accordance with one or both of these
7 //! This module contains a simple key-value store trait [`KVStore`] that
8 //! allows one to implement the persistence for [`ChannelManager`], [`NetworkGraph`],
9 //! and [`ChannelMonitor`] all in one place.
12 use core::convert::{TryFrom, TryInto};
14 use bitcoin::hashes::hex::{FromHex, ToHex};
15 use bitcoin::{BlockHash, Txid};
17 use crate::{io, log_error};
18 use crate::alloc::string::ToString;
19 use crate::prelude::*;
22 use crate::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
23 use crate::chain::chainmonitor::{Persist, MonitorUpdateId};
24 use crate::sign::{EntropySource, NodeSigner, WriteableEcdsaChannelSigner, SignerProvider};
25 use crate::chain::transaction::OutPoint;
26 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, CLOSED_CHANNEL_UPDATE_ID};
27 use crate::ln::channelmanager::ChannelManager;
28 use crate::routing::router::Router;
29 use crate::routing::gossip::NetworkGraph;
30 use crate::routing::scoring::WriteableScore;
31 use crate::util::logger::Logger;
32 use crate::util::ser::{Readable, ReadableArgs, Writeable};
34 /// The alphabet of characters allowed for namespaces and keys.
35 pub const KVSTORE_NAMESPACE_KEY_ALPHABET: &str = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-";
37 /// The maximum number of characters namespaces and keys may have.
38 pub const KVSTORE_NAMESPACE_KEY_MAX_LEN: usize = 120;
40 /// The primary namespace under which the [`ChannelManager`] will be persisted.
41 pub const CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE: &str = "";
42 /// The secondary namespace under which the [`ChannelManager`] will be persisted.
43 pub const CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE: &str = "";
44 /// The key under which the [`ChannelManager`] will be persisted.
45 pub const CHANNEL_MANAGER_PERSISTENCE_KEY: &str = "manager";
47 /// The primary namespace under which [`ChannelMonitor`]s will be persisted.
48 pub const CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE: &str = "monitors";
49 /// The secondary namespace under which [`ChannelMonitor`]s will be persisted.
50 pub const CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE: &str = "";
51 /// The primary namespace under which [`ChannelMonitorUpdate`]s will be persisted.
52 pub const CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE: &str = "monitor_updates";
54 /// The primary namespace under which the [`NetworkGraph`] will be persisted.
55 pub const NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE: &str = "";
56 /// The secondary namespace under which the [`NetworkGraph`] will be persisted.
57 pub const NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE: &str = "";
58 /// The key under which the [`NetworkGraph`] will be persisted.
59 pub const NETWORK_GRAPH_PERSISTENCE_KEY: &str = "network_graph";
61 /// The primary namespace under which the [`WriteableScore`] will be persisted.
62 pub const SCORER_PERSISTENCE_PRIMARY_NAMESPACE: &str = "";
63 /// The secondary namespace under which the [`WriteableScore`] will be persisted.
64 pub const SCORER_PERSISTENCE_SECONDARY_NAMESPACE: &str = "";
65 /// The key under which the [`WriteableScore`] will be persisted.
66 pub const SCORER_PERSISTENCE_KEY: &str = "scorer";
68 /// A sentinel value to be prepended to monitors persisted by the [`MonitorUpdatingPersister`].
70 /// This serves to prevent someone from accidentally loading such monitors (which may need
71 /// updates applied to be current) with another implementation.
72 pub const MONITOR_UPDATING_PERSISTER_PREPEND_SENTINEL: &[u8] = &[0xFF; 2];
74 /// Provides an interface that allows storage and retrieval of persisted values that are associated
77 /// In order to avoid collisions the key space is segmented based on the given `primary_namespace`s
78 /// and `secondary_namespace`s. Implementations of this trait are free to handle them in different
79 /// ways, as long as per-namespace key uniqueness is asserted.
81 /// Keys and namespaces are required to be valid ASCII strings in the range of
82 /// [`KVSTORE_NAMESPACE_KEY_ALPHABET`] and no longer than [`KVSTORE_NAMESPACE_KEY_MAX_LEN`]. Empty
83 /// primary namespaces and secondary namespaces (`""`) are assumed to be a valid, however, if
84 /// `primary_namespace` is empty, `secondary_namespace` is required to be empty, too. This means
85 /// that concerns should always be separated by primary namespace first, before secondary
86 /// namespaces are used. While the number of primary namespaces will be relatively small and is
87 /// determined at compile time, there may be many secondary namespaces per primary namespace. Note
88 /// that per-namespace uniqueness needs to also hold for keys *and* namespaces in any given
89 /// namespace, i.e., conflicts between keys and equally named
90 /// primary namespaces/secondary namespaces must be avoided.
92 /// **Note:** Users migrating custom persistence backends from the pre-v0.0.117 `KVStorePersister`
93 /// interface can use a concatenation of `[{primary_namespace}/[{secondary_namespace}/]]{key}` to
94 /// recover a `key` compatible with the data model previously assumed by `KVStorePersister::persist`.
96 /// Returns the data stored for the given `primary_namespace`, `secondary_namespace`, and
99 /// Returns an [`ErrorKind::NotFound`] if the given `key` could not be found in the given
100 /// `primary_namespace` and `secondary_namespace`.
102 /// [`ErrorKind::NotFound`]: io::ErrorKind::NotFound
103 fn read(&self, primary_namespace: &str, secondary_namespace: &str, key: &str) -> Result<Vec<u8>, io::Error>;
104 /// Persists the given data under the given `key`.
106 /// Will create the given `primary_namespace` and `secondary_namespace` if not already present
108 fn write(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: &[u8]) -> Result<(), io::Error>;
109 /// Removes any data that had previously been persisted under the given `key`.
111 /// If the `lazy` flag is set to `true`, the backend implementation might choose to lazily
112 /// remove the given `key` at some point in time after the method returns, e.g., as part of an
113 /// eventual batch deletion of multiple keys. As a consequence, subsequent calls to
114 /// [`KVStore::list`] might include the removed key until the changes are actually persisted.
116 /// Note that while setting the `lazy` flag reduces the I/O burden of multiple subsequent
117 /// `remove` calls, it also influences the atomicity guarantees as lazy `remove`s could
118 /// potentially get lost on crash after the method returns. Therefore, this flag should only be
119 /// set for `remove` operations that can be safely replayed at a later time.
121 /// Returns successfully if no data will be stored for the given `primary_namespace`,
122 /// `secondary_namespace`, and `key`, independently of whether it was present before its
123 /// invokation or not.
124 fn remove(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, lazy: bool) -> Result<(), io::Error>;
125 /// Returns a list of keys that are stored under the given `secondary_namespace` in
126 /// `primary_namespace`.
128 /// Returns the keys in arbitrary order, so users requiring a particular order need to sort the
129 /// returned keys. Returns an empty list if `primary_namespace` or `secondary_namespace` is unknown.
130 fn list(&self, primary_namespace: &str, secondary_namespace: &str) -> Result<Vec<String>, io::Error>;
133 /// Trait that handles persisting a [`ChannelManager`], [`NetworkGraph`], and [`WriteableScore`] to disk.
134 pub trait Persister<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref, S: WriteableScore<'a>>
135 where M::Target: 'static + chain::Watch<<SP::Target as SignerProvider>::Signer>,
136 T::Target: 'static + BroadcasterInterface,
137 ES::Target: 'static + EntropySource,
138 NS::Target: 'static + NodeSigner,
139 SP::Target: 'static + SignerProvider,
140 F::Target: 'static + FeeEstimator,
141 R::Target: 'static + Router,
142 L::Target: 'static + Logger,
144 /// Persist the given ['ChannelManager'] to disk, returning an error if persistence failed.
145 fn persist_manager(&self, channel_manager: &ChannelManager<M, T, ES, NS, SP, F, R, L>) -> Result<(), io::Error>;
147 /// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
148 fn persist_graph(&self, network_graph: &NetworkGraph<L>) -> Result<(), io::Error>;
150 /// Persist the given [`WriteableScore`] to disk, returning an error if persistence failed.
151 fn persist_scorer(&self, scorer: &S) -> Result<(), io::Error>;
155 impl<'a, A: KVStore, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref, S: WriteableScore<'a>> Persister<'a, M, T, ES, NS, SP, F, R, L, S> for A
156 where M::Target: 'static + chain::Watch<<SP::Target as SignerProvider>::Signer>,
157 T::Target: 'static + BroadcasterInterface,
158 ES::Target: 'static + EntropySource,
159 NS::Target: 'static + NodeSigner,
160 SP::Target: 'static + SignerProvider,
161 F::Target: 'static + FeeEstimator,
162 R::Target: 'static + Router,
163 L::Target: 'static + Logger,
165 /// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed.
166 fn persist_manager(&self, channel_manager: &ChannelManager<M, T, ES, NS, SP, F, R, L>) -> Result<(), io::Error> {
167 self.write(CHANNEL_MANAGER_PERSISTENCE_PRIMARY_NAMESPACE,
168 CHANNEL_MANAGER_PERSISTENCE_SECONDARY_NAMESPACE,
169 CHANNEL_MANAGER_PERSISTENCE_KEY,
170 &channel_manager.encode())
173 /// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
174 fn persist_graph(&self, network_graph: &NetworkGraph<L>) -> Result<(), io::Error> {
175 self.write(NETWORK_GRAPH_PERSISTENCE_PRIMARY_NAMESPACE,
176 NETWORK_GRAPH_PERSISTENCE_SECONDARY_NAMESPACE,
177 NETWORK_GRAPH_PERSISTENCE_KEY,
178 &network_graph.encode())
181 /// Persist the given [`WriteableScore`] to disk, returning an error if persistence failed.
182 fn persist_scorer(&self, scorer: &S) -> Result<(), io::Error> {
183 self.write(SCORER_PERSISTENCE_PRIMARY_NAMESPACE,
184 SCORER_PERSISTENCE_SECONDARY_NAMESPACE,
185 SCORER_PERSISTENCE_KEY,
190 impl<ChannelSigner: WriteableEcdsaChannelSigner, K: KVStore> Persist<ChannelSigner> for K {
191 // TODO: We really need a way for the persister to inform the user that its time to crash/shut
192 // down once these start returning failure.
193 // Then we should return InProgress rather than UnrecoverableError, implying we should probably
194 // just shut down the node since we're not retrying persistence!
196 fn persist_new_channel(&self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
197 let key = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
199 CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE,
200 CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE,
201 &key, &monitor.encode())
203 Ok(()) => chain::ChannelMonitorUpdateStatus::Completed,
204 Err(_) => chain::ChannelMonitorUpdateStatus::UnrecoverableError
208 fn update_persisted_channel(&self, funding_txo: OutPoint, _update: Option<&ChannelMonitorUpdate>, monitor: &ChannelMonitor<ChannelSigner>, _update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
209 let key = format!("{}_{}", funding_txo.txid.to_hex(), funding_txo.index);
211 CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE,
212 CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE,
213 &key, &monitor.encode())
215 Ok(()) => chain::ChannelMonitorUpdateStatus::Completed,
216 Err(_) => chain::ChannelMonitorUpdateStatus::UnrecoverableError
221 /// Read previously persisted [`ChannelMonitor`]s from the store.
222 pub fn read_channel_monitors<K: Deref, ES: Deref, SP: Deref>(
223 kv_store: K, entropy_source: ES, signer_provider: SP,
224 ) -> Result<Vec<(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>)>, io::Error>
227 ES::Target: EntropySource + Sized,
228 SP::Target: SignerProvider + Sized,
230 let mut res = Vec::new();
232 for stored_key in kv_store.list(
233 CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE)?
235 if stored_key.len() < 66 {
236 return Err(io::Error::new(
237 io::ErrorKind::InvalidData,
238 "Stored key has invalid length"));
241 let txid = Txid::from_hex(stored_key.split_at(64).0).map_err(|_| {
242 io::Error::new(io::ErrorKind::InvalidData, "Invalid tx ID in stored key")
245 let index: u16 = stored_key.split_at(65).1.parse().map_err(|_| {
246 io::Error::new(io::ErrorKind::InvalidData, "Invalid tx index in stored key")
249 match <(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>)>::read(
250 &mut io::Cursor::new(
251 kv_store.read(CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE, CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE, &stored_key)?),
252 (&*entropy_source, &*signer_provider),
254 Ok((block_hash, channel_monitor)) => {
255 if channel_monitor.get_funding_txo().0.txid != txid
256 || channel_monitor.get_funding_txo().0.index != index
258 return Err(io::Error::new(
259 io::ErrorKind::InvalidData,
260 "ChannelMonitor was stored under the wrong key",
263 res.push((block_hash, channel_monitor));
266 return Err(io::Error::new(
267 io::ErrorKind::InvalidData,
268 "Failed to read ChannelMonitor"
276 /// Implements [`Persist`] in a way that writes and reads both [`ChannelMonitor`]s and
277 /// [`ChannelMonitorUpdate`]s.
281 /// The main benefit this provides over the [`KVStore`]'s [`Persist`] implementation is decreased
282 /// I/O bandwidth and storage churn, at the expense of more IOPS (including listing, reading, and
283 /// deleting) and complexity. This is because it writes channel monitor differential updates,
284 /// whereas the other (default) implementation rewrites the entire monitor on each update. For
285 /// routing nodes, updates can happen many times per second to a channel, and monitors can be tens
286 /// of megabytes (or more). Updates can be as small as a few hundred bytes.
288 /// Note that monitors written with `MonitorUpdatingPersister` are _not_ backward-compatible with
289 /// the default [`KVStore`]'s [`Persist`] implementation. They have a prepended byte sequence,
290 /// [`MONITOR_UPDATING_PERSISTER_PREPEND_SENTINEL`], applied to prevent deserialization with other
291 /// persisters. This is because monitors written by this struct _may_ have unapplied updates. In
292 /// order to downgrade, you must ensure that all updates are applied to the monitor, and remove the
295 /// # Storing monitors
297 /// Monitors are stored by implementing the [`Persist`] trait, which has two functions:
299 /// - [`Persist::persist_new_channel`], which persists whole [`ChannelMonitor`]s.
300 /// - [`Persist::update_persisted_channel`], which persists only a [`ChannelMonitorUpdate`]
302 /// Whole [`ChannelMonitor`]s are stored in the [`CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE`],
303 /// using the familiar encoding of an [`OutPoint`] (for example, `[SOME-64-CHAR-HEX-STRING]_1`).
305 /// Each [`ChannelMonitorUpdate`] is stored in a dynamic secondary namespace, as follows:
307 /// - primary namespace: [`CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE`]
308 /// - secondary namespace: [the monitor's encoded outpoint name]
310 /// Under that secondary namespace, each update is stored with a number string, like `21`, which
311 /// represents its `update_id` value.
313 /// For example, consider this channel, named for its transaction ID and index, or [`OutPoint`]:
315 /// - Transaction ID: `deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef`
318 /// Full channel monitors would be stored at a single key:
320 /// `[CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE]/deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1`
322 /// Updates would be stored as follows (with `/` delimiting primary_namespace/secondary_namespace/key):
325 /// [CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE]/deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1/1
326 /// [CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE]/deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1/2
327 /// [CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE]/deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1/3
331 /// # Reading channel state from storage
333 /// Channel state can be reconstructed by calling
334 /// [`MonitorUpdatingPersister::read_all_channel_monitors_with_updates`]. Alternatively, users can
335 /// list channel monitors themselves and load channels individually using
336 /// [`MonitorUpdatingPersister::read_channel_monitor_with_updates`].
338 /// ## EXTREMELY IMPORTANT
340 /// It is extremely important that your [`KVStore::read`] implementation uses the
341 /// [`io::ErrorKind::NotFound`] variant correctly: that is, when a file is not found, and _only_ in
342 /// that circumstance (not when there is really a permissions error, for example). This is because
343 /// neither channel monitor reading function lists updates. Instead, either reads the monitor, and
344 /// using its stored `update_id`, synthesizes update storage keys, and tries them in sequence until
345 /// one is not found. All _other_ errors will be bubbled up in the function's [`Result`].
347 /// # Pruning stale channel updates
349 /// Stale updates are pruned when a full monitor is written. The old monitor is first read, and if
350 /// that succeeds, updates in the range between the old and new monitors are deleted. The `lazy`
351 /// flag is used on the [`KVStore::remove`] method, so there are no guarantees that the deletions
352 /// will complete. However, stale updates are not a problem for data integrity, since updates are
353 /// only read that are higher than the stored [`ChannelMonitor`]'s `update_id`.
355 /// If you have many stale updates stored (such as after a crash with pending lazy deletes), and
356 /// would like to get rid of them, consider using the
357 /// [`MonitorUpdatingPersister::cleanup_stale_updates`] function.
358 pub struct MonitorUpdatingPersister<K: Deref, L: Deref, ES: Deref, SP: Deref>
362 ES::Target: EntropySource + Sized,
363 SP::Target: SignerProvider + Sized,
367 maximum_pending_updates: u64,
373 impl<K: Deref, L: Deref, ES: Deref, SP: Deref>
374 MonitorUpdatingPersister<K, L, ES, SP>
378 ES::Target: EntropySource + Sized,
379 SP::Target: SignerProvider + Sized,
381 /// Constructs a new [`MonitorUpdatingPersister`].
383 /// The `maximum_pending_updates` parameter controls how many updates may be stored before a
384 /// [`MonitorUpdatingPersister`] consolidates updates by writing a full monitor. Note that
385 /// consolidation will frequently occur with fewer updates than what you set here; this number
386 /// is merely the maximum that may be stored. When setting this value, consider that for higher
387 /// values of `maximum_pending_updates`:
389 /// - [`MonitorUpdatingPersister`] will tend to write more [`ChannelMonitorUpdate`]s than
390 /// [`ChannelMonitor`]s, approaching one [`ChannelMonitor`] write for every
391 /// `maximum_pending_updates` [`ChannelMonitorUpdate`]s.
392 /// - [`MonitorUpdatingPersister`] will issue deletes differently. Lazy deletes will come in
393 /// "waves" for each [`ChannelMonitor`] write. A larger `maximum_pending_updates` means bigger,
394 /// less frequent "waves."
395 /// - [`MonitorUpdatingPersister`] will potentially have more listing to do if you need to run
396 /// [`MonitorUpdatingPersister::cleanup_stale_updates`].
398 kv_store: K, logger: L, maximum_pending_updates: u64, entropy_source: ES,
401 MonitorUpdatingPersister {
404 maximum_pending_updates,
410 /// Reads all stored channel monitors, along with any stored updates for them.
412 /// It is extremely important that your [`KVStore::read`] implementation uses the
413 /// [`io::ErrorKind::NotFound`] variant correctly. For more information, please see the
414 /// documentation for [`MonitorUpdatingPersister`].
415 pub fn read_all_channel_monitors_with_updates<B: Deref, F: Deref>(
416 &self, broadcaster: &B, fee_estimator: &F,
417 ) -> Result<Vec<(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>)>, io::Error>
419 B::Target: BroadcasterInterface,
420 F::Target: FeeEstimator,
422 let monitor_list = self.kv_store.list(
423 CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE,
424 CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE,
426 let mut res = Vec::with_capacity(monitor_list.len());
427 for monitor_key in monitor_list {
428 res.push(self.read_channel_monitor_with_updates(
437 /// Read a single channel monitor, along with any stored updates for it.
439 /// It is extremely important that your [`KVStore::read`] implementation uses the
440 /// [`io::ErrorKind::NotFound`] variant correctly. For more information, please see the
441 /// documentation for [`MonitorUpdatingPersister`].
443 /// For `monitor_key`, channel storage keys be the channel's transaction ID and index, or
444 /// [`OutPoint`], with an underscore `_` between them. For example, given:
446 /// - Transaction ID: `deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef`
449 /// The correct `monitor_key` would be:
450 /// `deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1`
452 /// Loading a large number of monitors will be faster if done in parallel. You can use this
453 /// function to accomplish this. Take care to limit the number of parallel readers.
454 pub fn read_channel_monitor_with_updates<B: Deref, F: Deref>(
455 &self, broadcaster: &B, fee_estimator: &F, monitor_key: String,
456 ) -> Result<(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>), io::Error>
458 B::Target: BroadcasterInterface,
459 F::Target: FeeEstimator,
461 let monitor_name = MonitorName::new(monitor_key)?;
462 let (block_hash, monitor) = self.read_monitor(&monitor_name)?;
463 let mut current_update_id = monitor.get_latest_update_id();
465 current_update_id = match current_update_id.checked_add(1) {
466 Some(next_update_id) => next_update_id,
469 let update_name = UpdateName::from(current_update_id);
470 let update = match self.read_monitor_update(&monitor_name, &update_name) {
471 Ok(update) => update,
472 Err(err) if err.kind() == io::ErrorKind::NotFound => {
473 // We can't find any more updates, so we are done.
476 Err(err) => return Err(err),
479 monitor.update_monitor(&update, broadcaster, fee_estimator, &self.logger)
483 "Monitor update failed. monitor: {} update: {} reason: {:?}",
484 monitor_name.as_str(),
485 update_name.as_str(),
488 io::Error::new(io::ErrorKind::Other, "Monitor update failed")
491 Ok((block_hash, monitor))
494 /// Read a channel monitor.
496 &self, monitor_name: &MonitorName,
497 ) -> Result<(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>), io::Error> {
498 let outpoint: OutPoint = monitor_name.try_into()?;
499 let mut monitor_cursor = io::Cursor::new(self.kv_store.read(
500 CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE,
501 CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE,
502 monitor_name.as_str(),
504 // Discard the sentinel bytes if found.
505 if monitor_cursor.get_ref().starts_with(MONITOR_UPDATING_PERSISTER_PREPEND_SENTINEL) {
506 monitor_cursor.set_position(MONITOR_UPDATING_PERSISTER_PREPEND_SENTINEL.len() as u64);
508 match <(BlockHash, ChannelMonitor<<SP::Target as SignerProvider>::Signer>)>::read(
510 (&*self.entropy_source, &*self.signer_provider),
512 Ok((blockhash, channel_monitor)) => {
513 if channel_monitor.get_funding_txo().0.txid != outpoint.txid
514 || channel_monitor.get_funding_txo().0.index != outpoint.index
518 "ChannelMonitor {} was stored under the wrong key!",
519 monitor_name.as_str()
522 io::ErrorKind::InvalidData,
523 "ChannelMonitor was stored under the wrong key",
526 Ok((blockhash, channel_monitor))
532 "Failed to read ChannelMonitor {}, reason: {}",
533 monitor_name.as_str(),
536 Err(io::Error::new(io::ErrorKind::InvalidData, "Failed to read ChannelMonitor"))
541 /// Read a channel monitor update.
542 fn read_monitor_update(
543 &self, monitor_name: &MonitorName, update_name: &UpdateName,
544 ) -> Result<ChannelMonitorUpdate, io::Error> {
545 let update_bytes = self.kv_store.read(
546 CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
547 monitor_name.as_str(),
548 update_name.as_str(),
550 ChannelMonitorUpdate::read(&mut io::Cursor::new(update_bytes)).map_err(|e| {
553 "Failed to read ChannelMonitorUpdate {}/{}/{}, reason: {}",
554 CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
555 monitor_name.as_str(),
556 update_name.as_str(),
559 io::Error::new(io::ErrorKind::InvalidData, "Failed to read ChannelMonitorUpdate")
563 /// Cleans up stale updates for all monitors.
565 /// This function works by first listing all monitors, and then for each of them, listing all
566 /// updates. The updates that have an `update_id` less than or equal to than the stored monitor
567 /// are deleted. The deletion can either be lazy or non-lazy based on the `lazy` flag; this will
568 /// be passed to [`KVStore::remove`].
569 pub fn cleanup_stale_updates(&self, lazy: bool) -> Result<(), io::Error> {
570 let monitor_keys = self.kv_store.list(
571 CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE,
572 CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE,
574 for monitor_key in monitor_keys {
575 let monitor_name = MonitorName::new(monitor_key)?;
576 let (_, current_monitor) = self.read_monitor(&monitor_name)?;
579 .list(CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE, monitor_name.as_str())?;
580 for update in updates {
581 let update_name = UpdateName::new(update)?;
582 // if the update_id is lower than the stored monitor, delete
583 if update_name.0 <= current_monitor.get_latest_update_id() {
584 self.kv_store.remove(
585 CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
586 monitor_name.as_str(),
587 update_name.as_str(),
597 impl<ChannelSigner: WriteableEcdsaChannelSigner, K: Deref, L: Deref, ES: Deref, SP: Deref>
598 Persist<ChannelSigner> for MonitorUpdatingPersister<K, L, ES, SP>
602 ES::Target: EntropySource + Sized,
603 SP::Target: SignerProvider + Sized,
605 /// Persists a new channel. This means writing the entire monitor to the
606 /// parametrized [`KVStore`].
607 fn persist_new_channel(
608 &self, funding_txo: OutPoint, monitor: &ChannelMonitor<ChannelSigner>,
609 _monitor_update_call_id: MonitorUpdateId,
610 ) -> chain::ChannelMonitorUpdateStatus {
611 // Determine the proper key for this monitor
612 let monitor_name = MonitorName::from(funding_txo);
613 let maybe_old_monitor = self.read_monitor(&monitor_name);
614 match maybe_old_monitor {
615 Ok((_, ref old_monitor)) => {
616 // Check that this key isn't already storing a monitor with a higher update_id
618 if old_monitor.get_latest_update_id() > monitor.get_latest_update_id() {
621 "Tried to write a monitor at the same outpoint {} with a higher update_id!",
622 monitor_name.as_str()
624 return chain::ChannelMonitorUpdateStatus::UnrecoverableError;
627 // This means the channel monitor is new.
628 Err(ref e) if e.kind() == io::ErrorKind::NotFound => {}
629 _ => return chain::ChannelMonitorUpdateStatus::UnrecoverableError,
631 // Serialize and write the new monitor
632 let mut monitor_bytes = Vec::with_capacity(
633 MONITOR_UPDATING_PERSISTER_PREPEND_SENTINEL.len() + monitor.serialized_length(),
635 monitor_bytes.extend_from_slice(MONITOR_UPDATING_PERSISTER_PREPEND_SENTINEL);
636 monitor.write(&mut monitor_bytes).unwrap();
637 match self.kv_store.write(
638 CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE,
639 CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE,
640 monitor_name.as_str(),
644 // Assess cleanup. Typically, we'll clean up only between the last two known full
646 if let Ok((_, old_monitor)) = maybe_old_monitor {
647 let start = old_monitor.get_latest_update_id();
648 let end = if monitor.get_latest_update_id() == CLOSED_CHANNEL_UPDATE_ID {
649 // We don't want to clean the rest of u64, so just do possible pending
650 // updates. Note that we never write updates at
651 // `CLOSED_CHANNEL_UPDATE_ID`.
653 start.saturating_add(self.maximum_pending_updates),
654 CLOSED_CHANNEL_UPDATE_ID - 1,
657 monitor.get_latest_update_id().saturating_sub(1)
659 // We should bother cleaning up only if there's at least one update
661 for update_id in start..=end {
662 let update_name = UpdateName::from(update_id);
663 #[cfg(debug_assertions)]
666 self.read_monitor_update(&monitor_name, &update_name)
668 // Assert that we are reading what we think we are.
669 debug_assert_eq!(update.update_id, update_name.0);
670 } else if update_id != start && monitor.get_latest_update_id() != CLOSED_CHANNEL_UPDATE_ID
672 // We're deleting something we should know doesn't exist.
674 "failed to read monitor update {}",
678 // On closed channels, we will unavoidably try to read
679 // non-existent updates since we have to guess at the range of
680 // stale updates, so do nothing.
682 if let Err(e) = self.kv_store.remove(
683 CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
684 monitor_name.as_str(),
685 update_name.as_str(),
690 "error cleaning up channel monitor updates for monitor {}, reason: {}",
691 monitor_name.as_str(),
697 chain::ChannelMonitorUpdateStatus::Completed
702 "error writing channel monitor {}/{}/{} reason: {}",
703 CHANNEL_MONITOR_PERSISTENCE_PRIMARY_NAMESPACE,
704 CHANNEL_MONITOR_PERSISTENCE_SECONDARY_NAMESPACE,
705 monitor_name.as_str(),
708 chain::ChannelMonitorUpdateStatus::UnrecoverableError
713 /// Persists a channel update, writing only the update to the parameterized [`KVStore`] if possible.
715 /// In some cases, this will forward to [`MonitorUpdatingPersister::persist_new_channel`]:
717 /// - No full monitor is found in [`KVStore`]
718 /// - The number of pending updates exceeds `maximum_pending_updates` as given to [`Self::new`]
719 /// - LDK commands re-persisting the entire monitor through this function, specifically when
720 /// `update` is `None`.
721 /// - The update is at [`CLOSED_CHANNEL_UPDATE_ID`]
722 fn update_persisted_channel(
723 &self, funding_txo: OutPoint, update: Option<&ChannelMonitorUpdate>,
724 monitor: &ChannelMonitor<ChannelSigner>, monitor_update_call_id: MonitorUpdateId,
725 ) -> chain::ChannelMonitorUpdateStatus {
726 // IMPORTANT: monitor_update_call_id: MonitorUpdateId is not to be confused with
727 // ChannelMonitorUpdate's update_id.
728 if let Some(update) = update {
729 if update.update_id != CLOSED_CHANNEL_UPDATE_ID
730 && update.update_id % self.maximum_pending_updates != 0
732 let monitor_name = MonitorName::from(funding_txo);
733 let update_name = UpdateName::from(update.update_id);
734 match self.kv_store.write(
735 CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
736 monitor_name.as_str(),
737 update_name.as_str(),
740 Ok(()) => chain::ChannelMonitorUpdateStatus::Completed,
744 "error writing channel monitor update {}/{}/{} reason: {}",
745 CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
746 monitor_name.as_str(),
747 update_name.as_str(),
750 chain::ChannelMonitorUpdateStatus::UnrecoverableError
754 // We could write this update, but it meets criteria of our design that call for a full monitor write.
755 self.persist_new_channel(funding_txo, monitor, monitor_update_call_id)
758 // There is no update given, so we must persist a new monitor.
759 self.persist_new_channel(funding_txo, monitor, monitor_update_call_id)
764 /// A struct representing a name for a monitor.
766 struct MonitorName(String);
769 /// Constructs a [`MonitorName`], after verifying that an [`OutPoint`] can
770 /// be formed from the given `name`.
771 pub fn new(name: String) -> Result<Self, io::Error> {
772 MonitorName::do_try_into_outpoint(&name)?;
775 /// Convert this monitor name to a str.
776 pub fn as_str(&self) -> &str {
779 /// Attempt to form a valid [`OutPoint`] from a given name string.
780 fn do_try_into_outpoint(name: &str) -> Result<OutPoint, io::Error> {
781 let mut parts = name.splitn(2, '_');
782 let txid = if let Some(part) = parts.next() {
783 Txid::from_hex(part).map_err(|_| {
784 io::Error::new(io::ErrorKind::InvalidData, "Invalid tx ID in stored key")
787 return Err(io::Error::new(
788 io::ErrorKind::InvalidData,
789 "Stored monitor key is not a splittable string",
792 let index = if let Some(part) = parts.next() {
793 part.parse().map_err(|_| {
794 io::Error::new(io::ErrorKind::InvalidData, "Invalid tx index in stored key")
797 return Err(io::Error::new(
798 io::ErrorKind::InvalidData,
799 "No tx index value found after underscore in stored key",
802 Ok(OutPoint { txid, index })
806 impl TryFrom<&MonitorName> for OutPoint {
807 type Error = io::Error;
809 fn try_from(value: &MonitorName) -> Result<Self, io::Error> {
810 MonitorName::do_try_into_outpoint(&value.0)
814 impl From<OutPoint> for MonitorName {
815 fn from(value: OutPoint) -> Self {
816 MonitorName(format!("{}_{}", value.txid.to_hex(), value.index))
820 /// A struct representing a name for an update.
822 struct UpdateName(u64, String);
825 /// Constructs an [`UpdateName`], after verifying that an update sequence ID
826 /// can be derived from the given `name`.
827 pub fn new(name: String) -> Result<Self, io::Error> {
828 match name.parse::<u64>() {
829 Ok(u) => Ok(u.into()),
831 Err(io::Error::new(io::ErrorKind::InvalidData, "cannot parse u64 from update name"))
836 /// Convert this monitor update name to a &str
837 pub fn as_str(&self) -> &str {
842 impl From<u64> for UpdateName {
843 fn from(value: u64) -> Self {
844 Self(value, value.to_string())
851 use crate::chain::chainmonitor::Persist;
852 use crate::chain::ChannelMonitorUpdateStatus;
853 use crate::events::{ClosureReason, MessageSendEventsProvider};
854 use crate::ln::functional_test_utils::*;
855 use crate::util::test_utils::{self, TestLogger, TestStore};
856 use crate::{check_added_monitors, check_closed_broadcast};
858 const EXPECTED_UPDATES_PER_PAYMENT: u64 = 5;
861 fn converts_u64_to_update_name() {
862 assert_eq!(UpdateName::from(0).as_str(), "0");
863 assert_eq!(UpdateName::from(21).as_str(), "21");
864 assert_eq!(UpdateName::from(u64::MAX).as_str(), "18446744073709551615");
868 fn bad_update_name_fails() {
869 assert!(UpdateName::new("deadbeef".to_string()).is_err());
870 assert!(UpdateName::new("-1".to_string()).is_err());
874 fn monitor_from_outpoint_works() {
875 let monitor_name1 = MonitorName::from(OutPoint {
876 txid: Txid::from_hex("deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef").unwrap(),
879 assert_eq!(monitor_name1.as_str(), "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_1");
881 let monitor_name2 = MonitorName::from(OutPoint {
882 txid: Txid::from_hex("f33dbeeff33dbeeff33dbeeff33dbeeff33dbeeff33dbeeff33dbeeff33dbeef").unwrap(),
885 assert_eq!(monitor_name2.as_str(), "f33dbeeff33dbeeff33dbeeff33dbeeff33dbeeff33dbeeff33dbeeff33dbeef_65535");
889 fn bad_monitor_string_fails() {
890 assert!(MonitorName::new("deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef".to_string()).is_err());
891 assert!(MonitorName::new("deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_65536".to_string()).is_err());
892 assert!(MonitorName::new("deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef_21".to_string()).is_err());
895 // Exercise the `MonitorUpdatingPersister` with real channels and payments.
897 fn persister_with_real_monitors() {
898 // This value is used later to limit how many iterations we perform.
899 let test_max_pending_updates = 7;
900 let chanmon_cfgs = create_chanmon_cfgs(4);
901 let persister_0 = MonitorUpdatingPersister {
902 kv_store: &TestStore::new(false),
903 logger: &TestLogger::new(),
904 maximum_pending_updates: test_max_pending_updates,
905 entropy_source: &chanmon_cfgs[0].keys_manager,
906 signer_provider: &chanmon_cfgs[0].keys_manager,
908 let persister_1 = MonitorUpdatingPersister {
909 kv_store: &TestStore::new(false),
910 logger: &TestLogger::new(),
911 // Intentionally set this to a smaller value to test a different alignment.
912 maximum_pending_updates: 3,
913 entropy_source: &chanmon_cfgs[1].keys_manager,
914 signer_provider: &chanmon_cfgs[1].keys_manager,
916 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
917 let chain_mon_0 = test_utils::TestChainMonitor::new(
918 Some(&chanmon_cfgs[0].chain_source),
919 &chanmon_cfgs[0].tx_broadcaster,
920 &chanmon_cfgs[0].logger,
921 &chanmon_cfgs[0].fee_estimator,
923 &chanmon_cfgs[0].keys_manager,
925 let chain_mon_1 = test_utils::TestChainMonitor::new(
926 Some(&chanmon_cfgs[1].chain_source),
927 &chanmon_cfgs[1].tx_broadcaster,
928 &chanmon_cfgs[1].logger,
929 &chanmon_cfgs[1].fee_estimator,
931 &chanmon_cfgs[1].keys_manager,
933 node_cfgs[0].chain_monitor = chain_mon_0;
934 node_cfgs[1].chain_monitor = chain_mon_1;
935 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
936 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
938 let broadcaster_0 = &chanmon_cfgs[2].tx_broadcaster;
939 let broadcaster_1 = &chanmon_cfgs[3].tx_broadcaster;
941 // Check that the persisted channel data is empty before any channels are
943 let mut persisted_chan_data_0 = persister_0.read_all_channel_monitors_with_updates(
944 &broadcaster_0, &&chanmon_cfgs[0].fee_estimator).unwrap();
945 assert_eq!(persisted_chan_data_0.len(), 0);
946 let mut persisted_chan_data_1 = persister_1.read_all_channel_monitors_with_updates(
947 &broadcaster_1, &&chanmon_cfgs[1].fee_estimator).unwrap();
948 assert_eq!(persisted_chan_data_1.len(), 0);
950 // Helper to make sure the channel is on the expected update ID.
951 macro_rules! check_persisted_data {
952 ($expected_update_id: expr) => {
953 persisted_chan_data_0 = persister_0.read_all_channel_monitors_with_updates(
954 &broadcaster_0, &&chanmon_cfgs[0].fee_estimator).unwrap();
955 // check that we stored only one monitor
956 assert_eq!(persisted_chan_data_0.len(), 1);
957 for (_, mon) in persisted_chan_data_0.iter() {
958 // check that when we read it, we got the right update id
959 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
960 // if the CM is at the correct update id without updates, ensure no updates are stored
961 let monitor_name = MonitorName::from(mon.get_funding_txo().0);
962 let (_, cm_0) = persister_0.read_monitor(&monitor_name).unwrap();
963 if cm_0.get_latest_update_id() == $expected_update_id {
965 persister_0.kv_store.list(CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
966 monitor_name.as_str()).unwrap().len(),
968 "updates stored when they shouldn't be in persister 0"
972 persisted_chan_data_1 = persister_1.read_all_channel_monitors_with_updates(
973 &broadcaster_1, &&chanmon_cfgs[1].fee_estimator).unwrap();
974 assert_eq!(persisted_chan_data_1.len(), 1);
975 for (_, mon) in persisted_chan_data_1.iter() {
976 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
977 let monitor_name = MonitorName::from(mon.get_funding_txo().0);
978 let (_, cm_1) = persister_1.read_monitor(&monitor_name).unwrap();
979 if cm_1.get_latest_update_id() == $expected_update_id {
981 persister_1.kv_store.list(CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE,
982 monitor_name.as_str()).unwrap().len(),
984 "updates stored when they shouldn't be in persister 1"
991 // Create some initial channel and check that a channel was persisted.
992 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
993 check_persisted_data!(0);
995 // Send a few payments and make sure the monitors are updated to the latest.
996 send_payment(&nodes[0], &vec![&nodes[1]][..], 8_000_000);
997 check_persisted_data!(EXPECTED_UPDATES_PER_PAYMENT);
998 send_payment(&nodes[1], &vec![&nodes[0]][..], 4_000_000);
999 check_persisted_data!(2 * EXPECTED_UPDATES_PER_PAYMENT);
1001 // Send a few more payments to try all the alignments of max pending updates with
1002 // updates for a payment sent and received.
1004 for i in 3..=test_max_pending_updates * 2 {
1013 send_payment(&nodes[sender], &vec![&nodes[receiver]][..], 21_000);
1014 check_persisted_data!(i * EXPECTED_UPDATES_PER_PAYMENT);
1017 // Force close because cooperative close doesn't result in any persisted
1019 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
1021 check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100000);
1022 check_closed_broadcast!(nodes[0], true);
1023 check_added_monitors!(nodes[0], 1);
1025 let node_txn = nodes[0].tx_broadcaster.txn_broadcast();
1026 assert_eq!(node_txn.len(), 1);
1028 connect_block(&nodes[1], &create_dummy_block(nodes[0].best_block_hash(), 42, vec![node_txn[0].clone(), node_txn[0].clone()]));
1030 check_closed_broadcast!(nodes[1], true);
1031 check_closed_event(&nodes[1], 1, ClosureReason::CommitmentTxConfirmed, false, &[nodes[0].node.get_our_node_id()], 100000);
1032 check_added_monitors!(nodes[1], 1);
1034 // Make sure everything is persisted as expected after close.
1035 check_persisted_data!(CLOSED_CHANNEL_UPDATE_ID);
1037 // Make sure the expected number of stale updates is present.
1038 let persisted_chan_data = persister_0.read_all_channel_monitors_with_updates(&broadcaster_0, &&chanmon_cfgs[0].fee_estimator).unwrap();
1039 let (_, monitor) = &persisted_chan_data[0];
1040 let monitor_name = MonitorName::from(monitor.get_funding_txo().0);
1041 // The channel should have 0 updates, as it wrote a full monitor and consolidated.
1042 assert_eq!(persister_0.kv_store.list(CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE, monitor_name.as_str()).unwrap().len(), 0);
1043 assert_eq!(persister_1.kv_store.list(CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE, monitor_name.as_str()).unwrap().len(), 0);
1046 // Test that if the `MonitorUpdatingPersister`'s can't actually write, trying to persist a
1047 // monitor or update with it results in the persister returning an UnrecoverableError status.
1049 fn unrecoverable_error_on_write_failure() {
1050 // Set up a dummy channel and force close. This will produce a monitor
1051 // that we can then use to test persistence.
1052 let chanmon_cfgs = create_chanmon_cfgs(2);
1053 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1054 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1055 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1056 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
1057 nodes[1].node.force_close_broadcasting_latest_txn(&chan.2, &nodes[0].node.get_our_node_id()).unwrap();
1058 check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed, false, &[nodes[0].node.get_our_node_id()], 100000);
1060 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
1061 let update_map = nodes[1].chain_monitor.latest_monitor_update_id.lock().unwrap();
1062 let update_id = update_map.get(&added_monitors[0].0.to_channel_id()).unwrap();
1063 let cmu_map = nodes[1].chain_monitor.monitor_updates.lock().unwrap();
1064 let cmu = &cmu_map.get(&added_monitors[0].0.to_channel_id()).unwrap()[0];
1065 let test_txo = OutPoint { txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
1067 let ro_persister = MonitorUpdatingPersister {
1068 kv_store: &TestStore::new(true),
1069 logger: &TestLogger::new(),
1070 maximum_pending_updates: 11,
1071 entropy_source: node_cfgs[0].keys_manager,
1072 signer_provider: node_cfgs[0].keys_manager,
1074 match ro_persister.persist_new_channel(test_txo, &added_monitors[0].1, update_id.2) {
1075 ChannelMonitorUpdateStatus::UnrecoverableError => {
1078 ChannelMonitorUpdateStatus::Completed => {
1079 panic!("Completed persisting new channel when shouldn't have")
1081 ChannelMonitorUpdateStatus::InProgress => {
1082 panic!("Returned InProgress when shouldn't have")
1085 match ro_persister.update_persisted_channel(test_txo, Some(cmu), &added_monitors[0].1, update_id.2) {
1086 ChannelMonitorUpdateStatus::UnrecoverableError => {
1089 ChannelMonitorUpdateStatus::Completed => {
1090 panic!("Completed persisting new channel when shouldn't have")
1092 ChannelMonitorUpdateStatus::InProgress => {
1093 panic!("Returned InProgress when shouldn't have")
1096 added_monitors.clear();
1098 nodes[1].node.get_and_clear_pending_msg_events();
1101 // Confirm that the `clean_stale_updates` function finds and deletes stale updates.
1103 fn clean_stale_updates_works() {
1104 let test_max_pending_updates = 7;
1105 let chanmon_cfgs = create_chanmon_cfgs(3);
1106 let persister_0 = MonitorUpdatingPersister {
1107 kv_store: &TestStore::new(false),
1108 logger: &TestLogger::new(),
1109 maximum_pending_updates: test_max_pending_updates,
1110 entropy_source: &chanmon_cfgs[0].keys_manager,
1111 signer_provider: &chanmon_cfgs[0].keys_manager,
1113 let persister_1 = MonitorUpdatingPersister {
1114 kv_store: &TestStore::new(false),
1115 logger: &TestLogger::new(),
1116 maximum_pending_updates: test_max_pending_updates,
1117 entropy_source: &chanmon_cfgs[1].keys_manager,
1118 signer_provider: &chanmon_cfgs[1].keys_manager,
1120 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1121 let chain_mon_0 = test_utils::TestChainMonitor::new(
1122 Some(&chanmon_cfgs[0].chain_source),
1123 &chanmon_cfgs[0].tx_broadcaster,
1124 &chanmon_cfgs[0].logger,
1125 &chanmon_cfgs[0].fee_estimator,
1127 &chanmon_cfgs[0].keys_manager,
1129 let chain_mon_1 = test_utils::TestChainMonitor::new(
1130 Some(&chanmon_cfgs[1].chain_source),
1131 &chanmon_cfgs[1].tx_broadcaster,
1132 &chanmon_cfgs[1].logger,
1133 &chanmon_cfgs[1].fee_estimator,
1135 &chanmon_cfgs[1].keys_manager,
1137 node_cfgs[0].chain_monitor = chain_mon_0;
1138 node_cfgs[1].chain_monitor = chain_mon_1;
1139 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1140 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1142 let broadcaster_0 = &chanmon_cfgs[2].tx_broadcaster;
1144 // Check that the persisted channel data is empty before any channels are
1146 let persisted_chan_data = persister_0.read_all_channel_monitors_with_updates(&broadcaster_0, &&chanmon_cfgs[0].fee_estimator).unwrap();
1147 assert_eq!(persisted_chan_data.len(), 0);
1149 // Create some initial channel
1150 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
1152 // Send a few payments to advance the updates a bit
1153 send_payment(&nodes[0], &vec![&nodes[1]][..], 8_000_000);
1154 send_payment(&nodes[1], &vec![&nodes[0]][..], 4_000_000);
1156 // Get the monitor and make a fake stale update at update_id=1 (lowest height of an update possible)
1157 let persisted_chan_data = persister_0.read_all_channel_monitors_with_updates(&broadcaster_0, &&chanmon_cfgs[0].fee_estimator).unwrap();
1158 let (_, monitor) = &persisted_chan_data[0];
1159 let monitor_name = MonitorName::from(monitor.get_funding_txo().0);
1162 .write(CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE, monitor_name.as_str(), UpdateName::from(1).as_str(), &[0u8; 1])
1165 // Do the stale update cleanup
1166 persister_0.cleanup_stale_updates(false).unwrap();
1168 // Confirm the stale update is unreadable/gone
1171 .read(CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE, monitor_name.as_str(), UpdateName::from(1).as_str())
1175 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
1176 check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100000);
1177 check_closed_broadcast!(nodes[0], true);
1178 check_added_monitors!(nodes[0], 1);
1180 // Write an update near u64::MAX
1183 .write(CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE, monitor_name.as_str(), UpdateName::from(u64::MAX - 1).as_str(), &[0u8; 1])
1186 // Do the stale update cleanup
1187 persister_0.cleanup_stale_updates(false).unwrap();
1189 // Confirm the stale update is unreadable/gone
1192 .read(CHANNEL_MONITOR_UPDATE_PERSISTENCE_PRIMARY_NAMESPACE, monitor_name.as_str(), UpdateName::from(u64::MAX - 1).as_str())