Account for NetAddress being renamed to SocketAddress

Author: tnull

README.md

@@ -11,7 +11,7 @@ LDK Node is a self-custodial Lightning node in library form. Its central goal is
 The primary abstraction of the library is the [`Node`][api_docs_node], which can be retrieved by setting up and configuring a [`Builder`][api_docs_builder] to your liking and calling one of the `build` methods. `Node` can then be controlled via commands such as `start`, `stop`, `connect_open_channel`, `send_payment`, etc.
 
 ```rust
-use ldk_node::{Builder, NetAddress};
+use ldk_node::{Builder, SocketAddress};
 use ldk_node::lightning_invoice::Invoice;
 use ldk_node::bitcoin::secp256k1::PublicKey;
 use ldk_node::bitcoin::Network;
@@ -32,7 +32,7 @@ fn main() {
 	// .. fund address ..
 
 	let node_id = PublicKey::from_str("NODE_ID").unwrap();
-	let node_addr = NetAddress::from_str("IP_ADDR:PORT").unwrap();
+	let node_addr = SocketAddress::from_str("IP_ADDR:PORT").unwrap();
 	node.connect_open_channel(node_id, node_addr, 10000, None, None, false).unwrap();
 
 	let event = node.wait_next_event();

bindings/ldk_node.udl

@@ -6,7 +6,7 @@ dictionary Config {
 	string storage_dir_path = "/tmp/ldk_node/";
 	string? log_dir_path = null;
 	Network network = "Bitcoin";
-	NetAddress? listening_address = null;
+	SocketAddress? listening_address = null;
 	u32 default_cltv_expiry_delta = 144;
 	u64 onchain_wallet_sync_interval_secs = 80;
 	u64 wallet_sync_interval_secs = 30;
@@ -29,7 +29,7 @@ interface Builder {
 	void set_gossip_source_rgs(string rgs_server_url);
 	void set_storage_dir_path(string storage_dir_path);
 	void set_network(Network network);
-	void set_listening_address(NetAddress listening_address);
+	void set_listening_address(SocketAddress listening_address);
 	[Throws=BuildError]
 	LDKNode build();
 };
@@ -43,7 +43,7 @@ interface LDKNode {
 	Event wait_next_event();
 	void event_handled();
 	PublicKey node_id();
-	NetAddress? listening_address();
+	SocketAddress? listening_address();
 	[Throws=NodeError]
 	Address new_onchain_address();
 	[Throws=NodeError]
@@ -55,11 +55,11 @@ interface LDKNode {
 	[Throws=NodeError]
 	u64 total_onchain_balance_sats();
 	[Throws=NodeError]
-	void connect(PublicKey node_id, NetAddress address, boolean persist);
+	void connect(PublicKey node_id, SocketAddress address, boolean persist);
 	[Throws=NodeError]
 	void disconnect(PublicKey node_id);
 	[Throws=NodeError]
-	void connect_open_channel(PublicKey node_id, NetAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
+	void connect_open_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config, boolean announce_channel);
 	[Throws=NodeError]
 	void close_channel([ByRef]ChannelId channel_id, PublicKey counterparty_node_id);
 	[Throws=NodeError]
@@ -110,7 +110,7 @@ enum NodeError {
 	"TxSyncFailed",
 	"GossipUpdateFailed",
 	"InvalidAddress",
-	"InvalidNetAddress",
+	"InvalidSocketAddress",
 	"InvalidPublicKey",
 	"InvalidSecretKey",
 	"InvalidPaymentHash",
@@ -199,7 +199,7 @@ dictionary ChannelDetails {
 
 dictionary PeerDetails {
 	PublicKey node_id;
-	NetAddress address;
+	SocketAddress address;
 	boolean is_persisted;
 	boolean is_connected;
 };
@@ -233,7 +233,7 @@ enum LogLevel {
 typedef string Txid;
 
 [Custom]
-typedef string NetAddress;
+typedef string SocketAddress;
 
 [Custom]
 typedef string PublicKey;

src/builder.rs

@@ -8,8 +8,8 @@ use crate::logger::{log_error, FilesystemLogger, Logger};
 use crate::payment_store::PaymentStore;
 use crate::peer_store::PeerStore;
 use crate::types::{
-	ChainMonitor, ChannelManager, FakeMessageRouter, GossipSync, KeysManager, NetAddress,
-	NetworkGraph, OnionMessenger, PeerManager,
+	ChainMonitor, ChannelManager, FakeMessageRouter, GossipSync, KeysManager, NetworkGraph,
+	OnionMessenger, PeerManager, SocketAddress,
 };
 use crate::wallet::Wallet;
 use crate::LogLevel;
@@ -217,7 +217,7 @@ impl NodeBuilder {
 	}
 
 	/// Sets the IP address and TCP port on which [`Node`] will listen for incoming network connections.
-	pub fn set_listening_address(&mut self, listening_address: NetAddress) -> &mut Self {
+	pub fn set_listening_address(&mut self, listening_address: SocketAddress) -> &mut Self {
 		self.config.listening_address = Some(listening_address);
 		self
 	}
@@ -353,7 +353,7 @@ impl ArcedNodeBuilder {
 	}
 
 	/// Sets the IP address and TCP port on which [`Node`] will listen for incoming network connections.
-	pub fn set_listening_address(&self, listening_address: NetAddress) {
+	pub fn set_listening_address(&self, listening_address: SocketAddress) {
 		self.inner.write().unwrap().set_listening_address(listening_address);
 	}
 

src/error.rs

@@ -38,7 +38,7 @@ pub enum Error {
 	/// The given address is invalid.
 	InvalidAddress,
 	/// The given network address is invalid.
-	InvalidNetAddress,
+	InvalidSocketAddress,
 	/// The given public key is invalid.
 	InvalidPublicKey,
 	/// The given secret key is invalid.
@@ -85,7 +85,7 @@ impl fmt::Display for Error {
 			Self::TxSyncFailed => write!(f, "Failed to sync transactions."),
 			Self::GossipUpdateFailed => write!(f, "Failed to update gossip data."),
 			Self::InvalidAddress => write!(f, "The given address is invalid."),
-			Self::InvalidNetAddress => write!(f, "The given network address is invalid."),
+			Self::InvalidSocketAddress => write!(f, "The given network address is invalid."),
 			Self::InvalidPublicKey => write!(f, "The given public key is invalid."),
 			Self::InvalidSecretKey => write!(f, "The given secret key is invalid."),
 			Self::InvalidPaymentHash => write!(f, "The given payment hash is invalid."),

src/lib.rs

@@ -26,7 +26,7 @@
 //! [`send_payment`], etc.:
 //!
 //! ```no_run
