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
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
//! Explicitly started URMA peer transport. Noise authenticates the remote
//! transport identity; packages still need independent Engine admission.
//! There are no built-in seeds, wallet keys or implicit listeners. Names in
//! explicitly dialed `/dns*` addresses resolve through the system resolver.
use crate::peer_transport::swarm;
pub(crate) use crate::peer_transport::{Behaviour, BehaviourEvent};
use crate::{
    DialLimit, Error,
    engine::Engine,
    model::RecordPackage,
    peer_gossip::{Dial, Dials, Shared, is_loopback, validate_announce, validate_peers},
    peer_inventory::{lookup, validate_inventory},
    peer_limits::LimitDenied,
    peer_live::Link,
    peer_parent::{Parent, validate_parent},
    peer_protocol::{GossipPeer, InventoryPage, Kind, Reply, Request, Response, VERSION},
    peer_rate::{Bucket, Count, peer_rate},
    peerbook::PeerAddress,
};
pub use crate::{
    peer_live::{PeerSource, SyncPeers},
    peer_parent::OverlayCommitSource,
    peer_transport::{Dns, DnsMode},
};
use bitcoin::{BlockHash, Txid};
use libp2p::{
    Multiaddr, PeerId,
    futures::StreamExt,
    identify,
    identity::Keypair,
    multiaddr::Protocol,
    request_response::{self, Message, OutboundRequestId, ResponseChannel},
    swarm::{ConnectionId, DialError, SwarmEvent},
};
use std::{
    collections::{HashMap, HashSet},
    sync::{
        Arc,
        atomic::{AtomicBool, AtomicU64, Ordering},
        mpsc,
    },
    thread::JoinHandle,
    time::{Duration, Instant},
};
use tokio::sync::mpsc as async_mpsc;
use urma_chain::observation::Chain;

pub(crate) const REQUEST_TIMEOUT: Duration = Duration::from_secs(8);
pub(crate) const CALL_TIMEOUT: Duration = Duration::from_secs(10);
const MAX_PENDING: usize = 8;

/// Owns one network thread and one bounded archive-reader thread. Drop requests
/// shutdown and joins both. An archive operation already running is not forcibly
/// interrupted. Source handles do not keep the network alive after this owner.
pub struct PeerNetwork {
    peer: PeerId,
    listen: Option<Multiaddr>,
    dns: Dns,
    pub(crate) commands: async_mpsc::Sender<Command>,
    pub(crate) stop: Arc<AtomicBool>,
    connected: Arc<AtomicU64>,
    pub(crate) shared: Arc<Shared>,
    worker: Option<JoinHandle<Result<(), Error>>>,
}

pub(crate) enum Command {
    Fetch(Fetch),
    /// Fire and forget: frees the slot held by a peer whose reply was rejected.
    Disconnect(PeerId),
    Dial(Dial),
}

/// A request to one peer, over its existing connection or the given addresses.
pub(crate) struct Fetch {
    peer: PeerId,
    addresses: Vec<Multiaddr>,
    kind: Kind,
    deadline: Instant,
    answer: Answer,
}

pub(crate) struct Pending {
    peer: PeerId,
    pub(crate) kind: Kind,
    deadline: Instant,
    answer: Answer,
}

/// Reply channel typed by request kind; a cross-kind reply is a peer error.
pub(crate) enum Answer {
    Record(mpsc::SyncSender<Result<Option<RecordPackage>, Error>>),
    Parent(mpsc::SyncSender<Result<Parent, Error>>),
    Inventory(mpsc::SyncSender<Result<Option<InventoryPage>, Error>>),
    Peers(mpsc::SyncSender<Result<Vec<GossipPeer>, Error>>),
}

impl Answer {
    fn fail(&self, error: Error) {
        match self {
            Answer::Record(sender) => {
                let _ = sender.try_send(Err(error));
            }
            Answer::Parent(sender) => {
                let _ = sender.try_send(Err(error));
            }
            Answer::Inventory(sender) => {
                let _ = sender.try_send(Err(error));
            }
            Answer::Peers(sender) => {
                let _ = sender.try_send(Err(error));
            }
        }
    }

