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