commonware-p2p 2026.5.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
49
50
51
52

use crate::Channel;
use commonware_cryptography::PublicKey;
use commonware_runtime::telemetry::metrics::EncodeStruct;
use std::fmt;

/// Per-peer label.
#[derive(Clone, Debug, Hash, PartialEq, Eq, EncodeStruct)]
pub struct Peer<P: PublicKey> {
    pub peer: P,
}

#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
pub enum MessageType {
    Data(u64),
    Ping,
    Invalid,
}

impl fmt::Display for MessageType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Data(channel) => write!(f, "data_{channel}"),
            Self::Ping => f.write_str("ping"),
            Self::Invalid => f.write_str("invalid"),
        }
    }
}

/// Per-peer, per-message-type label.
#[derive(Clone, Debug, Hash, PartialEq, Eq, EncodeStruct)]
pub struct Message<P: PublicKey> {
    pub peer: P,
    pub message: MessageType,
}

impl<P: PublicKey> Message<P> {
    fn new(peer: &P, message: MessageType) -> Self {
        Self {
            peer: peer.clone(),
            message,
        }
    }
    pub fn new_data(peer: &P, channel: Channel) -> Self {
        Self::new(peer, MessageType::Data(channel))
    }
    pub fn new_ping(peer: &P) -> Self {
        Self::new(peer, MessageType::Ping)
    }
    pub fn new_invalid(peer: &P) -> Self {
        Self::new(peer, MessageType::Invalid)
    }
}