f - replace FilteredBlock with HeaderOnly

Author: jkczyz

lightning-block-sync/src/lib.rs

@@ -46,7 +46,6 @@ mod utils;
 use crate::poll::{ChainTip, Poll, ValidatedBlockHeader};
 
 use bitcoin::blockdata::block::{Block, BlockHeader};
-use bitcoin::blockdata::transaction::Transaction;
 use bitcoin::hash_types::BlockHash;
 use bitcoin::util::uint::Uint256;
 
@@ -153,22 +152,18 @@ pub struct BlockHeaderData {
 	pub chainwork: Uint256,
 }
 
-/// A block containing either all or only pertinent transactions.
+/// A block including either all its transactions or only the block header.
 ///
-/// See [`chain::Filter`] for when a [`BlockSource`] should be implemented to filter only pertinent
-/// transactions.
+/// [`BlockSource`] may be implemented to either always return full blocks or, in the case of
+/// compact block filters (BIP 157/158), return header-only blocks when no pertinent transactions
+/// match. See [`chain::Filter`] for details on how to notify a source of such transactions.
 pub enum BlockData {
 	/// A block containing all its transactions.
 	FullBlock(Block),
-	/// A block that has been filtered for only pertinent transactions.
-	FilteredBlock(BlockHeader, OwnedTransactionData),
+	/// A block header for when the block does not contain any pertinent transactions.
+	HeaderOnly(BlockHeader),
 }
 
-/// Similar to [`TransactionData`] only for [`Transaction`] data owned outside of a block.
-///
-/// [`TransactionData`]: chain::transaction::TransactionData
-pub type OwnedTransactionData = Vec<(usize, Transaction)>;
-
 /// A lightweight client for keeping a listener in sync with the chain, allowing for Simplified
 /// Payment Verification (SPV).
 ///
@@ -423,9 +418,8 @@ impl<'a, C: Cache, L: Deref> ChainNotifier<'a, C, L> where L::Target: chain::Lis
 				BlockData::FullBlock(block) => {
 					self.chain_listener.block_connected(&block, height);
 				},
-				BlockData::FilteredBlock(header, txdata) => {
-					let txdata: Vec<_> = txdata.iter().map(|(idx, tx)| (*idx, tx)).collect();
-					self.chain_listener.filtered_block_connected(&header, &txdata, height);
+				BlockData::HeaderOnly(header) => {
+					self.chain_listener.filtered_block_connected(&header, &[], height);
 				},
 			}
 

lightning-block-sync/src/poll.rs

@@ -76,7 +76,7 @@ impl Validate for BlockData {
 	fn validate(self, block_hash: BlockHash) -> BlockSourceResult<Self::T> {
 		let header = match &self {
 			BlockData::FullBlock(block) => &block.header,
-			BlockData::FilteredBlock(header, _) => header,
+			BlockData::HeaderOnly(header) => header,
 		};
 
 		let pow_valid_block_hash = header

lightning-block-sync/src/test_utils.rs

@@ -162,9 +162,7 @@ impl BlockSource for Blockchain {
 					}
 
 					if self.filtered_blocks {
-						let header = block.header.clone();
-						let txdata = block.txdata.clone().into_iter().enumerate().collect();
-						return Ok(BlockData::FilteredBlock(header, txdata));
+						return Ok(BlockData::HeaderOnly(block.header.clone()));
 					} else {
 						return Ok(BlockData::FullBlock(block.clone()));
 					}