From: Jeffrey Czyz <jkczyz@gmail.com>
Date: Tue, 2 Mar 2021 18:03:11 +0000 (-0800)
Subject: Add validate_best_block_header utility
X-Git-Tag: v0.0.13~13^2
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=60f4daf2c22431504a77814679e6fa7f6629bd12;p=rust-lightning

Add validate_best_block_header utility

Refactor synchronize_listeners by pulling out a function returning the
validated block header of a BlockSource's best chain tip. This is needed
when a node is started from scratch and has no listeners to sync.
---

diff --git a/lightning-block-sync/src/init.rs b/lightning-block-sync/src/init.rs
index 24080b15a..83e356919 100644
--- a/lightning-block-sync/src/init.rs
+++ b/lightning-block-sync/src/init.rs
@@ -7,6 +7,18 @@ 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.
+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.
 ///
@@ -110,10 +122,7 @@ pub async fn synchronize_listeners<B: BlockSource, C: Cache>(
 	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();