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