Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
360 changes: 190 additions & 170 deletions lightning-block-sync/src/convert.rs

Large diffs are not rendered by default.

99 changes: 55 additions & 44 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,21 +6,21 @@ use crate::{AsyncBlockSourceResult, BlockData, BlockSource, BlockSourceError};

use bitcoin::blockdata::block::Block;
use bitcoin::blockdata::constants::ChainHash;
use bitcoin::blockdata::transaction::{TxOut, OutPoint};
use bitcoin::blockdata::transaction::{OutPoint, TxOut};
use bitcoin::hash_types::BlockHash;

use lightning::ln::peer_handler::APeerManager;

use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoResult, UtxoLookupError};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoLookupError, UtxoResult};

use lightning::util::logger::Logger;

use std::sync::{Arc, Mutex};
use std::collections::VecDeque;
use std::future::Future;
use std::ops::Deref;
use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::task::Poll;

/// A trait which extends [`BlockSource`] and can be queried to fetch the block at a given height
Expand All@@ -29,12 +29,14 @@ use std::task::Poll;
/// Note that while this is implementable for a [`BlockSource`] which returns filtered block data
/// (i.e. [`BlockData::HeaderOnly`] for [`BlockSource::get_block`] requests), such an
/// implementation will reject all gossip as it is not fully able to verify the UTXOs referenced.
pub trait UtxoSource: BlockSource + 'static {
pub trait UtxoSource: BlockSource + 'static {
/// Fetches the block hash of the block at the given height.
///
/// This will, in turn, be passed to to [`BlockSource::get_block`] to fetch the block needed
/// for gossip validation.
fn get_block_hash_by_height<'a>(&'a self, block_height: u32) -> AsyncBlockSourceResult<'a, BlockHash>;
fn get_block_hash_by_height<'a>(
&'a self, block_height: u32,
) -> AsyncBlockSourceResult<'a, BlockHash>;

/// Returns true if the given output has *not* been spent, i.e. is a member of the current UTXO
/// set.
Expand All@@ -45,7 +47,7 @@ pub trait UtxoSource : BlockSource + 'static {
///
/// If the `tokio` feature is enabled, this is implemented on `TokioSpawner` struct which
/// delegates to `tokio::spawn()`.
pub trait FutureSpawner: Send + Sync + 'static {
pub trait FutureSpawner: Send + Sync + 'static {
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
Expand All@@ -65,8 +67,8 @@ impl FutureSpawner for TokioSpawner {
/// A trivial future which joins two other futures and polls them at the same time, returning only
/// once both complete.
pub(crate) struct Joiner<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> {
pub a: A,
pub b: B,
Expand All@@ -75,16 +77,20 @@ pub(crate) struct Joiner<
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B> {
fn new(a: A, b: B) -> Self { Self { a, b, a_res: None, b_res: None } }
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B>
{
fn new(a: A, b: B) -> Self {
Self { a, b, a_res: None, b_res: None }
}
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B> {
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B>
{
type Output = Result<((BlockHash, Option<u32>), BlockHash), BlockSourceError>;
fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<Self::Output> {
if self.a_res.is_none() {
Expand All@@ -107,14 +113,13 @@ impl<
} else {
return Poll::Ready(Err(res.unwrap_err()));
}

},
Poll::Pending => {},
}
}
if let Some(b_res) = self.b_res {
if let Some(a_res) = self.a_res {
return Poll::Ready(Ok((a_res, b_res)))
return Poll::Ready(Ok((a_res, b_res)));
}
}
Poll::Pending
Expand All@@ -129,7 +134,8 @@ impl<
/// value of 1024 should more than suffice), and ensure you have sufficient file descriptors
/// available on both Bitcoin Core and your LDK application for each request to hold its own
/// connection.
pub struct GossipVerifier<S: FutureSpawner,
pub struct GossipVerifier<
S: FutureSpawner,
Blocks: Deref + Send + Sync + 'static + Clone,
L: Deref + Send + Sync + 'static,
> where
Expand All@@ -145,10 +151,9 @@ pub struct GossipVerifier<S: FutureSpawner,

const BLOCK_CACHE_SIZE: usize = 5;

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync>
GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand All@@ -157,27 +162,34 @@ impl<S: FutureSpawner,
/// This is expected to be given to a [`P2PGossipSync`] (initially constructed with `None` for
/// the UTXO lookup) via [`P2PGossipSync::add_utxo_lookup`].
pub fn new<APM: Deref + Send + Sync + Clone + 'static>(
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>, peer_manager: APM
) -> Self where APM::Target: APeerManager {
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>,
peer_manager: APM,
) -> Self
where
APM::Target: APeerManager,
{
let peer_manager_wake = Arc::new(move || peer_manager.as_ref().process_events());
Self {
source, spawn, gossiper, peer_manager_wake,
source,
spawn,
gossiper,
peer_manager_wake,
block_cache: Arc::new(Mutex::new(VecDeque::with_capacity(BLOCK_CACHE_SIZE))),
}
}

async fn retrieve_utxo(
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64,
) -> Result<TxOut, UtxoLookupError> {
let block_height = (short_channel_id >> 5 * 8) as u32; // block height is most significant three bytes
let transaction_index = ((short_channel_id >> 2 * 8) & 0xffffff) as u32;
let output_index = (short_channel_id & 0xffff) as u16;

let (outpoint, output);

'tx_found: loop { // Used as a simple goto
'tx_found: loop {
macro_rules! process_block {
($block: expr) => {{
($block: expr) => {{
if transaction_index as usize >= $block.txdata.len() {
return Err(UtxoLookupError::UnknownTx);
}
Expand All@@ -188,7 +200,7 @@ impl<S: FutureSpawner,

outpoint = OutPoint::new(transaction.txid(), output_index.into());
output = transaction.output[output_index as usize].clone();
} }
}};
}
{
let recent_blocks = block_cache.lock().unwrap();
Expand All@@ -202,8 +214,8 @@ impl<S: FutureSpawner,

let ((_, tip_height_opt), block_hash) =
Joiner::new(source.get_best_block(), source.get_block_hash_by_height(block_height))
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
if let Some(tip_height) = tip_height_opt {
// If the block doesn't yet have five confirmations, error out.
//
Expand All@@ -214,8 +226,8 @@ impl<S: FutureSpawner,
return Err(UtxoLookupError::UnknownTx);
}
}
let block_data = source.get_block(&block_hash).await
.map_err(|_| UtxoLookupError::UnknownTx)?;
let block_data =
source.get_block(&block_hash).await.map_err(|_| UtxoLookupError::UnknownTx)?;
let block = match block_data {
BlockData::HeaderOnly(_) => return Err(UtxoLookupError::UnknownTx),
BlockData::FullBlock(block) => block,
Expand All@@ -237,7 +249,7 @@ impl<S: FutureSpawner,
}
}
break 'tx_found;
};
}
let outpoint_unspent =
source.is_output_unspent(outpoint).await.map_err(|_| UtxoLookupError::UnknownTx)?;
if outpoint_unspent {
Expand All@@ -248,22 +260,21 @@ impl<S: FutureSpawner,
}
}

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> Deref for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> Deref
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
type Target = Self;
fn deref(&self) -> &Self { self }
fn deref(&self) -> &Self {
self
}
}


impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> UtxoLookup for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> UtxoLookup
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Run `rustfmt` on `lightning-block-sync` by tnull · Pull Request #3136 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
360 changes: 190 additions & 170 deletions lightning-block-sync/src/convert.rs

Large diffs are not rendered by default.

