X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-block-sync%2Fsrc%2Finit.rs;h=7e1cb3fb6ee8c375169b8377e721cb25081d66db;hb=790d26f63f1ed6fff8742bd0df58bf010a11b567;hp=24080b15acb1aa208eca0982e83f01a60117ab29;hpb=e241ca43396befbf7ebdab430c4eac7f379533e1;p=rust-lightning diff --git a/lightning-block-sync/src/init.rs b/lightning-block-sync/src/init.rs index 24080b15..7e1cb3fb 100644 --- a/lightning-block-sync/src/init.rs +++ b/lightning-block-sync/src/init.rs @@ -1,12 +1,31 @@ +//! Utilities to assist in the initial sync required to initialize or reload Rust-Lightning objects +//! from disk. + use crate::{BlockSource, BlockSourceResult, Cache, ChainNotifier}; use crate::poll::{ChainPoller, Validate, ValidatedBlockHeader}; -use bitcoin::blockdata::block::{Block, BlockHeader}; +use bitcoin::blockdata::block::BlockHeader; use bitcoin::hash_types::BlockHash; use bitcoin::network::constants::Network; use lightning::chain; +use std::ops::Deref; + +/// Returns a validated block header of the source's best chain tip. +/// +/// Upon success, the returned header can be used to initialize [`SpvClient`]. Useful during a fresh +/// start when there are no chain listeners to sync yet. +/// +/// [`SpvClient`]: crate::SpvClient +pub async fn validate_best_block_header(block_source: B) -> +BlockSourceResult where B::Target: BlockSource { + let (best_block_hash, best_block_height) = block_source.get_best_block().await?; + block_source + .get_header(&best_block_hash, best_block_height).await? + .validate(best_block_hash) +} + /// Performs a one-time sync of chain listeners using a single *trusted* block source, bringing each /// listener's view of the chain from its paired block hash to `block_source`'s best chain tip. /// @@ -23,8 +42,8 @@ use lightning::chain; /// /// use lightning::chain; /// use lightning::chain::Watch; +/// use lightning::chain::chainmonitor; /// use lightning::chain::chainmonitor::ChainMonitor; -/// use lightning::chain::channelmonitor; /// use lightning::chain::channelmonitor::ChannelMonitor; /// use lightning::chain::chaininterface::BroadcasterInterface; /// use lightning::chain::chaininterface::FeeEstimator; @@ -48,9 +67,9 @@ use lightning::chain; /// F: FeeEstimator, /// L: Logger, /// C: chain::Filter, -/// P: channelmonitor::Persist, +/// P: chainmonitor::Persist, /// >( -/// block_source: &mut B, +/// block_source: &B, /// chain_monitor: &ChainMonitor, /// config: UserConfig, /// keys_manager: &K, @@ -76,7 +95,7 @@ use lightning::chain; /// config, /// vec![&mut monitor], /// ); -/// <(BlockHash, ChannelManager, &T, &K, &F, &L>)>::read( +/// <(BlockHash, ChannelManager<&ChainMonitor, &T, &K, &F, &L>)>::read( /// &mut Cursor::new(&serialized_manager), read_args).unwrap() /// }; /// @@ -84,8 +103,8 @@ use lightning::chain; /// let mut cache = UnboundedCache::new(); /// let mut monitor_listener = (monitor, &*tx_broadcaster, &*fee_estimator, &*logger); /// let listeners = vec![ -/// (monitor_block_hash, &mut monitor_listener as &mut dyn chain::Listen), -/// (manager_block_hash, &mut manager as &mut dyn chain::Listen), +/// (monitor_block_hash, &monitor_listener as &dyn chain::Listen), +/// (manager_block_hash, &manager as &dyn chain::Listen), /// ]; /// let chain_tip = init::synchronize_listeners( /// block_source, Network::Bitcoin, &mut cache, listeners).await.unwrap(); @@ -101,19 +120,16 @@ use lightning::chain; /// } /// ``` /// -/// [`SpvClient`]: ../struct.SpvClient.html -/// [`ChannelManager`]: ../../lightning/ln/channelmanager/struct.ChannelManager.html -/// [`ChannelMonitor`]: ../../lightning/chain/channelmonitor/struct.ChannelMonitor.html -pub async fn synchronize_listeners( - block_source: &mut B, +/// [`SpvClient`]: crate::SpvClient +/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager +/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor +pub async fn synchronize_listeners( + block_source: B, network: Network, header_cache: &mut C, - mut chain_listeners: Vec<(BlockHash, &mut dyn chain::Listen)>, -) -> BlockSourceResult { - let (best_block_hash, best_block_height) = block_source.get_best_block().await?; - let best_header = block_source - .get_header(&best_block_hash, best_block_height).await? - .validate(best_block_hash)?; + mut chain_listeners: Vec<(BlockHash, &L)>, +) -> BlockSourceResult where B::Target: BlockSource { + let best_header = validate_best_block_header(&*block_source).await?; // Fetch the header for the block hash paired with each listener. let mut chain_listeners_with_old_headers = Vec::new(); @@ -184,10 +200,10 @@ impl<'a, C: Cache> Cache for ReadOnlyCache<'a, C> { } /// Wrapper for supporting dynamically sized chain listeners. -struct DynamicChainListener<'a>(&'a mut dyn chain::Listen); +struct DynamicChainListener<'a, L: chain::Listen + ?Sized>(&'a L); -impl<'a> chain::Listen for DynamicChainListener<'a> { - fn block_connected(&self, _block: &Block, _height: u32) { +impl<'a, L: chain::Listen + ?Sized> chain::Listen for DynamicChainListener<'a, L> { + fn filtered_block_connected(&self, _header: &BlockHeader, _txdata: &chain::transaction::TransactionData, _height: u32) { unreachable!() } @@ -197,10 +213,12 @@ impl<'a> chain::Listen for DynamicChainListener<'a> { } /// A set of dynamically sized chain listeners, each paired with a starting block height. -struct ChainListenerSet<'a>(Vec<(u32, &'a mut dyn chain::Listen)>); +struct ChainListenerSet<'a, L: chain::Listen + ?Sized>(Vec<(u32, &'a L)>); -impl<'a> chain::Listen for ChainListenerSet<'a> { - fn block_connected(&self, block: &Block, height: u32) { +impl<'a, L: chain::Listen + ?Sized> chain::Listen for ChainListenerSet<'a, L> { + // Needed to differentiate test expectations. + #[cfg(test)] + fn block_connected(&self, block: &bitcoin::Block, height: u32) { for (starting_height, chain_listener) in self.0.iter() { if height > *starting_height { chain_listener.block_connected(block, height); @@ -208,6 +226,14 @@ impl<'a> chain::Listen for ChainListenerSet<'a> { } } + fn filtered_block_connected(&self, header: &BlockHeader, txdata: &chain::transaction::TransactionData, height: u32) { + for (starting_height, chain_listener) in self.0.iter() { + if height > *starting_height { + chain_listener.filtered_block_connected(header, txdata, height); + } + } + } + fn block_disconnected(&self, _header: &BlockHeader, _height: u32) { unreachable!() } @@ -222,25 +248,25 @@ mod tests { #[tokio::test] async fn sync_from_same_chain() { - let mut chain = Blockchain::default().with_height(4); + let chain = Blockchain::default().with_height(4); - let mut listener_1 = MockChainListener::new() + let listener_1 = MockChainListener::new() .expect_block_connected(*chain.at_height(2)) .expect_block_connected(*chain.at_height(3)) .expect_block_connected(*chain.at_height(4)); - let mut listener_2 = MockChainListener::new() + let listener_2 = MockChainListener::new() .expect_block_connected(*chain.at_height(3)) .expect_block_connected(*chain.at_height(4)); - let mut listener_3 = MockChainListener::new() + let listener_3 = MockChainListener::new() .expect_block_connected(*chain.at_height(4)); let listeners = vec![ - (chain.at_height(1).block_hash, &mut listener_1 as &mut dyn chain::Listen), - (chain.at_height(2).block_hash, &mut listener_2 as &mut dyn chain::Listen), - (chain.at_height(3).block_hash, &mut listener_3 as &mut dyn chain::Listen), + (chain.at_height(1).block_hash, &listener_1 as &dyn chain::Listen), + (chain.at_height(2).block_hash, &listener_2 as &dyn chain::Listen), + (chain.at_height(3).block_hash, &listener_3 as &dyn chain::Listen), ]; let mut cache = chain.header_cache(0..=4); - match synchronize_listeners(&mut chain, Network::Bitcoin, &mut cache, listeners).await { + match synchronize_listeners(&chain, Network::Bitcoin, &mut cache, listeners).await { Ok(header) => assert_eq!(header, chain.tip()), Err(e) => panic!("Unexpected error: {:?}", e), } @@ -248,36 +274,36 @@ mod tests { #[tokio::test] async fn sync_from_different_chains() { - let mut main_chain = Blockchain::default().with_height(4); + let main_chain = Blockchain::default().with_height(4); let fork_chain_1 = main_chain.fork_at_height(1); let fork_chain_2 = main_chain.fork_at_height(2); let fork_chain_3 = main_chain.fork_at_height(3); - let mut listener_1 = MockChainListener::new() + let listener_1 = MockChainListener::new() .expect_block_disconnected(*fork_chain_1.at_height(4)) .expect_block_disconnected(*fork_chain_1.at_height(3)) .expect_block_disconnected(*fork_chain_1.at_height(2)) .expect_block_connected(*main_chain.at_height(2)) .expect_block_connected(*main_chain.at_height(3)) .expect_block_connected(*main_chain.at_height(4)); - let mut listener_2 = MockChainListener::new() + let listener_2 = MockChainListener::new() .expect_block_disconnected(*fork_chain_2.at_height(4)) .expect_block_disconnected(*fork_chain_2.at_height(3)) .expect_block_connected(*main_chain.at_height(3)) .expect_block_connected(*main_chain.at_height(4)); - let mut listener_3 = MockChainListener::new() + let listener_3 = MockChainListener::new() .expect_block_disconnected(*fork_chain_3.at_height(4)) .expect_block_connected(*main_chain.at_height(4)); let listeners = vec![ - (fork_chain_1.tip().block_hash, &mut listener_1 as &mut dyn chain::Listen), - (fork_chain_2.tip().block_hash, &mut listener_2 as &mut dyn chain::Listen), - (fork_chain_3.tip().block_hash, &mut listener_3 as &mut dyn chain::Listen), + (fork_chain_1.tip().block_hash, &listener_1 as &dyn chain::Listen), + (fork_chain_2.tip().block_hash, &listener_2 as &dyn chain::Listen), + (fork_chain_3.tip().block_hash, &listener_3 as &dyn chain::Listen), ]; let mut cache = fork_chain_1.header_cache(2..=4); cache.extend(fork_chain_2.header_cache(3..=4)); cache.extend(fork_chain_3.header_cache(4..=4)); - match synchronize_listeners(&mut main_chain, Network::Bitcoin, &mut cache, listeners).await { + match synchronize_listeners(&main_chain, Network::Bitcoin, &mut cache, listeners).await { Ok(header) => assert_eq!(header, main_chain.tip()), Err(e) => panic!("Unexpected error: {:?}", e), } @@ -285,26 +311,26 @@ mod tests { #[tokio::test] async fn sync_from_overlapping_chains() { - let mut main_chain = Blockchain::default().with_height(4); + let main_chain = Blockchain::default().with_height(4); let fork_chain_1 = main_chain.fork_at_height(1); let fork_chain_2 = fork_chain_1.fork_at_height(2); let fork_chain_3 = fork_chain_2.fork_at_height(3); - let mut listener_1 = MockChainListener::new() + let listener_1 = MockChainListener::new() .expect_block_disconnected(*fork_chain_1.at_height(4)) .expect_block_disconnected(*fork_chain_1.at_height(3)) .expect_block_disconnected(*fork_chain_1.at_height(2)) .expect_block_connected(*main_chain.at_height(2)) .expect_block_connected(*main_chain.at_height(3)) .expect_block_connected(*main_chain.at_height(4)); - let mut listener_2 = MockChainListener::new() + let listener_2 = MockChainListener::new() .expect_block_disconnected(*fork_chain_2.at_height(4)) .expect_block_disconnected(*fork_chain_2.at_height(3)) .expect_block_disconnected(*fork_chain_2.at_height(2)) .expect_block_connected(*main_chain.at_height(2)) .expect_block_connected(*main_chain.at_height(3)) .expect_block_connected(*main_chain.at_height(4)); - let mut listener_3 = MockChainListener::new() + let listener_3 = MockChainListener::new() .expect_block_disconnected(*fork_chain_3.at_height(4)) .expect_block_disconnected(*fork_chain_3.at_height(3)) .expect_block_disconnected(*fork_chain_3.at_height(2)) @@ -313,14 +339,14 @@ mod tests { .expect_block_connected(*main_chain.at_height(4)); let listeners = vec![ - (fork_chain_1.tip().block_hash, &mut listener_1 as &mut dyn chain::Listen), - (fork_chain_2.tip().block_hash, &mut listener_2 as &mut dyn chain::Listen), - (fork_chain_3.tip().block_hash, &mut listener_3 as &mut dyn chain::Listen), + (fork_chain_1.tip().block_hash, &listener_1 as &dyn chain::Listen), + (fork_chain_2.tip().block_hash, &listener_2 as &dyn chain::Listen), + (fork_chain_3.tip().block_hash, &listener_3 as &dyn chain::Listen), ]; let mut cache = fork_chain_1.header_cache(2..=4); cache.extend(fork_chain_2.header_cache(3..=4)); cache.extend(fork_chain_3.header_cache(4..=4)); - match synchronize_listeners(&mut main_chain, Network::Bitcoin, &mut cache, listeners).await { + match synchronize_listeners(&main_chain, Network::Bitcoin, &mut cache, listeners).await { Ok(header) => assert_eq!(header, main_chain.tip()), Err(e) => panic!("Unexpected error: {:?}", e), } @@ -328,18 +354,18 @@ mod tests { #[tokio::test] async fn cache_connected_and_keep_disconnected_blocks() { - let mut main_chain = Blockchain::default().with_height(2); + let main_chain = Blockchain::default().with_height(2); let fork_chain = main_chain.fork_at_height(1); let new_tip = main_chain.tip(); let old_tip = fork_chain.tip(); - let mut listener = MockChainListener::new() + let listener = MockChainListener::new() .expect_block_disconnected(*old_tip) .expect_block_connected(*new_tip); - let listeners = vec![(old_tip.block_hash, &mut listener as &mut dyn chain::Listen)]; + let listeners = vec![(old_tip.block_hash, &listener as &dyn chain::Listen)]; let mut cache = fork_chain.header_cache(2..=2); - match synchronize_listeners(&mut main_chain, Network::Bitcoin, &mut cache, listeners).await { + match synchronize_listeners(&main_chain, Network::Bitcoin, &mut cache, listeners).await { Ok(_) => { assert!(cache.contains_key(&new_tip.block_hash)); assert!(cache.contains_key(&old_tip.block_hash));