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