Renamed types and fixed readme (#246)

README.md

@@ -81,29 +81,29 @@ http_server_port = "7000"
 # If set to seed, keypair will be generated from that seed.
 # If set to key, a valid ed25519 private key must be provided, else the client will fail
 # If `secret_key` is not set, random seed will be used.
-secret_key = { key =  "1498b5467a63dffa2dc9d9e069caf075d16fc33fdd4c3b01bfadae6433767d93" }
-# Libp2p service port range (port, range) (default: 37000).
-libp2p_port = "37000"
-# Configures LibP2P TCP port reuse for local sockets, which implies reuse of listening ports for outgoing connections to enhance NAT traversal capabilities (default: false)
-libp2p_tcp_port_reuse = false
-# Configures LibP2P AutoNAT behaviour to reject probes as a server for clients that are observed at a non-global ip address (default: false)
-libp2p_autonat_only_global_ips = false
-# Libp2p AutoNat throttle period for re-using a peer as server for a dial-request. (default: 1 sec)
-libp2p_autonat_throttle = 1
+secret_key = { seed={seed} }
+# P2P service port (default: 37000).
+port = 3700
+# Configures TCP port reuse for local sockets, which implies reuse of listening ports for outgoing connections to enhance NAT traversal capabilities (default: false)
+tcp_port_reuse = bool
+# Configures AutoNAT behaviour to reject probes as a server for clients that are observed at a non-global ip address (default: false)
+autonat_only_global_ips = false
+# AutoNat throttle period for re-using a peer as server for a dial-request. (default: 1 sec)
+autonat_throttle = 2
 # Interval in which the NAT status should be re-tried if it is currently unknown or max confidence was not reached yet. (default: 10 sec)
-libp2p_autonat_retry_interval = 10
+autonat_retry_interval = 10
 # Interval in which the NAT should be tested again if max confidence was reached in a status. (default: 30 sec)
-libp2p_autonat_refresh_interval = 30
-# Libp2p AutoNat on init delay before starting the fist probe. (default: 5 sec)
-libp2p_autonat_boot_delay = 5
-# Sets libp2p application-specific version of the protocol family used by the peer. (default: "/avail_kad/id/1.0.0")
-libp2p_identify_protocol = "/avail_kad/id/1.0.0"
-# Sets libp2p agent version that is sent to peers. (default: "avail-light-client/rust-client")
-libp2p_identify_agent = "avail-light-client/rust-client"
-# Vector of Relay nodes, which are used for hole punching (default: empty)
-relays = [["12D3KooWMm1c4pzeLPGkkCJMAgFbsfQ8xmVDusg272icWsaNHWzN", "/ip4/127.0.0.1/tcp/37000"]]
-# Vector of IPFS bootstrap nodes, used to bootstrap DHT. If not set, light client acts as a bootstrap node, waiting for first peer to connect for DHT bootstrap (default: empty).
-bootstraps = [["12D3KooWMm1c4pzeLPGkkCJMAgFbsfQ8xmVDusg272icWsaNHWzN", "/ip4/127.0.0.1/tcp/37000"]]
+autonat_refresh_interval = 30
+# AutoNat on init delay before starting the fist probe. (default: 5 sec)
+autonat_boot_delay = 10
+# Sets application-specific version of the protocol family used by the peer. (default: "/avail_kad/id/1.0.0")
+identify_protocol = "/avail_kad/id/1.0.0"
+# Sets agent version that is sent to peers. (default: "avail-light-client/rust-client")
+identify_agent = "avail-light-client/rust-client"
+# Vector of Light Client bootstrap nodes, used to bootstrap DHT. If not set, light client acts as a bootstrap node, waiting for first peer to connect for DHT bootstrap (default: empty).
+bootstraps = [["12D3KooWE2xXc6C2JzeaCaEg7jvZLogWyjLsB5dA3iw5o3KcF9ds", "/ip4/13.51.79.255/udp/39000/quic-v1"]]
+# Vector of Relay nodes, which are used for hole punching
+relays = [["12D3KooWBETtE42fN7DZ5QsGgi7qfrN3jeYdXmBPL4peVTDmgG9b", "/ip4/13.49.44.246/udp/39111/quic-v1"]]
 # WebSocket endpoint of a full node for subscribing to the latest header, etc (default: ws://127.0.0.1:9944).
 full_node_ws = ["ws://127.0.0.1:9944"]
 # ID of application used to start application client. If app_id is not set, or set to 0, application client is not started (default: 0).

src/main.rs

@@ -15,7 +15,6 @@ use clap::Parser;
 use consts::STATE_CF;
 use libp2p::{metrics::Metrics as LibP2PMetrics, multiaddr::Protocol, Multiaddr, PeerId};
 use prometheus_client::registry::Registry;
-use rand::{thread_rng, Rng};
 use rocksdb::{ColumnFamilyDescriptor, Options, DB};
 use tokio::sync::mpsc::{channel, Sender};
 use tracing::{error, info, metadata::ParseLevelError, trace, warn, Level};
@@ -192,13 +191,8 @@ async fn run(error_sender: Sender<anyhow::Error>) -> Result<()> {
 	tokio::spawn(network_event_loop.run());
 
 	// Start listening on provided port
-	let port = if cfg.libp2p_port.1 > 0 {
-		let port: u16 = thread_rng().gen_range(cfg.libp2p_port.0..=cfg.libp2p_port.1);
-		info!("Using random port: {port}");
-		port
-	} else {
-		cfg.libp2p_port.0
-	};
+	let port = cfg.port;
+	info!("Listening on port: {port}");
 
 	// always listen on UDP to prioritize QUIC
 	network_client

src/types.rs

@@ -195,25 +195,24 @@ pub struct RuntimeConfig {
 	/// If set to key, a valid ed25519 private key must be provided, else the client will fail
 	/// If `secret_key` is not set, random seed will be used.
 	pub secret_key: Option<SecretKey>,
-	/// Libp2p service port range (port, range) (default: 37000).
-	#[serde(with = "port_range_format")]
-	pub libp2p_port: (u16, u16),
-	/// Configures LibP2P TCP port reuse for local sockets, which implies reuse of listening ports for outgoing connections to enhance NAT traversal capabilities (default: false)
-	pub libp2p_tcp_port_reuse: bool,
-	/// Configures LibP2P AutoNAT behaviour to reject probes as a server for clients that are observed at a non-global ip address (default: false)
-	pub libp2p_autonat_only_global_ips: bool,
-	/// Libp2p AutoNat throttle period for re-using a peer as server for a dial-request. (default: 1 sec)
-	pub libp2p_autonat_throttle: u64,
+	/// P2P service port (default: 37000).
+	pub port: u16,
+	/// Configures TCP port reuse for local sockets, which implies reuse of listening ports for outgoing connections to enhance NAT traversal capabilities (default: false)
+	pub tcp_port_reuse: bool,
+	/// Configures AutoNAT behaviour to reject probes as a server for clients that are observed at a non-global ip address (default: false)
+	pub autonat_only_global_ips: bool,
+	/// AutoNat throttle period for re-using a peer as server for a dial-request. (default: 1 sec)
+	pub autonat_throttle: u64,
 	/// Interval in which the NAT status should be re-tried if it is currently unknown or max confidence was not reached yet. (default: 10 sec)
-	pub libp2p_autonat_retry_interval: u64,
+	pub autonat_retry_interval: u64,
 	/// Interval in which the NAT should be tested again if max confidence was reached in a status. (default: 30 sec)
-	pub libp2p_autonat_refresh_interval: u64,
-	/// Libp2p AutoNat on init delay before starting the fist probe. (default: 5 sec)
-	pub libp2p_autonat_boot_delay: u64,
-	/// Sets libp2p application-specific version of the protocol family used by the peer. (default: "/avail_kad/id/1.0.0")
-	pub libp2p_identify_protocol: String,
-	/// Sets libp2p agent version that is sent to peers. (default: "avail-light-client/rust-client")
-	pub libp2p_identify_agent: String,
+	pub autonat_refresh_interval: u64,
+	/// AutoNat on init delay before starting the fist probe. (default: 5 sec)
+	pub autonat_boot_delay: u64,
+	/// Sets application-specific version of the protocol family used by the peer. (default: "/avail_kad/id/1.0.0")
+	pub identify_protocol: String,
+	/// Sets agent version that is sent to peers. (default: "avail-light-client/rust-client")
+	pub identify_agent: String,
 	/// Vector of Light Client bootstrap nodes, used to bootstrap DHT. If not set, light client acts as a bootstrap node, waiting for first peer to connect for DHT bootstrap (default: empty).
 	pub bootstraps: Vec<(String, Multiaddr)>,
 	/// Vector of Relay nodes, which are used for hole punching
@@ -342,7 +341,7 @@ impl From<&RuntimeConfig> for LightClientConfig {
 
 pub struct LibP2PConfig {
 	pub secret_key: Option<SecretKey>,
-	pub port: (u16, u16),
+	pub port: u16,
 	pub identify: IdentifyConfig,
 	pub autonat: AutoNATConfig,
 	pub kademlia: KademliaConfig,
@@ -361,7 +360,7 @@ impl From<&RuntimeConfig> for LibP2PConfig {
 
 		Self {
 			secret_key: val.secret_key.clone(),
-			port: val.libp2p_port,
+			port: val.port,
 			identify: val.into(),
 			autonat: val.into(),
 			kademlia: val.into(),
@@ -420,11 +419,11 @@ pub struct AutoNATConfig {
 impl From<&RuntimeConfig> for AutoNATConfig {
 	fn from(val: &RuntimeConfig) -> Self {
 		Self {
-			retry_interval: Duration::from_secs(val.libp2p_autonat_retry_interval),
-			refresh_interval: Duration::from_secs(val.libp2p_autonat_refresh_interval),
-			boot_delay: Duration::from_secs(val.libp2p_autonat_boot_delay),
-			throttle_server_period: Duration::from_secs(val.libp2p_autonat_throttle),
-			only_global_ips: val.libp2p_autonat_only_global_ips,
+			retry_interval: Duration::from_secs(val.autonat_retry_interval),
+			refresh_interval: Duration::from_secs(val.autonat_refresh_interval),
+			boot_delay: Duration::from_secs(val.autonat_boot_delay),
+			throttle_server_period: Duration::from_secs(val.autonat_throttle),
+			only_global_ips: val.autonat_only_global_ips,
 		}
 	}
 }
@@ -437,8 +436,8 @@ pub struct IdentifyConfig {
 impl From<&RuntimeConfig> for IdentifyConfig {
 	fn from(val: &RuntimeConfig) -> Self {
 		Self {
-			agent_version: val.libp2p_identify_agent.clone(),
-			protocol_version: val.libp2p_identify_protocol.clone(),
+			agent_version: val.identify_agent.clone(),
+			protocol_version: val.identify_protocol.clone(),
 		}
 	}
 }
@@ -485,21 +484,21 @@ impl Default for RuntimeConfig {
 		RuntimeConfig {
 			http_server_host: "127.0.0.1".to_owned(),
 			http_server_port: (7000, 0),
-			libp2p_port: (37000, 0),
+			port: 37000,
 			secret_key: None,
-			libp2p_tcp_port_reuse: false,
-			libp2p_autonat_only_global_ips: false,
-			libp2p_autonat_refresh_interval: 30,
-			libp2p_autonat_retry_interval: 10,
-			libp2p_autonat_throttle: 1,
-			libp2p_autonat_boot_delay: 5,
-			libp2p_identify_protocol: "/avail_kad/id/1.0.0".to_string(),
-			libp2p_identify_agent: "avail-light-client/rust-client".to_string(),
+			tcp_port_reuse: false,
+			autonat_only_global_ips: false,
+			autonat_refresh_interval: 30,
+			autonat_retry_interval: 10,
+			autonat_throttle: 1,
+			autonat_boot_delay: 5,
+			identify_protocol: "/avail_kad/id/1.0.0".to_string(),
+			identify_agent: "avail-light-client/rust-client".to_string(),
+			bootstraps: Vec::new(),
+			relays: Vec::new(),
 			full_node_ws: vec!["ws://127.0.0.1:9944".to_owned()],
 			app_id: None,
 			confidence: 92.0,
-			bootstraps: Vec::new(),
-			relays: Vec::new(),
 			avail_path: "avail_path".to_owned(),
 			log_level: "INFO".to_owned(),
 			log_format_json: false,