Skip to content

Commit 4089bfb

Browse files
committed
f dont use crate in Clean up some doc links in lightning_block_sync.
1 parent d24e335 commit 4089bfb

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

lightning-block-sync/src/init.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ use lightning::chain;
99

1010
/// Returns a validated block header of the source's best chain tip.
1111
///
12-
/// Upon success, the returned header can be used to initialize [`crate::SpvClient`]. Useful during a fresh
12+
/// Upon success, the returned header can be used to initialize [`SpvClient`]. Useful during a fresh
1313
/// start when there are no chain listeners to sync yet.
14+
///
15+
/// [`SpvClient`]: crate::SpvClient
1416
pub async fn validate_best_block_header<B: BlockSource>(block_source: &mut B) ->
1517
BlockSourceResult<ValidatedBlockHeader> {
1618
let (best_block_hash, best_block_height) = block_source.get_best_block().await?;
@@ -22,12 +24,12 @@ BlockSourceResult<ValidatedBlockHeader> {
2224
/// Performs a one-time sync of chain listeners using a single *trusted* block source, bringing each
2325
/// listener's view of the chain from its paired block hash to `block_source`'s best chain tip.
2426
///
25-
/// Upon success, the returned header can be used to initialize [`crate::SpvClient`]. In the case of
27+
/// Upon success, the returned header can be used to initialize [`SpvClient`]. In the case of
2628
/// failure, each listener may be left at a different block hash than the one it was originally
2729
/// paired with.
2830
///
2931
/// Useful during startup to bring the [`ChannelManager`] and each [`ChannelMonitor`] in sync before
30-
/// switching to [`crate::SpvClient`]. For example:
32+
/// switching to [`SpvClient`]. For example:
3133
///
3234
/// ```
3335
/// use bitcoin::hash_types::BlockHash;
@@ -113,6 +115,7 @@ BlockSourceResult<ValidatedBlockHeader> {
113115
/// }
114116
/// ```
115117
///
118+
/// [`SpvClient`]: crate::SpvClient
116119
/// [`ChannelManager`]: `lightning::ln::channelmanager::ChannelManager`
117120
/// [`ChannelMonitor`]: `lightning::chain::channelmonitor::ChannelMonitor`
118121
pub async fn synchronize_listeners<B: BlockSource, C: Cache>(

0 commit comments

Comments
 (0)