1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! # Subcoin Informant
//!
//! This crate is a fork of `sc-informant` for displaying the Subcoin network sync progress.

mod display;

use bitcoin::BlockHash;
use console::style;
use futures::prelude::*;
use futures_timer::Delay;
use sc_client_api::{AuxStore, BlockchainEvents, ClientInfo, UsageProvider};
use sp_blockchain::{HeaderBackend, HeaderMetadata};
use sp_runtime::traits::{Block as BlockT, Header};
use std::collections::VecDeque;
use std::fmt::Display;
use std::ops::Deref;
use std::sync::Arc;
use std::time::Duration;
use subcoin_network::NetworkApi;
use subcoin_primitives::BackendExt;
use tracing::{debug, info, trace};

/// Extended [`ClientInfo`].
#[derive(Debug)]
struct ClientInfoExt<Block: BlockT> {
    info: ClientInfo<Block>,
    best_bitcoin_hash: BlockHash,
    finalized_bitcoin_hash: BlockHash,
}

impl<Block: BlockT> Deref for ClientInfoExt<Block> {
    type Target = ClientInfo<Block>;
    fn deref(&self) -> &Self::Target {
        &self.info
    }
}

/// Creates a stream that returns a new value every `duration`.
fn interval(duration: Duration) -> impl Stream<Item = ()> + Unpin {
    futures::stream::unfold((), move |_| Delay::new(duration).map(|_| Some(((), ())))).map(drop)
}

/// Builds the informant and returns a `Future` that drives the informant.
pub async fn build<B: BlockT, C>(client: Arc<C>, network_api: Arc<dyn NetworkApi>)
where
    C: UsageProvider<B> + HeaderMetadata<B> + BlockchainEvents<B> + HeaderBackend<B> + AuxStore,
    <C as HeaderMetadata<B>>::Error: Display,
{
    let mut display = display::InformantDisplay::new();

    let net_client = client.clone();

    let display_notifications = interval(Duration::from_millis(5000))
        .filter_map(|_| async { network_api.status().await })
        .for_each({
            move |net_status| {
                let info = net_client.usage_info();
                if let Some(ref usage) = info.usage {
                    trace!(target: "usage", "Usage statistics: {}", usage);
                } else {
                    trace!(
                        target: "usage",
                        "Usage statistics not displayed as backend does not provide it",
                    )
                }

                let best_bitcoin_hash = net_client
                    .bitcoin_block_hash_for(info.chain.best_hash)
                    .expect("Best bitcoin hash must exist; qed");

                let finalized_bitcoin_hash = net_client
                    .bitcoin_block_hash_for(info.chain.finalized_hash)
                    .expect("Finalized bitcoin hash must exist; qed");

                let client_info_ext = ClientInfoExt {
                    info,
                    best_bitcoin_hash,
                    finalized_bitcoin_hash,
                };

                display.display(client_info_ext, net_status);
                future::ready(())
            }
        });

    futures::select! {
        () = display_notifications.fuse() => (),
        () = display_block_import(client, &network_api).fuse() => (),
    };
}

async fn display_block_import<B: BlockT, C>(client: Arc<C>, network_api: &Arc<dyn NetworkApi>)
where
    C: UsageProvider<B> + HeaderMetadata<B> + BlockchainEvents<B>,
    <C as HeaderMetadata<B>>::Error: Display,
{
    let mut last_best = {
        let info = client.usage_info();
        Some((info.chain.best_number, info.chain.best_hash))
    };

    // Hashes of the last blocks we have seen at import.
    let mut last_blocks = VecDeque::new();
    let max_blocks_to_track = 100;

    while let Some(n) = client.import_notification_stream().next().await {
        // detect and log reorganizations.
        if let Some((ref last_num, ref last_hash)) = last_best {
            if n.header.parent_hash() != last_hash && n.is_new_best {
                let maybe_ancestor =
                    sp_blockchain::lowest_common_ancestor(&*client, *last_hash, n.hash);

                match maybe_ancestor {
                    Ok(ref ancestor) if ancestor.hash != *last_hash => info!(
                        "♻️  Reorg on #{},{} to #{},{}, common ancestor #{},{}",
                        style(last_num).red().bold(),
                        last_hash,
                        style(n.header.number()).green().bold(),
                        n.hash,
                        style(ancestor.number).white().bold(),
                        ancestor.hash,
                    ),
                    Ok(_) => {}
                    Err(e) => debug!("Error computing tree route: {}", e),
                }
            }
        }

        if network_api.is_major_syncing() {
            continue;
        }

        if n.is_new_best {
            last_best = Some((*n.header.number(), n.hash));
        }

        // If we already printed a message for a given block recently,
        // we should not print it again.
        if !last_blocks.contains(&n.hash) {
            last_blocks.push_back(n.hash);

            if last_blocks.len() > max_blocks_to_track {
                last_blocks.pop_front();
            }

            let best_indicator = if n.is_new_best { "🏆" } else { "🆕" };
            info!(
                target: "subcoin",
                "{best_indicator} Imported #{} ({} → {})",
                style(n.header.number()).white().bold(),
                n.header.parent_hash(),
                n.hash,
            );
        }
    }
}