99 changes: 55 additions & 44 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,21 +6,21 @@ use crate::{AsyncBlockSourceResult, BlockData, BlockSource, BlockSourceError};

use bitcoin::blockdata::block::Block;
use bitcoin::blockdata::constants::ChainHash;
use bitcoin::blockdata::transaction::{TxOut, OutPoint};
use bitcoin::blockdata::transaction::{OutPoint, TxOut};
use bitcoin::hash_types::BlockHash;

use lightning::ln::peer_handler::APeerManager;

use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoResult, UtxoLookupError};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoLookupError, UtxoResult};

use lightning::util::logger::Logger;

use std::sync::{Arc, Mutex};
use std::collections::VecDeque;
use std::future::Future;
use std::ops::Deref;
use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::task::Poll;

/// A trait which extends [`BlockSource`] and can be queried to fetch the block at a given height
Expand All@@ -29,12 +29,14 @@ use std::task::Poll;
/// Note that while this is implementable for a [`BlockSource`] which returns filtered block data
/// (i.e. [`BlockData::HeaderOnly`] for [`BlockSource::get_block`] requests), such an
/// implementation will reject all gossip as it is not fully able to verify the UTXOs referenced.
pub trait UtxoSource: BlockSource + 'static {
pub trait UtxoSource: BlockSource + 'static {
/// Fetches the block hash of the block at the given height.
///
/// This will, in turn, be passed to to [`BlockSource::get_block`] to fetch the block needed
/// for gossip validation.
fn get_block_hash_by_height<'a>(&'a self, block_height: u32) -> AsyncBlockSourceResult<'a, BlockHash>;
fn get_block_hash_by_height<'a>(
&'a self, block_height: u32,
) -> AsyncBlockSourceResult<'a, BlockHash>;

/// Returns true if the given output has *not* been spent, i.e. is a member of the current UTXO
/// set.
Expand All@@ -45,7 +47,7 @@ pub trait UtxoSource : BlockSource + 'static {
///
/// If the `tokio` feature is enabled, this is implemented on `TokioSpawner` struct which
/// delegates to `tokio::spawn()`.
pub trait FutureSpawner: Send + Sync + 'static {
pub trait FutureSpawner: Send + Sync + 'static {
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
Expand All@@ -65,8 +67,8 @@ impl FutureSpawner for TokioSpawner {
/// A trivial future which joins two other futures and polls them at the same time, returning only
/// once both complete.
pub(crate) struct Joiner<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> {
pub a: A,
pub b: B,
Expand All@@ -75,16 +77,20 @@ pub(crate) struct Joiner<
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B> {
fn new(a: A, b: B) -> Self { Self { a, b, a_res: None, b_res: None } }
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B>
{
fn new(a: A, b: B) -> Self {
Self { a, b, a_res: None, b_res: None }
}
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B> {
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B>
{
type Output = Result<((BlockHash, Option<u32>), BlockHash), BlockSourceError>;
fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<Self::Output> {
if self.a_res.is_none() {
Expand All@@ -107,14 +113,13 @@ impl<
} else {
return Poll::Ready(Err(res.unwrap_err()));
}

},
Poll::Pending => {},
}
}
if let Some(b_res) = self.b_res {
if let Some(a_res) = self.a_res {
return Poll::Ready(Ok((a_res, b_res)))
return Poll::Ready(Ok((a_res, b_res)));
}
}
Poll::Pending
Expand All@@ -129,7 +134,8 @@ impl<
/// value of 1024 should more than suffice), and ensure you have sufficient file descriptors
/// available on both Bitcoin Core and your LDK application for each request to hold its own
/// connection.
pub struct GossipVerifier<S: FutureSpawner,
pub struct GossipVerifier<
S: FutureSpawner,
Blocks: Deref + Send + Sync + 'static + Clone,
L: Deref + Send + Sync + 'static,
> where
Expand All@@ -145,10 +151,9 @@ pub struct GossipVerifier<S: FutureSpawner,

const BLOCK_CACHE_SIZE: usize = 5;

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync>
GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand All@@ -157,27 +162,34 @@ impl<S: FutureSpawner,
/// This is expected to be given to a [`P2PGossipSync`] (initially constructed with `None` for
/// the UTXO lookup) via [`P2PGossipSync::add_utxo_lookup`].
pub fn new<APM: Deref + Send + Sync + Clone + 'static>(
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>, peer_manager: APM
) -> Self where APM::Target: APeerManager {
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>,
peer_manager: APM,
) -> Self
where
APM::Target: APeerManager,
{
let peer_manager_wake = Arc::new(move || peer_manager.as_ref().process_events());
Self {
source, spawn, gossiper, peer_manager_wake,
source,
spawn,
gossiper,
peer_manager_wake,
block_cache: Arc::new(Mutex::new(VecDeque::with_capacity(BLOCK_CACHE_SIZE))),
}
}

async fn retrieve_utxo(
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64,
) -> Result<TxOut, UtxoLookupError> {
let block_height = (short_channel_id >> 5 * 8) as u32; // block height is most significant three bytes
let transaction_index = ((short_channel_id >> 2 * 8) & 0xffffff) as u32;
let output_index = (short_channel_id & 0xffff) as u16;

let (outpoint, output);

'tx_found: loop { // Used as a simple goto
'tx_found: loop {
macro_rules! process_block {
($block: expr) => {{
($block: expr) => {{
if transaction_index as usize >= $block.txdata.len() {
return Err(UtxoLookupError::UnknownTx);
}
Expand All@@ -188,7 +200,7 @@ impl<S: FutureSpawner,

outpoint = OutPoint::new(transaction.txid(), output_index.into());
output = transaction.output[output_index as usize].clone();
} }
}};
}
{
let recent_blocks = block_cache.lock().unwrap();
Expand All@@ -202,8 +214,8 @@ impl<S: FutureSpawner,

let ((_, tip_height_opt), block_hash) =
Joiner::new(source.get_best_block(), source.get_block_hash_by_height(block_height))
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
if let Some(tip_height) = tip_height_opt {
// If the block doesn't yet have five confirmations, error out.
//
Expand All@@ -214,8 +226,8 @@ impl<S: FutureSpawner,
return Err(UtxoLookupError::UnknownTx);
}
}
let block_data = source.get_block(&block_hash).await
.map_err(|_| UtxoLookupError::UnknownTx)?;
let block_data =
source.get_block(&block_hash).await.map_err(|_| UtxoLookupError::UnknownTx)?;
let block = match block_data {
BlockData::HeaderOnly(_) => return Err(UtxoLookupError::UnknownTx),
BlockData::FullBlock(block) => block,
Expand All@@ -237,7 +249,7 @@ impl<S: FutureSpawner,
}
}
break 'tx_found;
};
}
let outpoint_unspent =
source.is_output_unspent(outpoint).await.map_err(|_| UtxoLookupError::UnknownTx)?;
if outpoint_unspent {
Expand All@@ -248,22 +260,21 @@ impl<S: FutureSpawner,
}
}

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> Deref for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> Deref
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
type Target = Self;
fn deref(&self) -> &Self { self }
fn deref(&self) -> &Self {
self
}
}


impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> UtxoLookup for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> UtxoLookup
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Run `rustfmt` on `lightning-block-sync` by tnull · Pull Request #3136 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
360 changes: 190 additions & 170 deletions lightning-block-sync/src/convert.rs

Large diffs are not rendered by default.

99 changes: 55 additions & 44 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,21 +6,21 @@ use crate::{AsyncBlockSourceResult, BlockData, BlockSource, BlockSourceError};

