stacks_common/deps_common/bitcoin/network/
message.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
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
// Rust Bitcoin Library
// Written in 2014 by
//     Andrew Poelstra <apoelstra@wpsoftware.net>
//
// To the extent possible under law, the author(s) have dedicated all
// copyright and related and neighboring rights to this software to
// the public domain worldwide. This software is distributed without
// any warranty.
//
// You should have received a copy of the CC0 Public Domain Dedication
// along with this software.
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
//

//! Network message
//!
//! This module defines the `Message` traits which are used
//! for (de)serializing Bitcoin objects for transmission on the network. It
//! also defines (de)serialization routines for many primitives.
//!

use std::io::Cursor;
use std::iter;

use crate::deps_common::bitcoin::blockdata::{block, transaction};
use crate::deps_common::bitcoin::network::address::Address;
use crate::deps_common::bitcoin::network::encodable::{
    CheckedData, ConsensusDecodable, ConsensusEncodable,
};
use crate::deps_common::bitcoin::network::serialize::{
    self, serialize, RawDecoder, SimpleDecoder, SimpleEncoder,
};
use crate::deps_common::bitcoin::network::{message_blockdata, message_network};

/// Serializer for command string
#[derive(PartialEq, Eq, Clone, Debug)]
pub struct CommandString(pub String);

impl<S: SimpleEncoder> ConsensusEncodable<S> for CommandString {
    #[inline]
    fn consensus_encode(&self, s: &mut S) -> Result<(), serialize::Error> {
        let CommandString(ref inner_str) = self;
        let mut rawbytes = [0u8; 12];
        let strbytes = inner_str.as_bytes();
        if strbytes.len() > 12 {
            panic!("Command string longer than 12 bytes");
        }
        rawbytes[..strbytes.len()].copy_from_slice(strbytes);
        rawbytes.consensus_encode(s)
    }
}

impl<D: SimpleDecoder> ConsensusDecodable<D> for CommandString {
    #[inline]
    fn consensus_decode(d: &mut D) -> Result<CommandString, serialize::Error> {
        let rawbytes: [u8; 12] = ConsensusDecodable::consensus_decode(d)?;
        let rv = iter::FromIterator::from_iter(rawbytes.iter().filter_map(|&u| {
            if u > 0 {
                Some(u as char)
            } else {
                None
            }
        }));
        Ok(CommandString(rv))
    }
}

/// A Network message
pub struct RawNetworkMessage {
    /// Magic bytes to identify the network these messages are meant for
    pub magic: u32,
    /// The actual message data
    pub payload: NetworkMessage,
}

#[derive(Clone, PartialEq, Eq, Debug)]
/// A Network message payload. Proper documentation is available on at
/// [Bitcoin Wiki: Protocol Specification](https://en.bitcoin.it/wiki/Protocol_specification)
pub enum NetworkMessage {
    /// `version`
    Version(message_network::VersionMessage),
    /// `verack`
    Verack,
    /// `addr`
    Addr(Vec<(u32, Address)>),
    /// `inv`
    Inv(Vec<message_blockdata::Inventory>),
    /// `getdata`
    GetData(Vec<message_blockdata::Inventory>),
    /// `notfound`
    NotFound(Vec<message_blockdata::Inventory>),
    /// `getblocks`
    GetBlocks(message_blockdata::GetBlocksMessage),
    /// `getheaders`
    GetHeaders(message_blockdata::GetHeadersMessage),
    /// `mempool`
    MemPool,
    /// tx
    Tx(transaction::Transaction),
    /// `block`
    Block(block::Block),
    /// `headers`
    Headers(Vec<block::LoneBlockHeader>),
    /// `getaddr`
    GetAddr,
    /// `ping`
    Ping(u64),
    /// `pong`
    Pong(u64),
    /// `alert`
    Alert(Vec<u8>),
}

