projects
/
rust-lightning
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
fix serialization backwards compat
[rust-lightning]
/
lightning-block-sync
/
src
/
init.rs
diff --git
a/lightning-block-sync/src/init.rs
b/lightning-block-sync/src/init.rs
index 83e356919b8e231a8d4a3bda41b0d65645e146fc..0bdc2a0255b85d4e902fc90e7c8924bf7d3990d7 100644
(file)
--- a/
lightning-block-sync/src/init.rs
+++ b/
lightning-block-sync/src/init.rs
@@
-1,3
+1,6
@@
+//! Utilities to assist in the initial sync required to initialize or reload Rust-Lightning objects
+//! from disk.
+
use crate::{BlockSource, BlockSourceResult, Cache, ChainNotifier};
use crate::poll::{ChainPoller, Validate, ValidatedBlockHeader};
use crate::{BlockSource, BlockSourceResult, Cache, ChainNotifier};
use crate::poll::{ChainPoller, Validate, ValidatedBlockHeader};
@@
-11,6
+14,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.
///
/// 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?;
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?;
@@
-35,8
+40,8
@@
BlockSourceResult<ValidatedBlockHeader> {
///
/// use lightning::chain;
/// use lightning::chain::Watch;
///
/// use lightning::chain;
/// use lightning::chain::Watch;
+/// use lightning::chain::chainmonitor;
/// use lightning::chain::chainmonitor::ChainMonitor;
/// use lightning::chain::chainmonitor::ChainMonitor;
-/// use lightning::chain::channelmonitor;
/// use lightning::chain::channelmonitor::ChannelMonitor;
/// use lightning::chain::chaininterface::BroadcasterInterface;
/// use lightning::chain::chaininterface::FeeEstimator;
/// use lightning::chain::channelmonitor::ChannelMonitor;
/// use lightning::chain::chaininterface::BroadcasterInterface;
/// use lightning::chain::chaininterface::FeeEstimator;
@@
-60,7
+65,7
@@
BlockSourceResult<ValidatedBlockHeader> {
/// F: FeeEstimator,
/// L: Logger,
/// C: chain::Filter,
/// F: FeeEstimator,
/// L: Logger,
/// C: chain::Filter,
-/// P: cha
nnel
monitor::Persist<S>,
+/// P: cha
in
monitor::Persist<S>,
/// >(
/// block_source: &mut B,
/// chain_monitor: &ChainMonitor<S, &C, &T, &F, &L, &P>,
/// >(
/// block_source: &mut B,
/// chain_monitor: &ChainMonitor<S, &C, &T, &F, &L, &P>,
@@
-113,9
+118,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,
pub async fn synchronize_listeners<B: BlockSource, C: Cache>(
block_source: &mut B,
network: Network,