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].
12 //! Messages known by this module can be read from the wire using [`read()`].
13 //! The [`Message`] enum returned by [`read()`] wraps the decoded message or the message type (if
14 //! unknown) to use with pattern matching.
16 //! Messages implementing the [`Encode`] trait define a message type and can be sent over the wire
17 //! using [`write()`].
19 //! [BOLT #1]: https://github.com/lightningnetwork/lightning-rfc/blob/master/01-messaging.md
22 use util::ser::{Readable, Writeable, Writer};
24 /// A Lightning message returned by [`read()`] when decoding bytes received over the wire. Each
25 /// variant contains a message from [`msgs`] or otherwise the message type if unknown.
26 #[allow(missing_docs)]
30 Error(msgs::ErrorMessage),
33 OpenChannel(msgs::OpenChannel),
34 AcceptChannel(msgs::AcceptChannel),
35 FundingCreated(msgs::FundingCreated),
36 FundingSigned(msgs::FundingSigned),
37 FundingLocked(msgs::FundingLocked),
38 Shutdown(msgs::Shutdown),
39 ClosingSigned(msgs::ClosingSigned),
40 UpdateAddHTLC(msgs::UpdateAddHTLC),
41 UpdateFulfillHTLC(msgs::UpdateFulfillHTLC),
42 UpdateFailHTLC(msgs::UpdateFailHTLC),
43 UpdateFailMalformedHTLC(msgs::UpdateFailMalformedHTLC),
44 CommitmentSigned(msgs::CommitmentSigned),
45 RevokeAndACK(msgs::RevokeAndACK),
46 UpdateFee(msgs::UpdateFee),
47 ChannelReestablish(msgs::ChannelReestablish),
48 AnnouncementSignatures(msgs::AnnouncementSignatures),
49 ChannelAnnouncement(msgs::ChannelAnnouncement),
50 NodeAnnouncement(msgs::NodeAnnouncement),
51 ChannelUpdate(msgs::ChannelUpdate),
52 QueryShortChannelIds(msgs::QueryShortChannelIds),
53 ReplyShortChannelIdsEnd(msgs::ReplyShortChannelIdsEnd),
54 QueryChannelRange(msgs::QueryChannelRange),
55 ReplyChannelRange(msgs::ReplyChannelRange),
56 GossipTimestampFilter(msgs::GossipTimestampFilter),
57 /// A message that could not be decoded because its type is unknown.
61 /// A number identifying a message to determine how it is encoded on the wire.
62 #[derive(Clone, Copy, Debug)]
63 pub struct MessageType(u16);
66 #[allow(dead_code)] // This method is only used in tests
67 /// Returns the type that was used to decode the message payload.
68 pub fn type_id(&self) -> MessageType {
70 &Message::Init(ref msg) => msg.type_id(),
71 &Message::Error(ref msg) => msg.type_id(),
72 &Message::Ping(ref msg) => msg.type_id(),
73 &Message::Pong(ref msg) => msg.type_id(),
74 &Message::OpenChannel(ref msg) => msg.type_id(),
75 &Message::AcceptChannel(ref msg) => msg.type_id(),
76 &Message::FundingCreated(ref msg) => msg.type_id(),
77 &Message::FundingSigned(ref msg) => msg.type_id(),
78 &Message::FundingLocked(ref msg) => msg.type_id(),
79 &Message::Shutdown(ref msg) => msg.type_id(),
80 &Message::ClosingSigned(ref msg) => msg.type_id(),
81 &Message::UpdateAddHTLC(ref msg) => msg.type_id(),
82 &Message::UpdateFulfillHTLC(ref msg) => msg.type_id(),
83 &Message::UpdateFailHTLC(ref msg) => msg.type_id(),
84 &Message::UpdateFailMalformedHTLC(ref msg) => msg.type_id(),
85 &Message::CommitmentSigned(ref msg) => msg.type_id(),
86 &Message::RevokeAndACK(ref msg) => msg.type_id(),
87 &Message::UpdateFee(ref msg) => msg.type_id(),
88 &Message::ChannelReestablish(ref msg) => msg.type_id(),
89 &Message::AnnouncementSignatures(ref msg) => msg.type_id(),
90 &Message::ChannelAnnouncement(ref msg) => msg.type_id(),
91 &Message::NodeAnnouncement(ref msg) => msg.type_id(),
92 &Message::ChannelUpdate(ref msg) => msg.type_id(),
93 &Message::QueryShortChannelIds(ref msg) => msg.type_id(),
94 &Message::ReplyShortChannelIdsEnd(ref msg) => msg.type_id(),
95 &Message::QueryChannelRange(ref msg) => msg.type_id(),
96 &Message::ReplyChannelRange(ref msg) => msg.type_id(),
97 &Message::GossipTimestampFilter(ref msg) => msg.type_id(),
98 &Message::Unknown(type_id) => type_id,
104 /// Returns whether the message type is even, indicating both endpoints must support it.
105 pub fn is_even(&self) -> bool {
110 impl ::core::fmt::Display for MessageType {
111 fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
112 write!(f, "{}", self.0)
116 /// Reads a message from the data buffer consisting of a 2-byte big-endian type and a
117 /// variable-length payload conforming to the type.
121 /// Returns an error if the message payload code not be decoded as the specified type.
122 pub fn read<R: ::std::io::Read>(buffer: &mut R) -> Result<Message, msgs::DecodeError> {
123 let message_type = <u16 as Readable>::read(buffer)?;
125 msgs::Init::TYPE => {
126 Ok(Message::Init(Readable::read(buffer)?))
128 msgs::ErrorMessage::TYPE => {
129 Ok(Message::Error(Readable::read(buffer)?))
131 msgs::Ping::TYPE => {
132 Ok(Message::Ping(Readable::read(buffer)?))
134 msgs::Pong::TYPE => {
135 Ok(Message::Pong(Readable::read(buffer)?))
137 msgs::OpenChannel::TYPE => {
138 Ok(Message::OpenChannel(Readable::read(buffer)?))
140 msgs::AcceptChannel::TYPE => {
141 Ok(Message::AcceptChannel(Readable::read(buffer)?))
143 msgs::FundingCreated::TYPE => {
144 Ok(Message::FundingCreated(Readable::read(buffer)?))
146 msgs::FundingSigned::TYPE => {
147 Ok(Message::FundingSigned(Readable::read(buffer)?))
149 msgs::FundingLocked::TYPE => {
150 Ok(Message::FundingLocked(Readable::read(buffer)?))
152 msgs::Shutdown::TYPE => {
153 Ok(Message::Shutdown(Readable::read(buffer)?))
155 msgs::ClosingSigned::TYPE => {
156 Ok(Message::ClosingSigned(Readable::read(buffer)?))
158 msgs::UpdateAddHTLC::TYPE => {
159 Ok(Message::UpdateAddHTLC(Readable::read(buffer)?))
161 msgs::UpdateFulfillHTLC::TYPE => {
162 Ok(Message::UpdateFulfillHTLC(Readable::read(buffer)?))
164 msgs::UpdateFailHTLC::TYPE => {
165 Ok(Message::UpdateFailHTLC(Readable::read(buffer)?))
167 msgs::UpdateFailMalformedHTLC::TYPE => {
168 Ok(Message::UpdateFailMalformedHTLC(Readable::read(buffer)?))
170 msgs::CommitmentSigned::TYPE => {
171 Ok(Message::CommitmentSigned(Readable::read(buffer)?))
173 msgs::RevokeAndACK::TYPE => {
174 Ok(Message::RevokeAndACK(Readable::read(buffer)?))
176 msgs::UpdateFee::TYPE => {
177 Ok(Message::UpdateFee(Readable::read(buffer)?))
179 msgs::ChannelReestablish::TYPE => {
180 Ok(Message::ChannelReestablish(Readable::read(buffer)?))
182 msgs::AnnouncementSignatures::TYPE => {
183 Ok(Message::AnnouncementSignatures(Readable::read(buffer)?))
185 msgs::ChannelAnnouncement::TYPE => {
186 Ok(Message::ChannelAnnouncement(Readable::read(buffer)?))
188 msgs::NodeAnnouncement::TYPE => {
189 Ok(Message::NodeAnnouncement(Readable::read(buffer)?))
191 msgs::ChannelUpdate::TYPE => {
192 Ok(Message::ChannelUpdate(Readable::read(buffer)?))
194 msgs::QueryShortChannelIds::TYPE => {
195 Ok(Message::QueryShortChannelIds(Readable::read(buffer)?))
197 msgs::ReplyShortChannelIdsEnd::TYPE => {
198 Ok(Message::ReplyShortChannelIdsEnd(Readable::read(buffer)?))
200 msgs::QueryChannelRange::TYPE => {
201 Ok(Message::QueryChannelRange(Readable::read(buffer)?))
203 msgs::ReplyChannelRange::TYPE => {
204 Ok(Message::ReplyChannelRange(Readable::read(buffer)?))
206 msgs::GossipTimestampFilter::TYPE => {
207 Ok(Message::GossipTimestampFilter(Readable::read(buffer)?))
210 Ok(Message::Unknown(MessageType(message_type)))
215 /// Writes a message to the data buffer encoded as a 2-byte big-endian type and a variable-length
220 /// Returns an I/O error if the write could not be completed.
221 pub fn write<M: Encode + Writeable, W: Writer>(message: &M, buffer: &mut W) -> Result<(), ::std::io::Error> {
222 M::TYPE.write(buffer)?;
223 message.write(buffer)
226 /// Defines a type-identified encoding for sending messages over the wire.
228 /// Messages implementing this trait specify a type and must be [`Writeable`] to use with [`write()`].
230 /// The type identifying the message payload.
233 /// Returns the type identifying the message payload. Convenience method for accessing
235 fn type_id(&self) -> MessageType {
236 MessageType(Self::TYPE)
240 impl Encode for msgs::Init {
241 const TYPE: u16 = 16;
244 impl Encode for msgs::ErrorMessage {
245 const TYPE: u16 = 17;
248 impl Encode for msgs::Ping {
249 const TYPE: u16 = 18;
252 impl Encode for msgs::Pong {
253 const TYPE: u16 = 19;
256 impl Encode for msgs::OpenChannel {
257 const TYPE: u16 = 32;
260 impl Encode for msgs::AcceptChannel {
261 const TYPE: u16 = 33;
264 impl Encode for msgs::FundingCreated {
265 const TYPE: u16 = 34;
268 impl Encode for msgs::FundingSigned {
269 const TYPE: u16 = 35;
272 impl Encode for msgs::FundingLocked {
273 const TYPE: u16 = 36;
276 impl Encode for msgs::Shutdown {
277 const TYPE: u16 = 38;
280 impl Encode for msgs::ClosingSigned {
281 const TYPE: u16 = 39;
284 impl Encode for msgs::UpdateAddHTLC {
285 const TYPE: u16 = 128;
288 impl Encode for msgs::UpdateFulfillHTLC {
289 const TYPE: u16 = 130;
292 impl Encode for msgs::UpdateFailHTLC {
293 const TYPE: u16 = 131;
296 impl Encode for msgs::UpdateFailMalformedHTLC {
297 const TYPE: u16 = 135;
300 impl Encode for msgs::CommitmentSigned {
301 const TYPE: u16 = 132;
304 impl Encode for msgs::RevokeAndACK {
305 const TYPE: u16 = 133;
308 impl Encode for msgs::UpdateFee {
309 const TYPE: u16 = 134;
312 impl Encode for msgs::ChannelReestablish {
313 const TYPE: u16 = 136;
316 impl Encode for msgs::AnnouncementSignatures {
317 const TYPE: u16 = 259;
320 impl Encode for msgs::ChannelAnnouncement {
321 const TYPE: u16 = 256;
324 impl Encode for msgs::NodeAnnouncement {
325 const TYPE: u16 = 257;
328 impl Encode for msgs::ChannelUpdate {
329 const TYPE: u16 = 258;
332 impl Encode for msgs::QueryShortChannelIds {
333 const TYPE: u16 = 261;
336 impl Encode for msgs::ReplyShortChannelIdsEnd {
337 const TYPE: u16 = 262;
340 impl Encode for msgs::QueryChannelRange {
341 const TYPE: u16 = 263;
344 impl Encode for msgs::ReplyChannelRange {
345 const TYPE: u16 = 264;
348 impl Encode for msgs::GossipTimestampFilter {
349 const TYPE: u16 = 265;
356 use core::convert::TryInto;
358 // Big-endian wire encoding of Pong message (type = 19, byteslen = 2).
359 const ENCODED_PONG: [u8; 6] = [0u8, 19u8, 0u8, 2u8, 0u8, 0u8];
362 fn read_empty_buffer() {
364 let mut reader = ::std::io::Cursor::new(buffer);
365 assert!(read(&mut reader).is_err());
369 fn read_incomplete_type() {
370 let buffer = &ENCODED_PONG[..1];
371 let mut reader = ::std::io::Cursor::new(buffer);
372 assert!(read(&mut reader).is_err());
376 fn read_empty_payload() {
377 let buffer = &ENCODED_PONG[..2];
378 let mut reader = ::std::io::Cursor::new(buffer);
379 assert!(read(&mut reader).is_err());
383 fn read_invalid_message() {
384 let buffer = &ENCODED_PONG[..4];
385 let mut reader = ::std::io::Cursor::new(buffer);
386 assert!(read(&mut reader).is_err());
390 fn read_known_message() {
391 let buffer = &ENCODED_PONG[..];
392 let mut reader = ::std::io::Cursor::new(buffer);
393 let message = read(&mut reader).unwrap();
395 Message::Pong(_) => (),
396 _ => panic!("Expected pong message; found message type: {}", message.type_id()),
401 fn read_unknown_message() {
402 let buffer = &::core::u16::MAX.to_be_bytes();
403 let mut reader = ::std::io::Cursor::new(buffer);
404 let message = read(&mut reader).unwrap();
406 Message::Unknown(MessageType(::core::u16::MAX)) => (),
407 _ => panic!("Expected message type {}; found: {}", ::core::u16::MAX, message.type_id()),
412 fn write_message_with_type() {
413 let message = msgs::Pong { byteslen: 2u16 };
414 let mut buffer = Vec::new();
415 assert!(write(&message, &mut buffer).is_ok());
417 let type_length = ::core::mem::size_of::<u16>();
418 let (type_bytes, payload_bytes) = buffer.split_at(type_length);
419 assert_eq!(u16::from_be_bytes(type_bytes.try_into().unwrap()), msgs::Pong::TYPE);
420 assert_eq!(payload_bytes, &ENCODED_PONG[type_length..]);
424 fn read_message_encoded_with_write() {
425 let message = msgs::Pong { byteslen: 2u16 };
426 let mut buffer = Vec::new();
427 assert!(write(&message, &mut buffer).is_ok());
429 let mut reader = ::std::io::Cursor::new(buffer);
430 let decoded_message = read(&mut reader).unwrap();
431 match decoded_message {
432 Message::Pong(msgs::Pong { byteslen: 2u16 }) => (),
433 Message::Pong(msgs::Pong { byteslen }) => {
434 panic!("Expected byteslen {}; found: {}", message.byteslen, byteslen);
436 _ => panic!("Expected pong message; found message type: {}", decoded_message.type_id()),
441 fn is_even_message_type() {
442 let message = Message::Unknown(MessageType(42));
443 assert!(message.type_id().is_even());
447 fn is_odd_message_type() {
448 let message = Message::Unknown(MessageType(43));
449 assert!(!message.type_id().is_even());
453 fn read_lnd_init_msg() {
454 // Taken from lnd v0.9.0-beta.
455 let buffer = vec![0, 16, 0, 2, 34, 0, 0, 3, 2, 162, 161];
456 check_init_msg(buffer, false);
460 fn read_clightning_init_msg() {
461 // Taken from c-lightning v0.8.0.
462 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];
463 check_init_msg(buffer, true);
466 fn check_init_msg(buffer: Vec<u8>, expect_unknown: bool) {
467 let mut reader = ::std::io::Cursor::new(buffer);
468 let decoded_msg = read(&mut reader).unwrap();
470 Message::Init(msgs::Init { features }) => {
471 assert!(features.supports_variable_length_onion());
472 assert!(features.supports_upfront_shutdown_script());
473 assert!(features.supports_gossip_queries());
474 assert_eq!(expect_unknown, features.supports_unknown_bits());
475 assert!(!features.requires_unknown_bits());
476 assert!(!features.initial_routing_sync());
478 _ => panic!("Expected init message, found message type: {}", decoded_msg.type_id())
483 fn read_lnd_node_announcement() {
484 // Taken from lnd v0.9.0-beta.
485 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];
486 let mut reader = ::std::io::Cursor::new(buffer);
487 let decoded_msg = read(&mut reader).unwrap();
489 Message::NodeAnnouncement(msgs::NodeAnnouncement { contents: msgs::UnsignedNodeAnnouncement { features, ..}, ..}) => {
490 assert!(features.supports_variable_length_onion());
491 assert!(features.supports_upfront_shutdown_script());
492 assert!(features.supports_gossip_queries());
493 assert!(!features.requires_unknown_bits());
495 _ => panic!("Expected node announcement, found message type: {}", decoded_msg.type_id())
500 fn read_lnd_chan_announcement() {
501 // Taken from lnd v0.9.0-beta.
502 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];
503 let mut reader = ::std::io::Cursor::new(buffer);
504 let decoded_msg = read(&mut reader).unwrap();
506 Message::ChannelAnnouncement(msgs::ChannelAnnouncement { contents: msgs::UnsignedChannelAnnouncement { features, ..}, ..}) => {
507 assert!(!features.requires_unknown_bits());
509 _ => panic!("Expected node announcement, found message type: {}", decoded_msg.type_id())