X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fmsgs.rs;h=0042cf51bf3c2c570c5f1f007567b317230fc54a;hb=0dfcacd22c23f69b6526c9c6507d21427a2b7ccb;hp=f02a478357b8c32598ad5c4096abe905482d5c8e;hpb=3996eaab6e2eaf5fde9374b51d952c0edef5ea92;p=rust-lightning

diff --git a/lightning/src/ln/msgs.rs b/lightning/src/ln/msgs.rs
index f02a4783..0042cf51 100644
--- a/lightning/src/ln/msgs.rs
+++ b/lightning/src/ln/msgs.rs
@@ -35,9 +35,11 @@ use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
 use prelude::*;
 use core::{cmp, fmt};
 use core::fmt::Debug;
-use std::io::Read;
+use io::{self, Read};
+use io_extras::read_to_end;
 
 use util::events::MessageSendEventsProvider;
+use util::logger;
 use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt};
 
 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
@@ -63,7 +65,7 @@ pub enum DecodeError {
 	BadLengthDescriptor,
 	/// Error from std::io
 	Io(/// (C-not exported) as ErrorKind doesn't have a reasonable mapping
-        ::std::io::ErrorKind),
+        io::ErrorKind),
 	/// The message included zlib-compressed values, which we don't support.
 	UnsupportedCompression,
 }