use bitcoin::blockdata::block::Block;
use bitcoin::blockdata::constants::ChainHash;
use bitcoin::blockdata::transaction::{TxOut, OutPoint};
use bitcoin::blockdata::transaction::{OutPoint, TxOut};
use bitcoin::hash_types::BlockHash;

use lightning::ln::peer_handler::APeerManager;

use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoResult, UtxoLookupError};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoLookupError, UtxoResult};

use lightning::util::logger::Logger;

use std::sync::{Arc, Mutex};
use std::collections::VecDeque;
use std::future::Future;
use std::ops::Deref;
use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::task::Poll;

/// A trait which extends [`BlockSource`] and can be queried to fetch the block at a given height
Expand All@@ -29,12 +29,14 @@ use std::task::Poll;
/// Note that while this is implementable for a [`BlockSource`] which returns filtered block data
/// (i.e. [`BlockData::HeaderOnly`] for [`BlockSource::get_block`] requests), such an
/// implementation will reject all gossip as it is not fully able to verify the UTXOs referenced.
pub trait UtxoSource: BlockSource + 'static {
pub trait UtxoSource: BlockSource + 'static {
/// Fetches the block hash of the block at the given height.
///
/// This will, in turn, be passed to to [`BlockSource::get_block`] to fetch the block needed
/// for gossip validation.
fn get_block_hash_by_height<'a>(&'a self, block_height: u32) -> AsyncBlockSourceResult<'a, BlockHash>;
fn get_block_hash_by_height<'a>(
&'a self, block_height: u32,
) -> AsyncBlockSourceResult<'a, BlockHash>;

/// Returns true if the given output has *not* been spent, i.e. is a member of the current UTXO
/// set.
Expand All@@ -45,7 +47,7 @@ pub trait UtxoSource : BlockSource + 'static {
///
/// If the `tokio` feature is enabled, this is implemented on `TokioSpawner` struct which
/// delegates to `tokio::spawn()`.
pub trait FutureSpawner: Send + Sync + 'static {
pub trait FutureSpawner: Send + Sync + 'static {
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
Expand All@@ -65,8 +67,8 @@ impl FutureSpawner for TokioSpawner {
/// A trivial future which joins two other futures and polls them at the same time, returning only
/// once both complete.
pub(crate) struct Joiner<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> {
pub a: A,
pub b: B,
Expand All@@ -75,16 +77,20 @@ pub(crate) struct Joiner<
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B> {
fn new(a: A, b: B) -> Self { Self { a, b, a_res: None, b_res: None } }
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B>
{
fn new(a: A, b: B) -> Self {
Self { a, b, a_res: None, b_res: None }
}
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B> {
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B>
{
type Output = Result<((BlockHash, Option<u32>), BlockHash), BlockSourceError>;
fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<Self::Output> {
if self.a_res.is_none() {
Expand All@@ -107,14 +113,13 @@ impl<
} else {
return Poll::Ready(Err(res.unwrap_err()));
}

},
Poll::Pending => {},
}
}
if let Some(b_res) = self.b_res {
if let Some(a_res) = self.a_res {
return Poll::Ready(Ok((a_res, b_res)))
return Poll::Ready(Ok((a_res, b_res)));
}
}
Poll::Pending
Expand All@@ -129,7 +134,8 @@ impl<
/// value of 1024 should more than suffice), and ensure you have sufficient file descriptors
/// available on both Bitcoin Core and your LDK application for each request to hold its own
/// connection.
pub struct GossipVerifier<S: FutureSpawner,
pub struct GossipVerifier<
S: FutureSpawner,
Blocks: Deref + Send + Sync + 'static + Clone,
L: Deref + Send + Sync + 'static,
> where
Expand All@@ -145,10 +151,9 @@ pub struct GossipVerifier<S: FutureSpawner,

const BLOCK_CACHE_SIZE: usize = 5;

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync>
GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand All@@ -157,27 +162,34 @@ impl<S: FutureSpawner,
/// This is expected to be given to a [`P2PGossipSync`] (initially constructed with `None` for
/// the UTXO lookup) via [`P2PGossipSync::add_utxo_lookup`].
pub fn new<APM: Deref + Send + Sync + Clone + 'static>(
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>, peer_manager: APM
) -> Self where APM::Target: APeerManager {
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>,
peer_manager: APM,
) -> Self
where
APM::Target: APeerManager,
{
let peer_manager_wake = Arc::new(move || peer_manager.as_ref().process_events());
Self {
source, spawn, gossiper, peer_manager_wake,
source,
spawn,
gossiper,
peer_manager_wake,
block_cache: Arc::new(Mutex::new(VecDeque::with_capacity(BLOCK_CACHE_SIZE))),
}
}

async fn retrieve_utxo(
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64,
) -> Result<TxOut, UtxoLookupError> {
let block_height = (short_channel_id >> 5 * 8) as u32; // block height is most significant three bytes
let transaction_index = ((short_channel_id >> 2 * 8) & 0xffffff) as u32;
let output_index = (short_channel_id & 0xffff) as u16;

let (outpoint, output);

'tx_found: loop { // Used as a simple goto
'tx_found: loop {
macro_rules! process_block {
($block: expr) => {{
($block: expr) => {{
if transaction_index as usize >= $block.txdata.len() {
return Err(UtxoLookupError::UnknownTx);
}
Expand All@@ -188,7 +200,7 @@ impl<S: FutureSpawner,

outpoint = OutPoint::new(transaction.txid(), output_index.into());
output = transaction.output[output_index as usize].clone();
} }
}};
}
{
let recent_blocks = block_cache.lock().unwrap();
Expand All@@ -202,8 +214,8 @@ impl<S: FutureSpawner,

let ((_, tip_height_opt), block_hash) =
Joiner::new(source.get_best_block(), source.get_block_hash_by_height(block_height))
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
if let Some(tip_height) = tip_height_opt {
// If the block doesn't yet have five confirmations, error out.
//
Expand All@@ -214,8 +226,8 @@ impl<S: FutureSpawner,
return Err(UtxoLookupError::UnknownTx);
}
}
let block_data = source.get_block(&block_hash).await
.map_err(|_| UtxoLookupError::UnknownTx)?;
let block_data =
source.get_block(&block_hash).await.map_err(|_| UtxoLookupError::UnknownTx)?;
let block = match block_data {
BlockData::HeaderOnly(_) => return Err(UtxoLookupError::UnknownTx),
BlockData::FullBlock(block) => block,
Expand All@@ -237,7 +249,7 @@ impl<S: FutureSpawner,
}
}
break 'tx_found;
};
}
let outpoint_unspent =
source.is_output_unspent(outpoint).await.map_err(|_| UtxoLookupError::UnknownTx)?;
if outpoint_unspent {
Expand All@@ -248,22 +260,21 @@ impl<S: FutureSpawner,
}
}

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> Deref for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> Deref
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
type Target = Self;
fn deref(&self) -> &Self { self }
fn deref(&self) -> &Self {
self
}
}


impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> UtxoLookup for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> UtxoLookup
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Run `rustfmt` on `lightning-block-sync` by tnull · Pull Request #3136 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
360 changes: 190 additions & 170 deletions lightning-block-sync/src/convert.rs

Large diffs are not rendered by default.

99 changes: 55 additions & 44 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,21 +6,21 @@ use crate::{AsyncBlockSourceResult, BlockData, BlockSource, BlockSourceError};

