commonware-p2p 2026.4.0

Communicate with authenticated peers over encrypted connections.
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

use commonware_cryptography::PublicKey;
use std::time::SystemTime;

/// Merges `b` into `a`, keeping the earliest time.
pub(crate) fn earliest(a: Option<SystemTime>, b: SystemTime) -> Option<SystemTime> {
    Some(a.map_or(b, |a| a.min(b)))
}

/// Result of checking whether a peer is dialable.
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum DialStatus {
    /// Peer can be dialed immediately.
    Now,
    /// Peer will become dialable at the given time.
    After(SystemTime),
    /// Peer is not dialable.
    Unavailable,
}

/// Result of attempting to reserve a peer.
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ReserveResult {
    /// Reservation succeeded.
    Reserved,
    /// Reservation denied because not enough time has elapsed since the last reservation.
    RateLimited,
    /// Reservation denied for any other reason (already reserved, is self, etc.).
    Unavailable,
}

/// Dialable peers and the next time it is worth querying again.
#[derive(Clone, Debug)]
pub struct Dialable<C: PublicKey> {
    /// Peers that can be dialed immediately.
    pub peers: Vec<C>,

    /// Earliest known time at which another peer may become dialable.
    pub next_query_at: Option<SystemTime>,
}

impl<C: PublicKey> Default for Dialable<C> {
    fn default() -> Self {
        Self {
            peers: Vec::new(),
            next_query_at: None,
        }
    }
}