-//! use ldk_node::{Builder, NetAddress};
+//! use ldk_node::{Builder, SocketAddress};
 //! use ldk_node::lightning_invoice::Bolt11Invoice;
 //! use ldk_node::bitcoin::secp256k1::PublicKey;
 //! use ldk_node::bitcoin::Network;
@@ -47,7 +47,7 @@
 //! 	// .. fund address ..
 //!
 //! 	let node_id = PublicKey::from_str("NODE_ID").unwrap();
-//! 	let node_addr = NetAddress::from_str("IP_ADDR:PORT").unwrap();
+//! 	let node_addr = SocketAddress::from_str("IP_ADDR:PORT").unwrap();
 //! 	node.connect_open_channel(node_id, node_addr, 10000, None, None, false).unwrap();
 //!
 //! 	let event = node.wait_next_event();
@@ -100,7 +100,7 @@ use error::Error;
 
 pub use event::Event;
 pub use types::ChannelConfig;
-pub use types::NetAddress;
+pub use types::SocketAddress;
 
 pub use io::utils::generate_entropy_mnemonic;
 
@@ -225,7 +225,7 @@ pub struct Config {
 	/// The used Bitcoin network.
 	pub network: Network,
 	/// The IP address and TCP port the node will listen on.
-	pub listening_address: Option<NetAddress>,
+	pub listening_address: Option<SocketAddress>,
 	/// The default CLTV expiry delta to be used for payments.
 	pub default_cltv_expiry_delta: u32,
 	/// The time in-between background sync attempts of the onchain wallet, in seconds.
@@ -504,7 +504,7 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 						"Unable to resolve listing address: {:?}",
 						listening_address
 					);
