X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-block-sync%2Fsrc%2Finit.rs;h=5ba6ba39a8f3db2a2452decea64d9cef474b473d;hb=8967d20b299db92991ffa03fc7cc3df361b6619c;hp=59c057157ef14bd6332d0bad1c2207b2919e741c;hpb=4894d52d30399c21b7994952a8de0d1d7848c58d;p=rust-lightning diff --git a/lightning-block-sync/src/init.rs b/lightning-block-sync/src/init.rs index 59c05715..5ba6ba39 100644 --- a/lightning-block-sync/src/init.rs +++ b/lightning-block-sync/src/init.rs @@ -1,3 +1,6 @@ +//! 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}; @@ -7,12 +10,16 @@ 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. -pub async fn validate_best_block_header(block_source: &mut B) -> -BlockSourceResult { +/// +/// [`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? @@ -35,8 +42,8 @@ BlockSourceResult { /// /// 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; @@ -60,9 +67,9 @@ BlockSourceResult { /// 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, @@ -73,12 +80,12 @@ BlockSourceResult { /// ) { /// // Read a serialized channel monitor paired with the block hash when it was persisted. /// let serialized_monitor = "..."; -/// let (monitor_block_hash_option, mut monitor) = <(Option, ChannelMonitor)>::read( +/// let (monitor_block_hash, mut monitor) = <(BlockHash, ChannelMonitor)>::read( /// &mut Cursor::new(&serialized_monitor), keys_manager).unwrap(); /// /// // Read the channel manager paired with the block hash when it was persisted. /// let serialized_manager = "..."; -/// let (manager_block_hash_option, mut manager) = { +/// let (manager_block_hash, mut manager) = { /// let read_args = ChannelManagerReadArgs::new( /// keys_manager, /// fee_estimator, @@ -88,20 +95,17 @@ BlockSourceResult { /// config, /// vec![&mut monitor], /// ); -/// <(Option, ChannelManager, &T, &K, &F, &L>)>::read( +/// <(BlockHash, ChannelManager, &T, &K, &F, &L>)>::read( /// &mut Cursor::new(&serialized_manager), read_args).unwrap() /// }; /// /// // Synchronize any channel monitors and the channel manager to be on the best block. /// let mut cache = UnboundedCache::new(); /// let mut monitor_listener = (monitor, &*tx_broadcaster, &*fee_estimator, &*logger); -/// let mut listeners = vec![]; -/// if let Some(monitor_block_hash) = monitor_block_hash_option { -/// listeners.push((monitor_block_hash, &mut monitor_listener as &mut dyn chain::Listen)) -/// } -/// if let Some(manager_block_hash) = manager_block_hash_option { -/// listeners.push((manager_block_hash, &mut manager as &mut dyn chain::Listen)) -/// } +/// let listeners = vec![ +/// (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(); /// @@ -116,16 +120,16 @@ BlockSourceResult { /// } /// ``` /// -/// [`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<'a, B: Deref + Sized + Send + Sync, C: Cache, L: chain::Listen + ?Sized>( + block_source: B, network: Network, header_cache: &mut C, - mut chain_listeners: Vec<(BlockHash, &mut dyn chain::Listen)>, -) -> BlockSourceResult { - let best_header = validate_best_block_header(block_source).await?; + mut chain_listeners: Vec<(BlockHash, &'a 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(); @@ -196,9 +200,9 @@ 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> { +impl<'a, L: chain::Listen + ?Sized> chain::Listen for DynamicChainListener<'a, L> { fn block_connected(&self, _block: &Block, _height: u32) { unreachable!() } @@ -209,9 +213,9 @@ 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> { +impl<'a, L: chain::Listen + ?Sized> chain::Listen for ChainListenerSet<'a, L> { fn block_connected(&self, block: &Block, height: u32) { for (starting_height, chain_listener) in self.0.iter() { if height > *starting_height { @@ -234,25 +238,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), } @@ -260,36 +264,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), } @@ -297,26 +301,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)) @@ -325,14 +329,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), } @@ -340,18 +344,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));