f Add Config and Network bindings

Author: tnull

bindings/ldk_node.udl

@@ -1,8 +1,18 @@
 namespace ldk_node {
 };
 
+dictionary Config {
+	string storage_dir_path;
+	string esplora_server_url;
+	Network network;
+	string? listening_address;
+	u32 default_cltv_expiry_delta;
+};
+
 interface Builder {
 	constructor();
+	[Name=from_config]
+	constructor(Config config);
 	Node build();
 };
 
@@ -41,6 +51,7 @@ enum NodeError {
 	"InvoiceInvalid",
 	"InvoiceCreationFailed",
 	"ChannelIdInvalid",
+	"NetworkInvalid",
 	"RoutingFailed",
 	"PeerInfoParseFailed",
 	"ChannelCreationFailed",
@@ -77,3 +88,6 @@ typedef string ChannelId;
 
 [Custom]
 typedef string UserChannelId;
+
+[Custom]
+typedef string Network;

src/error.rs

@@ -25,6 +25,8 @@ pub enum Error {
 	InvoiceCreationFailed,
 	/// The given channel ID is invalid.
 	ChannelIdInvalid,
+	/// The given network is invalid.
+	NetworkInvalid,
 	/// No route for the given target could be found.
 	RoutingFailed,
 	/// A given peer info could not be parsed.
@@ -57,6 +59,7 @@ impl fmt::Display for Error {
 			Self::InvoiceInvalid => write!(f, "The given invoice is invalid."),
 			Self::InvoiceCreationFailed => write!(f, "Failed to create invoice."),
 			Self::ChannelIdInvalid => write!(f, "The given channel ID is invalid."),
+			Self::NetworkInvalid => write!(f, "The given network is invalid."),
 			Self::RoutingFailed => write!(f, "Failed to find route."),
 			Self::PeerInfoParseFailed => write!(f, "Failed to parse the given peer information."),
 			Self::ChannelCreationFailed => write!(f, "Failed to create channel."),

src/io_utils.rs

@@ -42,7 +42,7 @@ pub(crate) fn read_network_graph(
 	}
 
 	let genesis_hash =
-		bitcoin::blockdata::constants::genesis_block(config.network).header.block_hash();
+		bitcoin::blockdata::constants::genesis_block(config.network.0).header.block_hash();
 	Ok(NetworkGraph::new(genesis_hash, logger))
 }
 

src/lib.rs

@@ -40,7 +40,7 @@ pub use event::Event;
 use event::{EventHandler, EventQueue};
 use peer_store::{PeerInfo, PeerInfoStorage};
 use types::{
-	ChainMonitor, ChannelManager, GossipSync, InvoicePayer, KeysManager, NetworkGraph,
+	ChainMonitor, ChannelManager, GossipSync, InvoicePayer, KeysManager, Network, NetworkGraph,
 	OnionMessenger, PaymentInfoStorage, PeerManager, Router, Scorer,
 };
 pub use types::{ChannelId, PaymentInfo, PaymentStatus, UserChannelId};
@@ -85,6 +85,7 @@ use std::convert::{TryFrom, TryInto};
 use std::default::Default;
 use std::fs;
 use std::net::SocketAddr;
+use std::str::FromStr;
 use std::sync::atomic::{AtomicBool, Ordering};
 use std::sync::{Arc, Mutex, RwLock};
 use std::time::{Duration, Instant, SystemTime};
@@ -109,7 +110,7 @@ pub struct Config {
 	/// The URL of the utilized Esplora server.
 	pub esplora_server_url: String,
 	/// The used Bitcoin network.
-	pub network: bitcoin::Network,
+	pub network: Network,
 	/// The IP address and TCP port the node will listen on.
 	pub listening_address: Option<String>,
 	/// The default CLTV expiry delta to be used for payments.
@@ -121,7 +122,7 @@ impl Default for Config {
 		// Set the config defaults
 		let storage_dir_path = "/tmp/ldk_node/".to_string();
 		let esplora_server_url = "https://blockstream.info/api".to_string();
-		let network = bitcoin::Network::Regtest;
+		let network = Network::default();
 		let listening_address = Some("0.0.0.0:9735".to_string());
 		let default_cltv_expiry_delta = 144;
 
@@ -175,16 +176,9 @@ impl Builder {
 	///
 	/// Options: `mainnet`/`bitcoin`, `testnet`, `regtest`, `signet`
 	///
-	/// Default: `testnet`
+	/// Default: `regtest`
 	pub fn set_network(&mut self, network: &str) -> &mut Self {
-		self.config.network = match network {
-			"mainnet" => bitcoin::Network::Bitcoin,
-			"bitcoin" => bitcoin::Network::Bitcoin,
-			"testnet" => bitcoin::Network::Testnet,
-			"regtest" => bitcoin::Network::Regtest,
-			"signet" => bitcoin::Network::Signet,
-			_ => bitcoin::Network::Regtest,
-		};
+		self.config.network = Network::from_str(network).unwrap_or(Network::default());
 		self
 	}
 
@@ -213,13 +207,13 @@ impl Builder {
 
 		// Step 1: Initialize the on-chain wallet and chain access
 		let seed = io_utils::read_or_generate_seed_file(Arc::clone(&config));
-		let xprv = bitcoin::util::bip32::ExtendedPrivKey::new_master(config.network, &seed)
+		let xprv = bitcoin::util::bip32::ExtendedPrivKey::new_master(config.network.0, &seed)
 			.expect("Failed to read wallet master key");
 
 		let wallet_name = bdk::wallet::wallet_name_from_descriptor(
 			Bip84(xprv, bdk::KeychainKind::External),
 			Some(Bip84(xprv, bdk::KeychainKind::Internal)),
-			config.network,
+			config.network.0,
 			&Secp256k1::new(),
 		)
 		.expect("Failed to derive on-chain wallet name");
@@ -229,7 +223,7 @@ impl Builder {
 		let bdk_wallet = bdk::Wallet::new(
 			Bip84(xprv, bdk::KeychainKind::External),
 			Some(Bip84(xprv, bdk::KeychainKind::Internal)),
-			config.network,
+			config.network.0,
 			database,
 		)
 		.expect("Failed to setup on-chain wallet");
@@ -318,12 +312,13 @@ impl Builder {
 				channel_manager
 			} else {
 				// We're starting a fresh node.
-				let dummy_block_hash = bitcoin::blockdata::constants::genesis_block(config.network)
-					.header
-					.block_hash();
+				let dummy_block_hash =
+					bitcoin::blockdata::constants::genesis_block(config.network.0)
+						.header
+						.block_hash();
 
 				let chain_params = ChainParameters {
-					network: config.network,
+					network: config.network.0,
 					best_block: BestBlock::new(dummy_block_hash, 0),
 				};
 				channelmanager::ChannelManager::new(
@@ -937,7 +932,7 @@ impl Node {
 	) -> Result<Invoice, Error> {
 		let mut inbound_payments_lock = self.inbound_payments.lock().unwrap();
 
-		let currency = match self.config.network {
+		let currency = match self.config.network.0 {
 			bitcoin::Network::Bitcoin => Currency::Bitcoin,
 			bitcoin::Network::Testnet => Currency::BitcoinTestnet,
 			bitcoin::Network::Regtest => Currency::Regtest,

src/types.rs

@@ -23,6 +23,8 @@ use bitcoin::secp256k1::PublicKey;
 use bitcoin::Address;
 
 use std::collections::HashMap;
+use std::default::Default;
+use std::fmt;
 use std::str::FromStr;
 use std::sync::{Arc, Mutex};
 
@@ -207,3 +209,45 @@ impl UniffiCustomTypeConverter for UserChannelId {
 		obj.0.to_string()
 	}
 }
+
+#[derive(PartialEq, Eq, Debug, Clone)]
+pub struct Network(pub bitcoin::Network);
+
+impl Default for Network {
+	fn default() -> Self {
+		Self(bitcoin::Network::Regtest)
+	}
+}
+
+impl FromStr for Network {
+	type Err = ();
+
+	fn from_str(s: &str) -> Result<Self, Self::Err> {
+		match s {
+			"mainnet" => Ok(Self(bitcoin::Network::Bitcoin)),
+			"bitcoin" => Ok(Self(bitcoin::Network::Bitcoin)),
+			"testnet" => Ok(Self(bitcoin::Network::Testnet)),
+			"regtest" => Ok(Self(bitcoin::Network::Regtest)),
+			"signet" => Ok(Self(bitcoin::Network::Signet)),
+			_ => Err(()),
+		}
+	}
+}
+
+impl fmt::Display for Network {
+	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+		write!(f, "{}", self.0)
+	}
+}
+
+impl UniffiCustomTypeConverter for Network {
+	type Builtin = String;
+
+	fn into_custom(val: Self::Builtin) -> uniffi::Result<Self> {
+		Ok(Network::from_str(&val).map_err(|_| Error::NetworkInvalid)?)
+	}
+
+	fn from_custom(obj: Self) -> Self::Builtin {
+		obj.0.to_string()
+	}
+}