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);
65 impl ::std::ops::Deref for MessageType {
67 fn deref(&self) -> &Self::Target {
73 #[allow(dead_code)] // This method is only used in tests
74 /// Returns the type that was used to decode the message payload.
75 pub fn type_id(&self) -> MessageType {
77 &Message::Init(ref msg) => msg.type_id(),
78 &Message::Error(ref msg) => msg.type_id(),
79 &Message::Ping(ref msg) => msg.type_id(),
80 &Message::Pong(ref msg) => msg.type_id(),
81 &Message::OpenChannel(ref msg) => msg.type_id(),
82 &Message::AcceptChannel(ref msg) => msg.type_id(),
83 &Message::FundingCreated(ref msg) => msg.type_id(),
84 &Message::FundingSigned(ref msg) => msg.type_id(),
85 &Message::FundingLocked(ref msg) => msg.type_id(),
86 &Message::Shutdown(ref msg) => msg.type_id(),
87 &Message::ClosingSigned(ref msg) => msg.type_id(),
88 &Message::UpdateAddHTLC(ref msg) => msg.type_id(),
89 &Message::UpdateFulfillHTLC(ref msg) => msg.type_id(),
90 &Message::UpdateFailHTLC(ref msg) => msg.type_id(),
91 &Message::UpdateFailMalformedHTLC(ref msg) => msg.type_id(),
92 &Message::CommitmentSigned(ref msg) => msg.type_id(),
93 &Message::RevokeAndACK(ref msg) => msg.type_id(),
94 &Message::UpdateFee(ref msg) => msg.type_id(),
95 &Message::ChannelReestablish(ref msg) => msg.type_id(),
96 &Message::AnnouncementSignatures(ref msg) => msg.type_id(),
97 &Message::ChannelAnnouncement(ref msg) => msg.type_id(),
98 &Message::NodeAnnouncement(ref msg) => msg.type_id(),
99 &Message::ChannelUpdate(ref msg) => msg.type_id(),
100 &Message::QueryShortChannelIds(ref msg) => msg.type_id(),
101 &Message::ReplyShortChannelIdsEnd(ref msg) => msg.type_id(),
102 &Message::QueryChannelRange(ref msg) => msg.type_id(),
103 &Message::ReplyChannelRange(ref msg) => msg.type_id(),
104 &Message::GossipTimestampFilter(ref msg) => msg.type_id(),
105 &Message::Unknown(type_id) => type_id,
111 /// Returns whether the message type is even, indicating both endpoints must support it.
112 pub fn is_even(&self) -> bool {
117 impl ::core::fmt::Display for MessageType {
118 fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
119 write!(f, "{}", self.0)
123 /// Reads a message from the data buffer consisting of a 2-byte big-endian type and a
124 /// variable-length payload conforming to the type.
128 /// Returns an error if the message payload code not be decoded as the specified type.
129 pub fn read<R: ::std::io::Read>(buffer: &mut R) -> Result<Message, msgs::DecodeError> {
130 let message_type = <u16 as Readable>::read(buffer)?;
132 msgs::Init::TYPE => {
133 Ok(Message::Init(Readable::read(buffer)?))
135 msgs::ErrorMessage::TYPE => {
136 Ok(Message::Error(Readable::read(buffer)?))
138 msgs::Ping::TYPE => {
139 Ok(Message::Ping(Readable::read(buffer)?))
141 msgs::Pong::TYPE => {
142 Ok(Message::Pong(Readable::read(buffer)?))
144 msgs::OpenChannel::TYPE => {
145 Ok(Message::OpenChannel(Readable::read(buffer)?))
147 msgs::AcceptChannel::TYPE => {
148 Ok(Message::AcceptChannel(Readable::read(buffer)?))
150 msgs::FundingCreated::TYPE => {
151 Ok(Message::FundingCreated(Readable::read(buffer)?))
153 msgs::FundingSigned::TYPE => {
154 Ok(Message::FundingSigned(Readable::read(buffer)?))
156 msgs::FundingLocked::TYPE => {
157 Ok(Message::FundingLocked(Readable::read(buffer)?))
159 msgs::Shutdown::TYPE => {
160 Ok(Message::Shutdown(Readable::read(buffer)?))
162 msgs::ClosingSigned::TYPE => {
163 Ok(Message::ClosingSigned(Readable::read(buffer)?))
165 msgs::UpdateAddHTLC::TYPE => {
166 Ok(Message::UpdateAddHTLC(Readable::read(buffer)?))
168 msgs::UpdateFulfillHTLC::TYPE => {
169 Ok(Message::UpdateFulfillHTLC(Readable::read(buffer)?))
171 msgs::UpdateFailHTLC::TYPE => {
172 Ok(Message::UpdateFailHTLC(Readable::read(buffer)?))
174 msgs::UpdateFailMalformedHTLC::TYPE => {
175 Ok(Message::UpdateFailMalformedHTLC(Readable::read(buffer)?))
177 msgs::CommitmentSigned::TYPE => {
178 Ok(Message::CommitmentSigned(Readable::read(buffer)?))
180 msgs::RevokeAndACK::TYPE => {
181 Ok(Message::RevokeAndACK(Readable::read(buffer)?))
183 msgs::UpdateFee::TYPE => {
184 Ok(Message::UpdateFee(Readable::read(buffer)?))
186 msgs::ChannelReestablish::TYPE => {
187 Ok(Message::ChannelReestablish(Readable::read(buffer)?))
189 msgs::AnnouncementSignatures::TYPE => {
190 Ok(Message::AnnouncementSignatures(Readable::read(buffer)?))
192 msgs::ChannelAnnouncement::TYPE => {
193 Ok(Message::ChannelAnnouncement(Readable::read(buffer)?))
195 msgs::NodeAnnouncement::TYPE => {
196 Ok(Message::NodeAnnouncement(Readable::read(buffer)?))
198 msgs::ChannelUpdate::TYPE => {
199 Ok(Message::ChannelUpdate(Readable::read(buffer)?))
201 msgs::QueryShortChannelIds::TYPE => {
202 Ok(Message::QueryShortChannelIds(Readable::read(buffer)?))
204 msgs::ReplyShortChannelIdsEnd::TYPE => {
205 Ok(Message::ReplyShortChannelIdsEnd(Readable::read(buffer)?))
207 msgs::QueryChannelRange::TYPE => {
208 Ok(Message::QueryChannelRange(Readable::read(buffer)?))
210 msgs::ReplyChannelRange::TYPE => {
211 Ok(Message::ReplyChannelRange(Readable::read(buffer)?))
213 msgs::GossipTimestampFilter::TYPE => {
214 Ok(Message::GossipTimestampFilter(Readable::read(buffer)?))
217 Ok(Message::Unknown(MessageType(message_type)))
222 /// Writes a message to the data buffer encoded as a 2-byte big-endian type and a variable-length
227 /// Returns an I/O error if the write could not be completed.
228 pub fn write<M: Encode + Writeable, W: Writer>(message: &M, buffer: &mut W) -> Result<(), ::std::io::Error> {
229 M::TYPE.write(buffer)?;
230 message.write(buffer)
233 /// Defines a type-identified encoding for sending messages over the wire.
235 /// Messages implementing this trait specify a type and must be [`Writeable`] to use with [`write()`].
237 /// The type identifying the message payload.
240 /// Returns the type identifying the message payload. Convenience method for accessing
242 fn type_id(&self) -> MessageType {
243 MessageType(Self::TYPE)
247 impl Encode for msgs::Init {
248 const TYPE: u16 = 16;
251 impl Encode for msgs::ErrorMessage {
252 const TYPE: u16 = 17;
255 impl Encode for msgs::Ping {
256 const TYPE: u16 = 18;
259 impl Encode for msgs::Pong {
260 const TYPE: u16 = 19;
263 impl Encode for msgs::OpenChannel {
264 const TYPE: u16 = 32;
267 impl Encode for msgs::AcceptChannel {
268 const TYPE: u16 = 33;
271 impl Encode for msgs::FundingCreated {
272 const TYPE: u16 = 34;
275 impl Encode for msgs::FundingSigned {
276 const TYPE: u16 = 35;
279 impl Encode for msgs::FundingLocked {
280 const TYPE: u16 = 36;
283 impl Encode for msgs::Shutdown {
284 const TYPE: u16 = 38;
287 impl Encode for msgs::ClosingSigned {
288 const TYPE: u16 = 39;
291 impl Encode for msgs::UpdateAddHTLC {
292 const TYPE: u16 = 128;
295 impl Encode for msgs::UpdateFulfillHTLC {
296 const TYPE: u16 = 130;
299 impl Encode for msgs::UpdateFailHTLC {
300 const TYPE: u16 = 131;
303 impl Encode for msgs::UpdateFailMalformedHTLC {
304 const TYPE: u16 = 135;
307 impl Encode for msgs::CommitmentSigned {
308 const TYPE: u16 = 132;
311 impl Encode for msgs::RevokeAndACK {
312 const TYPE: u16 = 133;
315 impl Encode for msgs::UpdateFee {
316 const TYPE: u16 = 134;
319 impl Encode for msgs::ChannelReestablish {
320 const TYPE: u16 = 136;
323 impl Encode for msgs::AnnouncementSignatures {
324 const TYPE: u16 = 259;
327 impl Encode for msgs::ChannelAnnouncement {
328 const TYPE: u16 = 256;
331 impl Encode for msgs::NodeAnnouncement {
332 const TYPE: u16 = 257;
335 impl Encode for msgs::ChannelUpdate {
336 const TYPE: u16 = 258;
339 impl Encode for msgs::QueryShortChannelIds {
340 const TYPE: u16 = 261;
343 impl Encode for msgs::ReplyShortChannelIdsEnd {
344 const TYPE: u16 = 262;
347 impl Encode for msgs::QueryChannelRange {
348 const TYPE: u16 = 263;
351 impl Encode for msgs::ReplyChannelRange {
352 const TYPE: u16 = 264;
355 impl Encode for msgs::GossipTimestampFilter {
356 const TYPE: u16 = 265;
363 use core::convert::TryInto;
365 // Big-endian wire encoding of Pong message (type = 19, byteslen = 2).
366 const ENCODED_PONG: [u8; 6] = [0u8, 19u8, 0u8, 2u8, 0u8, 0u8];
369 fn read_empty_buffer() {
371 let mut reader = ::std::io::Cursor::new(buffer);
372 assert!(read(&mut reader).is_err());
376 fn read_incomplete_type() {
377 let buffer = &ENCODED_PONG[..1];
378 let mut reader = ::std::io::Cursor::new(buffer);
379 assert!(read(&mut reader).is_err());
383 fn read_empty_payload() {
384 let buffer = &ENCODED_PONG[..2];
385 let mut reader = ::std::io::Cursor::new(buffer);
386 assert!(read(&mut reader).is_err());
390 fn read_invalid_message() {
391 let buffer = &ENCODED_PONG[..4];
392 let mut reader = ::std::io::Cursor::new(buffer);
393 assert!(read(&mut reader).is_err());
397 fn read_known_message() {
398 let buffer = &ENCODED_PONG[..];
399 let mut reader = ::std::io::Cursor::new(buffer);
400 let message = read(&mut reader).unwrap();
402 Message::Pong(_) => (),
403 _ => panic!("Expected pong message; found message type: {}", message.type_id()),
408 fn read_unknown_message() {
409 let buffer = &::core::u16::MAX.to_be_bytes();
410 let mut reader = ::std::io::Cursor::new(buffer);
411 let message = read(&mut reader).unwrap();
413 Message::Unknown(MessageType(::core::u16::MAX)) => (),
414 _ => panic!("Expected message type {}; found: {}", ::core::u16::MAX, message.type_id()),
419 fn write_message_with_type() {
420 let message = msgs::Pong { byteslen: 2u16 };
421 let mut buffer = Vec::new();
422 assert!(write(&message, &mut buffer).is_ok());
424 let type_length = ::core::mem::size_of::<u16>();
425 let (type_bytes, payload_bytes) = buffer.split_at(type_length);
426 assert_eq!(u16::from_be_bytes(type_bytes.try_into().unwrap()), msgs::Pong::TYPE);
427 assert_eq!(payload_bytes, &ENCODED_PONG[type_length..]);
431 fn read_message_encoded_with_write() {
432 let message = msgs::Pong { byteslen: 2u16 };
433 let mut buffer = Vec::new();
434 assert!(write(&message, &mut buffer).is_ok());
436 let mut reader = ::std::io::Cursor::new(buffer);
437 let decoded_message = read(&mut reader).unwrap();
438 match decoded_message {
439 Message::Pong(msgs::Pong { byteslen: 2u16 }) => (),
440 Message::Pong(msgs::Pong { byteslen }) => {
441 panic!("Expected byteslen {}; found: {}", message.byteslen, byteslen);
443 _ => panic!("Expected pong message; found message type: {}", decoded_message.type_id()),
448 fn is_even_message_type() {
449 let message = Message::Unknown(MessageType(42));
450 assert!(message.type_id().is_even());
454 fn is_odd_message_type() {
455 let message = Message::Unknown(MessageType(43));
456 assert!(!message.type_id().is_even());
460 fn read_lnd_init_msg() {
461 // Taken from lnd v0.9.0-beta.
462 let buffer = vec![0, 16, 0, 2, 34, 0, 0, 3, 2, 162, 161];
463 check_init_msg(buffer, false);
467 fn read_clightning_init_msg() {
468 // Taken from c-lightning v0.8.0.
469 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];
470 check_init_msg(buffer, true);
473 fn check_init_msg(buffer: Vec<u8>, expect_unknown: bool) {
474 let mut reader = ::std::io::Cursor::new(buffer);
475 let decoded_msg = read(&mut reader).unwrap();
477 Message::Init(msgs::Init { features }) => {
478 assert!(features.supports_variable_length_onion());
479 assert!(features.supports_upfront_shutdown_script());
480 assert!(features.supports_gossip_queries());
481 assert_eq!(expect_unknown, features.supports_unknown_bits());
482 assert!(!features.requires_unknown_bits());
483 assert!(!features.initial_routing_sync());
485 _ => panic!("Expected init message, found message type: {}", decoded_msg.type_id())
490 fn read_lnd_node_announcement() {
491 // Taken from lnd v0.9.0-beta.
492 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];
493 let mut reader = ::std::io::Cursor::new(buffer);
494 let decoded_msg = read(&mut reader).unwrap();
496 Message::NodeAnnouncement(msgs::NodeAnnouncement { contents: msgs::UnsignedNodeAnnouncement { features, ..}, ..}) => {
497 assert!(features.supports_variable_length_onion());
498 assert!(features.supports_upfront_shutdown_script());
499 assert!(features.supports_gossip_queries());
500 assert!(!features.requires_unknown_bits());
502 _ => panic!("Expected node announcement, found message type: {}", decoded_msg.type_id())
507 fn read_lnd_chan_announcement() {
508 // Taken from lnd v0.9.0-beta.
509 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];
510 let mut reader = ::std::io::Cursor::new(buffer);
511 let decoded_msg = read(&mut reader).unwrap();
513 Message::ChannelAnnouncement(msgs::ChannelAnnouncement { contents: msgs::UnsignedChannelAnnouncement { features, ..}, ..}) => {
514 assert!(!features.requires_unknown_bits());
516 _ => panic!("Expected node announcement, found message type: {}", decoded_msg.type_id())