impl RawNetworkMessage {
    /// Return the message command. This is useful for debug outputs.
    pub fn command(&self) -> String {
        match self.payload {
            NetworkMessage::Version(_) => "version",
            NetworkMessage::Verack => "verack",
            NetworkMessage::Addr(_) => "addr",
            NetworkMessage::Inv(_) => "inv",
            NetworkMessage::GetData(_) => "getdata",
            NetworkMessage::NotFound(_) => "notfound",
            NetworkMessage::GetBlocks(_) => "getblocks",
            NetworkMessage::GetHeaders(_) => "getheaders",
            NetworkMessage::MemPool => "mempool",
            NetworkMessage::Tx(_) => "tx",
            NetworkMessage::Block(_) => "block",
            NetworkMessage::Headers(_) => "headers",
            NetworkMessage::GetAddr => "getaddr",
            NetworkMessage::Ping(_) => "ping",
            NetworkMessage::Pong(_) => "pong",
            NetworkMessage::Alert(_) => "alert",
        }
        .to_owned()
    }
}

impl<S: SimpleEncoder> ConsensusEncodable<S> for RawNetworkMessage {
    fn consensus_encode(&self, s: &mut S) -> Result<(), serialize::Error> {
        self.magic.consensus_encode(s)?;
        CommandString(self.command()).consensus_encode(s)?;
        CheckedData(
            match self.payload {
                NetworkMessage::Version(ref dat) => serialize(dat),
                NetworkMessage::Verack => Ok(vec![]),
                NetworkMessage::Addr(ref dat) => serialize(dat),
                NetworkMessage::Inv(ref dat) => serialize(dat),
                NetworkMessage::GetData(ref dat) => serialize(dat),
                NetworkMessage::NotFound(ref dat) => serialize(dat),
                NetworkMessage::GetBlocks(ref dat) => serialize(dat),
                NetworkMessage::GetHeaders(ref dat) => serialize(dat),
                NetworkMessage::MemPool => Ok(vec![]),
                NetworkMessage::Tx(ref dat) => serialize(dat),
                NetworkMessage::Block(ref dat) => serialize(dat),
                NetworkMessage::Headers(ref dat) => serialize(dat),
                NetworkMessage::GetAddr => Ok(vec![]),
                NetworkMessage::Ping(ref dat) => serialize(dat),
                NetworkMessage::Pong(ref dat) => serialize(dat),
                NetworkMessage::Alert(ref dat) => serialize(dat),
            }
            .unwrap(),
        )
        .consensus_encode(s)?;
        Ok(())
    }
}

impl<D: SimpleDecoder> ConsensusDecodable<D> for RawNetworkMessage {
    fn consensus_decode(d: &mut D) -> Result<RawNetworkMessage, serialize::Error> {
        let magic = ConsensusDecodable::consensus_decode(d)?;
        let CommandString(cmd): CommandString = ConsensusDecodable::consensus_decode(d)?;
        let CheckedData(raw_payload): CheckedData = ConsensusDecodable::consensus_decode(d)?;

        let mut mem_d = RawDecoder::new(Cursor::new(raw_payload));
        let payload = match &cmd[..] {
            "version" => NetworkMessage::Version(ConsensusDecodable::consensus_decode(&mut mem_d)?),
            "verack" => NetworkMessage::Verack,
            "addr" => NetworkMessage::Addr(ConsensusDecodable::consensus_decode(&mut mem_d)?),
            "inv" => NetworkMessage::Inv(ConsensusDecodable::consensus_decode(&mut mem_d)?),
            "getdata" => NetworkMessage::GetData(ConsensusDecodable::consensus_decode(&mut mem_d)?),
            "notfound" => {
                NetworkMessage::NotFound(ConsensusDecodable::consensus_decode(&mut mem_d)?)
            }
            "getblocks" => {
                NetworkMessage::GetBlocks(ConsensusDecodable::consensus_decode(&mut mem_d)?)
            }
            "getheaders" => {
                NetworkMessage::GetHeaders(ConsensusDecodable::consensus_decode(&mut mem_d)?)
            }
            "mempool" => NetworkMessage::MemPool,
            "block" => NetworkMessage::Block(ConsensusDecodable::consensus_decode(&mut mem_d)?),
            "headers" => NetworkMessage::Headers(ConsensusDecodable::consensus_decode(&mut mem_d)?),
            "getaddr" => NetworkMessage::GetAddr,
            "ping" => NetworkMessage::Ping(ConsensusDecodable::consensus_decode(&mut mem_d)?),
            "pong" => NetworkMessage::Pong(ConsensusDecodable::consensus_decode(&mut mem_d)?),
            "tx" => NetworkMessage::Tx(ConsensusDecodable::consensus_decode(&mut mem_d)?),
            "alert" => NetworkMessage::Alert(ConsensusDecodable::consensus_decode(&mut mem_d)?),
            _ => return Err(serialize::Error::UnrecognizedNetworkCommand(cmd)),
        };
        Ok(RawNetworkMessage { magic, payload })
    }
}

