PR feedback + import ordering

Author: njgheorghita

newsfragments/331.added.md

@@ -0,0 +1 @@
+Initial HeaderOracle implementation.

src/main.rs

@@ -1,5 +1,4 @@
-use trin_core::cli::TrinConfig;
-use trin_core::utils::infura::build_infura_project_url_from_env;
+use trin_core::{cli::TrinConfig, utils::infura::build_infura_project_url_from_env};
 
 use trin::run_trin;
 

trin-core/src/portalnet/overlay.rs

@@ -1,6 +1,7 @@
 use anyhow::anyhow;
 use std::{
     collections::HashSet,
+    fmt::Debug,
     marker::{PhantomData, Sync},
     sync::Arc,
     time::Duration,
@@ -104,6 +105,8 @@ impl<
         TMetric: Metric + Send,
         TValidator: 'static + Validator<TContentKey> + Send,
     > OverlayProtocol<TContentKey, TMetric, TValidator>
+where
+    <TContentKey as TryFrom<Vec<u8>>>::Error: Debug,
 {
     pub async fn new(
         config: OverlayConfig,

trin-core/src/portalnet/overlay_service.rs

@@ -1,6 +1,7 @@
 use std::{
     collections::HashMap,
     fmt,
+    fmt::Debug,
     marker::{PhantomData, Sync},
     sync::Arc,
     task::Poll,
@@ -280,6 +281,8 @@ impl<
         TMetric: Metric + Send,
         TValidator: 'static + Validator<TContentKey> + Send,
     > OverlayService<TContentKey, TMetric, TValidator>
+where
+    <TContentKey as TryFrom<Vec<u8>>>::Error: Debug,
 {
     /// Spawns the overlay network service.
     ///
@@ -1003,32 +1006,31 @@ impl<
     async fn process_received_content(&mut self, content: ByteList, request: FindContent) {
         let content_key = match TContentKey::try_from(request.content_key) {
             Ok(val) => val,
-            Err(_) => {
-                error!("Unable to process received content: Invalid content key.");
+            Err(msg) => {
+                error!("Unable to process received content: Invalid content key: {msg:?}");
                 return;
             }
         };
-        match self
+        if let Err(err) = self
             .validator
             .validate_content(&content_key, &content)
             .await
         {
-            Ok(_) => (),
-            Err(msg) => {
-                error!("Unable to validate received content: {msg:?}");
-                return;
-            }
-        }
+            error!("Unable to validate received content: {err:?}");
+            return;
+        };
         match self.storage.read().should_store(&content_key) {
-            Ok(should_store) => match should_store {
-                true => match self.storage.write().store(&content_key, &content.into()) {
-                    Ok(_) => (),
-                    Err(msg) => error!("Content received, but not stored: {msg}"),
-                },
-                false => debug!(
-                    "Content received, but not stored: Content is already stored or its distance falls outside current radius."
-                ),
-            },
+            Ok(should_store) => {
+                if should_store {
+                    if let Err(err) = self.storage.write().store(&content_key, &content.into()) {
+                        error!("Content received, but not stored: {err}")
+                    }
+                } else {
+                    debug!(
+                        "Content received, but not stored: Content is already stored or its distance falls outside current radius."
+                    )
+                }
+            }
             Err(_) => {
                 error!("Content received, but not stored: Error communicating with db.");
             }

trin-core/src/types/validation.rs

@@ -2,15 +2,19 @@ use anyhow::anyhow;
 use async_trait::async_trait;
 use serde_json::{json, Value};
 
-use crate::jsonrpc::service::dispatch_infura_request;
-use crate::jsonrpc::types::{HistoryJsonRpcRequest, JsonRequest, Params};
-use crate::portalnet::types::content_key::IdentityContentKey;
-use crate::portalnet::types::messages::ByteList;
+use crate::{
+    jsonrpc::{
+        service::dispatch_infura_request,
+        types::{HistoryJsonRpcRequest, JsonRequest, Params},
+    },
+    portalnet::types::{content_key::IdentityContentKey, messages::ByteList},
+    utils::infura::INFURA_BASE_URL,
+};
 
 /// Responsible for dispatching cross-overlay-network requests
 /// for data to perform validation. Currently, it just proxies these requests
 /// on to infura.
-#[derive(Clone)]
+#[derive(Debug, Clone)]
 pub struct HeaderOracle {
     pub infura_url: String,
     // We could simply store the main portal jsonrpc tx channel here, rather than each
@@ -25,7 +29,7 @@ pub struct HeaderOracle {
 impl Default for HeaderOracle {
     fn default() -> Self {
         Self {
-            infura_url: "https://mainnet.infura.io:443/v3/".to_string(),
+            infura_url: INFURA_BASE_URL.to_string(),
             history_jsonrpc_tx: None,
             header_gossip_jsonrpc_tx: None,
             block_indices_jsonrpc_tx: None,

trin-core/src/utils/infura.rs

@@ -1,5 +1,7 @@
 use std::env;
 
+pub const INFURA_BASE_URL: &str = "https://mainnet.infura.io:443/v3/";
+
 pub fn build_infura_project_url_from_env() -> String {
     let infura_project_id = match env::var("TRIN_INFURA_PROJECT_ID") {
         Ok(val) => val,
@@ -9,5 +11,5 @@ pub fn build_infura_project_url_from_env() -> String {
         ),
     };
 
-    format!("https://mainnet.infura.io:443/v3/{}", infura_project_id)
+    format!("{}{}", INFURA_BASE_URL, infura_project_id)
 }

trin-history/src/lib.rs

@@ -8,8 +8,10 @@ use std::sync::{Arc, RwLock};
 use discv5::TalkRequest;
 use log::info;
 use network::HistoryNetwork;
-use tokio::sync::mpsc::UnboundedSender;
-use tokio::{sync::mpsc, task::JoinHandle};
+use tokio::{
+    sync::{mpsc, mpsc::UnboundedSender},
+    task::JoinHandle,
+};
 
 use crate::{events::HistoryEvents, jsonrpc::HistoryRequestHandler};
 use trin_core::{

trin-history/src/network.rs

@@ -1,7 +1,6 @@
 use anyhow::anyhow;
 use log::debug;
-use std::sync::Arc;
-use std::sync::RwLock as StdRwLock;
+use std::sync::{Arc, RwLock as StdRwLock};
 
 use parking_lot::RwLock;
 use tokio::sync::mpsc::UnboundedSender;

trin-history/src/validation.rs

@@ -4,10 +4,13 @@ use anyhow::anyhow;
 use async_trait::async_trait;
 use rlp::Rlp;
 
-use trin_core::portalnet::types::content_key::HistoryContentKey;
-use trin_core::portalnet::types::messages::ByteList;
-use trin_core::types::header::Header;
-use trin_core::types::validation::{HeaderOracle, Validator};
+use trin_core::{
+    portalnet::types::{content_key::HistoryContentKey, messages::ByteList},
+    types::{
+        header::Header,
+        validation::{HeaderOracle, Validator},
+    },
+};
 
 pub struct ChainHistoryValidator {
     pub header_oracle: Arc<RwLock<HeaderOracle>>,

trin-state/src/network.rs

@@ -21,8 +21,7 @@ use trin_core::{
     utp::stream::UtpListenerRequest,
 };
 
-use crate::trie::TrieDB;
-use crate::validation::StateValidator;
+use crate::{trie::TrieDB, validation::StateValidator};
 
 /// State network layer on top of the overlay protocol. Encapsulates state network specific data and logic.
 #[derive(Clone)]

trin-state/src/validation.rs

@@ -1,8 +1,9 @@
 use async_trait::async_trait;
 
-use trin_core::portalnet::types::content_key::StateContentKey;
-use trin_core::portalnet::types::messages::ByteList;
-use trin_core::types::validation::{HeaderOracle, Validator};
+use trin_core::{
+    portalnet::types::{content_key::StateContentKey, messages::ByteList},
+    types::validation::{HeaderOracle, Validator},
+};
 
 pub struct StateValidator {
     pub header_oracle: HeaderOracle,