_ Git - rust-lightning/blob - lightning/src/ln/wire.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Wire encoding/decoding for Lightning messages according to [BOLT #1], and for
  11 //! custom message through the [`CustomMessageReader`] trait.
  12 //!
  13 //! [BOLT #1]: https://github.com/lightningnetwork/lightning-rfc/blob/master/01-messaging.md
  14
  15 use io;
  16 use ln::msgs;
  17 use util::ser::{Readable, Writeable, Writer};
  18
  19 /// Trait to be implemented by custom message (unrelated to the channel/gossip LN layers)
  20 /// decoders.
  21 pub trait CustomMessageReader {
  22         /// The type of the message decoded by the implementation.
  23         type CustomMessage: core::fmt::Debug + Type + Writeable;
  24         /// Decodes a custom message to `CustomMessageType`. If the given message type is known to the
  25         /// implementation and the message could be decoded, must return `Ok(Some(message))`. If the
  26         /// message type is unknown to the implementation, must return `Ok(None)`. If a decoding error
  27         /// occur, must return `Err(DecodeError::X)` where `X` details the encountered error.
  28         fn read<R: io::Read>(&self, message_type: u16, buffer: &mut R) -> Result<Option<Self::CustomMessage>, msgs::DecodeError>;
  29 }
  30
  31 /// A Lightning message returned by [`read()`] when decoding bytes received over the wire. Each
  32 /// variant contains a message from [`msgs`] or otherwise the message type if unknown.
  33 #[allow(missing_docs)]
  34 #[derive(Debug)]
  35 pub(crate) enum Message<T> where T: core::fmt::Debug + Type {
  36         Init(msgs::Init),
  37         Error(msgs::ErrorMessage),
  38         Ping(msgs::Ping),
  39         Pong(msgs::Pong),
  40         OpenChannel(msgs::OpenChannel),
  41         AcceptChannel(msgs::AcceptChannel),
  42         FundingCreated(msgs::FundingCreated),
  43         FundingSigned(msgs::FundingSigned),
  44         FundingLocked(msgs::FundingLocked),
  45         Shutdown(msgs::Shutdown),
  46         ClosingSigned(msgs::ClosingSigned),
  47         UpdateAddHTLC(msgs::UpdateAddHTLC),
  48         UpdateFulfillHTLC(msgs::UpdateFulfillHTLC),
  49         UpdateFailHTLC(msgs::UpdateFailHTLC),
  50         UpdateFailMalformedHTLC(msgs::UpdateFailMalformedHTLC),
  51         CommitmentSigned(msgs::CommitmentSigned),
  52         RevokeAndACK(msgs::RevokeAndACK),
  53         UpdateFee(msgs::UpdateFee),
  54         ChannelReestablish(msgs::ChannelReestablish),
  55         AnnouncementSignatures(msgs::AnnouncementSignatures),
  56         ChannelAnnouncement(msgs::ChannelAnnouncement),
  57         NodeAnnouncement(msgs::NodeAnnouncement),
  58         ChannelUpdate(msgs::ChannelUpdate),
  59         QueryShortChannelIds(msgs::QueryShortChannelIds),
  60         ReplyShortChannelIdsEnd(msgs::ReplyShortChannelIdsEnd),
  61         QueryChannelRange(msgs::QueryChannelRange),
  62         ReplyChannelRange(msgs::ReplyChannelRange),
  63         GossipTimestampFilter(msgs::GossipTimestampFilter),
  64         /// A message that could not be decoded because its type is unknown.
  65         Unknown(u16),
  66         /// A message that was produced by a [`CustomMessageReader`] and is to be handled by a
  67         /// [`::ln::peer_handler::CustomMessageHandler`].
  68         Custom(T),
  69 }
  70
  71 impl<T> Message<T> where T: core::fmt::Debug + Type {
  72         /// Returns the type that was used to decode the message payload.
  73         pub fn type_id(&self) -> u16 {
  74                 match self {
  75                         &Message::Init(ref msg) => msg.type_id(),
  76                         &Message::Error(ref msg) => msg.type_id(),
  77                         &Message::Ping(ref msg) => msg.type_id(),
  78                         &Message::Pong(ref msg) => msg.type_id(),
  79                         &Message::OpenChannel(ref msg) => msg.type_id(),
  80                         &Message::AcceptChannel(ref msg) => msg.type_id(),
  81                         &Message::FundingCreated(ref msg) => msg.type_id(),
  82                         &Message::FundingSigned(ref msg) => msg.type_id(),
  83                         &Message::FundingLocked(ref msg) => msg.type_id(),
  84                         &Message::Shutdown(ref msg) => msg.type_id(),
  85                         &Message::ClosingSigned(ref msg) => msg.type_id(),
  86                         &Message::UpdateAddHTLC(ref msg) => msg.type_id(),
  87                         &Message::UpdateFulfillHTLC(ref msg) => msg.type_id(),
  88                         &Message::UpdateFailHTLC(ref msg) => msg.type_id(),
  89                         &Message::UpdateFailMalformedHTLC(ref msg) => msg.type_id(),
  90                         &Message::CommitmentSigned(ref msg) => msg.type_id(),
  91                         &Message::RevokeAndACK(ref msg) => msg.type_id(),
  92                         &Message::UpdateFee(ref msg) => msg.type_id(),
  93                         &Message::ChannelReestablish(ref msg) => msg.type_id(),
  94                         &Message::AnnouncementSignatures(ref msg) => msg.type_id(),
  95                         &Message::ChannelAnnouncement(ref msg) => msg.type_id(),
  96                         &Message::NodeAnnouncement(ref msg) => msg.type_id(),
  97                         &Message::ChannelUpdate(ref msg) => msg.type_id(),
  98                         &Message::QueryShortChannelIds(ref msg) => msg.type_id(),
  99                         &Message::ReplyShortChannelIdsEnd(ref msg) => msg.type_id(),
 100                         &Message::QueryChannelRange(ref msg) => msg.type_id(),
 101                         &Message::ReplyChannelRange(ref msg) => msg.type_id(),
 102                         &Message::GossipTimestampFilter(ref msg) => msg.type_id(),
 103                         &Message::Unknown(type_id) => type_id,
 104                         &Message::Custom(ref msg) => msg.type_id(),
 105                 }
 106         }
 107
 108         /// Returns whether the message's type is even, indicating both endpoints must support it.
 109         pub fn is_even(&self) -> bool {
 110                 (self.type_id() & 1) == 0
 111         }
 112 }
 113
 114 /// Reads a message from the data buffer consisting of a 2-byte big-endian type and a
 115 /// variable-length payload conforming to the type.
 116 ///
 117 /// # Errors
 118 ///
 119 /// Returns an error if the message payload code not be decoded as the specified type.
 120 pub(crate) fn read<R: io::Read, T, H: core::ops::Deref>(
 121         buffer: &mut R,
 122         custom_reader: H,
 123 ) -> Result<Message<T>, msgs::DecodeError>
 124 where
 125         T: core::fmt::Debug + Type + Writeable,
 126         H::Target: CustomMessageReader<CustomMessage = T>,
 127 {
 128         let message_type = <u16 as Readable>::read(buffer)?;
 129         match message_type {
 130                 msgs::Init::TYPE => {
 131                         Ok(Message::Init(Readable::read(buffer)?))
 132                 },
 133                 msgs::ErrorMessage::TYPE => {
 134                         Ok(Message::Error(Readable::read(buffer)?))
 135                 },
 136                 msgs::Ping::TYPE => {
 137                         Ok(Message::Ping(Readable::read(buffer)?))
 138                 },
 139                 msgs::Pong::TYPE => {
 140                         Ok(Message::Pong(Readable::read(buffer)?))
 141                 },
 142                 msgs::OpenChannel::TYPE => {
 143                         Ok(Message::OpenChannel(Readable::read(buffer)?))
 144                 },
 145                 msgs::AcceptChannel::TYPE => {
 146                         Ok(Message::AcceptChannel(Readable::read(buffer)?))
 147                 },
 148                 msgs::FundingCreated::TYPE => {
 149                         Ok(Message::FundingCreated(Readable::read(buffer)?))
 150                 },
 151                 msgs::FundingSigned::TYPE => {
 152                         Ok(Message::FundingSigned(Readable::read(buffer)?))
 153                 },
 154                 msgs::FundingLocked::TYPE => {
 155                         Ok(Message::FundingLocked(Readable::read(buffer)?))
 156                 },
 157                 msgs::Shutdown::TYPE => {
 158                         Ok(Message::Shutdown(Readable::read(buffer)?))
 159                 },
 160                 msgs::ClosingSigned::TYPE => {
 161                         Ok(Message::ClosingSigned(Readable::read(buffer)?))
 162                 },
 163                 msgs::UpdateAddHTLC::TYPE => {
 164                         Ok(Message::UpdateAddHTLC(Readable::read(buffer)?))
 165                 },
 166                 msgs::UpdateFulfillHTLC::TYPE => {
 167                         Ok(Message::UpdateFulfillHTLC(Readable::read(buffer)?))
 168                 },
 169                 msgs::UpdateFailHTLC::TYPE => {
 170                         Ok(Message::UpdateFailHTLC(Readable::read(buffer)?))
 171                 },
 172                 msgs::UpdateFailMalformedHTLC::TYPE => {
 173                         Ok(Message::UpdateFailMalformedHTLC(Readable::read(buffer)?))
 174                 },
 175                 msgs::CommitmentSigned::TYPE => {
 176                         Ok(Message::CommitmentSigned(Readable::read(buffer)?))
 177                 },
 178                 msgs::RevokeAndACK::TYPE => {
 179                         Ok(Message::RevokeAndACK(Readable::read(buffer)?))
 180                 },
 181                 msgs::UpdateFee::TYPE => {
 182                         Ok(Message::UpdateFee(Readable::read(buffer)?))
 183                 },
 184                 msgs::ChannelReestablish::TYPE => {
 185                         Ok(Message::ChannelReestablish(Readable::read(buffer)?))
 186                 },
 187                 msgs::AnnouncementSignatures::TYPE => {
 188                         Ok(Message::AnnouncementSignatures(Readable::read(buffer)?))
 189                 },
 190                 msgs::ChannelAnnouncement::TYPE => {
 191                         Ok(Message::ChannelAnnouncement(Readable::read(buffer)?))
 192                 },
 193                 msgs::NodeAnnouncement::TYPE => {
 194                         Ok(Message::NodeAnnouncement(Readable::read(buffer)?))
 195                 },
 196                 msgs::ChannelUpdate::TYPE => {
 197                         Ok(Message::ChannelUpdate(Readable::read(buffer)?))
 198                 },
 199                 msgs::QueryShortChannelIds::TYPE => {
 200                         Ok(Message::QueryShortChannelIds(Readable::read(buffer)?))
 201                 },
 202                 msgs::ReplyShortChannelIdsEnd::TYPE => {
 203                         Ok(Message::ReplyShortChannelIdsEnd(Readable::read(buffer)?))
 204                 },
 205                 msgs::QueryChannelRange::TYPE => {
 206                         Ok(Message::QueryChannelRange(Readable::read(buffer)?))
 207                 },
 208                 msgs::ReplyChannelRange::TYPE => {
 209                         Ok(Message::ReplyChannelRange(Readable::read(buffer)?))
 210                 }
 211                 msgs::GossipTimestampFilter::TYPE => {
 212                         Ok(Message::GossipTimestampFilter(Readable::read(buffer)?))
 213                 },
 214                 _ => {
 215                         if let Some(custom) = custom_reader.read(message_type, buffer)? {
 216                                 Ok(Message::Custom(custom))
 217                         } else {
 218                                 Ok(Message::Unknown(message_type))
 219                         }
 220                 },
 221         }
 222 }
 223
 224 /// Writes a message to the data buffer encoded as a 2-byte big-endian type and a variable-length
 225 /// payload.
 226 ///
 227 /// # Errors
 228 ///
 229 /// Returns an I/O error if the write could not be completed.
 230 pub(crate) fn write<M: Type + Writeable, W: Writer>(message: &M, buffer: &mut W) -> Result<(), io::Error> {
 231         message.type_id().write(buffer)?;
 232         message.write(buffer)
 233 }
 234
 235 mod encode {
 236         /// Defines a constant type identifier for reading messages from the wire.
 237         pub trait Encode {
 238                 /// The type identifying the message payload.
 239                 const TYPE: u16;
 240         }
 241 }
 242
 243 pub(crate) use self::encode::Encode;
 244
 245 /// Defines a type identifier for sending messages over the wire.
 246 ///
 247 /// Messages implementing this trait specify a type and must be [`Writeable`].
 248 pub trait Type {
 249         /// Returns the type identifying the message payload.
 250         fn type_id(&self) -> u16;
 251 }
 252
 253 impl<T> Type for T where T: Encode {
 254         fn type_id(&self) -> u16 {
 255                 T::TYPE
 256         }
 257 }
 258
 259 impl Encode for msgs::Init {
 260         const TYPE: u16 = 16;
 261 }
 262
 263 impl Encode for msgs::ErrorMessage {
 264         const TYPE: u16 = 17;
 265 }
 266
 267 impl Encode for msgs::Ping {
 268         const TYPE: u16 = 18;
 269 }
 270
 271 impl Encode for msgs::Pong {
 272         const TYPE: u16 = 19;
 273 }
 274
 275 impl Encode for msgs::OpenChannel {
 276         const TYPE: u16 = 32;
 277 }
 278
 279 impl Encode for msgs::AcceptChannel {
 280         const TYPE: u16 = 33;
 281 }
 282
 283 impl Encode for msgs::FundingCreated {
 284         const TYPE: u16 = 34;
 285 }
 286
 287 impl Encode for msgs::FundingSigned {
 288         const TYPE: u16 = 35;
 289 }
 290
 291 impl Encode for msgs::FundingLocked {
 292         const TYPE: u16 = 36;
 293 }
 294
 295 impl Encode for msgs::Shutdown {
 296         const TYPE: u16 = 38;
 297 }
 298
 299 impl Encode for msgs::ClosingSigned {
 300         const TYPE: u16 = 39;
 301 }
 302
 303 impl Encode for msgs::UpdateAddHTLC {
 304         const TYPE: u16 = 128;
 305 }
 306
 307 impl Encode for msgs::UpdateFulfillHTLC {
 308         const TYPE: u16 = 130;
 309 }
 310
 311 impl Encode for msgs::UpdateFailHTLC {
 312         const TYPE: u16 = 131;
 313 }
 314
 315 impl Encode for msgs::UpdateFailMalformedHTLC {
 316         const TYPE: u16 = 135;
 317 }
 318
 319 impl Encode for msgs::CommitmentSigned {
 320         const TYPE: u16 = 132;
 321 }
 322
 323 impl Encode for msgs::RevokeAndACK {
 324         const TYPE: u16 = 133;
 325 }
 326
 327 impl Encode for msgs::UpdateFee {
 328         const TYPE: u16 = 134;
 329 }
 330
 331 impl Encode for msgs::ChannelReestablish {
 332         const TYPE: u16 = 136;
 333 }
 334
 335 impl Encode for msgs::AnnouncementSignatures {
 336         const TYPE: u16 = 259;
 337 }
 338
 339 impl Encode for msgs::ChannelAnnouncement {
 340         const TYPE: u16 = 256;
 341 }
 342
 343 impl Encode for msgs::NodeAnnouncement {
 344         const TYPE: u16 = 257;
 345 }
 346
 347 impl Encode for msgs::ChannelUpdate {
 348         const TYPE: u16 = 258;
 349 }
 350
 351 impl Encode for msgs::QueryShortChannelIds {
 352         const TYPE: u16 = 261;
 353 }
 354
 355 impl Encode for msgs::ReplyShortChannelIdsEnd {
 356         const TYPE: u16 = 262;
 357 }
 358
 359 impl Encode for msgs::QueryChannelRange {
 360         const TYPE: u16 = 263;
 361 }
 362
 363 impl Encode for msgs::ReplyChannelRange {
 364         const TYPE: u16 = 264;
 365 }
 366
 367 impl Encode for msgs::GossipTimestampFilter {
 368         const TYPE: u16 = 265;
 369 }
 370
 371 #[cfg(test)]
 372 mod tests {
 373         use super::*;
 374         use prelude::*;
 375         use core::convert::TryInto;
 376         use ::ln::peer_handler::IgnoringMessageHandler;
 377
 378         // Big-endian wire encoding of Pong message (type = 19, byteslen = 2).
 379         const ENCODED_PONG: [u8; 6] = [0u8, 19u8, 0u8, 2u8, 0u8, 0u8];
 380
 381         #[test]
 382         fn read_empty_buffer() {
 383                 let buffer = [];
 384                 let mut reader = io::Cursor::new(buffer);
 385                 assert!(read(&mut reader, &IgnoringMessageHandler{}).is_err());
 386         }
 387
 388         #[test]
 389         fn read_incomplete_type() {
 390                 let buffer = &ENCODED_PONG[..1];
 391                 let mut reader = io::Cursor::new(buffer);
 392                 assert!(read(&mut reader, &IgnoringMessageHandler{}).is_err());
 393         }
 394
 395         #[test]
 396         fn read_empty_payload() {
 397                 let buffer = &ENCODED_PONG[..2];
 398                 let mut reader = io::Cursor::new(buffer);
 399                 assert!(read(&mut reader, &IgnoringMessageHandler{}).is_err());
 400         }
 401
 402         #[test]
 403         fn read_invalid_message() {
 404                 let buffer = &ENCODED_PONG[..4];
 405                 let mut reader = io::Cursor::new(buffer);
 406                 assert!(read(&mut reader, &IgnoringMessageHandler{}).is_err());
 407         }
 408
 409         #[test]
 410         fn read_known_message() {
 411                 let buffer = &ENCODED_PONG[..];
 412                 let mut reader = io::Cursor::new(buffer);
 413                 let message = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
 414                 match message {
 415                         Message::Pong(_) => (),
 416                         _ => panic!("Expected pong message; found message type: {}", message.type_id()),
 417                 }
 418         }
 419
 420         #[test]
 421         fn read_unknown_message() {
 422                 let buffer = &::core::u16::MAX.to_be_bytes();
 423                 let mut reader = io::Cursor::new(buffer);
 424                 let message = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
 425                 match message {
 426                         Message::Unknown(::core::u16::MAX) => (),
 427                         _ => panic!("Expected message type {}; found: {}", ::core::u16::MAX, message.type_id()),
 428                 }
 429         }
 430
 431         #[test]
 432         fn write_message_with_type() {
 433                 let message = msgs::Pong { byteslen: 2u16 };
 434                 let mut buffer = Vec::new();
 435                 assert!(write(&message, &mut buffer).is_ok());
 436
 437                 let type_length = ::core::mem::size_of::<u16>();
 438                 let (type_bytes, payload_bytes) = buffer.split_at(type_length);
 439                 assert_eq!(u16::from_be_bytes(type_bytes.try_into().unwrap()), msgs::Pong::TYPE);
 440                 assert_eq!(payload_bytes, &ENCODED_PONG[type_length..]);
 441         }
 442
 443         #[test]
 444         fn read_message_encoded_with_write() {
 445                 let message = msgs::Pong { byteslen: 2u16 };
 446                 let mut buffer = Vec::new();
 447                 assert!(write(&message, &mut buffer).is_ok());
 448
 449                 let mut reader = io::Cursor::new(buffer);
 450                 let decoded_message = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
 451                 match decoded_message {
 452                         Message::Pong(msgs::Pong { byteslen: 2u16 }) => (),
 453                         Message::Pong(msgs::Pong { byteslen }) => {
 454                                 panic!("Expected byteslen {}; found: {}", message.byteslen, byteslen);
 455                         },
 456                         _ => panic!("Expected pong message; found message type: {}", decoded_message.type_id()),
 457                 }
 458         }
 459
 460         #[test]
 461         fn is_even_message_type() {
 462                 let message = Message::<()>::Unknown(42);
 463                 assert!(message.is_even());
 464         }
 465
 466         #[test]
 467         fn is_odd_message_type() {
 468                 let message = Message::<()>::Unknown(43);
 469                 assert!(!message.is_even());
 470         }
 471
 472         #[test]
 473         fn read_lnd_init_msg() {
 474                 // Taken from lnd v0.9.0-beta.
 475                 let buffer = vec![0, 16, 0, 2, 34, 0, 0, 3, 2, 162, 161];
 476                 check_init_msg(buffer, false);
 477         }
 478
 479         #[test]
 480         fn read_clightning_init_msg() {
 481                 // Taken from c-lightning v0.8.0.
 482                 let buffer = vec![0, 16, 0, 2, 34, 0, 0, 3, 2, 170, 162, 1, 32, 6, 34, 110, 70, 17, 26, 11, 89, 202, 175, 18, 96, 67, 235, 91, 191, 40, 195, 79, 58, 94, 51, 42, 31, 199, 178, 183, 60, 241, 136, 145, 15];
 483                 check_init_msg(buffer, true);
 484         }
 485
 486         fn check_init_msg(buffer: Vec<u8>, expect_unknown: bool) {
 487                 let mut reader = io::Cursor::new(buffer);
 488                 let decoded_msg = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
 489                 match decoded_msg {
 490                         Message::Init(msgs::Init { features }) => {
 491                                 assert!(features.supports_variable_length_onion());
 492                                 assert!(features.supports_upfront_shutdown_script());
 493                                 assert!(features.supports_gossip_queries());
 494                                 assert_eq!(expect_unknown, features.supports_unknown_bits());
 495                                 assert!(!features.requires_unknown_bits());
 496                                 assert!(!features.initial_routing_sync());
 497                         },
 498                         _ => panic!("Expected init message, found message type: {}", decoded_msg.type_id())
 499                 }
 500         }
 501
 502         #[test]
 503         fn read_lnd_node_announcement() {
 504                 // Taken from lnd v0.9.0-beta.
 505                 let buffer = vec![1, 1, 91, 164, 146, 213, 213, 165, 21, 227, 102, 33, 105, 179, 214, 21, 221, 175, 228, 93, 57, 177, 191, 127, 107, 229, 31, 50, 21, 81, 179, 71, 39, 18, 35, 2, 89, 224, 110, 123, 66, 39, 148, 246, 177, 85, 12, 19, 70, 226, 173, 132, 156, 26, 122, 146, 71, 213, 247, 48, 93, 190, 185, 177, 12, 172, 0, 3, 2, 162, 161, 94, 103, 195, 37, 2, 37, 242, 97, 140, 2, 111, 69, 85, 39, 118, 30, 221, 99, 254, 120, 49, 103, 22, 170, 227, 111, 172, 164, 160, 49, 68, 138, 116, 16, 22, 206, 107, 51, 153, 255, 97, 108, 105, 99, 101, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, 1, 172, 21, 0, 2, 38, 7];
 506                 let mut reader = io::Cursor::new(buffer);
 507                 let decoded_msg = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
 508                 match decoded_msg {
 509                         Message::NodeAnnouncement(msgs::NodeAnnouncement { contents: msgs::UnsignedNodeAnnouncement { features, ..}, ..}) => {
 510                                 assert!(features.supports_variable_length_onion());
 511                                 assert!(features.supports_upfront_shutdown_script());
 512                                 assert!(features.supports_gossip_queries());
 513                                 assert!(!features.requires_unknown_bits());
 514                         },
 515                         _ => panic!("Expected node announcement, found message type: {}", decoded_msg.type_id())
 516                 }
 517         }
 518
 519         #[test]
 520         fn read_lnd_chan_announcement() {
 521                 // Taken from lnd v0.9.0-beta.
 522                 let buffer = vec![1, 0, 82, 238, 153, 33, 128, 87, 215, 2, 28, 241, 140, 250, 98, 255, 56, 5, 79, 240, 214, 231, 172, 35, 240, 171, 44, 9, 78, 91, 8, 193, 102, 5, 17, 178, 142, 106, 180, 183, 46, 38, 217, 212, 25, 236, 69, 47, 92, 217, 181, 221, 161, 205, 121, 201, 99, 38, 158, 216, 186, 193, 230, 86, 222, 6, 206, 67, 22, 255, 137, 212, 141, 161, 62, 134, 76, 48, 241, 54, 50, 167, 187, 247, 73, 27, 74, 1, 129, 185, 197, 153, 38, 90, 255, 138, 39, 161, 102, 172, 213, 74, 107, 88, 150, 90, 0, 49, 104, 7, 182, 184, 194, 219, 181, 172, 8, 245, 65, 226, 19, 228, 101, 145, 25, 159, 52, 31, 58, 93, 53, 59, 218, 91, 37, 84, 103, 17, 74, 133, 33, 35, 2, 203, 101, 73, 19, 94, 175, 122, 46, 224, 47, 168, 128, 128, 25, 26, 25, 214, 52, 247, 43, 241, 117, 52, 206, 94, 135, 156, 52, 164, 143, 234, 58, 185, 50, 185, 140, 198, 174, 71, 65, 18, 105, 70, 131, 172, 137, 0, 164, 51, 215, 143, 117, 119, 217, 241, 197, 177, 227, 227, 170, 199, 114, 7, 218, 12, 107, 30, 191, 236, 203, 21, 61, 242, 48, 192, 90, 233, 200, 199, 111, 162, 68, 234, 54, 219, 1, 233, 66, 5, 82, 74, 84, 211, 95, 199, 245, 202, 89, 223, 102, 124, 62, 166, 253, 253, 90, 180, 118, 21, 61, 110, 37, 5, 96, 167, 0, 0, 6, 34, 110, 70, 17, 26, 11, 89, 202, 175, 18, 96, 67, 235, 91, 191, 40, 195, 79, 58, 94, 51, 42, 31, 199, 178, 183, 60, 241, 136, 145, 15, 0, 2, 65, 0, 0, 1, 0, 0, 2, 37, 242, 97, 140, 2, 111, 69, 85, 39, 118, 30, 221, 99, 254, 120, 49, 103, 22, 170, 227, 111, 172, 164, 160, 49, 68, 138, 116, 16, 22, 206, 107, 3, 54, 61, 144, 88, 171, 247, 136, 208, 99, 9, 135, 37, 201, 178, 253, 136, 0, 185, 235, 68, 160, 106, 110, 12, 46, 21, 125, 204, 18, 75, 234, 16, 3, 42, 171, 28, 52, 224, 11, 30, 30, 253, 156, 148, 175, 203, 121, 250, 111, 122, 195, 84, 122, 77, 183, 56, 135, 101, 88, 41, 60, 191, 99, 232, 85, 2, 36, 17, 156, 11, 8, 12, 189, 177, 68, 88, 28, 15, 207, 21, 179, 151, 56, 226, 158, 148, 3, 120, 113, 177, 243, 184, 17, 173, 37, 46, 222, 16];
 523                 let mut reader = io::Cursor::new(buffer);
 524                 let decoded_msg = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
 525                 match decoded_msg {
 526                         Message::ChannelAnnouncement(msgs::ChannelAnnouncement { contents: msgs::UnsignedChannelAnnouncement { features, ..}, ..}) => {
 527                                 assert!(!features.requires_unknown_bits());
 528                         },
 529                         _ => panic!("Expected node announcement, found message type: {}", decoded_msg.type_id())
 530                 }
 531         }
 532
 533         #[derive(Eq, PartialEq, Debug)]
 534         struct TestCustomMessage {}
 535
 536         const CUSTOM_MESSAGE_TYPE : u16 = 9000;
 537
 538         impl Type for TestCustomMessage {
 539                 fn type_id(&self) -> u16 {
 540                         CUSTOM_MESSAGE_TYPE
 541                 }
 542         }
 543
 544         impl Writeable for TestCustomMessage {
 545                 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
 546                         Ok(())
 547                 }
 548         }
 549
 550         struct TestCustomMessageReader {}
 551
 552         impl CustomMessageReader for TestCustomMessageReader {
 553                 type CustomMessage = TestCustomMessage;
 554                 fn read<R: io::Read>(
 555                         &self,
 556                         message_type: u16,
 557                         _: &mut R
 558                 ) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
 559                         if message_type == CUSTOM_MESSAGE_TYPE {
 560                                 return Ok(Some(TestCustomMessage{}));
 561                         }
 562
 563                         Ok(None)
 564                 }
 565         }
 566
 567         #[test]
 568         fn read_custom_message() {
 569                 let buffer = vec![35, 40];
 570                 let mut reader = io::Cursor::new(buffer);
 571                 let decoded_msg = read(&mut reader, &TestCustomMessageReader{}).unwrap();
 572                 match decoded_msg {
 573                         Message::Custom(custom) => {
 574                                 assert_eq!(custom.type_id(), CUSTOM_MESSAGE_TYPE);
 575                                 assert_eq!(custom, TestCustomMessage {});
 576                         },
 577                         _ => panic!("Expected custom message, found message type: {}", decoded_msg.type_id()),
 578                 }
 579         }
 580
 581         #[test]
 582         fn read_with_custom_reader_unknown_message_type() {
 583                 let buffer = vec![35, 42];
 584                 let mut reader = io::Cursor::new(buffer);
 585                 let decoded_msg = read(&mut reader, &TestCustomMessageReader{}).unwrap();
 586                 match decoded_msg {
 587                         Message::Unknown(_) => {},
 588                         _ => panic!("Expected unknown message, found message type: {}", decoded_msg.type_id()),
 589                 }
 590         }
 591
 592         #[test]
 593         fn custom_reader_unknown_message_type() {
 594                 let buffer = Vec::new();
 595                 let mut reader = io::Cursor::new(buffer);
 596                 let res = TestCustomMessageReader{}.read(CUSTOM_MESSAGE_TYPE + 1, &mut reader).unwrap();
 597                 assert!(res.is_none());
 598         }
 599 }