f - Document the example code

Author: jkczyz

lightning-block-sync/src/init.rs

@@ -60,10 +60,12 @@ use lightning::chain;
 /// 	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<S>)>::read(
 /// 		&mut Cursor::new(&serialized_monitor), keys_manager).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(
@@ -79,6 +81,7 @@ use lightning::chain;
 /// 			&mut Cursor::new(&serialized_manager), read_args).unwrap()
 /// 	};
 ///
+/// 	// Synchronize any channel monitors and the channel manager to be on the best block.
 /// 	let mut cache = UnboundedCache::new();
 /// 	let mut monitor_listener = (RefCell::new(monitor), &*tx_broadcaster, &*fee_estimator, &*logger);
 /// 	let listeners = vec![
@@ -88,9 +91,11 @@ use lightning::chain;
 /// 	let chain_tip = init::synchronize_listeners(
 /// 		block_source, Network::Bitcoin, &mut cache, listeners).await.unwrap();
 ///
+/// 	// Allow the chain monitor to watch any channels.
 /// 	let monitor = monitor_listener.0.into_inner();
 /// 	chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
 ///
+/// 	// Create an SPV client to notify the chain monitor and channel manager of block events.
 /// 	let chain_poller = poll::ChainPoller::new(block_source, Network::Bitcoin);
 /// 	let mut chain_listener = (chain_monitor, &manager);
 /// 	let spv_client = SpvClient::new(chain_tip, chain_poller, &mut cache, &chain_listener);