use bitcoin::blockdata::block::Block;
use bitcoin::blockdata::constants::ChainHash;
use bitcoin::blockdata::transaction::{TxOut, OutPoint};
use bitcoin::blockdata::transaction::{OutPoint, TxOut};
use bitcoin::hash_types::BlockHash;

use lightning::ln::peer_handler::APeerManager;

use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoResult, UtxoLookupError};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoLookupError, UtxoResult};

use lightning::util::logger::Logger;

use std::sync::{Arc, Mutex};
use std::collections::VecDeque;
use std::future::Future;
use std::ops::Deref;
use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::task::Poll;

/// A trait which extends [`BlockSource`] and can be queried to fetch the block at a given height
Expand All@@ -29,12 +29,14 @@ use std::task::Poll;
/// Note that while this is implementable for a [`BlockSource`] which returns filtered block data
/// (i.e. [`BlockData::HeaderOnly`] for [`BlockSource::get_block`] requests), such an
/// implementation will reject all gossip as it is not fully able to verify the UTXOs referenced.
pub trait UtxoSource: BlockSource + 'static {
pub trait UtxoSource: BlockSource + 'static {
/// Fetches the block hash of the block at the given height.
///
/// This will, in turn, be passed to to [`BlockSource::get_block`] to fetch the block needed
/// for gossip validation.
fn get_block_hash_by_height<'a>(&'a self, block_height: u32) -> AsyncBlockSourceResult<'a, BlockHash>;
fn get_block_hash_by_height<'a>(
&'a self, block_height: u32,
) -> AsyncBlockSourceResult<'a, BlockHash>;

/// Returns true if the given output has *not* been spent, i.e. is a member of the current UTXO
/// set.
Expand All@@ -45,7 +47,7 @@ pub trait UtxoSource : BlockSource + 'static {
///
/// If the `tokio` feature is enabled, this is implemented on `TokioSpawner` struct which
/// delegates to `tokio::spawn()`.
pub trait FutureSpawner: Send + Sync + 'static {
pub trait FutureSpawner: Send + Sync + 'static {
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
Expand All@@ -65,8 +67,8 @@ impl FutureSpawner for TokioSpawner {
/// A trivial future which joins two other futures and polls them at the same time, returning only
/// once both complete.
pub(crate) struct Joiner<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> {
pub a: A,
pub b: B,
Expand All@@ -75,16 +77,20 @@ pub(crate) struct Joiner<
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B> {
fn new(a: A, b: B) -> Self { Self { a, b, a_res: None, b_res: None } }
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B>
{
fn new(a: A, b: B) -> Self {
Self { a, b, a_res: None, b_res: None }
}
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B> {
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B>
{
type Output = Result<((BlockHash, Option<u32>), BlockHash), BlockSourceError>;
fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<Self::Output> {
if self.a_res.is_none() {
Expand All@@ -107,14 +113,13 @@ impl<
} else {
return Poll::Ready(Err(res.unwrap_err()));
}

},
Poll::Pending => {},
}
}
if let Some(b_res) = self.b_res {
if let Some(a_res) = self.a_res {
return Poll::Ready(Ok((a_res, b_res)))
return Poll::Ready(Ok((a_res, b_res)));
}
}
Poll::Pending
Expand All@@ -129,7 +134,8 @@ impl<
/// value of 1024 should more than suffice), and ensure you have sufficient file descriptors
/// available on both Bitcoin Core and your LDK application for each request to hold its own
/// connection.
pub struct GossipVerifier<S: FutureSpawner,
pub struct GossipVerifier<
S: FutureSpawner,
Blocks: Deref + Send + Sync + 'static + Clone,
L: Deref + Send + Sync + 'static,
> where
Expand All@@ -145,10 +151,9 @@ pub struct GossipVerifier<S: FutureSpawner,

const BLOCK_CACHE_SIZE: usize = 5;

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync>
GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand All@@ -157,27 +162,34 @@ impl<S: FutureSpawner,
/// This is expected to be given to a [`P2PGossipSync`] (initially constructed with `None` for
/// the UTXO lookup) via [`P2PGossipSync::add_utxo_lookup`].
pub fn new<APM: Deref + Send + Sync + Clone + 'static>(
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>, peer_manager: APM
) -> Self where APM::Target: APeerManager {
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>,
peer_manager: APM,
) -> Self
where
APM::Target: APeerManager,
{
let peer_manager_wake = Arc::new(move || peer_manager.as_ref().process_events());
Self {
source, spawn, gossiper, peer_manager_wake,
source,
spawn,
gossiper,
peer_manager_wake,
block_cache: Arc::new(Mutex::new(VecDeque::with_capacity(BLOCK_CACHE_SIZE))),
}
}

async fn retrieve_utxo(
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64,
) -> Result<TxOut, UtxoLookupError> {
let block_height = (short_channel_id >> 5 * 8) as u32; // block height is most significant three bytes
let transaction_index = ((short_channel_id >> 2 * 8) & 0xffffff) as u32;
let output_index = (short_channel_id & 0xffff) as u16;

let (outpoint, output);

'tx_found: loop { // Used as a simple goto
'tx_found: loop {
macro_rules! process_block {
($block: expr) => {{
($block: expr) => {{
if transaction_index as usize >= $block.txdata.len() {
return Err(UtxoLookupError::UnknownTx);
}
Expand All@@ -188,7 +200,7 @@ impl<S: FutureSpawner,

outpoint = OutPoint::new(transaction.txid(), output_index.into());
output = transaction.output[output_index as usize].clone();
} }
}};
}
{
let recent_blocks = block_cache.lock().unwrap();
Expand All@@ -202,8 +214,8 @@ impl<S: FutureSpawner,

let ((_, tip_height_opt), block_hash) =
Joiner::new(source.get_best_block(), source.get_block_hash_by_height(block_height))
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
if let Some(tip_height) = tip_height_opt {
// If the block doesn't yet have five confirmations, error out.
//
Expand All@@ -214,8 +226,8 @@ impl<S: FutureSpawner,
return Err(UtxoLookupError::UnknownTx);
}
}
let block_data = source.get_block(&block_hash).await
.map_err(|_| UtxoLookupError::UnknownTx)?;
let block_data =
source.get_block(&block_hash).await.map_err(|_| UtxoLookupError::UnknownTx)?;
let block = match block_data {
BlockData::HeaderOnly(_) => return Err(UtxoLookupError::UnknownTx),
BlockData::FullBlock(block) => block,
Expand All@@ -237,7 +249,7 @@ impl<S: FutureSpawner,
}
}
break 'tx_found;
};
}
let outpoint_unspent =
source.is_output_unspent(outpoint).await.map_err(|_| UtxoLookupError::UnknownTx)?;
if outpoint_unspent {
Expand All@@ -248,22 +260,21 @@ impl<S: FutureSpawner,
}
}

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> Deref for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> Deref
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
type Target = Self;
fn deref(&self) -> &Self { self }
fn deref(&self) -> &Self {
self
}
}


impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> UtxoLookup for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> UtxoLookup
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Run `rustfmt` on `lightning-block-sync` by tnull · Pull Request #3136 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
360 changes: 190 additions & 170 deletions lightning-block-sync/src/convert.rs

Large diffs are not rendered by default.

99 changes: 55 additions & 44 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,21 +6,21 @@ use crate::{AsyncBlockSourceResult, BlockData, BlockSource, BlockSourceError};

use bitcoin::blockdata::block::Block;
use bitcoin::blockdata::constants::ChainHash;
use bitcoin::blockdata::transaction::{TxOut, OutPoint};
use bitcoin::blockdata::transaction::{OutPoint, TxOut};
use bitcoin::hash_types::BlockHash;

