reorganize utils/mod.rs into separate utils/db.rs and utils/distance.rs files (#144)

Author: oslfmt

ethportal-peertest/src/main.rs

@@ -17,7 +17,7 @@ use trin_core::portalnet::{
     utp::UtpListener,
     Enr, U256,
 };
-use trin_core::utils::setup_overlay_db;
+use trin_core::utils::db::setup_overlay_db;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {

src/main.rs

@@ -13,7 +13,7 @@ use trin_core::{
     cli::{TrinConfig, HISTORY_NETWORK, STATE_NETWORK},
     jsonrpc::service::launch_jsonrpc_server,
     portalnet::{discovery::Discovery, types::PortalnetConfig},
-    utils::setup_overlay_db,
+    utils::db::setup_overlay_db,
 };
 use trin_history::initialize_history_network;
 use trin_state::initialize_state_network;

trin-core/src/bin/generate-data.rs

@@ -7,7 +7,7 @@ use std::sync::Arc;
 use structopt::StructOpt;
 use trin_core::portalnet::storage::{DistanceFunction, PortalStorage, PortalStorageConfig};
 use trin_core::portalnet::U256;
-use trin_core::utils::get_data_dir;
+use trin_core::utils::db::get_data_dir;
 
 // For every 1 kb of data we store (key + value), RocksDB tends to grow by this many kb on disk...
 // ...but this is a crude empirical estimation that works mainly with default value data size of 32

trin-core/src/portalnet/overlay.rs

@@ -1,5 +1,5 @@
 use crate::locks::RwLoggingExt;
-use crate::utils::xor_two_values;
+use crate::utils::distance::xor_two_values;
 
 use super::{
     discovery::Discovery,

trin-core/src/portalnet/storage.rs

@@ -1,5 +1,5 @@
 use super::U256;
-use crate::utils::{get_data_dir, xor_two_values};
+use crate::utils::{db::get_data_dir, distance::xor_two_values};
 use discv5::enr::NodeId;
 use hex;
 use log;

trin-core/src/utils/db.rs

@@ -0,0 +1,38 @@
+use std::{env, fs};
+
+use directories::ProjectDirs;
+use discv5::enr::NodeId;
+use rocksdb::{Options, DB};
+
+const TRIN_DATA_ENV_VAR: &str = "TRIN_DATA_PATH";
+
+pub fn get_data_dir(node_id: NodeId) -> String {
+    let path = env::var(TRIN_DATA_ENV_VAR).unwrap_or_else(|_| get_default_data_dir(node_id));
+
+    fs::create_dir_all(&path).expect("Unable to create data directory folder");
+    path
+}
+
+pub fn get_default_data_dir(node_id: NodeId) -> String {
+    // Windows: C:\Users\Username\AppData\Roaming\Trin\data
+    // macOS: ~/Library/Application Support/Trin
+    // Unix-like: $HOME/.local/share/trin
+
+    // Append first 8 characters of Node ID
+    let mut application_string = "Trin_".to_owned();
+    let node_id_string = hex::encode(node_id.raw());
+    let suffix = &node_id_string[..8];
+    application_string.push_str(suffix);
+
+    match ProjectDirs::from("", "", &application_string) {
+        Some(proj_dirs) => proj_dirs.data_local_dir().to_str().unwrap().to_string(),
+        None => panic!("Unable to find data directory"),
+    }
+}
+
+pub fn setup_overlay_db(node_id: NodeId) -> DB {
+    let data_path = get_data_dir(node_id);
+    let mut db_opts = Options::default();
+    db_opts.create_if_missing(true);
+    DB::open(&db_opts, data_path).unwrap()
+}

trin-core/src/utils/distance.rs

@@ -0,0 +1,38 @@
+pub fn xor_two_values(first: &[u8], second: &[u8]) -> Vec<u8> {
+    if first.len() != second.len() {
+        panic!("Can only xor vectors of equal length.")
+    };
+
+    first
+        .iter()
+        .zip(&mut second.iter())
+        .map(|(&first, &second)| first ^ second)
+        .collect()
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn test_xor_two_zeros() {
+        let one = vec![0];
+        let two = vec![0];
+        assert_eq!(xor_two_values(&one, &two), [0]);
+    }
+
+    #[test]
+    fn test_xor_two_values() {
+        let one = vec![1, 0, 0];
+        let two = vec![0, 0, 1];
+        assert_eq!(xor_two_values(&one, &two), [1, 0, 1]);
+    }
+
+    #[test]
+    #[should_panic(expected = "Can only xor vectors of equal length.")]
+    fn test_xor_panics_with_different_lengths() {
+        let one = vec![1, 0];
+        let two = vec![0, 0, 1];
+        xor_two_values(&one, &two);
+    }
+}

trin-core/src/utils/mod.rs

@@ -1,78 +1,3 @@
-use directories::ProjectDirs;
-use discv5::enr::NodeId;
-use rocksdb::{Options, DB};
-use std::{env, fs};
-
+pub mod db;
+pub mod distance;
 pub mod hash_delay_queue;
-
-const TRIN_DATA_ENV_VAR: &str = "TRIN_DATA_PATH";
-
-pub fn xor_two_values(first: &[u8], second: &[u8]) -> Vec<u8> {
-    if first.len() != second.len() {
-        panic!("Can only xor vectors of equal length.")
-    };
-
-    first
-        .iter()
-        .zip(&mut second.iter())
-        .map(|(&first, &second)| first ^ second)
-        .collect()
-}
-
-pub fn get_data_dir(node_id: NodeId) -> String {
-    let path = env::var(TRIN_DATA_ENV_VAR).unwrap_or_else(|_| get_default_data_dir(node_id));
-
-    fs::create_dir_all(&path).expect("Unable to create data directory folder");
-    path
-}
-
-pub fn get_default_data_dir(node_id: NodeId) -> String {
-    // Windows: C:\Users\Username\AppData\Roaming\Trin\data
-    // macOS: ~/Library/Application Support/Trin
-    // Unix-like: $HOME/.local/share/trin
-
-    // Append first 8 characters of Node ID
-    let mut application_string = "Trin_".to_owned();
-    let node_id_string = hex::encode(node_id.raw());
-    let suffix = &node_id_string[..8];
-    application_string.push_str(suffix);
-
-    match ProjectDirs::from("", "", &application_string) {
-        Some(proj_dirs) => proj_dirs.data_local_dir().to_str().unwrap().to_string(),
-        None => panic!("Unable to find data directory"),
-    }
-}
-
-pub fn setup_overlay_db(node_id: NodeId) -> DB {
-    let data_path = get_data_dir(node_id);
-    let mut db_opts = Options::default();
-    db_opts.create_if_missing(true);
-    DB::open(&db_opts, data_path).unwrap()
-}
-
-#[cfg(test)]
-mod test {
-    use super::*;
-
-    #[test]
-    fn test_xor_two_zeros() {
-        let one = vec![0];
-        let two = vec![0];
-        assert_eq!(xor_two_values(&one, &two), [0]);
-    }
-
-    #[test]
-    fn test_xor_two_values() {
-        let one = vec![1, 0, 0];
-        let two = vec![0, 0, 1];
-        assert_eq!(xor_two_values(&one, &two), [1, 0, 1]);
-    }
-
-    #[test]
-    #[should_panic(expected = "Can only xor vectors of equal length.")]
-    fn test_xor_panics_with_different_lengths() {
-        let one = vec![1, 0];
-        let two = vec![0, 0, 1];
-        xor_two_values(&one, &two);
-    }
-}

trin-history/src/lib.rs

@@ -17,7 +17,7 @@ use trin_core::jsonrpc::types::HistoryJsonRpcRequest;
 use trin_core::portalnet::discovery::Discovery;
 use trin_core::portalnet::events::PortalnetEvents;
 use trin_core::portalnet::types::PortalnetConfig;
-use trin_core::utils::setup_overlay_db;
+use trin_core::utils::db::setup_overlay_db;
 
 pub async fn main() -> Result<(), Box<dyn std::error::Error>> {
     println!("Launching trin-history...");

trin-state/src/lib.rs

@@ -14,7 +14,7 @@ use trin_core::locks::RwLoggingExt;
 use trin_core::portalnet::discovery::Discovery;
 use trin_core::portalnet::events::PortalnetEvents;
 use trin_core::portalnet::types::PortalnetConfig;
-use trin_core::utils::setup_overlay_db;
+use trin_core::utils::db::setup_overlay_db;
 
 pub mod events;
 mod jsonrpc;