    fn deliver(&self, genesis: BlockHash, peer: PeerId, pending: &Pending, response: Response) {
        match self {
            Answer::Record(sender) => {
                let _ = sender.try_send(validate_response(genesis, peer, pending, response));
            }
            Answer::Parent(sender) => {
                let _ = sender.try_send(validate_parent(genesis, peer, pending, response));
            }
            Answer::Inventory(sender) => {
                let _ = sender.try_send(validate_inventory(genesis, peer, pending, response));
            }
            Answer::Peers(sender) => {
                let _ = sender.try_send(validate_peers(genesis, peer, pending, response));
            }
        }
    }
}

type Startup = mpsc::SyncSender<Result<(Option<Multiaddr>, Dns), Error>>;
struct ServeJob {
    deadline: Instant,
    request: Request,
    channel: ResponseChannel<Response>,
}
struct Served {
    response: Response,
    channel: ResponseChannel<Response>,
    bytes: usize,
}

impl PeerNetwork {
    /// Listen only when an explicit IP/TCP address is supplied. Port zero is
    /// allowed for an ephemeral listener; returned address includes this PeerId.
    /// Merely constructing source handles never dials. No peer is a seed by default.
    /// `announce` are operator-chosen public IP/TCP addresses identify advertises.
    pub fn start(
        engine: Arc<Engine>,
        identity: Keypair,
        listen: Option<Multiaddr>,
        announce: Vec<Multiaddr>,
    ) -> Result<Self, Error> {
        Self::start_with_dns(engine, identity, (listen, announce), DnsMode::System)
    }

    /// As `start`, with the name resolution mode explicit; `DnsMode::Refuse`
    /// stands in for an unreadable system resolver configuration.
    pub fn start_with_dns(
        engine: Arc<Engine>,
        identity: Keypair,
        (listen, announce): (Option<Multiaddr>, Vec<Multiaddr>),
        dns: DnsMode,
    ) -> Result<Self, Error> {
        if let Some(address) = &listen {
            validate_listener(address)?;
        }
        engine.status()?;
        let peer = identity.public().to_peer_id();
        let announce = announce
            .iter()
            .map(|address| validate_announce(address, peer))
            .collect::<Result<Vec<_>, _>>()?;
        let (commands, receiver) = async_mpsc::channel(MAX_PENDING);
        let (startup, ready) = mpsc::sync_channel(1);
        let stop = Arc::new(AtomicBool::new(false));
        let connected = Arc::new(AtomicU64::new(0));
        let shared = Arc::new(Shared::new(peer));
        let control = Control {
            commands: receiver,
            stop: stop.clone(),
            connected: connected.clone(),
            startup,
            shared: shared.clone(),
            announce,
        };
        let worker = std::thread::Builder::new()
            .name("urma-peer".into())
            .spawn(move || {
                let runtime = tokio::runtime::Builder::new_current_thread()
                    .enable_all()
                    .build()?;
                runtime.block_on(run(engine, identity, (listen, dns), control))
            })?;
        let (actual, dns) = match ready.recv_timeout(Duration::from_secs(5)) {
            Ok(Ok(started)) => started,
            result => {
                stop.store(true, Ordering::Release);
                let joined = worker.join();
                return Err(match result {
                    Ok(Err(error)) => error,
                    _ => match joined {
                        Ok(Err(error)) => error,
                        _ => Error::Busy("peer listener startup failed or expired".into()),
                    },
                });
            }
        };
        Ok(Self {
            peer,
            listen: actual,
            dns,
            commands,
            stop,
            connected,
            shared,
            worker: Some(worker),
        })
    }

    pub fn peer_id(&self) -> PeerId {
        self.peer
    }
    /// Distinct peers with at least one established connection right now.
    pub fn connected_peers(&self) -> u64 {
        self.connected.load(Ordering::Relaxed)
    }
    pub fn listen_address(&self) -> Option<Multiaddr> {
        self.listen.clone()
    }

    /// Whether named addresses can be dialed by this overlay.
    pub fn dns(&self) -> &Dns {
        &self.dns
    }

    /// Every address the listener is bound to now, with `/p2p`.
    pub fn listen_addresses(&self) -> Vec<Multiaddr> {
        self.shared.listeners()
    }

    fn link(&self) -> Link {
        Link {
            commands: self.commands.clone(),
            stop: self.stop.clone(),
            shared: Arc::clone(&self.shared),
        }
    }

    pub fn source(&self, address: PeerAddress) -> PeerSource {
        self.link()
            .source(address.peer_id(), vec![address.address().clone()])
    }

    /// `manual` peers first, then whoever is connected and on our chain.
    pub fn sync_peers(&self, manual: Vec<PeerAddress>) -> SyncPeers {
        SyncPeers::new(self.link(), manual)
    }