use lightning::ln::peer_handler::APeerManager;

use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoResult, UtxoLookupError};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoLookupError, UtxoResult};

use lightning::util::logger::Logger;

use std::sync::{Arc, Mutex};
use std::collections::VecDeque;
use std::future::Future;
use std::ops::Deref;
use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::task::Poll;

/// A trait which extends [`BlockSource`] and can be queried to fetch the block at a given height
Expand All@@ -29,12 +29,14 @@ use std::task::Poll;
/// Note that while this is implementable for a [`BlockSource`] which returns filtered block data
/// (i.e. [`BlockData::HeaderOnly`] for [`BlockSource::get_block`] requests), such an
/// implementation will reject all gossip as it is not fully able to verify the UTXOs referenced.
pub trait UtxoSource: BlockSource + 'static {
pub trait UtxoSource: BlockSource + 'static {
/// Fetches the block hash of the block at the given height.
///
/// This will, in turn, be passed to to [`BlockSource::get_block`] to fetch the block needed
/// for gossip validation.
fn get_block_hash_by_height<'a>(&'a self, block_height: u32) -> AsyncBlockSourceResult<'a, BlockHash>;
fn get_block_hash_by_height<'a>(
&'a self, block_height: u32,
) -> AsyncBlockSourceResult<'a, BlockHash>;

/// Returns true if the given output has *not* been spent, i.e. is a member of the current UTXO
/// set.
Expand All@@ -45,7 +47,7 @@ pub trait UtxoSource : BlockSource + 'static {
///
/// If the `tokio` feature is enabled, this is implemented on `TokioSpawner` struct which
/// delegates to `tokio::spawn()`.
pub trait FutureSpawner: Send + Sync + 'static {
pub trait FutureSpawner: Send + Sync + 'static {
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
Expand All@@ -65,8 +67,8 @@ impl FutureSpawner for TokioSpawner {
/// A trivial future which joins two other futures and polls them at the same time, returning only
/// once both complete.
pub(crate) struct Joiner<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> {
pub a: A,
pub b: B,
Expand All@@ -75,16 +77,20 @@ pub(crate) struct Joiner<
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B> {
fn new(a: A, b: B) -> Self { Self { a, b, a_res: None, b_res: None } }
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B>
{
fn new(a: A, b: B) -> Self {
Self { a, b, a_res: None, b_res: None }
}
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B> {
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B>
{
type Output = Result<((BlockHash, Option<u32>), BlockHash), BlockSourceError>;
fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<Self::Output> {
if self.a_res.is_none() {
Expand All@@ -107,14 +113,13 @@ impl<
} else {
return Poll::Ready(Err(res.unwrap_err()));
}

},
Poll::Pending => {},
}
}
if let Some(b_res) = self.b_res {
if let Some(a_res) = self.a_res {
return Poll::Ready(Ok((a_res, b_res)))
return Poll::Ready(Ok((a_res, b_res)));
}
}
Poll::Pending
Expand All@@ -129,7 +134,8 @@ impl<
/// value of 1024 should more than suffice), and ensure you have sufficient file descriptors
/// available on both Bitcoin Core and your LDK application for each request to hold its own
/// connection.
pub struct GossipVerifier<S: FutureSpawner,
pub struct GossipVerifier<
S: FutureSpawner,
Blocks: Deref + Send + Sync + 'static + Clone,
L: Deref + Send + Sync + 'static,
> where
Expand All@@ -145,10 +151,9 @@ pub struct GossipVerifier<S: FutureSpawner,

const BLOCK_CACHE_SIZE: usize = 5;

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync>
GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand All@@ -157,27 +162,34 @@ impl<S: FutureSpawner,
/// This is expected to be given to a [`P2PGossipSync`] (initially constructed with `None` for
/// the UTXO lookup) via [`P2PGossipSync::add_utxo_lookup`].
pub fn new<APM: Deref + Send + Sync + Clone + 'static>(
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>, peer_manager: APM
) -> Self where APM::Target: APeerManager {
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>,
peer_manager: APM,
) -> Self
where
APM::Target: APeerManager,
{
let peer_manager_wake = Arc::new(move || peer_manager.as_ref().process_events());
Self {
source, spawn, gossiper, peer_manager_wake,
source,
spawn,
gossiper,
peer_manager_wake,
block_cache: Arc::new(Mutex::new(VecDeque::with_capacity(BLOCK_CACHE_SIZE))),
}
}

async fn retrieve_utxo(
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64,
) -> Result<TxOut, UtxoLookupError> {
let block_height = (short_channel_id >> 5 * 8) as u32; // block height is most significant three bytes
let transaction_index = ((short_channel_id >> 2 * 8) & 0xffffff) as u32;
let output_index = (short_channel_id & 0xffff) as u16;

let (outpoint, output);

'tx_found: loop { // Used as a simple goto
'tx_found: loop {
macro_rules! process_block {
($block: expr) => {{
($block: expr) => {{
if transaction_index as usize >= $block.txdata.len() {
return Err(UtxoLookupError::UnknownTx);
}
Expand All@@ -188,7 +200,7 @@ impl<S: FutureSpawner,

outpoint = OutPoint::new(transaction.txid(), output_index.into());
output = transaction.output[output_index as usize].clone();
} }
}};
}
{
let recent_blocks = block_cache.lock().unwrap();
Expand All@@ -202,8 +214,8 @@ impl<S: FutureSpawner,

let ((_, tip_height_opt), block_hash) =
Joiner::new(source.get_best_block(), source.get_block_hash_by_height(block_height))
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
if let Some(tip_height) = tip_height_opt {
// If the block doesn't yet have five confirmations, error out.
//
Expand All@@ -214,8 +226,8 @@ impl<S: FutureSpawner,
return Err(UtxoLookupError::UnknownTx);
}
}
let block_data = source.get_block(&block_hash).await
.map_err(|_| UtxoLookupError::UnknownTx)?;
let block_data =
source.get_block(&block_hash).await.map_err(|_| UtxoLookupError::UnknownTx)?;
let block = match block_data {
BlockData::HeaderOnly(_) => return Err(UtxoLookupError::UnknownTx),
BlockData::FullBlock(block) => block,
Expand All@@ -237,7 +249,7 @@ impl<S: FutureSpawner,
}
}
break 'tx_found;
};
}
let outpoint_unspent =
source.is_output_unspent(outpoint).await.map_err(|_| UtxoLookupError::UnknownTx)?;
if outpoint_unspent {
Expand All@@ -248,22 +260,21 @@ impl<S: FutureSpawner,
}
}

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> Deref for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> Deref
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
type Target = Self;
fn deref(&self) -> &Self { self }
fn deref(&self) -> &Self {
self
}
}


impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> UtxoLookup for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> UtxoLookup
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Run `rustfmt` on `lightning-block-sync` by tnull · Pull Request #3136 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
360 changes: 190 additions & 170 deletions lightning-block-sync/src/convert.rs

Large diffs are not rendered by default.

99 changes: 55 additions & 44 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,21 +6,21 @@ use crate::{AsyncBlockSourceResult, BlockData, BlockSource, BlockSourceError};

use bitcoin::blockdata::block::Block;
use bitcoin::blockdata::constants::ChainHash;
use bitcoin::blockdata::transaction::{TxOut, OutPoint};
use bitcoin::blockdata::transaction::{OutPoint, TxOut};
use bitcoin::hash_types::BlockHash;

use lightning::ln::peer_handler::APeerManager;

