cuprate_p2p_core/
protocol.rs

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
//! This module defines [`PeerRequest`] and [`PeerResponse`]. Cuprate's P2P crates works by translating network messages into an internal
//! request/response enums, this is easy for levin "requests" and "responses" (admin messages) but takes a bit more work with "notifications"
//! (protocol messages).
//!
//! Some notifications are easy to translate, like [`GetObjectsRequest`] is obviously a request but others like [`NewFluffyBlock`] are a
//! bit tricker. To translate a [`NewFluffyBlock`] into a request/ response we will have to look to see if we asked for [`FluffyMissingTransactionsRequest`],
//! if we have, we interpret [`NewFluffyBlock`] as a response, if not, it's a request that doesn't require a response.
//!
//! Here is every P2P request/response.
//!
//! *note admin messages are already request/response so "Handshake" is actually made of a `HandshakeRequest` & `HandshakeResponse`
//!
//! ```md
//! Admin:
//!     Handshake,
//!     TimedSync,
//!     Ping,
//!     SupportFlags
//! Protocol:
//!     Request: GetObjectsRequest,                 Response: GetObjectsResponse,
//!     Request: ChainRequest,                      Response: ChainResponse,
//!     Request: FluffyMissingTransactionsRequest,  Response: NewFluffyBlock,  <- these 2 could be requests or responses
//!     Request: GetTxPoolCompliment,               Response: NewTransactions, <-
//!     Request: NewBlock,                          Response: None,
//!     Request: NewFluffyBlock,                    Response: None,
//!     Request: NewTransactions,                   Response: None
//!```
//!
use cuprate_wire::{
    protocol::{
        ChainRequest, ChainResponse, FluffyMissingTransactionsRequest, GetObjectsRequest,
        GetObjectsResponse, GetTxPoolCompliment, NewBlock, NewFluffyBlock, NewTransactions,
    },
    AdminRequestMessage, AdminResponseMessage,
};

mod try_from;

/// An enum representing a request/ response combination, so a handshake request
/// and response would have the same [`MessageID`]. This allows associating the
/// correct response to a request.
#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub enum MessageID {
    Handshake,
    TimedSync,
    Ping,
    SupportFlags,

    GetObjects,
    GetChain,
    FluffyMissingTxs,
    GetTxPoolCompliment,
    NewBlock,
    NewFluffyBlock,
    NewTransactions,
}

pub enum BroadcastMessage {
    NewFluffyBlock(NewFluffyBlock),
    NewTransaction(NewTransactions),
}

#[derive(Debug, Clone)]
pub enum ProtocolRequest {
    GetObjects(GetObjectsRequest),
    GetChain(ChainRequest),
    FluffyMissingTxs(FluffyMissingTransactionsRequest),
    GetTxPoolCompliment(GetTxPoolCompliment),
    NewBlock(NewBlock),
    NewFluffyBlock(NewFluffyBlock),
    NewTransactions(NewTransactions),
}

#[derive(Debug, Clone)]
pub enum PeerRequest {
    Admin(AdminRequestMessage),
    Protocol(ProtocolRequest),
}

impl PeerRequest {
    pub const fn id(&self) -> MessageID {
        match self {
            Self::Admin(admin_req) => match admin_req {
                AdminRequestMessage::Handshake(_) => MessageID::Handshake,
                AdminRequestMessage::TimedSync(_) => MessageID::TimedSync,
                AdminRequestMessage::Ping => MessageID::Ping,
                AdminRequestMessage::SupportFlags => MessageID::SupportFlags,
            },
            Self::Protocol(protocol_request) => match protocol_request {
                ProtocolRequest::GetObjects(_) => MessageID::GetObjects,
                ProtocolRequest::GetChain(_) => MessageID::GetChain,
                ProtocolRequest::FluffyMissingTxs(_) => MessageID::FluffyMissingTxs,
                ProtocolRequest::GetTxPoolCompliment(_) => MessageID::GetTxPoolCompliment,
                ProtocolRequest::NewBlock(_) => MessageID::NewBlock,
                ProtocolRequest::NewFluffyBlock(_) => MessageID::NewFluffyBlock,
                ProtocolRequest::NewTransactions(_) => MessageID::NewTransactions,
            },
        }
    }

    pub const fn needs_response(&self) -> bool {
        !matches!(
            self,
            Self::Protocol(
                ProtocolRequest::NewBlock(_)
                    | ProtocolRequest::NewFluffyBlock(_)
                    | ProtocolRequest::NewTransactions(_)
            )
        )
    }
}

#[derive(Debug, Clone)]
pub enum ProtocolResponse {
    GetObjects(GetObjectsResponse),
    GetChain(ChainResponse),
    NewFluffyBlock(NewFluffyBlock),
    NewTransactions(NewTransactions),
    FluffyMissingTransactionsRequest(FluffyMissingTransactionsRequest),
    NA,
}

#[derive(Debug, Clone)]
pub enum PeerResponse {
    Admin(AdminResponseMessage),
    Protocol(ProtocolResponse),
}

impl PeerResponse {
    pub const fn id(&self) -> Option<MessageID> {
        Some(match self {
            Self::Admin(admin_res) => match admin_res {
                AdminResponseMessage::Handshake(_) => MessageID::Handshake,
                AdminResponseMessage::TimedSync(_) => MessageID::TimedSync,
                AdminResponseMessage::Ping(_) => MessageID::Ping,
                AdminResponseMessage::SupportFlags(_) => MessageID::SupportFlags,
            },
            Self::Protocol(protocol_res) => match protocol_res {
                ProtocolResponse::GetObjects(_) => MessageID::GetObjects,
                ProtocolResponse::GetChain(_) => MessageID::GetChain,
                ProtocolResponse::NewFluffyBlock(_) => MessageID::NewBlock,
                ProtocolResponse::NewTransactions(_) => MessageID::NewFluffyBlock,
                ProtocolResponse::FluffyMissingTransactionsRequest(_) => {
                    MessageID::FluffyMissingTxs
                }

                ProtocolResponse::NA => return None,
            },
        })
    }
}