[pr] Rename Config and add link to docs

Author: ppodolsky

iroh-gateway/src/bad_bits.rs

@@ -112,7 +112,7 @@ mod tests {
     use hex_literal::hex;
     use http::StatusCode;
     use iroh_resolver::content_loader::{FullLoader, FullLoaderConfig, GatewayUrl};
-    use iroh_resolver::dns_resolver::DnsResolverConfig;
+    use iroh_resolver::dns_resolver::Config as DnsResolverConfig;
     use iroh_rpc_client::{Client as RpcClient, Config as RpcClientConfig};
 
     #[tokio::test]

iroh-gateway/src/client.rs

@@ -13,7 +13,7 @@ use iroh_metrics::{
     gateway::{GatewayHistograms, GatewayMetrics},
     observe, record,
 };
-use iroh_resolver::dns_resolver::DnsResolverConfig;
+use iroh_resolver::dns_resolver::Config;
 use iroh_resolver::{
     content_loader::ContentLoader,
     resolver::{
@@ -91,7 +91,7 @@ impl<T: ContentLoader + std::marker::Unpin> http_body::Body for PrettyStreamBody
 }
 
 impl<T: ContentLoader + std::marker::Unpin> Client<T> {
-    pub fn new(rpc_client: &T, dns_resolver_config: DnsResolverConfig) -> Self {
+    pub fn new(rpc_client: &T, dns_resolver_config: Config) -> Self {
         Self {
             resolver: Resolver::with_dns_resolver(rpc_client.clone(), dns_resolver_config),
         }

iroh-gateway/src/config.rs

@@ -6,7 +6,7 @@ use headers::{
     AccessControlAllowHeaders, AccessControlAllowMethods, AccessControlAllowOrigin, HeaderMapExt,
 };
 use iroh_metrics::config::Config as MetricsConfig;
-use iroh_resolver::dns_resolver::DnsResolverConfig;
+use iroh_resolver::dns_resolver::Config as DnsResolverConfig;
 use iroh_rpc_client::Config as RpcClientConfig;
 use iroh_rpc_types::{gateway::GatewayServerAddr, Addr};
 use iroh_util::insert_into_config_map;

iroh-gateway/src/core.rs

@@ -2,7 +2,7 @@ use axum::Router;
 use iroh_resolver::content_loader::ContentLoader;
 use iroh_rpc_types::gateway::GatewayServerAddr;
 
-use iroh_resolver::dns_resolver::DnsResolverConfig;
+use iroh_resolver::dns_resolver::Config as DnsResolverConfig;
 use std::{collections::HashMap, sync::Arc};
 use tokio::sync::RwLock;
 

iroh-resolver/src/dns_resolver.rs

@@ -7,22 +7,23 @@ use trust_dns_resolver::config::{NameServerConfigGroup, ResolverConfig, Resolver
 use trust_dns_resolver::{AsyncResolver, TokioAsyncResolver};
 
 #[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
-pub struct DnsResolverConfig {
+pub struct Config {
     /// Mapping from TLD to the specific instance of resolver
     tld_resolvers: Option<HashMap<String, ResolverConfig>>,
 }
 
-impl DnsResolverConfig {
+impl Config {
     pub fn empty() -> Self {
-        DnsResolverConfig {
+        Config {
             tld_resolvers: None,
         }
     }
 }
 
-impl Default for DnsResolverConfig {
+impl Default for Config {
     fn default() -> Self {
-        DnsResolverConfig {
+        Config {
+            /// Documentation on .eth TLD lives on https://eth.link/
             tld_resolvers: Some(HashMap::from_iter(vec![(
                 "eth".to_string(),
                 ResolverConfig::from_parts(
@@ -51,7 +52,7 @@ pub struct DnsResolver {
 
 impl DnsResolver {
     /// Creates resolver from its config
-    pub fn from_config(dns_resolver_config: DnsResolverConfig) -> DnsResolver {
+    pub fn from_config(dns_resolver_config: Config) -> DnsResolver {
         let tld_resolvers = dns_resolver_config
             .tld_resolvers
             .map(|dns_resolver_config| {
@@ -107,7 +108,7 @@ impl DnsResolver {
 
 impl Default for DnsResolver {
     fn default() -> Self {
-        DnsResolver::from_config(DnsResolverConfig::default())
+        DnsResolver::from_config(Config::default())
     }
 }
 

iroh-resolver/src/resolver.rs

@@ -23,7 +23,7 @@ use tokio::sync::Mutex;
 use tokio::task::JoinHandle;
 use tracing::{debug, trace, warn};
 
-use crate::dns_resolver::{DnsResolver, DnsResolverConfig};
+use crate::dns_resolver::{Config, DnsResolver};
 
 use iroh_metrics::{
     core::{MObserver, MRecorder},
@@ -737,10 +737,10 @@ struct InnerLoaderContext {
 
 impl<T: ContentLoader> Resolver<T> {
     pub fn new(loader: T) -> Self {
-        Self::with_dns_resolver(loader, DnsResolverConfig::default())
+        Self::with_dns_resolver(loader, Config::default())
     }
 
-    pub fn with_dns_resolver(loader: T, dns_resolver_config: DnsResolverConfig) -> Self {
+    pub fn with_dns_resolver(loader: T, dns_resolver_config: Config) -> Self {
         let (session_closer_s, session_closer_r) = async_channel::bounded(2048);
         let loader_thread = loader.clone();
         let worker = tokio::task::spawn(async move {