Rename SocketAddress from NetAddress

Author: yanganto

lightning-net-tokio/src/lib.rs

@@ -39,7 +39,7 @@ use tokio::io::AsyncWrite;
 use lightning::ln::peer_handler;
 use lightning::ln::peer_handler::SocketDescriptor as LnSocketTrait;
 use lightning::ln::peer_handler::APeerManager;
-use lightning::ln::msgs::NetAddress;
+use lightning::ln::msgs::SocketAddress;
 
 use std::ops::Deref;
 use std::task::{self, Poll};
@@ -274,13 +274,13 @@ impl Connection {
 	}
 }
 
-fn get_addr_from_stream(stream: &StdTcpStream) -> Option<NetAddress> {
+fn get_addr_from_stream(stream: &StdTcpStream) -> Option<SocketAddress> {
 	match stream.peer_addr() {
-		Ok(SocketAddr::V4(sockaddr)) => Some(NetAddress::IPv4 {
+		Ok(SocketAddr::V4(sockaddr)) => Some(SocketAddress::TcpIpV4 {
 			addr: sockaddr.ip().octets(),
 			port: sockaddr.port(),
 		}),
-		Ok(SocketAddr::V6(sockaddr)) => Some(NetAddress::IPv6 {
+		Ok(SocketAddr::V6(sockaddr)) => Some(SocketAddress::TcpIpV6 {
 			addr: sockaddr.ip().octets(),
 			port: sockaddr.port(),
 		}),

lightning/src/ln/msgs.rs

@@ -98,7 +98,7 @@ pub struct Init {
 	/// message. A node can decide to use that information to discover a potential update to its
 	/// public IPv4 address (NAT) and use that for a [`NodeAnnouncement`] update message containing
 	/// the new address.
-	pub remote_network_address: Option<NetAddress>,
+	pub remote_network_address: Option<SocketAddress>,
 }
 
 /// An [`error`] message to be sent to or received from a peer.
@@ -746,16 +746,16 @@ pub struct AnnouncementSignatures {
 
 /// An address which can be used to connect to a remote peer.
 #[derive(Clone, Debug, PartialEq, Eq)]
-pub enum NetAddress {
-	/// An IPv4 address/port on which the peer is listening.
-	IPv4 {
+pub enum SocketAddress {
+	/// An IPv4 address and port on which the peer is listening.
+	TcpIpV4 {
 		/// The 4-byte IPv4 address
 		addr: [u8; 4],
 		/// The port on which the node is listening
 		port: u16,
 	},
-	/// An IPv6 address/port on which the peer is listening.
-	IPv6 {
+	/// An IPv6 address and port on which the peer is listening.
+	TcpIpV6 {
 		/// The 16-byte IPv6 address
 		addr: [u8; 16],
 		/// The port on which the node is listening
@@ -788,28 +788,28 @@ pub enum NetAddress {
 		port: u16,
 	},
 }
-impl NetAddress {
+impl SocketAddress {
 	/// Gets the ID of this address type. Addresses in [`NodeAnnouncement`] messages should be sorted
 	/// by this.
 	pub(crate) fn get_id(&self) -> u8 {
 		match self {
-			&NetAddress::IPv4 {..} => { 1 },
-			&NetAddress::IPv6 {..} => { 2 },
-			&NetAddress::OnionV2(_) => { 3 },
-			&NetAddress::OnionV3 {..} => { 4 },
-			&NetAddress::Hostname {..} => { 5 },
+			&SocketAddress::TcpIpV4 {..} => { 1 },
+			&SocketAddress::TcpIpV6 {..} => { 2 },
+			&SocketAddress::OnionV2(_) => { 3 },
+			&SocketAddress::OnionV3 {..} => { 4 },
+			&SocketAddress::Hostname {..} => { 5 },
 		}
 	}
 
 	/// Strict byte-length of address descriptor, 1-byte type not recorded
 	fn len(&self) -> u16 {
 		match self {
-			&NetAddress::IPv4 { .. } => { 6 },
-			&NetAddress::IPv6 { .. } => { 18 },
-			&NetAddress::OnionV2(_) => { 12 },
-			&NetAddress::OnionV3 { .. } => { 37 },
+			&SocketAddress::TcpIpV4 { .. } => { 6 },
+			&SocketAddress::TcpIpV6 { .. } => { 18 },
+			&SocketAddress::OnionV2(_) => { 12 },
+			&SocketAddress::OnionV3 { .. } => { 37 },
 			// Consists of 1-byte hostname length, hostname bytes, and 2-byte port.
-			&NetAddress::Hostname { ref hostname, .. } => { u16::from(hostname.len()) + 3 },
+			&SocketAddress::Hostname { ref hostname, .. } => { u16::from(hostname.len()) + 3 },
 		}
 	}
 
@@ -819,31 +819,31 @@ impl NetAddress {
 	pub(crate) const MAX_LEN: u16 = 258;
 }
 
-impl Writeable for NetAddress {
+impl Writeable for SocketAddress {
 	fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 		match self {
-			&NetAddress::IPv4 { ref addr, ref port } => {
+			&SocketAddress::TcpIpV4 { ref addr, ref port } => {
 				1u8.write(writer)?;
 				addr.write(writer)?;
 				port.write(writer)?;
 			},
-			&NetAddress::IPv6 { ref addr, ref port } => {
+			&SocketAddress::TcpIpV6 { ref addr, ref port } => {
 				2u8.write(writer)?;
 				addr.write(writer)?;
 				port.write(writer)?;
 			},
-			&NetAddress::OnionV2(bytes) => {
+			&SocketAddress::OnionV2(bytes) => {
 				3u8.write(writer)?;
 				bytes.write(writer)?;
 			},
-			&NetAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
+			&SocketAddress::OnionV3 { ref ed25519_pubkey, ref checksum, ref version, ref port } => {
 				4u8.write(writer)?;
 				ed25519_pubkey.write(writer)?;
 				checksum.write(writer)?;
 				version.write(writer)?;
 				port.write(writer)?;
 			},
-			&NetAddress::Hostname { ref hostname, ref port } => {
+			&SocketAddress::Hostname { ref hostname, ref port } => {
 				5u8.write(writer)?;
 				hostname.write(writer)?;
 				port.write(writer)?;
@@ -853,33 +853,33 @@ impl Writeable for NetAddress {
 	}
 }
 
-impl Readable for Result<NetAddress, u8> {
-	fn read<R: Read>(reader: &mut R) -> Result<Result<NetAddress, u8>, DecodeError> {
+impl Readable for Result<SocketAddress, u8> {
+	fn read<R: Read>(reader: &mut R) -> Result<Result<SocketAddress, u8>, DecodeError> {
 		let byte = <u8 as Readable>::read(reader)?;
 		match byte {
 			1 => {
-				Ok(Ok(NetAddress::IPv4 {
+				Ok(Ok(SocketAddress::TcpIpV4 {
 					addr: Readable::read(reader)?,
 					port: Readable::read(reader)?,
 				}))
 			},
 			2 => {
-				Ok(Ok(NetAddress::IPv6 {
+				Ok(Ok(SocketAddress::TcpIpV6 {
 					addr: Readable::read(reader)?,
 					port: Readable::read(reader)?,
 				}))
 			},
-			3 => Ok(Ok(NetAddress::OnionV2(Readable::read(reader)?))),
+			3 => Ok(Ok(SocketAddress::OnionV2(Readable::read(reader)?))),
 			4 => {
-				Ok(Ok(NetAddress::OnionV3 {
+				Ok(Ok(SocketAddress::OnionV3 {
 					ed25519_pubkey: Readable::read(reader)?,
 					checksum: Readable::read(reader)?,
 					version: Readable::read(reader)?,
 					port: Readable::read(reader)?,
 				}))
 			},
 			5 => {
-				Ok(Ok(NetAddress::Hostname {
+				Ok(Ok(SocketAddress::Hostname {
 					hostname: Readable::read(reader)?,
 					port: Readable::read(reader)?,
 				}))
@@ -889,8 +889,8 @@ impl Readable for Result<NetAddress, u8> {
 	}
 }
 
-impl Readable for NetAddress {
-	fn read<R: Read>(reader: &mut R) -> Result<NetAddress, DecodeError> {
+impl Readable for SocketAddress {
+	fn read<R: Read>(reader: &mut R) -> Result<SocketAddress, DecodeError> {
 		match Readable::read(reader) {
 			Ok(Ok(res)) => Ok(res),
 			Ok(Err(_)) => Err(DecodeError::UnknownVersion),
@@ -938,7 +938,7 @@ pub struct UnsignedNodeAnnouncement {
 	/// This should be sanitized before use. There is no guarantee of uniqueness.
 	pub alias: NodeAlias,
 	/// List of addresses on which this node is reachable
-	pub addresses: Vec<NetAddress>,
+	pub addresses: Vec<SocketAddress>,
 	pub(crate) excess_address_data: Vec<u8>,
 	pub(crate) excess_data: Vec<u8>,
 }
@@ -1773,7 +1773,7 @@ impl Readable for Init {
 	fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
 		let global_features: InitFeatures = Readable::read(r)?;
 		let features: InitFeatures = Readable::read(r)?;
-		let mut remote_network_address: Option<NetAddress> = None;
+		let mut remote_network_address: Option<SocketAddress> = None;
 		let mut networks: Option<WithoutLength<Vec<ChainHash>>> = None;
 		decode_tlv_stream!(r, {
 			(1, networks, option),
@@ -2272,7 +2272,7 @@ impl Readable for UnsignedNodeAnnouncement {
 		let alias: NodeAlias = Readable::read(r)?;
 
 		let addr_len: u16 = Readable::read(r)?;
-		let mut addresses: Vec<NetAddress> = Vec::new();
+		let mut addresses: Vec<SocketAddress> = Vec::new();
 		let mut addr_readpos = 0;
 		let mut excess = false;
 		let mut excess_byte = 0;
@@ -2663,32 +2663,32 @@ mod tests {
 		};
 		let mut addresses = Vec::new();
 		if ipv4 {
-			addresses.push(msgs::NetAddress::IPv4 {
+			addresses.push(msgs::SocketAddress::TcpIpV4 {
 				addr: [255, 254, 253, 252],
 				port: 9735
 			});
 		}
 		if ipv6 {
-			addresses.push(msgs::NetAddress::IPv6 {
+			addresses.push(msgs::SocketAddress::TcpIpV6 {
 				addr: [255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240],
 				port: 9735
 			});
 		}
 		if onionv2 {
-			addresses.push(msgs::NetAddress::OnionV2(
+			addresses.push(msgs::SocketAddress::OnionV2(
 				[255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 38, 7]
 			));
 		}
 		if onionv3 {
-			addresses.push(msgs::NetAddress::OnionV3 {
+			addresses.push(msgs::SocketAddress::OnionV3 {
 				ed25519_pubkey:	[255, 254, 253, 252, 251, 250, 249, 248, 247, 246, 245, 244, 243, 242, 241, 240, 239, 238, 237, 236, 235, 234, 233, 232, 231, 230, 229, 228, 227, 226, 225, 224],
 				checksum: 32,
 				version: 16,
 				port: 9735
 			});
 		}
 		if hostname {
-			addresses.push(msgs::NetAddress::Hostname {
+			addresses.push(msgs::SocketAddress::Hostname {
 				hostname: Hostname::try_from(String::from("host")).unwrap(),
 				port: 9735,
 			});
@@ -3504,7 +3504,7 @@ mod tests {
 		}.encode(), hex::decode("00000000014001010101010101010101010101010101010101010101010101010101010101010202020202020202020202020202020202020202020202020202020202020202").unwrap());
 		let init_msg = msgs::Init { features: InitFeatures::from_le_bytes(vec![]),
 			networks: Some(vec![mainnet_hash]),
-			remote_network_address: Some(msgs::NetAddress::IPv4 {
+			remote_network_address: Some(msgs::SocketAddress::TcpIpV4 {
 				addr: [127, 0, 0, 1],
 				port: 1000,
 			}),