1 // This file is Copyright its original authors, visible in version control
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
10 //! Wire encoding/decoding for Lightning messages according to [BOLT #1], and for
11 //! custom message through the [`CustomMessageReader`] trait.
13 //! [BOLT #1]: https://github.com/lightning/bolts/blob/master/01-messaging.md
17 use crate::util::ser::{Readable, Writeable, Writer};
19 /// Trait to be implemented by custom message (unrelated to the channel/gossip LN layers)
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>;
31 // TestEq is a dummy trait which requires PartialEq when built in testing, and otherwise is
32 // blanket-implemented for all types.
35 pub trait TestEq : PartialEq {}
37 impl<T: PartialEq> TestEq for T {}
40 pub(crate) trait TestEq {}
42 impl<T> TestEq for T {}
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)]
49 #[cfg_attr(test, derive(PartialEq))]
50 pub(crate) enum Message<T> where T: core::fmt::Debug + Type + TestEq {
52 Error(msgs::ErrorMessage),
53 Warning(msgs::WarningMessage),
56 OpenChannel(msgs::OpenChannel),
57 OpenChannelV2(msgs::OpenChannelV2),
58 AcceptChannel(msgs::AcceptChannel),
59 AcceptChannelV2(msgs::AcceptChannelV2),
60 FundingCreated(msgs::FundingCreated),
61 FundingSigned(msgs::FundingSigned),
66 SpliceAck(msgs::SpliceAck),
68 SpliceLocked(msgs::SpliceLocked),
69 TxAddInput(msgs::TxAddInput),
70 TxAddOutput(msgs::TxAddOutput),
71 TxRemoveInput(msgs::TxRemoveInput),
72 TxRemoveOutput(msgs::TxRemoveOutput),
73 TxComplete(msgs::TxComplete),
74 TxSignatures(msgs::TxSignatures),
75 TxInitRbf(msgs::TxInitRbf),
76 TxAckRbf(msgs::TxAckRbf),
77 TxAbort(msgs::TxAbort),
78 ChannelReady(msgs::ChannelReady),
79 Shutdown(msgs::Shutdown),
80 ClosingSigned(msgs::ClosingSigned),
81 OnionMessage(msgs::OnionMessage),
82 UpdateAddHTLC(msgs::UpdateAddHTLC),
83 UpdateFulfillHTLC(msgs::UpdateFulfillHTLC),
84 UpdateFailHTLC(msgs::UpdateFailHTLC),
85 UpdateFailMalformedHTLC(msgs::UpdateFailMalformedHTLC),
86 CommitmentSigned(msgs::CommitmentSigned),
87 RevokeAndACK(msgs::RevokeAndACK),
88 UpdateFee(msgs::UpdateFee),
89 ChannelReestablish(msgs::ChannelReestablish),
90 AnnouncementSignatures(msgs::AnnouncementSignatures),
91 ChannelAnnouncement(msgs::ChannelAnnouncement),
92 NodeAnnouncement(msgs::NodeAnnouncement),
93 ChannelUpdate(msgs::ChannelUpdate),
94 QueryShortChannelIds(msgs::QueryShortChannelIds),
95 ReplyShortChannelIdsEnd(msgs::ReplyShortChannelIdsEnd),
96 QueryChannelRange(msgs::QueryChannelRange),
97 ReplyChannelRange(msgs::ReplyChannelRange),
98 GossipTimestampFilter(msgs::GossipTimestampFilter),
99 /// A message that could not be decoded because its type is unknown.
101 /// A message that was produced by a [`CustomMessageReader`] and is to be handled by a
102 /// [`crate::ln::peer_handler::CustomMessageHandler`].
106 impl<T> Writeable for Message<T> where T: core::fmt::Debug + Type + TestEq {
107 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
109 &Message::Init(ref msg) => msg.write(writer),
110 &Message::Error(ref msg) => msg.write(writer),
111 &Message::Warning(ref msg) => msg.write(writer),
112 &Message::Ping(ref msg) => msg.write(writer),
113 &Message::Pong(ref msg) => msg.write(writer),
114 &Message::OpenChannel(ref msg) => msg.write(writer),
115 &Message::OpenChannelV2(ref msg) => msg.write(writer),
116 &Message::AcceptChannel(ref msg) => msg.write(writer),
117 &Message::AcceptChannelV2(ref msg) => msg.write(writer),
118 &Message::FundingCreated(ref msg) => msg.write(writer),
119 &Message::FundingSigned(ref msg) => msg.write(writer),
120 &Message::Stfu(ref msg) => msg.write(writer),
122 &Message::Splice(ref msg) => msg.write(writer),
124 &Message::SpliceAck(ref msg) => msg.write(writer),
126 &Message::SpliceLocked(ref msg) => msg.write(writer),
127 &Message::TxAddInput(ref msg) => msg.write(writer),
128 &Message::TxAddOutput(ref msg) => msg.write(writer),
129 &Message::TxRemoveInput(ref msg) => msg.write(writer),
130 &Message::TxRemoveOutput(ref msg) => msg.write(writer),
131 &Message::TxComplete(ref msg) => msg.write(writer),
132 &Message::TxSignatures(ref msg) => msg.write(writer),
133 &Message::TxInitRbf(ref msg) => msg.write(writer),
134 &Message::TxAckRbf(ref msg) => msg.write(writer),
135 &Message::TxAbort(ref msg) => msg.write(writer),
136 &Message::ChannelReady(ref msg) => msg.write(writer),
137 &Message::Shutdown(ref msg) => msg.write(writer),
138 &Message::ClosingSigned(ref msg) => msg.write(writer),
139 &Message::OnionMessage(ref msg) => msg.write(writer),
140 &Message::UpdateAddHTLC(ref msg) => msg.write(writer),
141 &Message::UpdateFulfillHTLC(ref msg) => msg.write(writer),
142 &Message::UpdateFailHTLC(ref msg) => msg.write(writer),
143 &Message::UpdateFailMalformedHTLC(ref msg) => msg.write(writer),
144 &Message::CommitmentSigned(ref msg) => msg.write(writer),
145 &Message::RevokeAndACK(ref msg) => msg.write(writer),
146 &Message::UpdateFee(ref msg) => msg.write(writer),
147 &Message::ChannelReestablish(ref msg) => msg.write(writer),
148 &Message::AnnouncementSignatures(ref msg) => msg.write(writer),
149 &Message::ChannelAnnouncement(ref msg) => msg.write(writer),
150 &Message::NodeAnnouncement(ref msg) => msg.write(writer),
151 &Message::ChannelUpdate(ref msg) => msg.write(writer),
152 &Message::QueryShortChannelIds(ref msg) => msg.write(writer),
153 &Message::ReplyShortChannelIdsEnd(ref msg) => msg.write(writer),
154 &Message::QueryChannelRange(ref msg) => msg.write(writer),
155 &Message::ReplyChannelRange(ref msg) => msg.write(writer),
156 &Message::GossipTimestampFilter(ref msg) => msg.write(writer),
157 &Message::Unknown(_) => { Ok(()) },
158 &Message::Custom(ref msg) => msg.write(writer),
163 impl<T> Type for Message<T> where T: core::fmt::Debug + Type + TestEq {
164 /// Returns the type that was used to decode the message payload.
165 fn type_id(&self) -> u16 {
167 &Message::Init(ref msg) => msg.type_id(),
168 &Message::Error(ref msg) => msg.type_id(),
169 &Message::Warning(ref msg) => msg.type_id(),
170 &Message::Ping(ref msg) => msg.type_id(),
171 &Message::Pong(ref msg) => msg.type_id(),
172 &Message::OpenChannel(ref msg) => msg.type_id(),
173 &Message::OpenChannelV2(ref msg) => msg.type_id(),
174 &Message::AcceptChannel(ref msg) => msg.type_id(),
175 &Message::AcceptChannelV2(ref msg) => msg.type_id(),
176 &Message::FundingCreated(ref msg) => msg.type_id(),
177 &Message::FundingSigned(ref msg) => msg.type_id(),
178 &Message::Stfu(ref msg) => msg.type_id(),
180 &Message::Splice(ref msg) => msg.type_id(),
182 &Message::SpliceAck(ref msg) => msg.type_id(),
184 &Message::SpliceLocked(ref msg) => msg.type_id(),
185 &Message::TxAddInput(ref msg) => msg.type_id(),
186 &Message::TxAddOutput(ref msg) => msg.type_id(),
187 &Message::TxRemoveInput(ref msg) => msg.type_id(),
188 &Message::TxRemoveOutput(ref msg) => msg.type_id(),
189 &Message::TxComplete(ref msg) => msg.type_id(),
190 &Message::TxSignatures(ref msg) => msg.type_id(),
191 &Message::TxInitRbf(ref msg) => msg.type_id(),
192 &Message::TxAckRbf(ref msg) => msg.type_id(),
193 &Message::TxAbort(ref msg) => msg.type_id(),
194 &Message::ChannelReady(ref msg) => msg.type_id(),
195 &Message::Shutdown(ref msg) => msg.type_id(),
196 &Message::ClosingSigned(ref msg) => msg.type_id(),
197 &Message::OnionMessage(ref msg) => msg.type_id(),
198 &Message::UpdateAddHTLC(ref msg) => msg.type_id(),
199 &Message::UpdateFulfillHTLC(ref msg) => msg.type_id(),
200 &Message::UpdateFailHTLC(ref msg) => msg.type_id(),
201 &Message::UpdateFailMalformedHTLC(ref msg) => msg.type_id(),
202 &Message::CommitmentSigned(ref msg) => msg.type_id(),
203 &Message::RevokeAndACK(ref msg) => msg.type_id(),
204 &Message::UpdateFee(ref msg) => msg.type_id(),
205 &Message::ChannelReestablish(ref msg) => msg.type_id(),
206 &Message::AnnouncementSignatures(ref msg) => msg.type_id(),
207 &Message::ChannelAnnouncement(ref msg) => msg.type_id(),
208 &Message::NodeAnnouncement(ref msg) => msg.type_id(),
209 &Message::ChannelUpdate(ref msg) => msg.type_id(),
210 &Message::QueryShortChannelIds(ref msg) => msg.type_id(),
211 &Message::ReplyShortChannelIdsEnd(ref msg) => msg.type_id(),
212 &Message::QueryChannelRange(ref msg) => msg.type_id(),
213 &Message::ReplyChannelRange(ref msg) => msg.type_id(),
214 &Message::GossipTimestampFilter(ref msg) => msg.type_id(),
215 &Message::Unknown(type_id) => type_id,
216 &Message::Custom(ref msg) => msg.type_id(),
221 impl<T> Message<T> where T: core::fmt::Debug + Type + TestEq {
222 /// Returns whether the message's type is even, indicating both endpoints must support it.
223 pub fn is_even(&self) -> bool {
224 (self.type_id() & 1) == 0
228 /// Reads a message from the data buffer consisting of a 2-byte big-endian type and a
229 /// variable-length payload conforming to the type.
233 /// Returns an error if the message payload could not be decoded as the specified type.
234 pub(crate) fn read<R: io::Read, T, H: core::ops::Deref>(buffer: &mut R, custom_reader: H)
235 -> Result<Message<T>, (msgs::DecodeError, Option<u16>)> where
236 T: core::fmt::Debug + Type + Writeable,
237 H::Target: CustomMessageReader<CustomMessage = T>,
239 let message_type = <u16 as Readable>::read(buffer).map_err(|e| (e, None))?;
240 do_read(buffer, message_type, custom_reader).map_err(|e| (e, Some(message_type)))
243 fn do_read<R: io::Read, T, H: core::ops::Deref>(buffer: &mut R, message_type: u16, custom_reader: H)
244 -> Result<Message<T>, msgs::DecodeError> where
245 T: core::fmt::Debug + Type + Writeable,
246 H::Target: CustomMessageReader<CustomMessage = T>,
249 msgs::Init::TYPE => {
250 Ok(Message::Init(Readable::read(buffer)?))
252 msgs::ErrorMessage::TYPE => {
253 Ok(Message::Error(Readable::read(buffer)?))
255 msgs::WarningMessage::TYPE => {
256 Ok(Message::Warning(Readable::read(buffer)?))
258 msgs::Ping::TYPE => {
259 Ok(Message::Ping(Readable::read(buffer)?))
261 msgs::Pong::TYPE => {
262 Ok(Message::Pong(Readable::read(buffer)?))
264 msgs::OpenChannel::TYPE => {
265 Ok(Message::OpenChannel(Readable::read(buffer)?))
267 msgs::OpenChannelV2::TYPE => {
268 Ok(Message::OpenChannelV2(Readable::read(buffer)?))
270 msgs::AcceptChannel::TYPE => {
271 Ok(Message::AcceptChannel(Readable::read(buffer)?))
273 msgs::AcceptChannelV2::TYPE => {
274 Ok(Message::AcceptChannelV2(Readable::read(buffer)?))
276 msgs::FundingCreated::TYPE => {
277 Ok(Message::FundingCreated(Readable::read(buffer)?))
279 msgs::FundingSigned::TYPE => {
280 Ok(Message::FundingSigned(Readable::read(buffer)?))
283 msgs::Splice::TYPE => {
284 Ok(Message::Splice(Readable::read(buffer)?))
286 msgs::Stfu::TYPE => {
287 Ok(Message::Stfu(Readable::read(buffer)?))
290 msgs::SpliceAck::TYPE => {
291 Ok(Message::SpliceAck(Readable::read(buffer)?))
294 msgs::SpliceLocked::TYPE => {
295 Ok(Message::SpliceLocked(Readable::read(buffer)?))
297 msgs::TxAddInput::TYPE => {
298 Ok(Message::TxAddInput(Readable::read(buffer)?))
300 msgs::TxAddOutput::TYPE => {
301 Ok(Message::TxAddOutput(Readable::read(buffer)?))
303 msgs::TxRemoveInput::TYPE => {
304 Ok(Message::TxRemoveInput(Readable::read(buffer)?))
306 msgs::TxRemoveOutput::TYPE => {
307 Ok(Message::TxRemoveOutput(Readable::read(buffer)?))
309 msgs::TxComplete::TYPE => {
310 Ok(Message::TxComplete(Readable::read(buffer)?))
312 msgs::TxSignatures::TYPE => {
313 Ok(Message::TxSignatures(Readable::read(buffer)?))
315 msgs::TxInitRbf::TYPE => {
316 Ok(Message::TxInitRbf(Readable::read(buffer)?))
318 msgs::TxAckRbf::TYPE => {
319 Ok(Message::TxAckRbf(Readable::read(buffer)?))
321 msgs::TxAbort::TYPE => {
322 Ok(Message::TxAbort(Readable::read(buffer)?))
324 msgs::ChannelReady::TYPE => {
325 Ok(Message::ChannelReady(Readable::read(buffer)?))
327 msgs::Shutdown::TYPE => {
328 Ok(Message::Shutdown(Readable::read(buffer)?))
330 msgs::ClosingSigned::TYPE => {
331 Ok(Message::ClosingSigned(Readable::read(buffer)?))
333 msgs::OnionMessage::TYPE => {
334 Ok(Message::OnionMessage(Readable::read(buffer)?))
336 msgs::UpdateAddHTLC::TYPE => {
337 Ok(Message::UpdateAddHTLC(Readable::read(buffer)?))
339 msgs::UpdateFulfillHTLC::TYPE => {
340 Ok(Message::UpdateFulfillHTLC(Readable::read(buffer)?))
342 msgs::UpdateFailHTLC::TYPE => {
343 Ok(Message::UpdateFailHTLC(Readable::read(buffer)?))
345 msgs::UpdateFailMalformedHTLC::TYPE => {
346 Ok(Message::UpdateFailMalformedHTLC(Readable::read(buffer)?))
348 msgs::CommitmentSigned::TYPE => {
349 Ok(Message::CommitmentSigned(Readable::read(buffer)?))
351 msgs::RevokeAndACK::TYPE => {
352 Ok(Message::RevokeAndACK(Readable::read(buffer)?))
354 msgs::UpdateFee::TYPE => {
355 Ok(Message::UpdateFee(Readable::read(buffer)?))
357 msgs::ChannelReestablish::TYPE => {
358 Ok(Message::ChannelReestablish(Readable::read(buffer)?))
360 msgs::AnnouncementSignatures::TYPE => {
361 Ok(Message::AnnouncementSignatures(Readable::read(buffer)?))
363 msgs::ChannelAnnouncement::TYPE => {
364 Ok(Message::ChannelAnnouncement(Readable::read(buffer)?))
366 msgs::NodeAnnouncement::TYPE => {
367 Ok(Message::NodeAnnouncement(Readable::read(buffer)?))
369 msgs::ChannelUpdate::TYPE => {
370 Ok(Message::ChannelUpdate(Readable::read(buffer)?))
372 msgs::QueryShortChannelIds::TYPE => {
373 Ok(Message::QueryShortChannelIds(Readable::read(buffer)?))
375 msgs::ReplyShortChannelIdsEnd::TYPE => {
376 Ok(Message::ReplyShortChannelIdsEnd(Readable::read(buffer)?))
378 msgs::QueryChannelRange::TYPE => {
379 Ok(Message::QueryChannelRange(Readable::read(buffer)?))
381 msgs::ReplyChannelRange::TYPE => {
382 Ok(Message::ReplyChannelRange(Readable::read(buffer)?))
384 msgs::GossipTimestampFilter::TYPE => {
385 Ok(Message::GossipTimestampFilter(Readable::read(buffer)?))
388 if let Some(custom) = custom_reader.read(message_type, buffer)? {
389 Ok(Message::Custom(custom))
391 Ok(Message::Unknown(message_type))
397 /// Writes a message to the data buffer encoded as a 2-byte big-endian type and a variable-length
402 /// Returns an I/O error if the write could not be completed.
403 pub(crate) fn write<M: Type + Writeable, W: Writer>(message: &M, buffer: &mut W) -> Result<(), io::Error> {
404 message.type_id().write(buffer)?;
405 message.write(buffer)
409 /// Defines a constant type identifier for reading messages from the wire.
411 /// The type identifying the message payload.
416 pub(crate) use self::encode::Encode;
419 /// Defines a type identifier for sending messages over the wire.
421 /// Messages implementing this trait specify a type and must be [`Writeable`].
422 pub trait Type: core::fmt::Debug + Writeable {
423 /// Returns the type identifying the message payload.
424 fn type_id(&self) -> u16;
428 pub trait Type: core::fmt::Debug + Writeable + PartialEq {
429 fn type_id(&self) -> u16;
432 #[cfg(any(feature = "_test_utils", fuzzing, test))]
434 fn type_id(&self) -> u16 { unreachable!(); }
438 impl<T: core::fmt::Debug + Writeable + PartialEq> Type for T where T: Encode {
439 fn type_id(&self) -> u16 { T::TYPE }
443 impl<T: core::fmt::Debug + Writeable> Type for T where T: Encode {
444 fn type_id(&self) -> u16 { T::TYPE }
447 impl Encode for msgs::Stfu {
451 impl Encode for msgs::Init {
452 const TYPE: u16 = 16;
455 impl Encode for msgs::ErrorMessage {
456 const TYPE: u16 = 17;
459 impl Encode for msgs::WarningMessage {
463 impl Encode for msgs::Ping {
464 const TYPE: u16 = 18;
467 impl Encode for msgs::Pong {
468 const TYPE: u16 = 19;
471 impl Encode for msgs::OpenChannel {
472 const TYPE: u16 = 32;
475 impl Encode for msgs::AcceptChannel {
476 const TYPE: u16 = 33;
479 impl Encode for msgs::FundingCreated {
480 const TYPE: u16 = 34;
483 impl Encode for msgs::FundingSigned {
484 const TYPE: u16 = 35;
487 impl Encode for msgs::ChannelReady {
488 const TYPE: u16 = 36;
491 impl Encode for msgs::Shutdown {
492 const TYPE: u16 = 38;
495 impl Encode for msgs::ClosingSigned {
496 const TYPE: u16 = 39;
499 impl Encode for msgs::OpenChannelV2 {
500 const TYPE: u16 = 64;
503 impl Encode for msgs::AcceptChannelV2 {
504 const TYPE: u16 = 65;
507 impl Encode for msgs::Splice {
508 // TODO(splicing) Double check with finalized spec; draft spec contains 74, which is probably wrong as it is used by tx_Abort; CLN uses 75
509 const TYPE: u16 = 75;
512 impl Encode for msgs::SpliceAck {
513 const TYPE: u16 = 76;
516 impl Encode for msgs::SpliceLocked {
517 const TYPE: u16 = 77;
520 impl Encode for msgs::TxAddInput {
521 const TYPE: u16 = 66;
524 impl Encode for msgs::TxAddOutput {
525 const TYPE: u16 = 67;
528 impl Encode for msgs::TxRemoveInput {
529 const TYPE: u16 = 68;
532 impl Encode for msgs::TxRemoveOutput {
533 const TYPE: u16 = 69;
536 impl Encode for msgs::TxComplete {
537 const TYPE: u16 = 70;
540 impl Encode for msgs::TxSignatures {
541 const TYPE: u16 = 71;
544 impl Encode for msgs::TxInitRbf {
545 const TYPE: u16 = 72;
548 impl Encode for msgs::TxAckRbf {
549 const TYPE: u16 = 73;
552 impl Encode for msgs::TxAbort {
553 const TYPE: u16 = 74;
556 impl Encode for msgs::OnionMessage {
557 const TYPE: u16 = 513;
560 impl Encode for msgs::UpdateAddHTLC {
561 const TYPE: u16 = 128;
564 impl Encode for msgs::UpdateFulfillHTLC {
565 const TYPE: u16 = 130;
568 impl Encode for msgs::UpdateFailHTLC {
569 const TYPE: u16 = 131;
572 impl Encode for msgs::UpdateFailMalformedHTLC {
573 const TYPE: u16 = 135;
576 impl Encode for msgs::CommitmentSigned {
577 const TYPE: u16 = 132;
580 impl Encode for msgs::RevokeAndACK {
581 const TYPE: u16 = 133;
584 impl Encode for msgs::UpdateFee {
585 const TYPE: u16 = 134;
588 impl Encode for msgs::ChannelReestablish {
589 const TYPE: u16 = 136;
592 impl Encode for msgs::AnnouncementSignatures {
593 const TYPE: u16 = 259;
596 impl Encode for msgs::ChannelAnnouncement {
597 const TYPE: u16 = 256;
600 impl Encode for msgs::NodeAnnouncement {
601 const TYPE: u16 = 257;
604 impl Encode for msgs::ChannelUpdate {
605 const TYPE: u16 = 258;
608 impl Encode for msgs::QueryShortChannelIds {
609 const TYPE: u16 = 261;
612 impl Encode for msgs::ReplyShortChannelIdsEnd {
613 const TYPE: u16 = 262;
616 impl Encode for msgs::QueryChannelRange {
617 const TYPE: u16 = 263;
620 impl Encode for msgs::ReplyChannelRange {
621 const TYPE: u16 = 264;
624 impl Encode for msgs::GossipTimestampFilter {
625 const TYPE: u16 = 265;
631 use crate::prelude::*;
632 use crate::ln::peer_handler::IgnoringMessageHandler;
634 // Big-endian wire encoding of Pong message (type = 19, byteslen = 2).
635 const ENCODED_PONG: [u8; 6] = [0u8, 19u8, 0u8, 2u8, 0u8, 0u8];
638 fn read_empty_buffer() {
640 let mut reader = io::Cursor::new(buffer);
641 assert!(read(&mut reader, &IgnoringMessageHandler{}).is_err());
645 fn read_incomplete_type() {
646 let buffer = &ENCODED_PONG[..1];
647 let mut reader = io::Cursor::new(buffer);
648 assert!(read(&mut reader, &IgnoringMessageHandler{}).is_err());
652 fn read_empty_payload() {
653 let buffer = &ENCODED_PONG[..2];
654 let mut reader = io::Cursor::new(buffer);
655 assert!(read(&mut reader, &IgnoringMessageHandler{}).is_err());
659 fn read_invalid_message() {
660 let buffer = &ENCODED_PONG[..4];
661 let mut reader = io::Cursor::new(buffer);
662 assert!(read(&mut reader, &IgnoringMessageHandler{}).is_err());
666 fn read_known_message() {
667 let buffer = &ENCODED_PONG[..];
668 let mut reader = io::Cursor::new(buffer);
669 let message = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
671 Message::Pong(_) => (),
672 _ => panic!("Expected pong message; found message type: {}", message.type_id()),
677 fn read_unknown_message() {
678 let buffer = &::core::u16::MAX.to_be_bytes();
679 let mut reader = io::Cursor::new(buffer);
680 let message = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
682 Message::Unknown(::core::u16::MAX) => (),
683 _ => panic!("Expected message type {}; found: {}", ::core::u16::MAX, message.type_id()),
688 fn write_message_with_type() {
689 let message = msgs::Pong { byteslen: 2u16 };
690 let mut buffer = Vec::new();
691 assert!(write(&message, &mut buffer).is_ok());
693 let type_length = ::core::mem::size_of::<u16>();
694 let (type_bytes, payload_bytes) = buffer.split_at(type_length);
695 assert_eq!(u16::from_be_bytes(type_bytes.try_into().unwrap()), msgs::Pong::TYPE);
696 assert_eq!(payload_bytes, &ENCODED_PONG[type_length..]);
700 fn read_message_encoded_with_write() {
701 let message = msgs::Pong { byteslen: 2u16 };
702 let mut buffer = Vec::new();
703 assert!(write(&message, &mut buffer).is_ok());
705 let mut reader = io::Cursor::new(buffer);
706 let decoded_message = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
707 match decoded_message {
708 Message::Pong(msgs::Pong { byteslen: 2u16 }) => (),
709 Message::Pong(msgs::Pong { byteslen }) => {
710 panic!("Expected byteslen {}; found: {}", message.byteslen, byteslen);
712 _ => panic!("Expected pong message; found message type: {}", decoded_message.type_id()),
717 fn is_even_message_type() {
718 let message = Message::<()>::Unknown(42);
719 assert!(message.is_even());
723 fn is_odd_message_type() {
724 let message = Message::<()>::Unknown(43);
725 assert!(!message.is_even());
729 fn read_lnd_init_msg() {
730 // Taken from lnd v0.9.0-beta.
731 let buffer = vec![0, 16, 0, 2, 34, 0, 0, 3, 2, 162, 161];
732 check_init_msg(buffer, false);
736 fn read_clightning_init_msg() {
737 // Taken from c-lightning v0.8.0.
738 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];
739 check_init_msg(buffer, true);
742 fn check_init_msg(buffer: Vec<u8>, expect_unknown: bool) {
743 let mut reader = io::Cursor::new(buffer);
744 let decoded_msg = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
746 Message::Init(msgs::Init { features, .. }) => {
747 assert!(features.supports_variable_length_onion());
748 assert!(features.supports_upfront_shutdown_script());
749 assert!(features.supports_gossip_queries());
750 assert_eq!(expect_unknown, features.supports_unknown_bits());
751 assert!(!features.requires_unknown_bits());
752 assert!(!features.initial_routing_sync());
754 _ => panic!("Expected init message, found message type: {}", decoded_msg.type_id())
759 fn read_lnd_node_announcement() {
760 // Taken from lnd v0.9.0-beta.
761 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];
762 let mut reader = io::Cursor::new(buffer);
763 let decoded_msg = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
765 Message::NodeAnnouncement(msgs::NodeAnnouncement { contents: msgs::UnsignedNodeAnnouncement { features, ..}, ..}) => {
766 assert!(features.supports_variable_length_onion());
767 assert!(features.supports_upfront_shutdown_script());
768 assert!(features.supports_gossip_queries());
769 assert!(!features.requires_unknown_bits());
771 _ => panic!("Expected node announcement, found message type: {}", decoded_msg.type_id())
776 fn read_lnd_chan_announcement() {
777 // Taken from lnd v0.9.0-beta.
778 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];
779 let mut reader = io::Cursor::new(buffer);
780 let decoded_msg = read(&mut reader, &IgnoringMessageHandler{}).unwrap();
782 Message::ChannelAnnouncement(msgs::ChannelAnnouncement { contents: msgs::UnsignedChannelAnnouncement { features, ..}, ..}) => {
783 assert!(!features.requires_unknown_bits());
785 _ => panic!("Expected node announcement, found message type: {}", decoded_msg.type_id())
789 #[derive(Eq, PartialEq, Debug)]
790 struct TestCustomMessage {}
792 const CUSTOM_MESSAGE_TYPE : u16 = 9000;
794 impl Type for TestCustomMessage {
795 fn type_id(&self) -> u16 {
800 impl Writeable for TestCustomMessage {
801 fn write<W: Writer>(&self, _: &mut W) -> Result<(), io::Error> {
806 struct TestCustomMessageReader {}
808 impl CustomMessageReader for TestCustomMessageReader {
809 type CustomMessage = TestCustomMessage;
810 fn read<R: io::Read>(
814 ) -> Result<Option<Self::CustomMessage>, msgs::DecodeError> {
815 if message_type == CUSTOM_MESSAGE_TYPE {
816 return Ok(Some(TestCustomMessage{}));
824 fn read_custom_message() {
825 let buffer = vec![35, 40];
826 let mut reader = io::Cursor::new(buffer);
827 let decoded_msg = read(&mut reader, &TestCustomMessageReader{}).unwrap();
829 Message::Custom(custom) => {
830 assert_eq!(custom.type_id(), CUSTOM_MESSAGE_TYPE);
831 assert_eq!(custom, TestCustomMessage {});
833 _ => panic!("Expected custom message, found message type: {}", decoded_msg.type_id()),
838 fn read_with_custom_reader_unknown_message_type() {
839 let buffer = vec![35, 42];
840 let mut reader = io::Cursor::new(buffer);
841 let decoded_msg = read(&mut reader, &TestCustomMessageReader{}).unwrap();
843 Message::Unknown(_) => {},
844 _ => panic!("Expected unknown message, found message type: {}", decoded_msg.type_id()),
849 fn custom_reader_unknown_message_type() {
850 let buffer = Vec::new();
851 let mut reader = io::Cursor::new(buffer);
852 let res = TestCustomMessageReader{}.read(CUSTOM_MESSAGE_TYPE + 1, &mut reader).unwrap();
853 assert!(res.is_none());