urma-node 0.6.0

Optional URMA archive node: Litecoin follower, record archive, libp2p overlay and loopback service
Documentation 
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

//! Overlay steps of the Service round: peer discovery, then inventory sync.
//! Each is optional, stop-guarded and keeps its own recorded error.
use super::Service;
use crate::{
    Error,
    model::{BookEntry, OverlayStatus},
    peer::SyncPeers,
    peer_discovery::Discovery,
    peer_sync::{PeerSync, Scheduler},
    recorded::{record, unix_seconds},
    retrieval::RecordSource,
};
use std::sync::{Arc, atomic::Ordering};

impl Service {
    /// Overlay peers as record sources: every retrieval call takes the
    /// current window as separate sources, so each package is verified on
    /// its own and a bad one only moves retrieval on to the next peer.
    pub fn with_record_peers(mut self, peers: SyncPeers) -> Self {
        self.record_peers = Some(peers);
        self
    }

    pub(super) fn record_sources(&self) -> Vec<Arc<dyn RecordSource + Send + Sync>> {
        let mut sources = self.sources.clone();
        let peers = self.record_peers.iter().flat_map(SyncPeers::record_sources);
        sources.extend(peers.map(|peer| -> Arc<dyn RecordSource + Send + Sync> { Arc::new(peer) }));
        sources
    }

    pub(super) fn record_source_count(&self) -> usize {
        let peers = self
            .record_peers
            .as_ref()
            .map_or(0, SyncPeers::record_count);
        self.sources.len() + peers
    }

    /// Fast inventory synchronization from configured overlay peers. Only
    /// run(true) schedules it; configuring peers does not dial or fetch.
    pub fn with_peer_sync(mut self, sync: PeerSync) -> Result<Self, Error> {
        self.peer_sync = Some(Scheduler::new(sync)?);
        Ok(self)
    }

    /// Automatic peer discovery from seeds and peer address exchange. Only
    /// run(true) schedules it, as its own bounded step before inventory sync.
    pub fn with_discovery(mut self, discovery: Discovery) -> Result<Self, Error> {
        self.discovery = Some(discovery);
        Ok(self)
    }

    pub(super) fn discover_peers(&self) {
        let Some(discovery) = &self.discovery else {
            return;
        };
        if self.stop.load(Ordering::Acquire) {
            return;
        }
        let result = self
            .share_sync_backoff(discovery)
            .and_then(|()| discovery.step(&self.engine, &self.stop));
        if self.stop.load(Ordering::Acquire) {
            return;
        }
        record(&self.discovery_error, &result);
    }

    /// Discovery must not redial a peer sync is holding off, or it would
    /// refill the slot an eviction or idle release just freed.
    fn share_sync_backoff(&self, discovery: &Discovery) -> Result<(), Error> {
        let Some(scheduler) = &self.peer_sync else {
            return Ok(());
        };
        discovery.hold_off(scheduler.backed_off(unix_seconds()?)?)
    }

    pub(super) fn sync_next_inventory(&self) {
        let Some(scheduler) = &self.peer_sync else {
            return;
        };
        if self.stop.load(Ordering::Acquire) {
            return;
        }
        let result = scheduler
            .step(&self.engine, &self.stop)
            .and_then(|()| self.penalize_in_book(scheduler));
        if self.stop.load(Ordering::Acquire) {
            return;
        }
        record(&self.inventory_error, &result);
    }

    /// Peers the scheduler backed off also back off in the book, so discovery
    /// stops dialing them; without discovery there is no book to tell.
    fn penalize_in_book(&self, scheduler: &Scheduler) -> Result<(), Error> {
        let penalized = scheduler.drain_penalized()?;
        match &self.discovery {
            Some(discovery) => discovery.penalize(&penalized),
            None => Ok(()),
        }
    }

    /// The sync view with discovery counters attached when both run.
    pub(super) fn overlay_status(&self) -> Result<Option<OverlayStatus>, Error> {
        let Some(scheduler) = &self.peer_sync else {
            return Ok(None);
        };
        let mut overlay = scheduler.status(&self.engine)?;
        if let Some(discovery) = &self.discovery {
            overlay.discovery = Some(discovery.status()?);
        }
        Ok(Some(overlay))
    }

    /// `None` without discovery: the route answers 404 "overlay disabled".
    pub(super) fn overlay_book(&self) -> Result<Option<Vec<BookEntry>>, Error> {
        self.discovery.as_ref().map(Discovery::book).transpose()
    }
}