#[cfg(test)]
mod test {
    use super::{CommandString, NetworkMessage, RawNetworkMessage};
    use crate::deps_common::bitcoin::network::serialize::{deserialize, serialize};

    #[test]
    fn serialize_commandstring_test() {
        let cs = CommandString("Andrew".to_owned());
        assert_eq!(
            serialize(&cs).ok(),
            Some(vec![0x41u8, 0x6e, 0x64, 0x72, 0x65, 0x77, 0, 0, 0, 0, 0, 0])
        );
    }

    #[test]
    fn deserialize_commandstring_test() {
        let cs: Result<CommandString, _> =
            deserialize(&[0x41u8, 0x6e, 0x64, 0x72, 0x65, 0x77, 0, 0, 0, 0, 0, 0]);
        assert!(cs.is_ok());
        assert_eq!(cs.unwrap(), CommandString("Andrew".to_owned()));

        let short_cs: Result<CommandString, _> =
            deserialize(&[0x41u8, 0x6e, 0x64, 0x72, 0x65, 0x77, 0, 0, 0, 0, 0]);
        assert!(short_cs.is_err());
    }

    #[test]
    fn serialize_verack_test() {
        assert_eq!(
            serialize(&RawNetworkMessage {
                magic: 0xd9b4bef9,
                payload: NetworkMessage::Verack
            })
            .ok(),
            Some(vec![
                0xf9, 0xbe, 0xb4, 0xd9, 0x76, 0x65, 0x72, 0x61, 0x63, 0x6B, 0x00, 0x00, 0x00, 0x00,
                0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2
            ])
        );
    }

    #[test]
    fn serialize_ping_test() {
        assert_eq!(
            serialize(&RawNetworkMessage {
                magic: 0xd9b4bef9,
                payload: NetworkMessage::Ping(100)
            })
            .ok(),
            Some(vec![
                0xf9, 0xbe, 0xb4, 0xd9, 0x70, 0x69, 0x6e, 0x67, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
                0x00, 0x00, 0x08, 0x00, 0x00, 0x00, 0x24, 0x67, 0xf1, 0x1d, 0x64, 0x00, 0x00, 0x00,
                0x00, 0x00, 0x00, 0x00
            ])
        );
    }

    #[test]
    fn serialize_mempool_test() {
        assert_eq!(
            serialize(&RawNetworkMessage {
                magic: 0xd9b4bef9,
                payload: NetworkMessage::MemPool
            })
            .ok(),
            Some(vec![
                0xf9, 0xbe, 0xb4, 0xd9, 0x6d, 0x65, 0x6d, 0x70, 0x6f, 0x6f, 0x6c, 0x00, 0x00, 0x00,
                0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2
            ])
        );
    }

    #[test]
    fn serialize_getaddr_test() {
        assert_eq!(
            serialize(&RawNetworkMessage {
                magic: 0xd9b4bef9,
                payload: NetworkMessage::GetAddr
            })
            .ok(),
            Some(vec![
                0xf9, 0xbe, 0xb4, 0xd9, 0x67, 0x65, 0x74, 0x61, 0x64, 0x64, 0x72, 0x00, 0x00, 0x00,
                0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x5d, 0xf6, 0xe0, 0xe2
            ])
        );
    }
}