X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;ds=inline;f=lightning-block-sync%2Fsrc%2Finit.rs;h=6611d185da393e3da10e11b720468adc06084a4c;hb=3cdbbf56e42daf67b954cd983052b09a9a18b8cd;hp=83e356919b8e231a8d4a3bda41b0d65645e146fc;hpb=03a518965100b6852f36e4f95ead4c1d93f5c4b0;p=rust-lightning diff --git a/lightning-block-sync/src/init.rs b/lightning-block-sync/src/init.rs index 83e35691..6611d185 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}; @@ -11,7 +14,9 @@ use lightning::chain; /// /// 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) -> +/// +/// [`SpvClient`]: crate::SpvClient +pub async fn validate_best_block_header(block_source: &B) -> BlockSourceResult { let (best_block_hash, best_block_height) = block_source.get_best_block().await?; block_source @@ -35,8 +40,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 +65,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, @@ -96,8 +101,8 @@ BlockSourceResult { /// 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(); @@ -113,14 +118,14 @@ 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: BlockSource, C: Cache, L: chain::Listen + ?Sized>( + block_source: &B, network: Network, header_cache: &mut C, - mut chain_listeners: Vec<(BlockHash, &mut dyn chain::Listen)>, + mut chain_listeners: Vec<(BlockHash, &'a L)>, ) -> BlockSourceResult { let best_header = validate_best_block_header(block_source).await?; @@ -193,9 +198,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!() } @@ -206,9 +211,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 { @@ -233,20 +238,20 @@ mod tests { async fn sync_from_same_chain() { let mut 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 { @@ -262,26 +267,26 @@ mod tests { 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)); @@ -299,21 +304,21 @@ mod tests { 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)) @@ -322,9 +327,9 @@ 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)); @@ -342,11 +347,11 @@ mod tests { 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 { Ok(_) => {