X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fln%2Fmsgs.rs;h=7513aa79711da888796c5090bc35fe435773b45e;hb=6e1318b0e28522244493c280f556e6749694b81e;hp=5dd3165bfc0977728f8c80b03ba9cfeff3ecdb9f;hpb=66fbc66da0c064e4ee271ad5a8e0a37410c80078;p=rust-lightning

diff --git a/src/ln/msgs.rs b/src/ln/msgs.rs
index 5dd3165b..7513aa79 100644
--- a/src/ln/msgs.rs
+++ b/src/ln/msgs.rs
@@ -1,9 +1,11 @@
 //! Wire messages, traits representing wire message handlers, and a few error types live here.
+//!
 //! For a normal node you probably don't need to use anything here, however, if you wish to split a
 //! node into an internet-facing route/message socket handling daemon and a separate daemon (or
 //! server entirely) which handles only channel-related messages you may wish to implement
 //! ChannelMessageHandler yourself and use it to re-serialize messages and pass them across
 //! daemons/servers.
+//!
 //! Note that if you go with such an architecture (instead of passing raw socket events to a
 //! non-internet-facing system) you trust the frontend internet-facing system to not lie about the
 //! source node_id of the mssage, however this does allow you to significantly reduce bandwidth
@@ -30,16 +32,14 @@ use util::ser::{Readable, Writeable, Writer};
 /// An error in decoding a message or struct.
 #[derive(Debug)]
 pub enum DecodeError {
-	/// Unknown realm byte in an OnionHopData packet
-	UnknownRealmByte,
+	/// A version byte specified something we don't know how to handle.
+	/// Includes unknown realm byte in an OnionHopData packet
+	UnknownVersion,
 	/// Unknown feature mandating we fail to parse message
 	UnknownRequiredFeature,
-	/// Failed to decode a public key (ie it's invalid)
-	BadPublicKey,
-	/// Failed to decode a signature (ie it's invalid)
-	BadSignature,
-	/// Value expected to be text wasn't decodable as text
-	BadText,
+	/// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0
+	/// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, etc
+	InvalidValue,
 	/// Buffer too short
 	ShortRead,
 	/// node_announcement included more than one address of a given type!
@@ -49,8 +49,6 @@ pub enum DecodeError {
 	BadLengthDescriptor,
 	/// Error from std::io
 	Io(::std::io::Error),
-	/// 1 or 0 is not found for boolean value
-	InvalidValue,
 }
 
 /// Tracks localfeatures which are only in init messages
@@ -488,9 +486,10 @@ pub enum HTLCFailChannelUpdate {
 	},
 }
 
-/// A trait to describe an object which can receive channel messages. Messages MAY be called in
-/// parallel when they originate from different their_node_ids, however they MUST NOT be called in
-/// parallel when the two calls have the same their_node_id.
+/// A trait to describe an object which can receive channel messages.
+///
+/// Messages MAY be called in parallel when they originate from different their_node_ids, however
+/// they MUST NOT be called in parallel when the two calls have the same their_node_id.
 pub trait ChannelMessageHandler : events::EventsProvider + Send + Sync {
 	//Channel init:
 	/// Handle an incoming open_channel message from the given peer.
@@ -614,16 +613,13 @@ pub(crate) struct OnionErrorPacket {
 impl Error for DecodeError {
 	fn description(&self) -> &str {
 		match *self {
-			DecodeError::UnknownRealmByte => "Unknown realm byte in Onion packet",
+			DecodeError::UnknownVersion => "Unknown realm byte in Onion packet",
 			DecodeError::UnknownRequiredFeature => "Unknown required feature preventing decode",
-			DecodeError::BadPublicKey => "Invalid public key in packet",
-			DecodeError::BadSignature => "Invalid signature in packet",
-			DecodeError::BadText => "Invalid text in packet",
+			DecodeError::InvalidValue => "Nonsense bytes didn't map to the type they were interpreted as",
 			DecodeError::ShortRead => "Packet extended beyond the provided bytes",
 			DecodeError::ExtraAddressesPerType => "More than one address of a single type",
 			DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly",
 			DecodeError::Io(ref e) => e.description(),
-			DecodeError::InvalidValue => "0 or 1 is not found for boolean",
 		}
 	}
 }
@@ -919,7 +915,7 @@ impl<R: Read> Readable<R> for OnionHopData {
 			realm: {
 				let r: u8 = Readable::read(r)?;
 				if r != 0 {
-					return Err(DecodeError::UnknownRealmByte);
+					return Err(DecodeError::UnknownVersion);
 				}
 				r
 			},
@@ -1087,7 +1083,7 @@ impl<R: Read> Readable<R> for ErrorMessage {
 				sz = cmp::min(data_len, sz);
 				match String::from_utf8(data[..sz as usize].to_vec()) {
 					Ok(s) => s,
-					Err(_) => return Err(DecodeError::BadText),
+					Err(_) => return Err(DecodeError::InvalidValue),
 				}
 			}
 		})