X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-block-sync%2Fsrc%2Finit.rs;h=0bdc2a0255b85d4e902fc90e7c8924bf7d3990d7;hb=f8d4186746ca542371e64b141d6b529131f0c0c6;hp=24080b15acb1aa208eca0982e83f01a60117ab29;hpb=e8ea0d9f041651f6cfc45e54c02e8c132c0fdeaf;p=rust-lightning

diff --git a/lightning-block-sync/src/init.rs b/lightning-block-sync/src/init.rs
index 24080b15..0bdc2a02 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,6 +10,20 @@ use bitcoin::network::constants::Network;
 
 use lightning::chain;
 
+/// 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<B: BlockSource>(block_source: &mut B) ->
+BlockSourceResult<ValidatedBlockHeader> {
+	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 +40,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,7 +65,7 @@ use lightning::chain;
 /// 	F: FeeEstimator,
 /// 	L: Logger,
 /// 	C: chain::Filter,
-/// 	P: channelmonitor::Persist<S>,
+/// 	P: chainmonitor::Persist<S>,
 /// >(
 /// 	block_source: &mut B,
 /// 	chain_monitor: &ChainMonitor<S, &C, &T, &F, &L, &P>,
@@ -101,19 +118,16 @@ use lightning::chain;
 /// }
 /// ```
 ///
-/// [`SpvClient`]: ../struct.SpvClient.html
-/// [`ChannelManager`]: ../../lightning/ln/channelmanager/struct.ChannelManager.html
-/// [`ChannelMonitor`]: ../../lightning/chain/channelmonitor/struct.ChannelMonitor.html
+/// [`SpvClient`]: crate::SpvClient
+/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
+/// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
 pub async fn synchronize_listeners<B: BlockSource, C: Cache>(
 	block_source: &mut B,
 	network: Network,
 	header_cache: &mut C,
 	mut chain_listeners: Vec<(BlockHash, &mut dyn chain::Listen)>,
 ) -> BlockSourceResult<ValidatedBlockHeader> {
-	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)?;
+	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();