    pub fn commit_source(&self, chain: Chain, manual: Vec<PeerAddress>) -> OverlayCommitSource {
        OverlayCommitSource::new(chain, self.sync_peers(manual))
    }

    pub fn shutdown(mut self) -> Result<(), Error> {
        self.stop.store(true, Ordering::Release);
        match self.worker.take().expect("network owner has worker").join() {
            Ok(result) => result,
            Err(_) => Err(Error::Invalid("peer worker panicked".into())),
        }
    }
}

impl Drop for PeerNetwork {
    fn drop(&mut self) {
        self.stop.store(true, Ordering::Release);
        if let Some(worker) = self.worker.take() {
            let _ = worker.join();
        }
    }
}

/// One bounded request: CALL_TIMEOUT and the caller's own deadline, if earlier.
/// Without addresses the peer must already be connected or known to the swarm.
pub(crate) fn request<T>(
    commands: &async_mpsc::Sender<Command>,
    stop: &AtomicBool,
    (peer, addresses): (PeerId, Vec<Multiaddr>),
    kind: Kind,
    limit: Instant,
    answer: fn(mpsc::SyncSender<Result<T, Error>>) -> Answer,
) -> Result<T, Error> {
    if stop.load(Ordering::Acquire) {
        return Err(Error::Busy("peer network stopped".into()));
    }
    let deadline = limit.min(Instant::now() + CALL_TIMEOUT);
    let (sender, receiver) = mpsc::sync_channel(1);
    commands
        .try_send(Command::Fetch(Fetch {
            peer,
            addresses,
            kind,
            deadline,
            answer: answer(sender),
        }))
        .map_err(|_| Error::Busy("peer command queue unavailable".into()))?;
    receiver
        .recv_timeout(deadline.saturating_duration_since(Instant::now()))
        .map_err(|_| Error::Busy("peer acquisition deadline or shutdown".into()))?
}

impl PeerSource {
    pub(crate) fn parent(&self, txid: Txid, deadline: Instant) -> Result<Parent, Error> {
        self.request(Kind::Parent { txid }, deadline, Answer::Parent)
    }
}

fn validate_listener(address: &Multiaddr) -> Result<(), Error> {
    let mut parts = address.iter();
    let ip = matches!(
        parts.next(),
        Some(Protocol::Ip4(_)) | Some(Protocol::Ip6(_))
    );
    if !ip || !matches!(parts.next(), Some(Protocol::Tcp(_))) || parts.next().is_some() {
        return Err(Error::Invalid(
            "peer listener requires only IP and TCP".into(),
        ));
    }
    Ok(())
}

struct Control {
    commands: async_mpsc::Receiver<Command>,
    stop: Arc<AtomicBool>,
    connected: Arc<AtomicU64>,
    startup: Startup,
    shared: Arc<Shared>,
    announce: Vec<Multiaddr>,
}

/// Remote address per live connection, so gossip can tell loopback requesters.
#[derive(Default)]
struct Remotes(HashMap<ConnectionId, (Multiaddr, bool)>);

impl Remotes {
    fn loopback(&self, connection: ConnectionId) -> bool {
        self.0
            .get(&connection)
            .is_some_and(|(address, _)| is_loopback(address))
    }

    fn outbound(&self, connection: ConnectionId) -> bool {
        self.0
            .get(&connection)
            .is_some_and(|(_, outbound)| *outbound)
    }
}