use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoResult, UtxoLookupError};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoLookupError, UtxoResult};

use lightning::util::logger::Logger;

use std::sync::{Arc, Mutex};
use std::collections::VecDeque;
use std::future::Future;
use std::ops::Deref;
use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::task::Poll;

/// A trait which extends [`BlockSource`] and can be queried to fetch the block at a given height
Expand All@@ -29,12 +29,14 @@ use std::task::Poll;
/// Note that while this is implementable for a [`BlockSource`] which returns filtered block data
/// (i.e. [`BlockData::HeaderOnly`] for [`BlockSource::get_block`] requests), such an
/// implementation will reject all gossip as it is not fully able to verify the UTXOs referenced.
pub trait UtxoSource: BlockSource + 'static {
pub trait UtxoSource: BlockSource + 'static {
/// Fetches the block hash of the block at the given height.
///
/// This will, in turn, be passed to to [`BlockSource::get_block`] to fetch the block needed
/// for gossip validation.
fn get_block_hash_by_height<'a>(&'a self, block_height: u32) -> AsyncBlockSourceResult<'a, BlockHash>;
fn get_block_hash_by_height<'a>(
&'a self, block_height: u32,
) -> AsyncBlockSourceResult<'a, BlockHash>;

/// Returns true if the given output has *not* been spent, i.e. is a member of the current UTXO
/// set.
Expand All@@ -45,7 +47,7 @@ pub trait UtxoSource : BlockSource + 'static {
///
/// If the `tokio` feature is enabled, this is implemented on `TokioSpawner` struct which
/// delegates to `tokio::spawn()`.
pub trait FutureSpawner: Send + Sync + 'static {
pub trait FutureSpawner: Send + Sync + 'static {
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
Expand All@@ -65,8 +67,8 @@ impl FutureSpawner for TokioSpawner {
/// A trivial future which joins two other futures and polls them at the same time, returning only
/// once both complete.
pub(crate) struct Joiner<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> {
pub a: A,
pub b: B,
Expand All@@ -75,16 +77,20 @@ pub(crate) struct Joiner<
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B> {
fn new(a: A, b: B) -> Self { Self { a, b, a_res: None, b_res: None } }
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B>
{
fn new(a: A, b: B) -> Self {
Self { a, b, a_res: None, b_res: None }
}
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B> {
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B>
{
type Output = Result<((BlockHash, Option<u32>), BlockHash), BlockSourceError>;
fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<Self::Output> {
if self.a_res.is_none() {
Expand All@@ -107,14 +113,13 @@ impl<
} else {
return Poll::Ready(Err(res.unwrap_err()));
}

},
Poll::Pending => {},
}
}
if let Some(b_res) = self.b_res {
if let Some(a_res) = self.a_res {
return Poll::Ready(Ok((a_res, b_res)))
return Poll::Ready(Ok((a_res, b_res)));
}
}
Poll::Pending
Expand All@@ -129,7 +134,8 @@ impl<
/// value of 1024 should more than suffice), and ensure you have sufficient file descriptors
/// available on both Bitcoin Core and your LDK application for each request to hold its own
/// connection.
pub struct GossipVerifier<S: FutureSpawner,
pub struct GossipVerifier<
S: FutureSpawner,
Blocks: Deref + Send + Sync + 'static + Clone,
L: Deref + Send + Sync + 'static,
> where
Expand All@@ -145,10 +151,9 @@ pub struct GossipVerifier<S: FutureSpawner,

const BLOCK_CACHE_SIZE: usize = 5;

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync>
GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand All@@ -157,27 +162,34 @@ impl<S: FutureSpawner,
/// This is expected to be given to a [`P2PGossipSync`] (initially constructed with `None` for
/// the UTXO lookup) via [`P2PGossipSync::add_utxo_lookup`].
pub fn new<APM: Deref + Send + Sync + Clone + 'static>(
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>, peer_manager: APM
) -> Self where APM::Target: APeerManager {
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>,
peer_manager: APM,
) -> Self
where
APM::Target: APeerManager,
{
let peer_manager_wake = Arc::new(move || peer_manager.as_ref().process_events());
Self {
source, spawn, gossiper, peer_manager_wake,
source,
spawn,
gossiper,
peer_manager_wake,
block_cache: Arc::new(Mutex::new(VecDeque::with_capacity(BLOCK_CACHE_SIZE))),
}
}

async fn retrieve_utxo(
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64,
) -> Result<TxOut, UtxoLookupError> {
let block_height = (short_channel_id >> 5 * 8) as u32; // block height is most significant three bytes
let transaction_index = ((short_channel_id >> 2 * 8) & 0xffffff) as u32;
let output_index = (short_channel_id & 0xffff) as u16;

let (outpoint, output);

'tx_found: loop { // Used as a simple goto
'tx_found: loop {
macro_rules! process_block {
($block: expr) => {{
($block: expr) => {{
if transaction_index as usize >= $block.txdata.len() {
return Err(UtxoLookupError::UnknownTx);
}
Expand All@@ -188,7 +200,7 @@ impl<S: FutureSpawner,

outpoint = OutPoint::new(transaction.txid(), output_index.into());
output = transaction.output[output_index as usize].clone();
} }
}};
}
{
let recent_blocks = block_cache.lock().unwrap();
Expand All@@ -202,8 +214,8 @@ impl<S: FutureSpawner,

let ((_, tip_height_opt), block_hash) =
Joiner::new(source.get_best_block(), source.get_block_hash_by_height(block_height))
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
if let Some(tip_height) = tip_height_opt {
// If the block doesn't yet have five confirmations, error out.
//
Expand All@@ -214,8 +226,8 @@ impl<S: FutureSpawner,
return Err(UtxoLookupError::UnknownTx);
}
}
let block_data = source.get_block(&block_hash).await
.map_err(|_| UtxoLookupError::UnknownTx)?;
let block_data =
source.get_block(&block_hash).await.map_err(|_| UtxoLookupError::UnknownTx)?;
let block = match block_data {
BlockData::HeaderOnly(_) => return Err(UtxoLookupError::UnknownTx),
BlockData::FullBlock(block) => block,
Expand All@@ -237,7 +249,7 @@ impl<S: FutureSpawner,
}
}
break 'tx_found;
};
}
let outpoint_unspent =
source.is_output_unspent(outpoint).await.map_err(|_| UtxoLookupError::UnknownTx)?;
if outpoint_unspent {
Expand All@@ -248,22 +260,21 @@ impl<S: FutureSpawner,
}
}

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> Deref for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> Deref
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
type Target = Self;
fn deref(&self) -> &Self { self }
fn deref(&self) -> &Self {
self
}
}


impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> UtxoLookup for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> UtxoLookup
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Run `rustfmt` on `lightning-block-sync` by tnull · Pull Request #3136 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
360 changes: 190 additions & 170 deletions lightning-block-sync/src/convert.rs

Large diffs are not rendered by default.

99 changes: 55 additions & 44 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,21 +6,21 @@ use crate::{AsyncBlockSourceResult, BlockData, BlockSource, BlockSourceError};

use bitcoin::blockdata::block::Block;
use bitcoin::blockdata::constants::ChainHash;
use bitcoin::blockdata::transaction::{TxOut, OutPoint};
use bitcoin::blockdata::transaction::{OutPoint, TxOut};
use bitcoin::hash_types::BlockHash;

use lightning::ln::peer_handler::APeerManager;

use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoResult, UtxoLookupError};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoLookupError, UtxoResult};

use lightning::util::logger::Logger;