-					Error::InvalidNetAddress
+					Error::InvalidSocketAddress
 				})?
 				.next()
 				.ok_or_else(|| {
@@ -513,7 +513,7 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 						"Unable to resolve listing address: {:?}",
 						listening_address
 					);
-					Error::InvalidNetAddress
+					Error::InvalidSocketAddress
 				})?;
 
 			runtime.spawn(async move {
@@ -776,7 +776,7 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 	}
 
 	/// Returns our own listening address.
-	pub fn listening_address(&self) -> Option<NetAddress> {
+	pub fn listening_address(&self) -> Option<SocketAddress> {
 		self.config.listening_address.clone()
 	}
 
@@ -833,7 +833,7 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 	///
 	/// If `persist` is set to `true`, we'll remember the peer and reconnect to it on restart.
 	pub fn connect(
-		&self, node_id: PublicKey, address: NetAddress, persist: bool,
+		&self, node_id: PublicKey, address: SocketAddress, persist: bool,
 	) -> Result<(), Error> {
 		let rt_lock = self.runtime.read().unwrap();
 		if rt_lock.is_none() {
@@ -898,7 +898,7 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 	///
 	/// Returns a temporary channel id.
 	pub fn connect_open_channel(
-		&self, node_id: PublicKey, address: NetAddress, channel_amount_sats: u64,
+		&self, node_id: PublicKey, address: SocketAddress, channel_amount_sats: u64,
 		push_to_counterparty_msat: Option<u64>, channel_config: Option<Arc<ChannelConfig>>,
 		announce_channel: bool,
 	) -> Result<(), Error> {
@@ -1536,7 +1536,7 @@ impl<K: KVStore + Sync + Send + 'static> Node<K> {
 			let stored_peer = self.peer_store.get_peer(&node_id);
 			let stored_addr_opt = stored_peer.as_ref().map(|p| p.address.clone());
 			let address = match (con_addr_opt, stored_addr_opt) {
-				(Some(con_addr), _) => NetAddress(con_addr),
+				(Some(con_addr), _) => SocketAddress(con_addr),
 				(None, Some(stored_addr)) => stored_addr,
 				(None, None) => continue,
 			};
@@ -1590,7 +1590,7 @@ impl<K: KVStore + Sync + Send + 'static> Drop for Node<K> {
 }
 
 async fn connect_peer_if_necessary<K: KVStore + Sync + Send + 'static>(
-	node_id: PublicKey, addr: NetAddress, peer_manager: Arc<PeerManager<K>>,
+	node_id: PublicKey, addr: SocketAddress, peer_manager: Arc<PeerManager<K>>,
 	logger: Arc<FilesystemLogger>,
 ) -> Result<(), Error> {
 	for (pman_node_id, _pman_addr) in peer_manager.get_peer_node_ids() {
@@ -1603,7 +1603,7 @@ async fn connect_peer_if_necessary<K: KVStore + Sync + Send + 'static>(
 }
 
 async fn do_connect_peer<K: KVStore + Sync + Send + 'static>(
-	node_id: PublicKey, addr: NetAddress, peer_manager: Arc<PeerManager<K>>,
+	node_id: PublicKey, addr: SocketAddress, peer_manager: Arc<PeerManager<K>>,
 	logger: Arc<FilesystemLogger>,
 ) -> Result<(), Error> {
 	log_info!(logger, "Connecting to peer: {}@{}", node_id, addr);
@@ -1612,7 +1612,7 @@ async fn do_connect_peer<K: KVStore + Sync + Send + 'static>(
 		.to_socket_addrs()
 		.map_err(|e| {
 			log_error!(logger, "Failed to resolve network address: {}", e);
-			Error::InvalidNetAddress
+			Error::InvalidSocketAddress
 		})?
 		.next()
 		.ok_or(Error::ConnectionFailed)?;

src/peer_store.rs

@@ -1,6 +1,6 @@
 use crate::io::{KVStore, PEER_INFO_PERSISTENCE_KEY, PEER_INFO_PERSISTENCE_NAMESPACE};
 use crate::logger::{log_error, Logger};
-use crate::{Error, NetAddress};
+use crate::{Error, SocketAddress};
 
 use lightning::impl_writeable_tlv_based;
 use lightning::util::ser::{Readable, ReadableArgs, Writeable, Writer};
@@ -122,7 +122,7 @@ impl Writeable for PeerStoreSerWrapper<'_> {
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub(crate) struct PeerInfo {
 	pub node_id: PublicKey,
-	pub address: NetAddress,
+	pub address: SocketAddress,
 }
 
 impl_writeable_tlv_based!(PeerInfo, {
@@ -147,7 +147,7 @@ mod tests {
 			"0276607124ebe6a6c9338517b6f485825b27c2dcc0b9fc2aa6a4c0df91194e5993",
 		)
 		.unwrap();
-		let address = NetAddress::from_str("127.0.0.1:9738").unwrap();
+		let address = SocketAddress::from_str("127.0.0.1:9738").unwrap();
 		let expected_peer_info = PeerInfo { node_id, address };
 		peer_store.add_peer(expected_peer_info.clone()).unwrap();
 		assert!(store.get_and_clear_did_persist());