Fix Forest when using a config file to run calibnet

CHANGELOG.md

@@ -29,10 +29,16 @@
 
 ### Changed
 
+- [#2796] (https://github.com/ChainSafe/forest/pull/2796): Remove ability to use
+  at the same time `--chain` and `--config` flags for forest binary.
+
 ### Removed
 
 ### Fixed
 
+- [#2796] (https://github.com/ChainSafe/forest/pull/2796): Fix issue when
+  running Forest on calibnet using a configuration file only.
+
 ## Forest v0.8.1 "Cold Exposure"
 
 ### Fixed

forest/shared/src/cli/config.rs

@@ -7,7 +7,7 @@ use std::{path::PathBuf, sync::Arc};
 use forest_chain_sync::SyncConfig;
 use forest_db::db_engine::DbConfig;
 use forest_libp2p::Libp2pConfig;
-use forest_networks::ChainConfig;
+use forest_networks::{ChainConfig, NetworkChain};
 use log::LevelFilter;
 use serde::{Deserialize, Serialize};
 use url::Url;
@@ -197,6 +197,18 @@ pub struct Config {
     pub tokio: TokioConfig,
 }
 
+impl Config {
+    pub fn from_chain(network_type: &NetworkChain) -> Self {
+        match network_type {
+            NetworkChain::Mainnet => Config::default(),
+            NetworkChain::Calibnet => Config {
+                chain: Arc::new(ChainConfig::calibnet()),
+                ..Config::default()
+            },
+        }
+    }
+}
+
 impl Config {
     cfg_if::cfg_if! {
         if #[cfg(feature = "rocksdb")] {

forest/shared/src/cli/mod.rs

@@ -8,14 +8,13 @@ mod snapshot_fetch;
 use std::{
     net::SocketAddr,
     path::{Path, PathBuf},
-    sync::Arc,
 };
 
 use ahash::HashSet;
 use byte_unit::Byte;
 use clap::Parser;
 use directories::ProjectDirs;
-use forest_networks::ChainConfig;
+use forest_networks::NetworkChain;
 use forest_utils::io::{read_file_to_string, read_toml, ProgressBarVisibility};
 use log::error;
 use num::BigInt;
@@ -39,7 +38,7 @@ OPTIONS:
 ";
 
 /// CLI options
-#[derive(Debug, Parser)]
+#[derive(Default, Debug, Parser)]
 pub struct CliOpts {
     /// A TOML file containing relevant configurations
     #[arg(short, long)]
@@ -98,7 +97,7 @@ pub struct CliOpts {
     pub encrypt_keystore: Option<bool>,
     /// Choose network chain to sync to
     #[arg(long)]
-    pub chain: Option<String>,
+    pub chain: Option<NetworkChain>,
     /// Daemonize Forest process
     #[arg(long)]
     pub detach: bool,
@@ -141,6 +140,10 @@ pub struct CliOpts {
 
 impl CliOpts {
     pub fn to_config(&self) -> Result<(Config, Option<ConfigPath>), anyhow::Error> {
+        if self.config.is_some() && self.chain.is_some() {
+            anyhow::bail!("Can't use a config file and chain flag at the same time!")
+        }
+
         let path = find_config_path(self);
         let mut cfg: Config = match &path {
             Some(path) => {
@@ -149,15 +152,16 @@ impl CliOpts {
                 // Parse and return the configuration file
                 read_toml(&toml)?
             }
-            None => Config::default(),
+            None => {
+                if let Some(chain) = &self.chain {
+                    Config::from_chain(chain)
+                } else {
+                    // Create the default `mainnet` configuration.
+                    Config::default()
+                }
+            }
         };
 
-        match &self.chain {
-            // override the chain configuration
-            Some(name) if name == "calibnet" => cfg.chain = Arc::new(ChainConfig::calibnet()),
-            _ => cfg.chain = Arc::new(ChainConfig::mainnet()),
-        }
-
         if let Some(genesis_file) = &self.genesis {
             cfg.client.genesis_file = Some(genesis_file.to_owned());
         }
@@ -425,4 +429,23 @@ mod tests {
             ]
         );
     }
+
+    #[test]
+    fn combination_of_following_flags_should_fail() {
+        // Check for --chain and --config
+        let options = CliOpts {
+            config: Some("config.toml".into()),
+            chain: Some(NetworkChain::Calibnet),
+            ..Default::default()
+        };
+        assert!(options.to_config().is_err());
+
+        // Check for --import_snapshot and --import_chain
+        let options = CliOpts {
+            import_snapshot: Some("snapshot.car".into()),
+            import_chain: Some("snapshot.car".into()),
+            ..Default::default()
+        };
+        assert!(options.to_config().is_err());
+    }
 }

forest/shared/src/logger/mod.rs

@@ -28,6 +28,12 @@ impl LoggingColor {
     }
 }
 
+impl Default for LoggingColor {
+    fn default() -> Self {
+        Self::Auto
+    }
+}
+
 impl FromStr for LoggingColor {
     type Err = anyhow::Error;
 

networks/src/lib.rs

@@ -1,8 +1,9 @@
 // Copyright 2019-2023 ChainSafe Systems
 // SPDX-License-Identifier: Apache-2.0, MIT
 
-use std::sync::Arc;
+use std::{str::FromStr, sync::Arc};
 
+use anyhow::Error;
 use cid::Cid;
 use fil_actors_runtime_v10::runtime::Policy;
 use forest_beacon::{BeaconPoint, BeaconSchedule, DrandBeacon, DrandConfig};
@@ -25,6 +26,26 @@ const CALIBNET_ETH_CHAIN_ID: u64 = 314159;
 /// Newest network version for all networks
 pub const NEWEST_NETWORK_VERSION: NetworkVersion = NetworkVersion::V17;
 
+/// The `filecoin` network chain. In general only `mainnet` and its chain
+/// information should be considered stable.
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum NetworkChain {
+    Mainnet,
+    Calibnet,
+}
+
+impl FromStr for NetworkChain {
+    type Err = Error;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "mainnet" => Ok(NetworkChain::Mainnet),
+            "calibnet" => Ok(NetworkChain::Calibnet),
+            name => Err(anyhow::anyhow!("unsupported network chain: {name}")),
+        }
+    }
+}
+
 /// Defines the meaningful heights of the protocol.
 #[derive(Debug, Display, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Hash)]
 pub enum Height {