use std::sync::{Arc, Mutex};
use std::collections::VecDeque;
use std::future::Future;
use std::ops::Deref;
use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::task::Poll;

/// A trait which extends [`BlockSource`] and can be queried to fetch the block at a given height
Expand All@@ -29,12 +29,14 @@ use std::task::Poll;
/// Note that while this is implementable for a [`BlockSource`] which returns filtered block data
/// (i.e. [`BlockData::HeaderOnly`] for [`BlockSource::get_block`] requests), such an
/// implementation will reject all gossip as it is not fully able to verify the UTXOs referenced.
pub trait UtxoSource: BlockSource + 'static {
pub trait UtxoSource: BlockSource + 'static {
/// Fetches the block hash of the block at the given height.
///
/// This will, in turn, be passed to to [`BlockSource::get_block`] to fetch the block needed
/// for gossip validation.
fn get_block_hash_by_height<'a>(&'a self, block_height: u32) -> AsyncBlockSourceResult<'a, BlockHash>;
fn get_block_hash_by_height<'a>(
&'a self, block_height: u32,
) -> AsyncBlockSourceResult<'a, BlockHash>;

/// Returns true if the given output has *not* been spent, i.e. is a member of the current UTXO
/// set.
Expand All@@ -45,7 +47,7 @@ pub trait UtxoSource : BlockSource + 'static {
///
/// If the `tokio` feature is enabled, this is implemented on `TokioSpawner` struct which
/// delegates to `tokio::spawn()`.
pub trait FutureSpawner: Send + Sync + 'static {
pub trait FutureSpawner: Send + Sync + 'static {
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
Expand All@@ -65,8 +67,8 @@ impl FutureSpawner for TokioSpawner {
/// A trivial future which joins two other futures and polls them at the same time, returning only
/// once both complete.
pub(crate) struct Joiner<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> {
pub a: A,
pub b: B,
Expand All@@ -75,16 +77,20 @@ pub(crate) struct Joiner<
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B> {
fn new(a: A, b: B) -> Self { Self { a, b, a_res: None, b_res: None } }
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B>
{
fn new(a: A, b: B) -> Self {
Self { a, b, a_res: None, b_res: None }
}
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B> {
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B>
{
type Output = Result<((BlockHash, Option<u32>), BlockHash), BlockSourceError>;
fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<Self::Output> {
if self.a_res.is_none() {
Expand All@@ -107,14 +113,13 @@ impl<
} else {
return Poll::Ready(Err(res.unwrap_err()));
}

},
Poll::Pending => {},
}
}
if let Some(b_res) = self.b_res {
if let Some(a_res) = self.a_res {
return Poll::Ready(Ok((a_res, b_res)))
return Poll::Ready(Ok((a_res, b_res)));
}
}
Poll::Pending
Expand All@@ -129,7 +134,8 @@ impl<
/// value of 1024 should more than suffice), and ensure you have sufficient file descriptors
/// available on both Bitcoin Core and your LDK application for each request to hold its own
/// connection.
pub struct GossipVerifier<S: FutureSpawner,
pub struct GossipVerifier<
S: FutureSpawner,
Blocks: Deref + Send + Sync + 'static + Clone,
L: Deref + Send + Sync + 'static,
> where
Expand All@@ -145,10 +151,9 @@ pub struct GossipVerifier<S: FutureSpawner,

const BLOCK_CACHE_SIZE: usize = 5;

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync>
GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand All@@ -157,27 +162,34 @@ impl<S: FutureSpawner,
/// This is expected to be given to a [`P2PGossipSync`] (initially constructed with `None` for
/// the UTXO lookup) via [`P2PGossipSync::add_utxo_lookup`].
pub fn new<APM: Deref + Send + Sync + Clone + 'static>(
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>, peer_manager: APM
) -> Self where APM::Target: APeerManager {
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>,
peer_manager: APM,
) -> Self
where
APM::Target: APeerManager,
{
let peer_manager_wake = Arc::new(move || peer_manager.as_ref().process_events());
Self {
source, spawn, gossiper, peer_manager_wake,
source,
spawn,
gossiper,
peer_manager_wake,
block_cache: Arc::new(Mutex::new(VecDeque::with_capacity(BLOCK_CACHE_SIZE))),
}
}

async fn retrieve_utxo(
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64,
) -> Result<TxOut, UtxoLookupError> {
let block_height = (short_channel_id >> 5 * 8) as u32; // block height is most significant three bytes
let transaction_index = ((short_channel_id >> 2 * 8) & 0xffffff) as u32;
let output_index = (short_channel_id & 0xffff) as u16;

let (outpoint, output);

'tx_found: loop { // Used as a simple goto
'tx_found: loop {
macro_rules! process_block {
($block: expr) => {{
($block: expr) => {{
if transaction_index as usize >= $block.txdata.len() {
return Err(UtxoLookupError::UnknownTx);
}
Expand All@@ -188,7 +200,7 @@ impl<S: FutureSpawner,

outpoint = OutPoint::new(transaction.txid(), output_index.into());
output = transaction.output[output_index as usize].clone();
} }
}};
}
{
let recent_blocks = block_cache.lock().unwrap();
Expand All@@ -202,8 +214,8 @@ impl<S: FutureSpawner,

let ((_, tip_height_opt), block_hash) =
Joiner::new(source.get_best_block(), source.get_block_hash_by_height(block_height))
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
if let Some(tip_height) = tip_height_opt {
// If the block doesn't yet have five confirmations, error out.
//
Expand All@@ -214,8 +226,8 @@ impl<S: FutureSpawner,
return Err(UtxoLookupError::UnknownTx);
}
}
let block_data = source.get_block(&block_hash).await
.map_err(|_| UtxoLookupError::UnknownTx)?;
let block_data =
source.get_block(&block_hash).await.map_err(|_| UtxoLookupError::UnknownTx)?;
let block = match block_data {
BlockData::HeaderOnly(_) => return Err(UtxoLookupError::UnknownTx),
BlockData::FullBlock(block) => block,
Expand All@@ -237,7 +249,7 @@ impl<S: FutureSpawner,
}
}
break 'tx_found;
};
}
let outpoint_unspent =
source.is_output_unspent(outpoint).await.map_err(|_| UtxoLookupError::UnknownTx)?;
if outpoint_unspent {
Expand All@@ -248,22 +260,21 @@ impl<S: FutureSpawner,
}
}

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> Deref for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> Deref
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
type Target = Self;
fn deref(&self) -> &Self { self }
fn deref(&self) -> &Self {
self
}
}


impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> UtxoLookup for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> UtxoLookup
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Run `rustfmt` on `lightning-block-sync` by tnull · Pull Request #3136 · lightningdevkit/rust-lightning · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
360 changes: 190 additions & 170 deletions lightning-block-sync/src/convert.rs

Large diffs are not rendered by default.

99 changes: 55 additions & 44 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,21 +6,21 @@ use crate::{AsyncBlockSourceResult, BlockData, BlockSource, BlockSourceError};

use bitcoin::blockdata::block::Block;
use bitcoin::blockdata::constants::ChainHash;
use bitcoin::blockdata::transaction::{TxOut, OutPoint};
use bitcoin::blockdata::transaction::{OutPoint, TxOut};
use bitcoin::hash_types::BlockHash;

use lightning::ln::peer_handler::APeerManager;

use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoResult, UtxoLookupError};
use lightning::routing::utxo::{UtxoFuture, UtxoLookup, UtxoLookupError, UtxoResult};

use lightning::util::logger::Logger;

