X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fmsgs.rs;h=87944ccae639027da172e120ea83ea8b4d06411a;hb=77948dbcd7b167ff4386f1b9de13bd2d2aa97032;hp=5b49f43b1188013c5f44822e59622409590aefb3;hpb=731773cad252ba1720dd3f47335406b6bc06c198;p=rust-lightning

diff --git a/lightning/src/ln/msgs.rs b/lightning/src/ln/msgs.rs
index 5b49f43b..87944cca 100644
--- a/lightning/src/ln/msgs.rs
+++ b/lightning/src/ln/msgs.rs
@@ -30,7 +30,7 @@ use bitcoin::secp256k1;
 use bitcoin::blockdata::script::Script;
 use bitcoin::hash_types::{Txid, BlockHash};
 
-use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
+use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
 
 use prelude::*;
 use core::{cmp, fmt};
@@ -148,6 +148,10 @@ pub struct OpenChannel {
 	pub channel_flags: u8,
 	/// Optionally, a request to pre-set the to-sender output's scriptPubkey for when we collaboratively close
 	pub shutdown_scriptpubkey: OptionalField<Script>,
+	/// The channel type that this channel will represent. If none is set, we derive the channel
+	/// type from the intersection of our feature bits with our counterparty's feature bits from
+	/// the Init message.
+	pub channel_type: Option<ChannelTypeFeatures>,
 }
 
 /// An accept_channel message to be sent or received from a peer
@@ -745,35 +749,6 @@ pub struct CommitmentUpdate {
 	pub commitment_signed: CommitmentSigned,
 }
 
-/// The information we received from a peer along the route of a payment we originated. This is
-/// returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
-/// RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
-#[derive(Clone, Debug, PartialEq)]
-pub enum HTLCFailChannelUpdate {
-	/// We received an error which included a full ChannelUpdate message.
-	ChannelUpdateMessage {
-		/// The unwrapped message we received
-		msg: ChannelUpdate,
-	},
-	/// We received an error which indicated only that a channel has been closed
-	ChannelClosed {
-		/// The short_channel_id which has now closed.
-		short_channel_id: u64,
-		/// when this true, this channel should be permanently removed from the
-		/// consideration. Otherwise, this channel can be restored as new channel_update is received
-		is_permanent: bool,
-	},
-	/// We received an error which indicated only that a node has failed
-	NodeFailure {
-		/// The node_id that has failed.
-		node_id: PublicKey,
-		/// when this true, node should be permanently removed from the
-		/// consideration. Otherwise, the channels connected to this node can be
-		/// restored as new channel_update is received
-		is_permanent: bool,
-	}
-}
-
 /// Messages could have optional fields to use with extended features
 /// As we wish to serialize these differently from Option<T>s (Options get a tag byte, but
 /// OptionalFeild simply gets Present if there are enough bytes to read into it), we have a
