X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fwire.rs;h=55e31399ae10074d2e72f1b04a4c1c71ed1808df;hb=d00e55077aa613457b6cc1957238a91a700873f8;hp=cbf5c77d60095d73abe235c7652eeccb8380cf04;hpb=994fa07793588f0b51e1e319766d935f9466f138;p=rust-lightning diff --git a/lightning/src/ln/wire.rs b/lightning/src/ln/wire.rs index cbf5c77d..55e31399 100644 --- a/lightning/src/ln/wire.rs +++ b/lightning/src/ln/wire.rs @@ -9,12 +9,12 @@ //! Wire encoding/decoding for Lightning messages according to [BOLT #1], and for //! custom message through the [`CustomMessageReader`] trait. -//! +//! //! [BOLT #1]: https://github.com/lightning/bolts/blob/master/01-messaging.md -use io; -use ln::msgs; -use util::ser::{Readable, Writeable, Writer}; +use crate::io; +use crate::ln::msgs; +use crate::util::ser::{Readable, Writeable, Writer}; /// Trait to be implemented by custom message (unrelated to the channel/gossip LN layers) /// decoders. @@ -42,7 +42,7 @@ pub(crate) trait TestEq {} impl TestEq for T {} -/// A Lightning message returned by [`read()`] when decoding bytes received over the wire. Each +/// A Lightning message returned by [`read`] when decoding bytes received over the wire. Each /// variant contains a message from [`msgs`] or otherwise the message type if unknown. #[allow(missing_docs)] #[derive(Debug)] @@ -54,12 +54,31 @@ pub(crate) enum Message where T: core::fmt::Debug + Type + TestEq { Ping(msgs::Ping), Pong(msgs::Pong), OpenChannel(msgs::OpenChannel), + OpenChannelV2(msgs::OpenChannelV2), AcceptChannel(msgs::AcceptChannel), + AcceptChannelV2(msgs::AcceptChannelV2), FundingCreated(msgs::FundingCreated), FundingSigned(msgs::FundingSigned), + Stfu(msgs::Stfu), + #[cfg(splicing)] + Splice(msgs::Splice), + #[cfg(splicing)] + SpliceAck(msgs::SpliceAck), + #[cfg(splicing)] + SpliceLocked(msgs::SpliceLocked), + TxAddInput(msgs::TxAddInput), + TxAddOutput(msgs::TxAddOutput), + TxRemoveInput(msgs::TxRemoveInput), + TxRemoveOutput(msgs::TxRemoveOutput), + TxComplete(msgs::TxComplete), + TxSignatures(msgs::TxSignatures), + TxInitRbf(msgs::TxInitRbf), + TxAckRbf(msgs::TxAckRbf), + TxAbort(msgs::TxAbort), ChannelReady(msgs::ChannelReady), Shutdown(msgs::Shutdown), ClosingSigned(msgs::ClosingSigned), + OnionMessage(msgs::OnionMessage), UpdateAddHTLC(msgs::UpdateAddHTLC), UpdateFulfillHTLC(msgs::UpdateFulfillHTLC), UpdateFailHTLC(msgs::UpdateFailHTLC), @@ -80,13 +99,70 @@ pub(crate) enum Message where T: core::fmt::Debug + Type + TestEq { /// A message that could not be decoded because its type is unknown. Unknown(u16), /// A message that was produced by a [`CustomMessageReader`] and is to be handled by a - /// [`::ln::peer_handler::CustomMessageHandler`]. + /// [`crate::ln::peer_handler::CustomMessageHandler`]. Custom(T), } -impl Message where T: core::fmt::Debug + Type + TestEq { +impl Writeable for Message where T: core::fmt::Debug + Type + TestEq { + fn write(&self, writer: &mut W) -> Result<(), io::Error> { + match self { + &Message::Init(ref msg) => msg.write(writer), + &Message::Error(ref msg) => msg.write(writer), + &Message::Warning(ref msg) => msg.write(writer), + &Message::Ping(ref msg) => msg.write(writer), + &Message::Pong(ref msg) => msg.write(writer), + &Message::OpenChannel(ref msg) => msg.write(writer), + &Message::OpenChannelV2(ref msg) => msg.write(writer), + &Message::AcceptChannel(ref msg) => msg.write(writer), + &Message::AcceptChannelV2(ref msg) => msg.write(writer), + &Message::FundingCreated(ref msg) => msg.write(writer), + &Message::FundingSigned(ref msg) => msg.write(writer), + &Message::Stfu(ref msg) => msg.write(writer), + #[cfg(splicing)] + &Message::Splice(ref msg) => msg.write(writer), + #[cfg(splicing)] + &Message::SpliceAck(ref msg) => msg.write(writer), + #[cfg(splicing)] + &Message::SpliceLocked(ref msg) => msg.write(writer), + &Message::TxAddInput(ref msg) => msg.write(writer), + &Message::TxAddOutput(ref msg) => msg.write(writer), + &Message::TxRemoveInput(ref msg) => msg.write(writer), + &Message::TxRemoveOutput(ref msg) => msg.write(writer), + &Message::TxComplete(ref msg) => msg.write(writer), + &Message::TxSignatures(ref msg) => msg.write(writer), + &Message::TxInitRbf(ref msg) => msg.write(writer), + &Message::TxAckRbf(ref msg) => msg.write(writer), + &Message::TxAbort(ref msg) => msg.write(writer), + &Message::ChannelReady(ref msg) => msg.write(writer), + &Message::Shutdown(ref msg) => msg.write(writer), + &Message::ClosingSigned(ref msg) => msg.write(writer), + &Message::OnionMessage(ref msg) => msg.write(writer), + &Message::UpdateAddHTLC(ref msg) => msg.write(writer), + &Message::UpdateFulfillHTLC(ref msg) => msg.write(writer), + &Message::UpdateFailHTLC(ref msg) => msg.write(writer), + &Message::UpdateFailMalformedHTLC(ref msg) => msg.write(writer), + &Message::CommitmentSigned(ref msg) => msg.write(writer), + &Message::RevokeAndACK(ref msg) => msg.write(writer), + &Message::UpdateFee(ref msg) => msg.write(writer), + &Message::ChannelReestablish(ref msg) => msg.write(writer), + &Message::AnnouncementSignatures(ref msg) => msg.write(writer), + &Message::ChannelAnnouncement(ref msg) => msg.write(writer), + &Message::NodeAnnouncement(ref msg) => msg.write(writer), + &Message::ChannelUpdate(ref msg) => msg.write(writer), + &Message::QueryShortChannelIds(ref msg) => msg.write(writer), + &Message::ReplyShortChannelIdsEnd(ref msg) => msg.write(writer), + &Message::QueryChannelRange(ref msg) => msg.write(writer), + &Message::ReplyChannelRange(ref msg) => msg.write(writer), + &Message::GossipTimestampFilter(ref msg) => msg.write(writer), + &Message::Unknown(_) => { Ok(()) }, + &Message::Custom(ref msg) => msg.write(writer), + } + } +} + +impl Type for Message where T: core::fmt::Debug + Type + TestEq { /// Returns the type that was used to decode the message payload. - pub fn type_id(&self) -> u16 { + fn type_id(&self) -> u16 { match self { &Message::Init(ref msg) => msg.type_id(), &Message::Error(ref msg) => msg.type_id(), @@ -94,12 +170,31 @@ impl Message where T: core::fmt::Debug + Type + TestEq { &Message::Ping(ref msg) => msg.type_id(), &Message::Pong(ref msg) => msg.type_id(), &Message::OpenChannel(ref msg) => msg.type_id(), + &Message::OpenChannelV2(ref msg) => msg.type_id(), &Message::AcceptChannel(ref msg) => msg.type_id(), + &Message::AcceptChannelV2(ref msg) => msg.type_id(), &Message::FundingCreated(ref msg) => msg.type_id(), &Message::FundingSigned(ref msg) => msg.type_id(), + &Message::Stfu(ref msg) => msg.type_id(), + #[cfg(splicing)] + &Message::Splice(ref msg) => msg.type_id(), + #[cfg(splicing)] + &Message::SpliceAck(ref msg) => msg.type_id(), + #[cfg(splicing)] + &Message::SpliceLocked(ref msg) => msg.type_id(), + &Message::TxAddInput(ref msg) => msg.type_id(), + &Message::TxAddOutput(ref msg) => msg.type_id(), + &Message::TxRemoveInput(ref msg) => msg.type_id(), + &Message::TxRemoveOutput(ref msg) => msg.type_id(), + &Message::TxComplete(ref msg) => msg.type_id(), + &Message::TxSignatures(ref msg) => msg.type_id(), + &Message::TxInitRbf(ref msg) => msg.type_id(), + &Message::TxAckRbf(ref msg) => msg.type_id(), + &Message::TxAbort(ref msg) => msg.type_id(), &Message::ChannelReady(ref msg) => msg.type_id(), &Message::Shutdown(ref msg) => msg.type_id(), &Message::ClosingSigned(ref msg) => msg.type_id(), + &Message::OnionMessage(ref msg) => msg.type_id(), &Message::UpdateAddHTLC(ref msg) => msg.type_id(), &Message::UpdateFulfillHTLC(ref msg) => msg.type_id(), &Message::UpdateFailHTLC(ref msg) => msg.type_id(), @@ -121,7 +216,9 @@ impl Message where T: core::fmt::Debug + Type + TestEq { &Message::Custom(ref msg) => msg.type_id(), } } +} +impl Message where T: core::fmt::Debug + Type + TestEq { /// Returns whether the message's type is even, indicating both endpoints must support it. pub fn is_even(&self) -> bool { (self.type_id() & 1) == 0 @@ -133,7 +230,7 @@ impl Message where T: core::fmt::Debug + Type + TestEq { /// /// # Errors /// -/// Returns an error if the message payload code not be decoded as the specified type. +/// Returns an error if the message payload could not be decoded as the specified type. pub(crate) fn read(buffer: &mut R, custom_reader: H) -> Result, (msgs::DecodeError, Option)> where T: core::fmt::Debug + Type + Writeable, @@ -167,15 +264,63 @@ fn do_read(buffer: &mut R, message_type: u1 msgs::OpenChannel::TYPE => { Ok(Message::OpenChannel(Readable::read(buffer)?)) }, + msgs::OpenChannelV2::TYPE => { + Ok(Message::OpenChannelV2(Readable::read(buffer)?)) + }, msgs::AcceptChannel::TYPE => { Ok(Message::AcceptChannel(Readable::read(buffer)?)) }, + msgs::AcceptChannelV2::TYPE => { + Ok(Message::AcceptChannelV2(Readable::read(buffer)?)) + }, msgs::FundingCreated::TYPE => { Ok(Message::FundingCreated(Readable::read(buffer)?)) }, msgs::FundingSigned::TYPE => { Ok(Message::FundingSigned(Readable::read(buffer)?)) }, + #[cfg(splicing)] + msgs::Splice::TYPE => { + Ok(Message::Splice(Readable::read(buffer)?)) + }, + msgs::Stfu::TYPE => { + Ok(Message::Stfu(Readable::read(buffer)?)) + }, + #[cfg(splicing)] + msgs::SpliceAck::TYPE => { + Ok(Message::SpliceAck(Readable::read(buffer)?)) + }, + #[cfg(splicing)] + msgs::SpliceLocked::TYPE => { + Ok(Message::SpliceLocked(Readable::read(buffer)?)) + }, + msgs::TxAddInput::TYPE => { + Ok(Message::TxAddInput(Readable::read(buffer)?)) + }, + msgs::TxAddOutput::TYPE => { + Ok(Message::TxAddOutput(Readable::read(buffer)?)) + }, + msgs::TxRemoveInput::TYPE => { + Ok(Message::TxRemoveInput(Readable::read(buffer)?)) + }, + msgs::TxRemoveOutput::TYPE => { + Ok(Message::TxRemoveOutput(Readable::read(buffer)?)) + }, + msgs::TxComplete::TYPE => { + Ok(Message::TxComplete(Readable::read(buffer)?)) + }, + msgs::TxSignatures::TYPE => { + Ok(Message::TxSignatures(Readable::read(buffer)?)) + }, + msgs::TxInitRbf::TYPE => { + Ok(Message::TxInitRbf(Readable::read(buffer)?)) + }, + msgs::TxAckRbf::TYPE => { + Ok(Message::TxAckRbf(Readable::read(buffer)?)) + }, + msgs::TxAbort::TYPE => { + Ok(Message::TxAbort(Readable::read(buffer)?)) + }, msgs::ChannelReady::TYPE => { Ok(Message::ChannelReady(Readable::read(buffer)?)) }, @@ -185,6 +330,9 @@ fn do_read(buffer: &mut R, message_type: u1 msgs::ClosingSigned::TYPE => { Ok(Message::ClosingSigned(Readable::read(buffer)?)) }, + msgs::OnionMessage::TYPE => { + Ok(Message::OnionMessage(Readable::read(buffer)?)) + }, msgs::UpdateAddHTLC::TYPE => { Ok(Message::UpdateAddHTLC(Readable::read(buffer)?)) }, @@ -296,6 +444,10 @@ impl Type for T where T: Encode { fn type_id(&self) -> u16 { T::TYPE } } +impl Encode for msgs::Stfu { + const TYPE: u16 = 2; +} + impl Encode for msgs::Init { const TYPE: u16 = 16; } @@ -344,6 +496,67 @@ impl Encode for msgs::ClosingSigned { const TYPE: u16 = 39; } +impl Encode for msgs::OpenChannelV2 { + const TYPE: u16 = 64; +} + +impl Encode for msgs::AcceptChannelV2 { + const TYPE: u16 = 65; +} + +impl Encode for msgs::Splice { + // 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 + const TYPE: u16 = 75; +} + +impl Encode for msgs::SpliceAck { + const TYPE: u16 = 76; +} + +impl Encode for msgs::SpliceLocked { + const TYPE: u16 = 77; +} + +impl Encode for msgs::TxAddInput { + const TYPE: u16 = 66; +} + +impl Encode for msgs::TxAddOutput { + const TYPE: u16 = 67; +} + +impl Encode for msgs::TxRemoveInput { + const TYPE: u16 = 68; +} + +impl Encode for msgs::TxRemoveOutput { + const TYPE: u16 = 69; +} + +impl Encode for msgs::TxComplete { + const TYPE: u16 = 70; +} + +impl Encode for msgs::TxSignatures { + const TYPE: u16 = 71; +} + +impl Encode for msgs::TxInitRbf { + const TYPE: u16 = 72; +} + +impl Encode for msgs::TxAckRbf { + const TYPE: u16 = 73; +} + +impl Encode for msgs::TxAbort { + const TYPE: u16 = 74; +} + +impl Encode for msgs::OnionMessage { + const TYPE: u16 = 513; +} + impl Encode for msgs::UpdateAddHTLC { const TYPE: u16 = 128; } @@ -415,9 +628,8 @@ impl Encode for msgs::GossipTimestampFilter { #[cfg(test)] mod tests { use super::*; - use prelude::*; - use core::convert::TryInto; - use ::ln::peer_handler::IgnoringMessageHandler; + use crate::prelude::*; + use crate::ln::peer_handler::IgnoringMessageHandler; // Big-endian wire encoding of Pong message (type = 19, byteslen = 2). const ENCODED_PONG: [u8; 6] = [0u8, 19u8, 0u8, 2u8, 0u8, 0u8];