async fn run(
    engine: Arc<Engine>,
    identity: Keypair,
    (listen, dns): (Option<Multiaddr>, DnsMode),
    control: Control,
) -> Result<(), Error> {
    let Control {
        mut commands,
        stop,
        connected,
        startup,
        shared,
        announce,
    } = control;
    let genesis = engine.status()?.chain_genesis;
    let (mut swarm, dns) = swarm(identity, &dns)?;
    for address in announce {
        swarm.add_external_address(address);
    }
    let mut ready = Some(startup);
    let listening = listen.is_some();
    if let Some(address) = listen {
        swarm
            .listen_on(address)
            .map_err(|e| Error::Invalid(format!("peer listen: {e}")))?;
    }
    let (jobs, input) = mpsc::sync_channel::<ServeJob>(2);
    let (served, mut responses) = async_mpsc::channel::<Served>(2);
    let serving_stop = stop.clone();
    let serving = std::thread::Builder::new()
        .name("urma-peer-read".into())
        .spawn(move || serve(&engine, genesis, &serving_stop, input, served))?;
    if !listening {
        let _ = ready.take().unwrap().send(Ok((None, dns.clone())));
    }
    let mut pending = HashMap::<OutboundRequestId, Pending>::new();
    let mut inbound = HashSet::new();
    let mut remotes = Remotes::default();
    let mut dials = Dials::default();
    let mut rates = HashMap::<PeerId, Bucket>::new();
    let mut requests = Bucket::new(16, 16);
    let mut bytes = Bucket::new(64 * 1024 * 1024, 4 * 1024 * 1024);
    let mut tick = tokio::time::interval(Duration::from_millis(50));
    let started = Instant::now();
    let result = loop {
        if stop.load(Ordering::Acquire) {
            break Ok(());
        }
        if ready.is_some() && started.elapsed() > Duration::from_secs(4) {
            break Err(Error::Busy("peer listener startup deadline".into()));
        }
        tokio::select! {
            _ = tick.tick() => {
                // Keep the request tracked until libp2p reports completion. This
                // bounds its internal pending queue even if a caller times out.
                for value in pending.values_mut() {
                    if Instant::now() >= value.deadline {
                        value.answer.fail(Error::Busy("peer acquisition deadline".into()));
                        let _ = swarm.disconnect_peer_id(value.peer);
                    }
                }
                dials.expire();
            }
            command = commands.recv() => {
                let command = match command {
                    Some(Command::Fetch(fetch)) => fetch,
                    // A Fetch queued for this peer since the rejection keeps its connection.
                    Some(Command::Disconnect(peer)) => {
                        if !pending.values().any(|p| p.peer == peer) { let _ = swarm.disconnect_peer_id(peer); }
                        continue;
                    }
                    Some(Command::Dial(dial)) => { dials.start(&mut swarm, dial); continue; }
                    None => break Ok(()),
                };
                if Instant::now() >= command.deadline || pending.len() >= MAX_PENDING
                    || pending.values().any(|p| p.peer == command.peer) {
                    command.answer.fail(Error::Busy("peer acquisition capacity or deadline".into()));
                    continue;
                }
                let request = Request { version: VERSION, chain_genesis: genesis, kind: command.kind };
                let id = swarm.behaviour_mut().records.send_request_with_addresses(
                    &command.peer, request, command.addresses);
                pending.insert(id, Pending { peer: command.peer, kind: command.kind, deadline: command.deadline, answer: command.answer });
            }
            response = responses.recv() => {
                let Some(mut response) = response else { break Err(Error::Invalid("peer archive reader stopped".into())); };
                if response.channel.is_open() {
                    if !bytes.take(u64::try_from(response.bytes.saturating_sub(256)).unwrap_or(u64::MAX)) { response.response.result = Reply::Busy; }
                    let _ = swarm.behaviour_mut().records.send_response(response.channel, response.response);
                }
            }
            event = swarm.select_next_some() => match event {
                SwarmEvent::NewListenAddr { mut address, .. } => {
                    address.push(Protocol::P2p(*swarm.local_peer_id()));
                    shared.listening(address.clone(), true);
                    if let Some(ready) = ready.take() { let _ = ready.send(Ok((Some(address), dns.clone()))); }
                }
                SwarmEvent::ExpiredListenAddr { address, .. } => shared.listening(address.with(Protocol::P2p(*swarm.local_peer_id())), false),
                SwarmEvent::ListenerClosed { addresses, .. } => for address in addresses { shared.listening(address.with(Protocol::P2p(*swarm.local_peer_id())), false) },
                SwarmEvent::ListenerError { error, .. } if ready.is_some() => break Err(Error::Io(error)),
                SwarmEvent::ConnectionEstablished { peer_id, connection_id, endpoint, num_established, .. } => {
                    remotes.0.insert(connection_id, (endpoint.get_remote_address().clone(), endpoint.is_dialer()));
                    dials.established(connection_id, peer_id);
                    shared.opened(peer_id, endpoint.is_dialer());
                    if num_established.get() == 1 {
                        connected.fetch_add(1, Ordering::Relaxed);
                    }
                }
                SwarmEvent::ConnectionClosed { peer_id, connection_id, endpoint, num_established, .. } => {
                    remotes.0.remove(&connection_id);
                    shared.closed(peer_id, endpoint.is_dialer());
                    if num_established == 0 {
                        connected.fetch_sub(1, Ordering::Relaxed);
                    }
                }
                SwarmEvent::OutgoingConnectionError { connection_id, peer_id, error } => {
                    // Queued before request-response reports the same DialFailure.
                    if let (Some(peer), DialError::Denied { cause }) = (peer_id, &error) {
                        if let Some(LimitDenied(limit)) = cause.downcast_ref::<LimitDenied>() { release_denied(&mut pending, peer, *limit); }
                    }
                    dials.failed(connection_id, &error);
                }
                SwarmEvent::Behaviour(BehaviourEvent::Identify(identify::Event::Received { connection_id, peer_id, info })) => {
                    // Inbound peers could steer our address; only dialed peers witness it.
                    if remotes.outbound(connection_id) {
                        if let Some(confirmed) = shared.observe(info.observed_addr, peer_id) { swarm.add_external_address(confirmed); }
                    }
                    shared.identified(peer_id, info.listen_addrs);
                }
                SwarmEvent::Behaviour(BehaviourEvent::Records(event)) => match event {
                    request_response::Event::Message { peer, connection_id, message: Message::Request { request_id, request, channel } } => {
                        // Every request, including refusals, consumes rate and
                        // response allowance. Over-rate requests get an explicit
                        // Busy; only an exhausted byte allowance drops the channel.
                        if request.version == VERSION && request.chain_genesis == genesis { shared.on_chain(peer); }
                        let over_rate = !requests.take(1) || !peer_rate(&mut rates, peer);
                        if !bytes.take(256) {
                            continue;
                        }
                        let refusal = if over_rate { Some(Reply::Busy) }
                            else if request.version != VERSION { Some(Reply::UnsupportedVersion) }
                            else if request.chain_genesis != genesis { Some(Reply::WrongNetwork) }
                            else if let Kind::Peers { limit } = request.kind {
                                // Gossip is answered from memory, never by the archive reader.
                                Some(shared.serve(peer, remotes.loopback(connection_id), limit))
                            }
                            else if inbound.len() >= 2 || inbound.iter().any(|(p, _)| *p == peer)
                                { Some(Reply::Busy) }
                            else { None };
                        if let Some(result) = refusal {
                            let _ = swarm.behaviour_mut().records.send_response(channel, Response { version: VERSION, chain_genesis: genesis, kind: request.kind, result });
                        } else {
                            match jobs.try_send(ServeJob { deadline: Instant::now() + REQUEST_TIMEOUT, request, channel }) {
                                Ok(()) => { inbound.insert((peer, request_id)); }
                                Err(_) => { /* Dropped response channel refuses the request. */ }
                            }
                        }
                    }
                    request_response::Event::Message { peer, message: Message::Response { request_id, response }, .. } => {
                        if response.version == VERSION && response.chain_genesis == genesis { shared.on_chain(peer); }
                        if let Some(value) = pending.remove(&request_id) {
                            value.answer.deliver(genesis, peer, &value, response);
                        }
                    }
                    request_response::Event::OutboundFailure { request_id, error, .. } => {
                        if let Some(value) = pending.remove(&request_id) {
                            value.answer.fail(Error::Transport(error.to_string()));
                        }
                    }
                    request_response::Event::InboundFailure { peer, request_id, .. }
                    | request_response::Event::ResponseSent { peer, request_id, .. } => { inbound.remove(&(peer, request_id)); }
                },
                _ => (),
            }
        }
    };
    stop.store(true, Ordering::Release);
    for (_, value) in pending {
        value
            .answer
            .fail(Error::Busy("peer network stopped".into()));
    }
    dials.close();
    // Drop channels before joining: the archive reader must not wait for a
    // consumer which is already shutting down. No socket belongs to that reader.
    drop(swarm);
    drop(jobs);
    drop(responses);
    if serving.join().is_err() {
        return Err(Error::Invalid("peer archive reader panicked".into()));
    }
    result
}

