add comments + fmt

Author: Boog900

binaries/cuprated/src/config.rs

@@ -42,9 +42,8 @@ mod tracing_config;
 mod macros;
 mod default;
 
-pub use crate::config::p2p::p2p_port;
 use fs::FileSystemConfig;
-use p2p::P2PConfig;
+pub use p2p::{p2p_port, P2PConfig};
 use rayon::RayonConfig;
 pub use rpc::{restricted_rpc_port, unrestricted_rpc_port, RpcConfig};
 pub use storage::{StorageConfig, TxpoolConfig};

binaries/cuprated/src/config/default.rs

@@ -1,5 +1,12 @@
 use serde::{Deserialize, Serialize};
 
+/// An enum that can be either a default value or a custom value.
+///
+/// Useful when config value's defaults depend on other values, i.e. the default ports to listen on
+/// depend on the network chosen.
+///
+/// The [`DefaultOrCustom::Default`] variant will be serialised as a string: "Default",
+/// [`DefaultOrCustom::Custom`] will just use the serialisation of the inner value.
 #[derive(Copy, Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
 pub enum DefaultOrCustom<T> {
     Default,

binaries/cuprated/src/config/p2p.rs

@@ -21,10 +21,10 @@ use cuprate_p2p_core::{
 use cuprate_p2p_transport::{Arti, ArtiClientConfig, ArtiServerConfig};
 use cuprate_wire::OnionAddr;
 
-use super::macros::config_struct;
-use crate::config::default::DefaultOrCustom;
 use crate::{p2p::ProxySettings, tor::TorMode};
 
+use super::{default::DefaultOrCustom, macros::config_struct};
+
 config_struct! {
     /// P2P config.
     #[derive(Debug, Default, Deserialize, Serialize, PartialEq)]
@@ -259,6 +259,7 @@ config_struct! {
     }
 }
 
+/// Gets the port to listen on for p2p connections.
 pub const fn p2p_port(setting: DefaultOrCustom<u16>, network: Network) -> u16 {
     match setting {
         DefaultOrCustom::Default => match network {
@@ -271,7 +272,8 @@ pub const fn p2p_port(setting: DefaultOrCustom<u16>, network: Network) -> u16 {
 }
 
 impl ClearNetConfig {
-    pub fn tor_transport_config(&self, network: Network) -> TransportConfig<ClearNet, Tcp> {
+    /// Gets the transport config for [`ClearNet`] over [`Tcp`].
+    pub fn tcp_transport_config(&self, network: Network) -> TransportConfig<ClearNet, Tcp> {
         let server_config = if self.enable_inbound {
             let mut sc = TcpServerConfig::default();
             sc.ipv4 = Some(self.listen_on);

binaries/cuprated/src/config/rpc.rs

@@ -1,13 +1,14 @@
-use crate::config::default::DefaultOrCustom;
-use crate::config::macros::config_struct;
-use cuprate_helper::network::Network;
-use serde::{Deserialize, Serialize};
-use std::net::IpAddr;
 use std::{
-    net::{Ipv4Addr, SocketAddr, SocketAddrV4},
+    net::{IpAddr, Ipv4Addr, SocketAddr, SocketAddrV4},
     time::Duration,
 };
 
+use serde::{Deserialize, Serialize};
+
+use cuprate_helper::network::Network;
+
+use super::{default::DefaultOrCustom, macros::config_struct};
+
 config_struct! {
     /// RPC config.
     #[derive(Clone, Debug, Default, Deserialize, Serialize, PartialEq, Eq)]
@@ -28,14 +29,14 @@ config_struct! {
         /// The address the RPC server will listen on.
         ///
         /// Type     | IPv4/IPv6 address
-        /// Examples | "", "127.0.0.1:18081", "192.168.1.50:18085"
+        /// Examples | "", "127.0.0.1", "192.168.1.50"
         pub address: IpAddr,
 
         /// The port the RPC server will listen on.
         ///
         /// Type         | Number
         /// Valid values | 0..65534
-        /// Examples     | 18080, 9999, 5432
+        /// Examples     | 18081, 18089, 5432
         pub port: DefaultOrCustom<u16>,
 
         /// Toggle the RPC server.
@@ -118,6 +119,7 @@ impl Default for RestrictedRpcConfig {
     }
 }
 
+/// Gets the port to listen on for restricted RPC connections.
 pub const fn restricted_rpc_port(config: DefaultOrCustom<u16>, network: Network) -> u16 {
     match config {
         DefaultOrCustom::Default => match network {
@@ -129,6 +131,7 @@ pub const fn restricted_rpc_port(config: DefaultOrCustom<u16>, network: Network)
     }
 }
 
+/// Gets the port to listen on for unrestricted RPC connections.
 pub const fn unrestricted_rpc_port(config: DefaultOrCustom<u16>, network: Network) -> u16 {
     match config {
         DefaultOrCustom::Default => match network {

binaries/cuprated/src/p2p.rs

@@ -110,7 +110,7 @@ pub async fn initialize_zones_p2p(
                     context_svc.clone(),
                     txpool_read_handle.clone(),
                     config.clearnet_p2p_config(),
-                    config.p2p.clear_net.tor_transport_config(config.network),
+                    config.p2p.clear_net.tcp_transport_config(config.network),
                 )
                 .await
                 .unwrap()

binaries/cuprated/src/rpc/server.rs

@@ -17,9 +17,8 @@ use cuprate_helper::network::Network;
 use cuprate_rpc_interface::{RouterBuilder, RpcHandler};
 use cuprate_txpool::service::TxpoolReadHandle;
 
-use crate::config::{restricted_rpc_port, unrestricted_rpc_port};
 use crate::{
-    config::RpcConfig,
+    config::{restricted_rpc_port, unrestricted_rpc_port, RpcConfig},
     rpc::{rpc_handler::BlockchainManagerHandle, CupratedRpcHandler},
     txpool::IncomingTxHandler,
 };

binaries/cuprated/src/tor.rs

@@ -25,8 +25,10 @@ use cuprate_p2p_transport::{
 };
 use cuprate_wire::OnionAddr;
 
-use crate::config::p2p_port;
-use crate::{config::Config, p2p::ProxySettings};
+use crate::{
+    config::{p2p_port, Config},
+    p2p::ProxySettings,
+};
 //---------------------------------------------------------------------------------------------------- Initialization
 
 #[derive(Clone, Default, Debug, Copy, PartialEq, Eq, Serialize, Deserialize)]