1 //! Utilities to assist in the initial sync required to initialize or reload Rust-Lightning objects
4 use crate::{BlockSource, BlockSourceResult, Cache, ChainNotifier};
5 use crate::poll::{ChainPoller, Validate, ValidatedBlockHeader};
7 use bitcoin::blockdata::block::BlockHeader;
8 use bitcoin::hash_types::BlockHash;
9 use bitcoin::network::constants::Network;
15 /// Returns a validated block header of the source's best chain tip.
17 /// Upon success, the returned header can be used to initialize [`SpvClient`]. Useful during a fresh
18 /// start when there are no chain listeners to sync yet.
20 /// [`SpvClient`]: crate::SpvClient
21 pub async fn validate_best_block_header<B: Deref>(block_source: B) ->
22 BlockSourceResult<ValidatedBlockHeader> where B::Target: BlockSource {
23 let (best_block_hash, best_block_height) = block_source.get_best_block().await?;
25 .get_header(&best_block_hash, best_block_height).await?
26 .validate(best_block_hash)
29 /// Performs a one-time sync of chain listeners using a single *trusted* block source, bringing each
30 /// listener's view of the chain from its paired block hash to `block_source`'s best chain tip.
32 /// Upon success, the returned header can be used to initialize [`SpvClient`]. In the case of
33 /// failure, each listener may be left at a different block hash than the one it was originally
36 /// Useful during startup to bring the [`ChannelManager`] and each [`ChannelMonitor`] in sync before
37 /// switching to [`SpvClient`]. For example:
40 /// use bitcoin::hash_types::BlockHash;
41 /// use bitcoin::network::constants::Network;
43 /// use lightning::chain;
44 /// use lightning::chain::Watch;
45 /// use lightning::chain::chainmonitor;
46 /// use lightning::chain::chainmonitor::ChainMonitor;
47 /// use lightning::chain::channelmonitor::ChannelMonitor;
48 /// use lightning::chain::chaininterface::BroadcasterInterface;
49 /// use lightning::chain::chaininterface::FeeEstimator;
50 /// use lightning::chain::keysinterface;
51 /// use lightning::chain::keysinterface::KeysInterface;
52 /// use lightning::ln::channelmanager::ChannelManager;
53 /// use lightning::ln::channelmanager::ChannelManagerReadArgs;
54 /// use lightning::util::config::UserConfig;
55 /// use lightning::util::logger::Logger;
56 /// use lightning::util::ser::ReadableArgs;
58 /// use lightning_block_sync::*;
60 /// use std::io::Cursor;
62 /// async fn init_sync<
64 /// K: KeysInterface<Signer = S>,
65 /// S: keysinterface::Sign,
66 /// T: BroadcasterInterface,
70 /// P: chainmonitor::Persist<S>,
73 /// chain_monitor: &ChainMonitor<S, &C, &T, &F, &L, &P>,
74 /// config: UserConfig,
76 /// tx_broadcaster: &T,
77 /// fee_estimator: &F,
81 /// // Read a serialized channel monitor paired with the block hash when it was persisted.
82 /// let serialized_monitor = "...";
83 /// let (monitor_block_hash, mut monitor) = <(BlockHash, ChannelMonitor<S>)>::read(
84 /// &mut Cursor::new(&serialized_monitor), keys_manager).unwrap();
86 /// // Read the channel manager paired with the block hash when it was persisted.
87 /// let serialized_manager = "...";
88 /// let (manager_block_hash, mut manager) = {
89 /// let read_args = ChannelManagerReadArgs::new(
96 /// vec![&mut monitor],
98 /// <(BlockHash, ChannelManager<&ChainMonitor<S, &C, &T, &F, &L, &P>, &T, &K, &F, &L>)>::read(
99 /// &mut Cursor::new(&serialized_manager), read_args).unwrap()
102 /// // Synchronize any channel monitors and the channel manager to be on the best block.
103 /// let mut cache = UnboundedCache::new();
104 /// let mut monitor_listener = (monitor, &*tx_broadcaster, &*fee_estimator, &*logger);
105 /// let listeners = vec![
106 /// (monitor_block_hash, &monitor_listener as &dyn chain::Listen),
107 /// (manager_block_hash, &manager as &dyn chain::Listen),
109 /// let chain_tip = init::synchronize_listeners(
110 /// block_source, Network::Bitcoin, &mut cache, listeners).await.unwrap();
112 /// // Allow the chain monitor to watch any channels.
113 /// let monitor = monitor_listener.0;
114 /// chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
116 /// // Create an SPV client to notify the chain monitor and channel manager of block events.
117 /// let chain_poller = poll::ChainPoller::new(block_source, Network::Bitcoin);
118 /// let mut chain_listener = (chain_monitor, &manager);
119 /// let spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);
123 /// [`SpvClient`]: crate::SpvClient
124 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
125 /// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
126 pub async fn synchronize_listeners<B: Deref + Sized + Send + Sync, C: Cache, L: chain::Listen + ?Sized>(
129 header_cache: &mut C,
130 mut chain_listeners: Vec<(BlockHash, &L)>,
131 ) -> BlockSourceResult<ValidatedBlockHeader> where B::Target: BlockSource {
132 let best_header = validate_best_block_header(&*block_source).await?;
134 // Fetch the header for the block hash paired with each listener.
135 let mut chain_listeners_with_old_headers = Vec::new();
136 for (old_block_hash, chain_listener) in chain_listeners.drain(..) {
137 let old_header = match header_cache.look_up(&old_block_hash) {
138 Some(header) => *header,
140 .get_header(&old_block_hash, None).await?
141 .validate(old_block_hash)?
143 chain_listeners_with_old_headers.push((old_header, chain_listener))
146 // Find differences and disconnect blocks for each listener individually.
147 let mut chain_poller = ChainPoller::new(block_source, network);
148 let mut chain_listeners_at_height = Vec::new();
149 let mut most_common_ancestor = None;
150 let mut most_connected_blocks = Vec::new();
151 for (old_header, chain_listener) in chain_listeners_with_old_headers.drain(..) {
152 // Disconnect any stale blocks, but keep them in the cache for the next iteration.
153 let header_cache = &mut ReadOnlyCache(header_cache);
154 let (common_ancestor, connected_blocks) = {
155 let chain_listener = &DynamicChainListener(chain_listener);
156 let mut chain_notifier = ChainNotifier { header_cache, chain_listener };
158 chain_notifier.find_difference(best_header, &old_header, &mut chain_poller).await?;
159 chain_notifier.disconnect_blocks(difference.disconnected_blocks);
160 (difference.common_ancestor, difference.connected_blocks)
163 // Keep track of the most common ancestor and all blocks connected across all listeners.
164 chain_listeners_at_height.push((common_ancestor.height, chain_listener));
165 if connected_blocks.len() > most_connected_blocks.len() {
166 most_common_ancestor = Some(common_ancestor);
167 most_connected_blocks = connected_blocks;
171 // Connect new blocks for all listeners at once to avoid re-fetching blocks.
172 if let Some(common_ancestor) = most_common_ancestor {
173 let chain_listener = &ChainListenerSet(chain_listeners_at_height);
174 let mut chain_notifier = ChainNotifier { header_cache, chain_listener };
175 chain_notifier.connect_blocks(common_ancestor, most_connected_blocks, &mut chain_poller)
176 .await.or_else(|(e, _)| Err(e))?;
182 /// A wrapper to make a cache read-only.
184 /// Used to prevent losing headers that may be needed to disconnect blocks common to more than one
186 struct ReadOnlyCache<'a, C: Cache>(&'a mut C);
188 impl<'a, C: Cache> Cache for ReadOnlyCache<'a, C> {
189 fn look_up(&self, block_hash: &BlockHash) -> Option<&ValidatedBlockHeader> {
190 self.0.look_up(block_hash)
193 fn block_connected(&mut self, _block_hash: BlockHash, _block_header: ValidatedBlockHeader) {
197 fn block_disconnected(&mut self, _block_hash: &BlockHash) -> Option<ValidatedBlockHeader> {
202 /// Wrapper for supporting dynamically sized chain listeners.
203 struct DynamicChainListener<'a, L: chain::Listen + ?Sized>(&'a L);
205 impl<'a, L: chain::Listen + ?Sized> chain::Listen for DynamicChainListener<'a, L> {
206 fn filtered_block_connected(&self, _header: &BlockHeader, _txdata: &chain::transaction::TransactionData, _height: u32) {
210 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
211 self.0.block_disconnected(header, height)
215 /// A set of dynamically sized chain listeners, each paired with a starting block height.
216 struct ChainListenerSet<'a, L: chain::Listen + ?Sized>(Vec<(u32, &'a L)>);
218 impl<'a, L: chain::Listen + ?Sized> chain::Listen for ChainListenerSet<'a, L> {
219 // Needed to differentiate test expectations.
221 fn block_connected(&self, block: &bitcoin::Block, height: u32) {
222 for (starting_height, chain_listener) in self.0.iter() {
223 if height > *starting_height {
224 chain_listener.block_connected(block, height);
229 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &chain::transaction::TransactionData, height: u32) {
230 for (starting_height, chain_listener) in self.0.iter() {
231 if height > *starting_height {
232 chain_listener.filtered_block_connected(header, txdata, height);
237 fn block_disconnected(&self, _header: &BlockHeader, _height: u32) {
244 use crate::test_utils::{Blockchain, MockChainListener};
247 use bitcoin::network::constants::Network;
250 async fn sync_from_same_chain() {
251 let chain = Blockchain::default().with_height(4);
253 let listener_1 = MockChainListener::new()
254 .expect_block_connected(*chain.at_height(2))
255 .expect_block_connected(*chain.at_height(3))
256 .expect_block_connected(*chain.at_height(4));
257 let listener_2 = MockChainListener::new()
258 .expect_block_connected(*chain.at_height(3))
259 .expect_block_connected(*chain.at_height(4));
260 let listener_3 = MockChainListener::new()
261 .expect_block_connected(*chain.at_height(4));
263 let listeners = vec![
264 (chain.at_height(1).block_hash, &listener_1 as &dyn chain::Listen),
265 (chain.at_height(2).block_hash, &listener_2 as &dyn chain::Listen),
266 (chain.at_height(3).block_hash, &listener_3 as &dyn chain::Listen),
268 let mut cache = chain.header_cache(0..=4);
269 match synchronize_listeners(&chain, Network::Bitcoin, &mut cache, listeners).await {
270 Ok(header) => assert_eq!(header, chain.tip()),
271 Err(e) => panic!("Unexpected error: {:?}", e),
276 async fn sync_from_different_chains() {
277 let main_chain = Blockchain::default().with_height(4);
278 let fork_chain_1 = main_chain.fork_at_height(1);
279 let fork_chain_2 = main_chain.fork_at_height(2);
280 let fork_chain_3 = main_chain.fork_at_height(3);
282 let listener_1 = MockChainListener::new()
283 .expect_block_disconnected(*fork_chain_1.at_height(4))
284 .expect_block_disconnected(*fork_chain_1.at_height(3))
285 .expect_block_disconnected(*fork_chain_1.at_height(2))
286 .expect_block_connected(*main_chain.at_height(2))
287 .expect_block_connected(*main_chain.at_height(3))
288 .expect_block_connected(*main_chain.at_height(4));
289 let listener_2 = MockChainListener::new()
290 .expect_block_disconnected(*fork_chain_2.at_height(4))
291 .expect_block_disconnected(*fork_chain_2.at_height(3))
292 .expect_block_connected(*main_chain.at_height(3))
293 .expect_block_connected(*main_chain.at_height(4));
294 let listener_3 = MockChainListener::new()
295 .expect_block_disconnected(*fork_chain_3.at_height(4))
296 .expect_block_connected(*main_chain.at_height(4));
298 let listeners = vec![
299 (fork_chain_1.tip().block_hash, &listener_1 as &dyn chain::Listen),
300 (fork_chain_2.tip().block_hash, &listener_2 as &dyn chain::Listen),
301 (fork_chain_3.tip().block_hash, &listener_3 as &dyn chain::Listen),
303 let mut cache = fork_chain_1.header_cache(2..=4);
304 cache.extend(fork_chain_2.header_cache(3..=4));
305 cache.extend(fork_chain_3.header_cache(4..=4));
306 match synchronize_listeners(&main_chain, Network::Bitcoin, &mut cache, listeners).await {
307 Ok(header) => assert_eq!(header, main_chain.tip()),
308 Err(e) => panic!("Unexpected error: {:?}", e),
313 async fn sync_from_overlapping_chains() {
314 let main_chain = Blockchain::default().with_height(4);
315 let fork_chain_1 = main_chain.fork_at_height(1);
316 let fork_chain_2 = fork_chain_1.fork_at_height(2);
317 let fork_chain_3 = fork_chain_2.fork_at_height(3);
319 let listener_1 = MockChainListener::new()
320 .expect_block_disconnected(*fork_chain_1.at_height(4))
321 .expect_block_disconnected(*fork_chain_1.at_height(3))
322 .expect_block_disconnected(*fork_chain_1.at_height(2))
323 .expect_block_connected(*main_chain.at_height(2))
324 .expect_block_connected(*main_chain.at_height(3))
325 .expect_block_connected(*main_chain.at_height(4));
326 let listener_2 = MockChainListener::new()
327 .expect_block_disconnected(*fork_chain_2.at_height(4))
328 .expect_block_disconnected(*fork_chain_2.at_height(3))
329 .expect_block_disconnected(*fork_chain_2.at_height(2))
330 .expect_block_connected(*main_chain.at_height(2))
331 .expect_block_connected(*main_chain.at_height(3))
332 .expect_block_connected(*main_chain.at_height(4));
333 let listener_3 = MockChainListener::new()
334 .expect_block_disconnected(*fork_chain_3.at_height(4))
335 .expect_block_disconnected(*fork_chain_3.at_height(3))
336 .expect_block_disconnected(*fork_chain_3.at_height(2))
337 .expect_block_connected(*main_chain.at_height(2))
338 .expect_block_connected(*main_chain.at_height(3))
339 .expect_block_connected(*main_chain.at_height(4));
341 let listeners = vec![
342 (fork_chain_1.tip().block_hash, &listener_1 as &dyn chain::Listen),
343 (fork_chain_2.tip().block_hash, &listener_2 as &dyn chain::Listen),
344 (fork_chain_3.tip().block_hash, &listener_3 as &dyn chain::Listen),
346 let mut cache = fork_chain_1.header_cache(2..=4);
347 cache.extend(fork_chain_2.header_cache(3..=4));
348 cache.extend(fork_chain_3.header_cache(4..=4));
349 match synchronize_listeners(&main_chain, Network::Bitcoin, &mut cache, listeners).await {
350 Ok(header) => assert_eq!(header, main_chain.tip()),
351 Err(e) => panic!("Unexpected error: {:?}", e),
356 async fn cache_connected_and_keep_disconnected_blocks() {
357 let main_chain = Blockchain::default().with_height(2);
358 let fork_chain = main_chain.fork_at_height(1);
359 let new_tip = main_chain.tip();
360 let old_tip = fork_chain.tip();
362 let listener = MockChainListener::new()
363 .expect_block_disconnected(*old_tip)
364 .expect_block_connected(*new_tip);
366 let listeners = vec![(old_tip.block_hash, &listener as &dyn chain::Listen)];
367 let mut cache = fork_chain.header_cache(2..=2);
368 match synchronize_listeners(&main_chain, Network::Bitcoin, &mut cache, listeners).await {
370 assert!(cache.contains_key(&new_tip.block_hash));
371 assert!(cache.contains_key(&old_tip.block_hash));
373 Err(e) => panic!("Unexpected error: {:?}", e),