/// The bounded archive reader: one local lookup per job, sized before sending.
fn serve(
    engine: &Engine,
    genesis: BlockHash,
    stop: &AtomicBool,
    input: mpsc::Receiver<ServeJob>,
    served: async_mpsc::Sender<Served>,
) {
    while let Ok(job) = input.recv() {
        if stop.load(Ordering::Acquire) {
            break;
        }
        if !job.channel.is_open() || Instant::now() >= job.deadline {
            continue;
        }
        let result = lookup(engine, &job.request);
        if stop.load(Ordering::Acquire) || !job.channel.is_open() || Instant::now() >= job.deadline
        {
            continue;
        }
        let mut response = Response {
            version: VERSION,
            chain_genesis: genesis,
            kind: job.request.kind,
            result,
        };
        let mut count = Count(0);
        if serde_json::to_writer(&mut count, &response).is_err() {
            response.result = Reply::TooLarge;
            count.0 = 256;
        }
        let reply = Served {
            channel: job.channel,
            response,
            bytes: count.0,
        };
        if served.blocking_send(reply).is_err() {
            break;
        }
    }
}

/// A dial refused by our own limits is local capacity: the waiting requests
/// fail with which limit refused it, never blaming the peer.
fn release_denied(
    pending: &mut HashMap<OutboundRequestId, Pending>,
    peer: PeerId,
    limit: DialLimit,
) {
    pending.retain(|_, value| {
        if value.peer != peer {
            return true;
        }
        value.answer.fail(Error::DialDenied(limit));
        false
    });
}

