//! Adapters that make one or more [`BlockSource`]s simpler to poll for new chain tip transitions.
-use crate::{AsyncBlockSourceResult, BlockData, BlockHeaderData, BlockSource, BlockSourceError, BlockSourceResult};
+use crate::{
+ AsyncBlockSourceResult, BlockData, BlockHeaderData, BlockSource, BlockSourceError,
+ BlockSourceResult,
+};
use bitcoin::hash_types::BlockHash;
use bitcoin::network::Network;
/// [`ChainPoller`]: ../struct.ChainPoller.html
pub trait Poll {
/// Returns a chain tip in terms of its relationship to the provided chain tip.
- fn poll_chain_tip<'a>(&'a self, best_known_chain_tip: ValidatedBlockHeader) ->
- AsyncBlockSourceResult<'a, ChainTip>;
+ fn poll_chain_tip<'a>(
+ &'a self, best_known_chain_tip: ValidatedBlockHeader,
+ ) -> AsyncBlockSourceResult<'a, ChainTip>;
/// Returns the header that preceded the given header in the chain.
- fn look_up_previous_header<'a>(&'a self, header: &'a ValidatedBlockHeader) ->
- AsyncBlockSourceResult<'a, ValidatedBlockHeader>;
+ fn look_up_previous_header<'a>(
+ &'a self, header: &'a ValidatedBlockHeader,
+ ) -> AsyncBlockSourceResult<'a, ValidatedBlockHeader>;
/// Returns the block associated with the given header.
- fn fetch_block<'a>(&'a self, header: &'a ValidatedBlockHeader) ->
- AsyncBlockSourceResult<'a, ValidatedBlock>;
+ fn fetch_block<'a>(
+ &'a self, header: &'a ValidatedBlockHeader,
+ ) -> AsyncBlockSourceResult<'a, ValidatedBlock>;
}
/// A chain tip relative to another chain tip in terms of block hash and chainwork.
type T = ValidatedBlockHeader;
fn validate(self, block_hash: BlockHash) -> BlockSourceResult<Self::T> {
- let pow_valid_block_hash = self.header
- .validate_pow(self.header.target())
- .map_err(BlockSourceError::persistent)?;
+ let pow_valid_block_hash =
+ self.header.validate_pow(self.header.target()).map_err(BlockSourceError::persistent)?;
if pow_valid_block_hash != block_hash {
return Err(BlockSourceError::persistent("invalid block hash"));
BlockData::HeaderOnly(header) => header,
};
- let pow_valid_block_hash = header
- .validate_pow(header.target())
- .map_err(BlockSourceError::persistent)?;
+ let pow_valid_block_hash =
+ header.validate_pow(header.target()).map_err(BlockSourceError::persistent)?;
if pow_valid_block_hash != block_hash {
return Err(BlockSourceError::persistent("invalid block hash"));
impl ValidatedBlockHeader {
/// Checks that the header correctly builds on previous_header: the claimed work differential
/// matches the actual PoW and the difficulty transition is possible, i.e., within 4x.
- fn check_builds_on(&self, previous_header: &ValidatedBlockHeader, network: Network) -> BlockSourceResult<()> {
+ fn check_builds_on(
+ &self, previous_header: &ValidatedBlockHeader, network: Network,
+ ) -> BlockSourceResult<()> {
if self.header.prev_blockhash != previous_header.block_hash {
return Err(BlockSourceError::persistent("invalid previous block hash"));
}
let min_target = previous_target.min_difficulty_transition_threshold();
let max_target = previous_target.max_difficulty_transition_threshold();
if target > max_target || target < min_target {
- return Err(BlockSourceError::persistent("invalid difficulty transition"))
+ return Err(BlockSourceError::persistent("invalid difficulty transition"));
}
} else if self.header.bits != previous_header.header.bits {
- return Err(BlockSourceError::persistent("invalid difficulty"))
+ return Err(BlockSourceError::persistent("invalid difficulty"));
}
}
Ok(())
}
- /// Returns the [`BestBlock`] corresponding to this validated block header, which can be passed
- /// into [`ChannelManager::new`] as part of its [`ChainParameters`]. Useful for ensuring that
- /// the [`SpvClient`] and [`ChannelManager`] are initialized to the same block during a fresh
- /// start.
- ///
- /// [`SpvClient`]: crate::SpvClient
- /// [`ChainParameters`]: lightning::ln::channelmanager::ChainParameters
- /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
- /// [`ChannelManager::new`]: lightning::ln::channelmanager::ChannelManager::new
- pub fn to_best_block(&self) -> BestBlock {
- BestBlock::new(self.block_hash, self.inner.height)
- }
+ /// Returns the [`BestBlock`] corresponding to this validated block header, which can be passed
+ /// into [`ChannelManager::new`] as part of its [`ChainParameters`]. Useful for ensuring that
+ /// the [`SpvClient`] and [`ChannelManager`] are initialized to the same block during a fresh
+ /// start.
+ ///
+ /// [`SpvClient`]: crate::SpvClient
+ /// [`ChainParameters`]: lightning::ln::channelmanager::ChainParameters
+ /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
+ /// [`ChannelManager::new`]: lightning::ln::channelmanager::ChannelManager::new
+ pub fn to_best_block(&self) -> BestBlock {
+ BestBlock::new(self.block_hash, self.inner.height)
+ }
}
/// A block with validated data against its transaction list and corresponding block hash.
///
/// Other `Poll` implementations should be built using `ChainPoller` as it provides the simplest way
/// of validating chain data and checking consistency.
-pub struct ChainPoller<B: Deref<Target=T> + Sized + Send + Sync, T: BlockSource + ?Sized> {
+pub struct ChainPoller<B: Deref<Target = T> + Sized + Send + Sync, T: BlockSource + ?Sized> {
block_source: B,
network: Network,
}
-impl<B: Deref<Target=T> + Sized + Send + Sync, T: BlockSource + ?Sized> ChainPoller<B, T> {
+impl<B: Deref<Target = T> + Sized + Send + Sync, T: BlockSource + ?Sized> ChainPoller<B, T> {
/// Creates a new poller for the given block source.
///
/// If the `network` parameter is mainnet, then the difficulty between blocks is checked for
}
}
-impl<B: Deref<Target=T> + Sized + Send + Sync, T: BlockSource + ?Sized> Poll for ChainPoller<B, T> {
- fn poll_chain_tip<'a>(&'a self, best_known_chain_tip: ValidatedBlockHeader) ->
- AsyncBlockSourceResult<'a, ChainTip>
- {
+impl<B: Deref<Target = T> + Sized + Send + Sync, T: BlockSource + ?Sized> Poll
+ for ChainPoller<B, T>
+{
+ fn poll_chain_tip<'a>(
+ &'a self, best_known_chain_tip: ValidatedBlockHeader,
+ ) -> AsyncBlockSourceResult<'a, ChainTip> {
Box::pin(async move {
let (block_hash, height) = self.block_source.get_best_block().await?;
if block_hash == best_known_chain_tip.header.block_hash() {
return Ok(ChainTip::Common);
}
- let chain_tip = self.block_source
- .get_header(&block_hash, height).await?
- .validate(block_hash)?;
+ let chain_tip =
+ self.block_source.get_header(&block_hash, height).await?.validate(block_hash)?;
if chain_tip.chainwork > best_known_chain_tip.chainwork {
Ok(ChainTip::Better(chain_tip))
} else {
})
}
- fn look_up_previous_header<'a>(&'a self, header: &'a ValidatedBlockHeader) ->
- AsyncBlockSourceResult<'a, ValidatedBlockHeader>
- {
+ fn look_up_previous_header<'a>(
+ &'a self, header: &'a ValidatedBlockHeader,
+ ) -> AsyncBlockSourceResult<'a, ValidatedBlockHeader> {
Box::pin(async move {
if header.height == 0 {
return Err(BlockSourceError::persistent("genesis block reached"));
let previous_hash = &header.header.prev_blockhash;
let height = header.height - 1;
- let previous_header = self.block_source
- .get_header(previous_hash, Some(height)).await?
+ let previous_header = self
+ .block_source
+ .get_header(previous_hash, Some(height))
+ .await?
.validate(*previous_hash)?;
header.check_builds_on(&previous_header, self.network)?;
})
}
- fn fetch_block<'a>(&'a self, header: &'a ValidatedBlockHeader) ->
- AsyncBlockSourceResult<'a, ValidatedBlock>
- {
+ fn fetch_block<'a>(
+ &'a self, header: &'a ValidatedBlockHeader,
+ ) -> AsyncBlockSourceResult<'a, ValidatedBlock> {
Box::pin(async move {
- self.block_source
- .get_block(&header.block_hash).await?
- .validate(header.block_hash)
+ self.block_source.get_block(&header.block_hash).await?.validate(header.block_hash)
})
}
}
#[cfg(test)]
mod tests {
- use crate::*;
- use crate::test_utils::Blockchain;
use super::*;
+ use crate::test_utils::Blockchain;
+ use crate::*;
#[tokio::test]
async fn poll_empty_chain() {
match poller.poll_chain_tip(best_known_chain_tip).await {
Err(e) => {
assert_eq!(e.kind(), BlockSourceErrorKind::Persistent);
- assert_eq!(e.into_inner().as_ref().to_string(), "block target correct but not attained");
+ assert_eq!(
+ e.into_inner().as_ref().to_string(),
+ "block target correct but not attained"
+ );
},
Ok(_) => panic!("Expected error"),
}
projects / rust-lightning / commitdiff