@@ -419,7 +421,7 @@ impl NetAddress {
 }
 
 impl Writeable for NetAddress {
-	fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 		match self {
 			&NetAddress::IPv4 { ref addr, ref port } => {
 				1u8.write(writer)?;
@@ -688,7 +690,11 @@ pub enum ErrorAction {
 		msg: Option<ErrorMessage>
 	},
 	/// The peer did something harmless that we weren't able to process, just log and ignore
+	// New code should *not* use this. New code must use IgnoreAndLog, below!
 	IgnoreError,
+	/// The peer did something harmless that we weren't able to meaningfully process.
+	/// If the error is logged, log it at the given level.
+	IgnoreAndLog(logger::Level),
 	/// The peer did something incorrect. Tell them.
 	SendErrorMessage {
 		/// The message to send.
@@ -880,7 +886,7 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider {
 
 mod fuzzy_internal_msgs {
 	use prelude::*;
-	use ln::PaymentSecret;
+	use ln::{PaymentPreimage, PaymentSecret};
 
 	// These types aren't intended to be pub, but are exposed for direct fuzzing (as we deserialize
 	// them from untrusted input):
@@ -901,6 +907,7 @@ mod fuzzy_internal_msgs {
 		},
 		FinalNode {
 			payment_data: Option<FinalOnionHopData>,
+			keysend_preimage: Option<PaymentPreimage>,
 		},
 	}
 
@@ -973,9 +980,9 @@ impl fmt::Display for DecodeError {
 	}
 }
 
-impl From<::std::io::Error> for DecodeError {
-	fn from(e: ::std::io::Error) -> Self {
-		if e.kind() == ::std::io::ErrorKind::UnexpectedEof {
+impl From<io::Error> for DecodeError {
+	fn from(e: io::Error) -> Self {
+		if e.kind() == io::ErrorKind::UnexpectedEof {
 			DecodeError::ShortRead
 		} else {
 			DecodeError::Io(e.kind())
@@ -984,7 +991,7 @@ impl From<::std::io::Error> for DecodeError {
 }
 
 impl Writeable for OptionalField<Script> {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		match *self {
 			OptionalField::Present(ref script) => {
 				// Note that Writeable for script includes the 16-bit length tag for us
@@ -1011,7 +1018,7 @@ impl Readable for OptionalField<Script> {
 }
 
 impl Writeable for OptionalField<u64> {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		match *self {
 			OptionalField::Present(ref value) => {
 				value.write(w)?;
@@ -1059,7 +1066,7 @@ impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
 });
 
 impl Writeable for ChannelReestablish {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(if let OptionalField::Present(..) = self.data_loss_protect { 32+2*8+33+32 } else { 32+2*8 });
 		self.channel_id.write(w)?;
 		self.next_local_commitment_number.write(w)?;
@@ -1136,7 +1143,7 @@ impl_writeable!(FundingLocked, 32+33, {
 });
 
 impl Writeable for Init {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		// global_features gets the bottom 13 bits of our features, and local_features gets all of
 		// our relevant feature bits. This keeps us compatible with old nodes.
 		self.features.write_up_to_13(w)?;
@@ -1225,7 +1232,7 @@ impl_writeable_len_match!(OnionErrorPacket, {
 });
 
 impl Writeable for OnionPacket {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(1 + 33 + 20*65 + 32);
 		self.version.write(w)?;
 		match self.public_key {
@@ -1263,7 +1270,7 @@ impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
 });
 
 impl Writeable for FinalOnionHopData {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(32 + 8 - (self.total_msat.leading_zeros()/8) as usize);
 		self.payment_secret.0.write(w)?;
 		HighZeroBytesDroppedVarInt(self.total_msat).write(w)
@@ -1279,7 +1286,7 @@ impl Readable for FinalOnionHopData {
 }
 
 impl Writeable for OnionHopData {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(33);
 		// Note that this should never be reachable if Rust-Lightning generated the message, as we
 		// check values are sane long before we get here, though its possible in the future
@@ -1295,20 +1302,20 @@ impl Writeable for OnionHopData {
 			},
 			OnionHopDataFormat::NonFinalNode { short_channel_id } => {
 				encode_varint_length_prefixed_tlv!(w, {
-					(2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
-					(4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value)),
-					(6, short_channel_id)
-				}, { });
+					(2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
+					(4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
+					(6, short_channel_id, required)
+				});
 			},
-			OnionHopDataFormat::FinalNode { ref payment_data } => {
+			OnionHopDataFormat::FinalNode { ref payment_data, ref keysend_preimage } => {
 				if let Some(final_data) = payment_data {
 					if final_data.total_msat > MAX_VALUE_MSAT { panic!("We should never be sending infinite/overflow onion payments"); }
 				}
 				encode_varint_length_prefixed_tlv!(w, {
-					(2, HighZeroBytesDroppedVarInt(self.amt_to_forward)),
-					(4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value))
-				}, {
-					(8, payment_data)
+					(2, HighZeroBytesDroppedVarInt(self.amt_to_forward), required),
+					(4, HighZeroBytesDroppedVarInt(self.outgoing_cltv_value), required),
+					(8, payment_data, option),
+					(5482373484, keysend_preimage, option)
 				});
 			},
 		}
@@ -1331,12 +1338,14 @@ impl Readable for OnionHopData {
 			let mut cltv_value = HighZeroBytesDroppedVarInt(0u32);
 			let mut short_id: Option<u64> = None;
 			let mut payment_data: Option<FinalOnionHopData> = None;
-			decode_tlv!(&mut rd, {
-				(2, amt),
-				(4, cltv_value)
-			}, {
-				(6, short_id),
-				(8, payment_data)
+			let mut keysend_preimage: Option<PaymentPreimage> = None;
+			// The TLV type is chosen to be compatible with lnd and c-lightning.
+			decode_tlv_stream!(&mut rd, {
+				(2, amt, required),
+				(4, cltv_value, required),
+				(6, short_id, option),
+				(8, payment_data, option),
+				(5482373484, keysend_preimage, option)
 			});
 			rd.eat_remaining().map_err(|_| DecodeError::ShortRead)?;
 			let format = if let Some(short_channel_id) = short_id {
@@ -1351,7 +1360,8 @@ impl Readable for OnionHopData {
 					}
 				}
 				OnionHopDataFormat::FinalNode {
-					payment_data
+					payment_data,
+					keysend_preimage,
 				}
 			};
 			(format, amt.0, cltv_value.0)
@@ -1377,7 +1387,7 @@ impl Readable for OnionHopData {
 }
 
 impl Writeable for Ping {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(self.byteslen as usize + 4);
 		self.ponglen.write(w)?;
 		vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
@@ -1399,7 +1409,7 @@ impl Readable for Ping {
 }
 
 impl Writeable for Pong {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(self.byteslen as usize + 2);
 		vec![0u8; self.byteslen as usize].write(w)?; // size-unchecked write
 		Ok(())
@@ -1419,7 +1429,7 @@ impl Readable for Pong {
 }
 
 impl Writeable for UnsignedChannelAnnouncement {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(2 + 32 + 8 + 4*33 + self.features.byte_count() + self.excess_data.len());
 		self.features.write(w)?;
 		self.chain_hash.write(w)?;
@@ -1443,11 +1453,7 @@ impl Readable for UnsignedChannelAnnouncement {
 			node_id_2: Readable::read(r)?,
 			bitcoin_key_1: Readable::read(r)?,
 			bitcoin_key_2: Readable::read(r)?,
-			excess_data: {
-				let mut excess_data = vec![];
-				r.read_to_end(&mut excess_data)?;
-				excess_data
-			},
+			excess_data: read_to_end(r)?,
 		})
 	}
 }
@@ -1464,7 +1470,7 @@ impl_writeable_len_match!(ChannelAnnouncement, {
 });
 
 impl Writeable for UnsignedChannelUpdate {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		let mut size = 64 + self.excess_data.len();
 		let mut message_flags: u8 = 0;
 		if let OptionalField::Present(_) = self.htlc_maximum_msat {
@@ -1505,11 +1511,7 @@ impl Readable for UnsignedChannelUpdate {
 			fee_base_msat: Readable::read(r)?,
 			fee_proportional_millionths: Readable::read(r)?,
 			htlc_maximum_msat: if has_htlc_maximum_msat { Readable::read(r)? } else { OptionalField::Absent },
-			excess_data: {
-				let mut excess_data = vec![];
-				r.read_to_end(&mut excess_data)?;
-				excess_data
-			},
+			excess_data: read_to_end(r)?,
 		})
 	}
 }
@@ -1523,7 +1525,7 @@ impl_writeable_len_match!(ChannelUpdate, {
 });
 
 impl Writeable for ErrorMessage {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(32 + 2 + self.data.len());
 		self.channel_id.write(w)?;
 		(self.data.len() as u16).write(w)?;
@@ -1538,9 +1540,8 @@ impl Readable for ErrorMessage {
 			channel_id: Readable::read(r)?,
 			data: {
 				let mut sz: usize = <u16 as Readable>::read(r)? as usize;
-				let mut data = vec![];
-				let data_len = r.read_to_end(&mut data)?;
-				sz = cmp::min(data_len, sz);
+				let data = read_to_end(r)?;
+				sz = cmp::min(data.len(), sz);
 				match String::from_utf8(data[..sz as usize].to_vec()) {
 					Ok(s) => s,
 					Err(_) => return Err(DecodeError::InvalidValue),
@@ -1551,7 +1552,7 @@ impl Readable for ErrorMessage {
 }
 
 impl Writeable for UnsignedNodeAnnouncement {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(76 + self.features.byte_count() + self.addresses.len()*38 + self.excess_address_data.len() + self.excess_data.len());
 		self.features.write(w)?;
 		self.timestamp.write(w)?;
@@ -1621,7 +1622,7 @@ impl Readable for UnsignedNodeAnnouncement {
 			}
 			Vec::new()
 		};
-		r.read_to_end(&mut excess_data)?;
+		excess_data.extend(read_to_end(r)?.iter());
 		Ok(UnsignedNodeAnnouncement {
 			features,
 			timestamp,
@@ -1678,7 +1679,7 @@ impl Readable for QueryShortChannelIds {
 }
 
 impl Writeable for QueryShortChannelIds {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		// Calculated from 1-byte encoding_type plus 8-bytes per short_channel_id
 		let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
 
@@ -1709,7 +1710,7 @@ impl Readable for ReplyShortChannelIdsEnd {
 }
 
 impl Writeable for ReplyShortChannelIdsEnd {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(32 + 1);
 		self.chain_hash.write(w)?;
 		self.full_information.write(w)?;
@@ -1744,7 +1745,7 @@ impl Readable for QueryChannelRange {
 }
 
 impl Writeable for QueryChannelRange {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(32 + 4 + 4);
 		self.chain_hash.write(w)?;
 		self.first_blocknum.write(w)?;
@@ -1794,7 +1795,7 @@ impl Readable for ReplyChannelRange {
 }
 
 impl Writeable for ReplyChannelRange {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		let encoding_len: u16 = 1 + self.short_channel_ids.len() as u16 * 8;
 		w.size_hint(32 + 4 + 4 + 1 + 2 + encoding_len as usize);
 		self.chain_hash.write(w)?;
@@ -1826,7 +1827,7 @@ impl Readable for GossipTimestampFilter {
 }
 
 impl Writeable for GossipTimestampFilter {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
 		w.size_hint(32 + 4 + 4);
 		self.chain_hash.write(w)?;
 		self.first_timestamp.write(w)?;
@@ -1854,8 +1855,8 @@ mod tests {
 	use bitcoin::secp256k1::key::{PublicKey,SecretKey};
 	use bitcoin::secp256k1::{Secp256k1, Message};
 
+	use io::Cursor;
 	use prelude::*;
-	use std::io::Cursor;
 
 	#[test]
 	fn encoding_channel_reestablish_no_secret() {
@@ -2531,6 +2532,7 @@ mod tests {
 		let mut msg = msgs::OnionHopData {
 			format: OnionHopDataFormat::FinalNode {
 				payment_data: None,
+				keysend_preimage: None,
 			},
 			amt_to_forward: 0x0badf00d01020304,
 			outgoing_cltv_value: 0xffffffff,
@@ -2539,7 +2541,7 @@ mod tests {
 		let target_value = hex::decode("1002080badf00d010203040404ffffffff").unwrap();
 		assert_eq!(encoded_value, target_value);
 		msg = Readable::read(&mut Cursor::new(&target_value[..])).unwrap();
-		if let OnionHopDataFormat::FinalNode { payment_data: None } = msg.format { } else { panic!(); }
+		if let OnionHopDataFormat::FinalNode { payment_data: None, .. } = msg.format { } else { panic!(); }
 		assert_eq!(msg.amt_to_forward, 0x0badf00d01020304);
 		assert_eq!(msg.outgoing_cltv_value, 0xffffffff);
 	}
@@ -2553,6 +2555,7 @@ mod tests {
 					payment_secret: expected_payment_secret,
 					total_msat: 0x1badca1f
 				}),
+				keysend_preimage: None,
 			},
 			amt_to_forward: 0x0badf00d01020304,
 			outgoing_cltv_value: 0xffffffff,
@@ -2565,7 +2568,8 @@ mod tests {
 			payment_data: Some(FinalOnionHopData {
 				payment_secret,
 				total_msat: 0x1badca1f
-			})
+			}),
+			keysend_preimage: None,
 		} = msg.format {
 			assert_eq!(payment_secret, expected_payment_secret);
 		} else { panic!(); }