pub(crate) fn bind_response(
    genesis: BlockHash,
    peer: PeerId,
    pending: &Pending,
    response: &Response,
) -> Result<(), Error> {
    if Instant::now() >= pending.deadline {
        return Err(Error::Busy("peer acquisition deadline".into()));
    }
    if peer != pending.peer
        || response.version != VERSION
        || response.chain_genesis != genesis
        || response.kind != pending.kind
    {
        return Err(Error::Invalid(
            "peer response identity, network or version mismatch".into(),
        ));
    }
    Ok(())
}

fn validate_response(
    genesis: BlockHash,
    peer: PeerId,
    pending: &Pending,
    response: Response,
) -> Result<Option<RecordPackage>, Error> {
    bind_response(genesis, peer, pending, &response)?;
    match response.result {
        Reply::Record(package) if package.chain_genesis == genesis => Ok(Some(*package)),
        Reply::Missing => Ok(None),
        Reply::Busy => Err(Error::PeerBusy),
        _ => Err(Error::Invalid(
            "peer refused record or returned wrong network".into(),
        )),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use bitcoin::hashes::Hash;

    #[test]
    fn public_response_metadata_is_bound_but_is_not_record_verification() {
        let genesis = BlockHash::all_zeros();
        let txid = Txid::all_zeros();
        let peer = Keypair::generate_ed25519().public().to_peer_id();
        let other = Keypair::generate_ed25519().public().to_peer_id();
        let (answer, _receiver) = mpsc::sync_channel(1);
        let pending = Pending {
            peer,
            kind: Kind::Record { txid },
            deadline: Instant::now() + CALL_TIMEOUT,
            answer: Answer::Record(answer),
        };
        let response = Response {
            version: VERSION,
            chain_genesis: genesis,
            kind: Kind::Record { txid },
            result: Reply::Missing,
        };
        assert!(
            validate_response(genesis, peer, &pending, response.clone())
                .unwrap()
                .is_none()
        );
        assert!(validate_response(genesis, other, &pending, response.clone()).is_err());
        let mut bad = response.clone();
        bad.version += 1;
        assert!(validate_response(genesis, peer, &pending, bad).is_err());
        let mut bad = response.clone();
        bad.chain_genesis = BlockHash::from_byte_array([1; 32]);
        assert!(validate_response(genesis, peer, &pending, bad).is_err());
        let mut bad = response.clone();
        bad.kind = Kind::Record {
            txid: Txid::from_byte_array([1; 32]),
        };
        assert!(validate_response(genesis, peer, &pending, bad).is_err());
        let expired = Pending {
            deadline: Instant::now(),
            ..pending
        };
        assert!(matches!(
            validate_response(genesis, peer, &expired, response),
            Err(Error::Busy(_))
        ));
    }

    #[test]
    fn listener_accepts_only_explicit_ip_tcp_without_implicit_resolution() {
        for value in [
            "/ip4/127.0.0.1/tcp/0",
            "/ip6/::1/tcp/0",
            "/ip4/0.0.0.0/tcp/28332",
        ] {
            validate_listener(&value.parse().unwrap()).unwrap();
        }
        for value in [
            "/dns4/localhost/tcp/1",
            "/ip4/127.0.0.1/udp/1",
            "/ip4/127.0.0.1/tcp/1/ws",
        ] {
            assert!(validate_listener(&value.parse().unwrap()).is_err());
        }
    }
}