Clean up some doc links in lightning_block_sync.
[rust-lightning] / lightning-block-sync / src / init.rs
index 59c057157ef14bd6332d0bad1c2207b2919e741c..e9ff098940c67de501634781dc4cdc7a86c3484c 100644 (file)
@@ -11,6 +11,8 @@ use lightning::chain;
 ///
 /// 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?;
@@ -73,12 +75,12 @@ BlockSourceResult<ValidatedBlockHeader> {
 /// ) {
 ///    // Read a serialized channel monitor paired with the block hash when it was persisted.
 ///    let serialized_monitor = "...";
-///    let (monitor_block_hash_option, mut monitor) = <(Option<BlockHash>, ChannelMonitor<S>)>::read(
+///    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_option, mut manager) = {
+///    let (manager_block_hash, mut manager) = {
 ///            let read_args = ChannelManagerReadArgs::new(
 ///                    keys_manager,
 ///                    fee_estimator,
@@ -88,20 +90,17 @@ BlockSourceResult<ValidatedBlockHeader> {
 ///                    config,
 ///                    vec![&mut monitor],
 ///            );
-///            <(Option<BlockHash>, ChannelManager<S, &ChainMonitor<S, &C, &T, &F, &L, &P>, &T, &K, &F, &L>)>::read(
+///            <(BlockHash, ChannelManager<S, &ChainMonitor<S, &C, &T, &F, &L, &P>, &T, &K, &F, &L>)>::read(
 ///                    &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 = (monitor, &*tx_broadcaster, &*fee_estimator, &*logger);
-///    let mut listeners = vec![];
-///    if let Some(monitor_block_hash) = monitor_block_hash_option {
-///            listeners.push((monitor_block_hash, &mut monitor_listener as &mut dyn chain::Listen))
-///    }
-///    if let Some(manager_block_hash) = manager_block_hash_option {
-///            listeners.push((manager_block_hash, &mut manager as &mut dyn chain::Listen))
-///    }
+///    let listeners = vec![
+///            (monitor_block_hash, &mut monitor_listener as &mut dyn chain::Listen),
+///            (manager_block_hash, &mut manager as &mut dyn chain::Listen),
+///    ];
 ///    let chain_tip = init::synchronize_listeners(
 ///            block_source, Network::Bitcoin, &mut cache, listeners).await.unwrap();
 ///
@@ -116,9 +115,9 @@ BlockSourceResult<ValidatedBlockHeader> {
 /// }
 /// ```
 ///
-/// [`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,