@@ -868,8 +843,6 @@ pub trait RoutingMessageHandler : MessageSendEventsProvider {
 	/// Handle an incoming channel_update message, returning true if it should be forwarded on,
 	/// false or returning an Err otherwise.
 	fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<bool, LightningError>;
-	/// Handle some updates to the route graph that we learned due to an outbound failed payment.
-	fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
 	/// Gets a subset of the channel announcements and updates required to dump our routing table
 	/// to a remote node, starting at the short_channel_id indicated by starting_point and
 	/// including the batch_amount entries immediately higher in numerical value than starting_point.
@@ -1053,10 +1026,7 @@ impl Readable for OptionalField<u64> {
 }
 
 
-impl_writeable_len_match!(AcceptChannel, {
-		{AcceptChannel{ shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 270 + 2 + script.len()},
-		{_, 270}
-	}, {
+impl_writeable_msg!(AcceptChannel, {
 	temporary_channel_id,
 	dust_limit_satoshis,
 	max_htlc_value_in_flight_msat,
@@ -1072,18 +1042,17 @@ impl_writeable_len_match!(AcceptChannel, {
 	htlc_basepoint,
 	first_per_commitment_point,
 	shutdown_scriptpubkey
-});
+}, {});
 
-impl_writeable!(AnnouncementSignatures, 32+8+64*2, {
+impl_writeable_msg!(AnnouncementSignatures, {
 	channel_id,
 	short_channel_id,
 	node_signature,
 	bitcoin_signature
-});
+}, {});
 
 impl Writeable for ChannelReestablish {
 	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)?;
 		self.next_remote_commitment_number.write(w)?;
@@ -1119,69 +1088,44 @@ impl Readable for ChannelReestablish{
 	}
 }
 
-impl Writeable for ClosingSigned {
-	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
-		w.size_hint(32 + 8 + 64 + if self.fee_range.is_some() { 1+1+ 2*8 } else { 0 });
-		self.channel_id.write(w)?;
-		self.fee_satoshis.write(w)?;
-		self.signature.write(w)?;
-		encode_tlv_stream!(w, {
-			(1, self.fee_range, option),
-		});
-		Ok(())
-	}
-}
+impl_writeable_msg!(ClosingSigned,
+	{ channel_id, fee_satoshis, signature },
+	{ (1, fee_range, option) }
+);
 
-impl Readable for ClosingSigned {
-	fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
-		let channel_id = Readable::read(r)?;
-		let fee_satoshis = Readable::read(r)?;
-		let signature = Readable::read(r)?;
-		let mut fee_range = None;
-		decode_tlv_stream!(r, {
-			(1, fee_range, option),
-		});
-		Ok(Self { channel_id, fee_satoshis, signature, fee_range })
-	}
-}
-
-impl_writeable!(ClosingSignedFeeRange, 2*8, {
+impl_writeable!(ClosingSignedFeeRange, {
 	min_fee_satoshis,
 	max_fee_satoshis
 });
 
-impl_writeable_len_match!(CommitmentSigned, {
-		{ CommitmentSigned { ref htlc_signatures, .. }, 32+64+2+htlc_signatures.len()*64 }
-	}, {
+impl_writeable_msg!(CommitmentSigned, {
 	channel_id,
 	signature,
 	htlc_signatures
-});
+}, {});
 
-impl_writeable_len_match!(DecodedOnionErrorPacket, {
-		{ DecodedOnionErrorPacket { ref failuremsg, ref pad, .. }, 32 + 4 + failuremsg.len() + pad.len() }
-	}, {
+impl_writeable!(DecodedOnionErrorPacket, {
 	hmac,
 	failuremsg,
 	pad
 });
 
-impl_writeable!(FundingCreated, 32+32+2+64, {
+impl_writeable_msg!(FundingCreated, {
 	temporary_channel_id,
 	funding_txid,
 	funding_output_index,
 	signature
-});
+}, {});
 
-impl_writeable!(FundingSigned, 32+64, {
+impl_writeable_msg!(FundingSigned, {
 	channel_id,
 	signature
-});
+}, {});
 
-impl_writeable!(FundingLocked, 32+33, {
+impl_writeable_msg!(FundingLocked, {
 	channel_id,
-	next_per_commitment_point
-});
+	next_per_commitment_point,
+}, {});
 
 impl Writeable for Init {
 	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
@@ -1202,10 +1146,7 @@ impl Readable for Init {
 	}
 }
 
-impl_writeable_len_match!(OpenChannel, {
-		{ OpenChannel { shutdown_scriptpubkey: OptionalField::Present(ref script), .. }, 319 + 2 + script.len() },
-		{ _, 319 }
-	}, {
+impl_writeable_msg!(OpenChannel, {
 	chain_hash,
 	temporary_channel_id,
 	funding_satoshis,
@@ -1225,56 +1166,57 @@ impl_writeable_len_match!(OpenChannel, {
 	first_per_commitment_point,
 	channel_flags,
 	shutdown_scriptpubkey
+}, {
+	(1, channel_type, option),
 });
 
-impl_writeable!(RevokeAndACK, 32+32+33, {
+impl_writeable_msg!(RevokeAndACK, {
 	channel_id,
 	per_commitment_secret,
 	next_per_commitment_point
-});
+}, {});
 
-impl_writeable_len_match!(Shutdown, {
-		{ Shutdown { ref scriptpubkey, .. }, 32 + 2 + scriptpubkey.len() }
-	}, {
+impl_writeable_msg!(Shutdown, {
 	channel_id,
 	scriptpubkey
-});
+}, {});
 
-impl_writeable_len_match!(UpdateFailHTLC, {
-		{ UpdateFailHTLC { ref reason, .. }, 32 + 10 + reason.data.len() }
-	}, {
+impl_writeable_msg!(UpdateFailHTLC, {
 	channel_id,
 	htlc_id,
 	reason
-});
+}, {});
 
-impl_writeable!(UpdateFailMalformedHTLC, 32+8+32+2, {
+impl_writeable_msg!(UpdateFailMalformedHTLC, {
 	channel_id,
 	htlc_id,
 	sha256_of_onion,
 	failure_code
-});
+}, {});
 
-impl_writeable!(UpdateFee, 32+4, {
+impl_writeable_msg!(UpdateFee, {
 	channel_id,
 	feerate_per_kw
-});
+}, {});
 
-impl_writeable!(UpdateFulfillHTLC, 32+8+32, {
+impl_writeable_msg!(UpdateFulfillHTLC, {
 	channel_id,
 	htlc_id,
 	payment_preimage
-});
+}, {});
 
-impl_writeable_len_match!(OnionErrorPacket, {
-		{ OnionErrorPacket { ref data, .. }, 2 + data.len() }
-	}, {
+// Note that this is written as a part of ChannelManager objects, and thus cannot change its
+// serialization format in a way which assumes we know the total serialized length/message end
+// position.
+impl_writeable!(OnionErrorPacket, {
 	data
 });
 
+// Note that this is written as a part of ChannelManager objects, and thus cannot change its
+// serialization format in a way which assumes we know the total serialized length/message end
+// position.
 impl Writeable for OnionPacket {
 	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 {
 			Ok(pubkey) => pubkey.write(w)?,
@@ -1301,18 +1243,17 @@ impl Readable for OnionPacket {
 	}
 }
 
-impl_writeable!(UpdateAddHTLC, 32+8+8+32+4+1366, {
+impl_writeable_msg!(UpdateAddHTLC, {
 	channel_id,
 	htlc_id,
 	amount_msat,
 	payment_hash,
 	cltv_expiry,
 	onion_routing_packet
-});
+}, {});
 
 impl Writeable for FinalOnionHopData {
 	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)
 	}
@@ -1328,7 +1269,6 @@ impl Readable for FinalOnionHopData {
 
 impl Writeable for OnionHopData {
 	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
 		// user-generated messages may hit this.
@@ -1429,7 +1369,6 @@ impl Readable for OnionHopData {
 
 impl Writeable for Ping {
 	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
 		Ok(())
@@ -1451,7 +1390,6 @@ impl Readable for Ping {
 
 impl Writeable for Pong {
 	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(())
 	}
@@ -1471,7 +1409,6 @@ impl Readable for Pong {
 
 impl Writeable for UnsignedChannelAnnouncement {
 	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)?;
 		self.short_channel_id.write(w)?;
@@ -1499,10 +1436,7 @@ impl Readable for UnsignedChannelAnnouncement {
 	}
 }
 
-impl_writeable_len_match!(ChannelAnnouncement, {
-		{ ChannelAnnouncement { contents: UnsignedChannelAnnouncement {ref features, ref excess_data, ..}, .. },
-			2 + 32 + 8 + 4*33 + features.byte_count() + excess_data.len() + 4*64 }
-	}, {
+impl_writeable!(ChannelAnnouncement, {
 	node_signature_1,
 	node_signature_2,
 	bitcoin_signature_1,
@@ -1512,13 +1446,10 @@ impl_writeable_len_match!(ChannelAnnouncement, {
 
 impl Writeable for UnsignedChannelUpdate {
 	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 {
-			size += 8;
 			message_flags = 1;
 		}
-		w.size_hint(size);
 		self.chain_hash.write(w)?;
 		self.short_channel_id.write(w)?;
 		self.timestamp.write(w)?;
@@ -1557,17 +1488,13 @@ impl Readable for UnsignedChannelUpdate {
 	}
 }
 
-impl_writeable_len_match!(ChannelUpdate, {
-		{ ChannelUpdate { contents: UnsignedChannelUpdate {ref excess_data, ref htlc_maximum_msat, ..}, .. },
-			64 + 64 + excess_data.len() + if let OptionalField::Present(_) = htlc_maximum_msat { 8 } else { 0 } }
-	}, {
+impl_writeable!(ChannelUpdate, {
 	signature,
 	contents
 });
 
 impl Writeable for ErrorMessage {
 	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)?;
 		w.write_all(self.data.as_bytes())?;
@@ -1594,7 +1521,6 @@ impl Readable for ErrorMessage {
 
 impl Writeable for UnsignedNodeAnnouncement {
 	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)?;
 		self.node_id.write(w)?;
@@ -1677,10 +1603,7 @@ impl Readable for UnsignedNodeAnnouncement {
 	}
 }
 
-impl_writeable_len_match!(NodeAnnouncement, <=, {
-		{ NodeAnnouncement { contents: UnsignedNodeAnnouncement { ref features, ref addresses, ref excess_address_data, ref excess_data, ..}, .. },
-			64 + 76 + features.byte_count() + addresses.len()*(NetAddress::MAX_LEN as usize + 1) + excess_address_data.len() + excess_data.len() }
-	}, {
+impl_writeable!(NodeAnnouncement, {
 	signature,
 	contents
 });
@@ -1724,7 +1647,6 @@ impl Writeable for QueryShortChannelIds {
 		// 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;
 
-		w.size_hint(32 + 2 + encoding_len as usize);
 		self.chain_hash.write(w)?;
 		encoding_len.write(w)?;
 
@@ -1739,25 +1661,10 @@ impl Writeable for QueryShortChannelIds {
 	}
 }
 
-impl Readable for ReplyShortChannelIdsEnd {
-	fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
-		let chain_hash: BlockHash = Readable::read(r)?;
-		let full_information: bool = Readable::read(r)?;
-		Ok(ReplyShortChannelIdsEnd {
-			chain_hash,
-			full_information,
-		})
-	}
-}
-
-impl Writeable for ReplyShortChannelIdsEnd {
-	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)?;
-		Ok(())
-	}
-}
+impl_writeable_msg!(ReplyShortChannelIdsEnd, {
+	chain_hash,
+	full_information,
+}, {});
 
 impl QueryChannelRange {
 	/**
@@ -1772,28 +1679,11 @@ impl QueryChannelRange {
 	}
 }
 
-impl Readable for QueryChannelRange {
-	fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
-		let chain_hash: BlockHash = Readable::read(r)?;
-		let first_blocknum: u32 = Readable::read(r)?;
-		let number_of_blocks: u32 = Readable::read(r)?;
-		Ok(QueryChannelRange {
-			chain_hash,
-			first_blocknum,
-			number_of_blocks
-		})
-	}
-}
-
-impl Writeable for QueryChannelRange {
-	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)?;
-		self.number_of_blocks.write(w)?;
-		Ok(())
-	}
-}
+impl_writeable_msg!(QueryChannelRange, {
+	chain_hash,
+	first_blocknum,
+	number_of_blocks
+}, {});
 
 impl Readable for ReplyChannelRange {
 	fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
@@ -1838,7 +1728,6 @@ impl Readable for ReplyChannelRange {
 impl Writeable for ReplyChannelRange {
 	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)?;
 		self.first_blocknum.write(w)?;
 		self.number_of_blocks.write(w)?;
@@ -1854,36 +1743,19 @@ impl Writeable for ReplyChannelRange {
 	}
 }
 
-impl Readable for GossipTimestampFilter {
-	fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
-		let chain_hash: BlockHash = Readable::read(r)?;
-		let first_timestamp: u32 = Readable::read(r)?;
-		let timestamp_range: u32 = Readable::read(r)?;
-		Ok(GossipTimestampFilter {
-			chain_hash,
-			first_timestamp,
-			timestamp_range,
-		})
-	}
-}
-
-impl Writeable for GossipTimestampFilter {
-	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)?;
-		self.timestamp_range.write(w)?;
-		Ok(())
-	}
-}
-
+impl_writeable_msg!(GossipTimestampFilter, {
+	chain_hash,
+	first_timestamp,
+	timestamp_range,
+}, {});
 
 #[cfg(test)]
 mod tests {
 	use hex;
 	use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
+	use ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
 	use ln::msgs;
-	use ln::msgs::{ChannelFeatures, FinalOnionHopData, InitFeatures, NodeFeatures, OptionalField, OnionErrorPacket, OnionHopDataFormat};
+	use ln::msgs::{FinalOnionHopData, OptionalField, OnionErrorPacket, OnionHopDataFormat};
 	use util::ser::{Writeable, Readable};
 
 	use bitcoin::hashes::hex::FromHex;
@@ -2187,7 +2059,7 @@ mod tests {
 		do_encoding_channel_update(true, true, true, true);
 	}
 
-	fn do_encoding_open_channel(random_bit: bool, shutdown: bool) {
+	fn do_encoding_open_channel(random_bit: bool, shutdown: bool, incl_chan_type: bool) {
 		let secp_ctx = Secp256k1::new();
 		let (_, pubkey_1) = get_keys_from!("0101010101010101010101010101010101010101010101010101010101010101", secp_ctx);
 		let (_, pubkey_2) = get_keys_from!("0202020202020202020202020202020202020202020202020202020202020202", secp_ctx);
@@ -2214,7 +2086,8 @@ mod tests {
 			htlc_basepoint: pubkey_5,
 			first_per_commitment_point: pubkey_6,
 			channel_flags: if random_bit { 1 << 5 } else { 0 },
-			shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent }
+			shutdown_scriptpubkey: if shutdown { OptionalField::Present(Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: pubkey_1}, Network::Testnet).script_pubkey()) } else { OptionalField::Absent },
+			channel_type: if incl_chan_type { Some(ChannelTypeFeatures::empty()) } else { None },
 		};
 		let encoded_value = open_channel.encode();
 		let mut target_value = Vec::new();
@@ -2228,15 +2101,22 @@ mod tests {
 		if shutdown {
 			target_value.append(&mut hex::decode("001976a91479b000887626b294a914501a4cd226b58b23598388ac").unwrap());
 		}
+		if incl_chan_type {
+			target_value.append(&mut hex::decode("0100").unwrap());
+		}
 		assert_eq!(encoded_value, target_value);
 	}
 
 	#[test]
 	fn encoding_open_channel() {
-		do_encoding_open_channel(false, false);
-		do_encoding_open_channel(true, false);
-		do_encoding_open_channel(false, true);
-		do_encoding_open_channel(true, true);
+		do_encoding_open_channel(false, false, false);
+		do_encoding_open_channel(false, false, true);
+		do_encoding_open_channel(false, true, false);
+		do_encoding_open_channel(false, true, true);
+		do_encoding_open_channel(true, false, false);
+		do_encoding_open_channel(true, false, true);
+		do_encoding_open_channel(true, true, false);
+		do_encoding_open_channel(true, true, true);
 	}
 
 	fn do_encoding_accept_channel(shutdown: bool) {