use std::sync::{Arc, Mutex};
use std::collections::VecDeque;
use std::future::Future;
use std::ops::Deref;
use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::task::Poll;

/// A trait which extends [`BlockSource`] and can be queried to fetch the block at a given height
Expand All@@ -29,12 +29,14 @@ use std::task::Poll;
/// Note that while this is implementable for a [`BlockSource`] which returns filtered block data
/// (i.e. [`BlockData::HeaderOnly`] for [`BlockSource::get_block`] requests), such an
/// implementation will reject all gossip as it is not fully able to verify the UTXOs referenced.
pub trait UtxoSource: BlockSource + 'static {
pub trait UtxoSource: BlockSource + 'static {
/// Fetches the block hash of the block at the given height.
///
/// This will, in turn, be passed to to [`BlockSource::get_block`] to fetch the block needed
/// for gossip validation.
fn get_block_hash_by_height<'a>(&'a self, block_height: u32) -> AsyncBlockSourceResult<'a, BlockHash>;
fn get_block_hash_by_height<'a>(
&'a self, block_height: u32,
) -> AsyncBlockSourceResult<'a, BlockHash>;

/// Returns true if the given output has *not* been spent, i.e. is a member of the current UTXO
/// set.
Expand All@@ -45,7 +47,7 @@ pub trait UtxoSource : BlockSource + 'static {
///
/// If the `tokio` feature is enabled, this is implemented on `TokioSpawner` struct which
/// delegates to `tokio::spawn()`.
pub trait FutureSpawner: Send + Sync + 'static {
pub trait FutureSpawner: Send + Sync + 'static {
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
Expand All@@ -65,8 +67,8 @@ impl FutureSpawner for TokioSpawner {
/// A trivial future which joins two other futures and polls them at the same time, returning only
/// once both complete.
pub(crate) struct Joiner<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> {
pub a: A,
pub b: B,
Expand All@@ -75,16 +77,20 @@ pub(crate) struct Joiner<
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B> {
fn new(a: A, b: B) -> Self { Self { a, b, a_res: None, b_res: None } }
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Joiner<A, B>
{
fn new(a: A, b: B) -> Self {
Self { a, b, a_res: None, b_res: None }
}
}

impl<
A: Future<Output=Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output=Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B> {
A: Future<Output = Result<(BlockHash, Option<u32>), BlockSourceError>> + Unpin,
B: Future<Output = Result<BlockHash, BlockSourceError>> + Unpin,
> Future for Joiner<A, B>
{
type Output = Result<((BlockHash, Option<u32>), BlockHash), BlockSourceError>;
fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<Self::Output> {
if self.a_res.is_none() {
Expand All@@ -107,14 +113,13 @@ impl<
} else {
return Poll::Ready(Err(res.unwrap_err()));
}

},
Poll::Pending => {},
}
}
if let Some(b_res) = self.b_res {
if let Some(a_res) = self.a_res {
return Poll::Ready(Ok((a_res, b_res)))
return Poll::Ready(Ok((a_res, b_res)));
}
}
Poll::Pending
Expand All@@ -129,7 +134,8 @@ impl<
/// value of 1024 should more than suffice), and ensure you have sufficient file descriptors
/// available on both Bitcoin Core and your LDK application for each request to hold its own
/// connection.
pub struct GossipVerifier<S: FutureSpawner,
pub struct GossipVerifier<
S: FutureSpawner,
Blocks: Deref + Send + Sync + 'static + Clone,
L: Deref + Send + Sync + 'static,
> where
Expand All@@ -145,10 +151,9 @@ pub struct GossipVerifier<S: FutureSpawner,

const BLOCK_CACHE_SIZE: usize = 5;

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync>
GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand All@@ -157,27 +162,34 @@ impl<S: FutureSpawner,
/// This is expected to be given to a [`P2PGossipSync`] (initially constructed with `None` for
/// the UTXO lookup) via [`P2PGossipSync::add_utxo_lookup`].
pub fn new<APM: Deref + Send + Sync + Clone + 'static>(
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>, peer_manager: APM
) -> Self where APM::Target: APeerManager {
source: Blocks, spawn: S, gossiper: Arc<P2PGossipSync<Arc<NetworkGraph<L>>, Self, L>>,
peer_manager: APM,
) -> Self
where
APM::Target: APeerManager,
{
let peer_manager_wake = Arc::new(move || peer_manager.as_ref().process_events());
Self {
source, spawn, gossiper, peer_manager_wake,
source,
spawn,
gossiper,
peer_manager_wake,
block_cache: Arc::new(Mutex::new(VecDeque::with_capacity(BLOCK_CACHE_SIZE))),
}
}

async fn retrieve_utxo(
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64
source: Blocks, block_cache: Arc<Mutex<VecDeque<(u32, Block)>>>, short_channel_id: u64,
) -> Result<TxOut, UtxoLookupError> {
let block_height = (short_channel_id >> 5 * 8) as u32; // block height is most significant three bytes
let transaction_index = ((short_channel_id >> 2 * 8) & 0xffffff) as u32;
let output_index = (short_channel_id & 0xffff) as u16;

let (outpoint, output);

'tx_found: loop { // Used as a simple goto
'tx_found: loop {
macro_rules! process_block {
($block: expr) => {{
($block: expr) => {{
if transaction_index as usize >= $block.txdata.len() {
return Err(UtxoLookupError::UnknownTx);
}
Expand All@@ -188,7 +200,7 @@ impl<S: FutureSpawner,

outpoint = OutPoint::new(transaction.txid(), output_index.into());
output = transaction.output[output_index as usize].clone();
} }
}};
}
{
let recent_blocks = block_cache.lock().unwrap();
Expand All@@ -202,8 +214,8 @@ impl<S: FutureSpawner,

let ((_, tip_height_opt), block_hash) =
Joiner::new(source.get_best_block(), source.get_block_hash_by_height(block_height))
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
.await
.map_err(|_| UtxoLookupError::UnknownTx)?;
if let Some(tip_height) = tip_height_opt {
// If the block doesn't yet have five confirmations, error out.
//
Expand All@@ -214,8 +226,8 @@ impl<S: FutureSpawner,
return Err(UtxoLookupError::UnknownTx);
}
}
let block_data = source.get_block(&block_hash).await
.map_err(|_| UtxoLookupError::UnknownTx)?;
let block_data =
source.get_block(&block_hash).await.map_err(|_| UtxoLookupError::UnknownTx)?;
let block = match block_data {
BlockData::HeaderOnly(_) => return Err(UtxoLookupError::UnknownTx),
BlockData::FullBlock(block) => block,
Expand All@@ -237,7 +249,7 @@ impl<S: FutureSpawner,
}
}
break 'tx_found;
};
}
let outpoint_unspent =
source.is_output_unspent(outpoint).await.map_err(|_| UtxoLookupError::UnknownTx)?;
if outpoint_unspent {
Expand All@@ -248,22 +260,21 @@ impl<S: FutureSpawner,
}
}

impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> Deref for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> Deref
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
type Target = Self;
fn deref(&self) -> &Self { self }
fn deref(&self) -> &Self {
self
}
}


impl<S: FutureSpawner,
Blocks: Deref + Send + Sync + Clone,
L: Deref + Send + Sync,
> UtxoLookup for GossipVerifier<S, Blocks, L> where
impl<S: FutureSpawner, Blocks: Deref + Send + Sync + Clone, L: Deref + Send + Sync> UtxoLookup
for GossipVerifier<S, Blocks, L>
where
Blocks::Target: UtxoSource,
L::Target: Logger,
{
Expand Down
Loading