X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-block-sync%2Fsrc%2Finit.rs;h=ba93d12f5bcd7ff49d703e530c448b27707bd1a5;hb=ef2e739295be14b09d2cb6f7b2d6d7b089d2eea4;hp=d971cadcf8aea0d47a400a7a87cb4d20aaa213eb;hpb=ca163c3fae94e64b7f70a7a549cd761cfa7e52d2;p=rust-lightning diff --git a/lightning-block-sync/src/init.rs b/lightning-block-sync/src/init.rs index d971cadc..ba93d12f 100644 --- a/lightning-block-sync/src/init.rs +++ b/lightning-block-sync/src/init.rs @@ -4,20 +4,22 @@ use crate::{BlockSource, BlockSourceResult, Cache, ChainNotifier}; use crate::poll::{ChainPoller, Validate, ValidatedBlockHeader}; -use bitcoin::blockdata::block::{Block, BlockHeader}; +use bitcoin::blockdata::block::Header; 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: &mut B) -> -BlockSourceResult { +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? @@ -45,10 +47,10 @@ BlockSourceResult { /// use lightning::chain::channelmonitor::ChannelMonitor; /// use lightning::chain::chaininterface::BroadcasterInterface; /// use lightning::chain::chaininterface::FeeEstimator; -/// use lightning::chain::keysinterface; -/// use lightning::chain::keysinterface::KeysInterface; -/// use lightning::ln::channelmanager::ChannelManager; -/// use lightning::ln::channelmanager::ChannelManagerReadArgs; +/// use lightning::sign; +/// use lightning::sign::{EntropySource, NodeSigner, SignerProvider}; +/// use lightning::ln::channelmanager::{ChannelManager, ChannelManagerReadArgs}; +/// use lightning::routing::router::Router; /// use lightning::util::config::UserConfig; /// use lightning::util::logger::Logger; /// use lightning::util::ser::ReadableArgs; @@ -59,41 +61,49 @@ BlockSourceResult { /// /// async fn init_sync< /// B: BlockSource, -/// K: KeysInterface, -/// S: keysinterface::Sign, +/// ES: EntropySource, +/// NS: NodeSigner, +/// SP: SignerProvider, /// T: BroadcasterInterface, /// F: FeeEstimator, +/// R: Router, /// L: Logger, /// C: chain::Filter, -/// P: chainmonitor::Persist, +/// P: chainmonitor::Persist, /// >( -/// block_source: &mut B, -/// chain_monitor: &ChainMonitor, +/// block_source: &B, +/// chain_monitor: &ChainMonitor, /// config: UserConfig, -/// keys_manager: &K, +/// entropy_source: &ES, +/// node_signer: &NS, +/// signer_provider: &SP, /// tx_broadcaster: &T, /// fee_estimator: &F, +/// router: &R, /// logger: &L, /// persister: &P, /// ) { /// // Read a serialized channel monitor paired with the block hash when it was persisted. /// let serialized_monitor = "..."; -/// let (monitor_block_hash, mut monitor) = <(BlockHash, ChannelMonitor)>::read( -/// &mut Cursor::new(&serialized_monitor), keys_manager).unwrap(); +/// let (monitor_block_hash, mut monitor) = <(BlockHash, ChannelMonitor)>::read( +/// &mut Cursor::new(&serialized_monitor), (entropy_source, signer_provider)).unwrap(); /// /// // Read the channel manager paired with the block hash when it was persisted. /// let serialized_manager = "..."; /// let (manager_block_hash, mut manager) = { /// let read_args = ChannelManagerReadArgs::new( -/// keys_manager, +/// entropy_source, +/// node_signer, +/// signer_provider, /// fee_estimator, /// chain_monitor, /// tx_broadcaster, +/// router, /// logger, /// config, /// vec![&mut monitor], /// ); -/// <(BlockHash, ChannelManager, &T, &K, &F, &L>)>::read( +/// <(BlockHash, ChannelManager<&ChainMonitor, &T, &ES, &NS, &SP, &F, &R, &L>)>::read( /// &mut Cursor::new(&serialized_manager), read_args).unwrap() /// }; /// @@ -121,13 +131,13 @@ BlockSourceResult { /// [`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: &mut B, +pub async fn synchronize_listeners( + block_source: B, network: Network, header_cache: &mut C, - mut chain_listeners: Vec<(BlockHash, &'a L)>, -) -> BlockSourceResult { - let best_header = validate_best_block_header(block_source).await?; + 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(); @@ -171,7 +181,7 @@ pub async fn synchronize_listeners<'a, B: BlockSource, C: Cache, L: chain::Liste let chain_listener = &ChainListenerSet(chain_listeners_at_height); let mut chain_notifier = ChainNotifier { header_cache, chain_listener }; chain_notifier.connect_blocks(common_ancestor, most_connected_blocks, &mut chain_poller) - .await.or_else(|(e, _)| Err(e))?; + .await.map_err(|(e, _)| e)?; } Ok(best_header) @@ -201,11 +211,11 @@ impl<'a, C: Cache> Cache for ReadOnlyCache<'a, C> { struct DynamicChainListener<'a, L: chain::Listen + ?Sized>(&'a L); impl<'a, L: chain::Listen + ?Sized> chain::Listen for DynamicChainListener<'a, L> { - fn block_connected(&self, _block: &Block, _height: u32) { + fn filtered_block_connected(&self, _header: &Header, _txdata: &chain::transaction::TransactionData, _height: u32) { unreachable!() } - fn block_disconnected(&self, header: &BlockHeader, height: u32) { + fn block_disconnected(&self, header: &Header, height: u32) { self.0.block_disconnected(header, height) } } @@ -214,7 +224,9 @@ impl<'a, L: chain::Listen + ?Sized> chain::Listen for DynamicChainListener<'a, L struct ChainListenerSet<'a, L: chain::Listen + ?Sized>(Vec<(u32, &'a L)>); impl<'a, L: chain::Listen + ?Sized> chain::Listen for ChainListenerSet<'a, L> { - fn block_connected(&self, block: &Block, height: u32) { + // 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); @@ -222,7 +234,15 @@ impl<'a, L: chain::Listen + ?Sized> chain::Listen for ChainListenerSet<'a, L> { } } - fn block_disconnected(&self, _header: &BlockHeader, _height: u32) { + fn filtered_block_connected(&self, header: &Header, 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: &Header, _height: u32) { unreachable!() } } @@ -232,11 +252,9 @@ mod tests { use crate::test_utils::{Blockchain, MockChainListener}; use super::*; - use bitcoin::network::constants::Network; - #[tokio::test] async fn sync_from_same_chain() { - let mut chain = Blockchain::default().with_height(4); + let chain = Blockchain::default().with_height(4); let listener_1 = MockChainListener::new() .expect_block_connected(*chain.at_height(2)) @@ -254,7 +272,7 @@ mod tests { (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), } @@ -262,7 +280,7 @@ 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); @@ -291,7 +309,7 @@ mod tests { 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), } @@ -299,7 +317,7 @@ 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); @@ -334,7 +352,7 @@ mod tests { 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), } @@ -342,7 +360,7 @@ 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(); @@ -353,7 +371,7 @@ mod tests { 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));