add a notion of home directory

Author: ma2bd

linera-client/src/client_options.rs

@@ -42,19 +42,25 @@ util::impl_from_infallible!(Error);
 
 #[derive(Clone, clap::Parser)]
 pub struct ClientContextOptions {
-    /// Sets the file storing the private state of user chains (an empty one will be created if missing)
+    /// DEPRECATED: Use --with-wallet=NAME instead. Sets the file
+    /// storing the private state of user chains (an empty one will be created if missing)
     #[arg(long = "wallet")]
     pub wallet_state_path: Option<PathBuf>,
 
-    /// Sets the file storing the keystore state.
+    /// DEPRECATED: Use --with-wallet=NAME instead. Sets the file
+    /// storing the keystore state.
     #[arg(long = "keystore")]
     pub keystore_path: Option<PathBuf>,
 
-    /// Given an ASCII alphanumeric parameter `X`, read the wallet state and the wallet
-    /// storage config from the environment variables `LINERA_WALLET_{X}` and
-    /// `LINERA_STORAGE_{X}` instead of `LINERA_WALLET` and
-    /// `LINERA_STORAGE`.
-    #[arg(long, short = 'w', value_parser = util::parse_ascii_alphanumeric_string)]
+    /// Sets the home directory for storing Linera wallets. Alternatively, one may set the
+    /// environment variable LINERA_HOME.
+    #[arg(long, env = "LINERA_HOME")]
+    pub home_directory: Option<PathBuf>,
+
+    /// Name of the wallet to be used. Data will be stored in the corresponding
+    /// subdirectory of the home directory -- unless other (deprecated) options are
+    /// used.
+    #[arg(long, short = 'w', value_name = "NAME", value_parser = util::parse_ascii_alphanumeric_string)]
     pub with_wallet: Option<String>,
 
     /// Timeout for sending queries (milliseconds)

linera-service/src/cli/main.rs

@@ -1767,17 +1767,21 @@ impl ClientOptions {
             .unwrap_or_default()
     }
 
-    fn config_path() -> Result<PathBuf, Error> {
-        let mut config_dir = dirs::config_dir().ok_or_else(|| anyhow!(
+    fn config_path(&self, file: &str) -> Result<PathBuf, Error> {
+        let mut path = self.context_options.home_directory.clone().or_else(dirs::config_dir).ok_or_else(|| anyhow!(
             "Default wallet directory is not supported in this platform: please specify storage and wallet paths"
         ))?;
-        config_dir.push("linera");
-        if !config_dir.exists() {
-            debug!("Creating default wallet directory {}", config_dir.display());
-            fs_err::create_dir_all(&config_dir)?;
+        path.push("linera");
+        if let Some(name) = &self.context_options.with_wallet {
+            path.push(name);
         }
-        info!("Using default wallet directory {}", config_dir.display());
-        Ok(config_dir)
+        if !path.exists() {
+            debug!("Creating default wallet directory {}", path.display());
+            fs_err::create_dir_all(&path)?;
+        }
+        path.push(file);
+        info!("Using wallet path {}", path.display());
+        Ok(path)
     }
 
     fn storage_config(&self) -> Result<StorageConfig, Error> {
@@ -1787,14 +1791,15 @@ impl ClientOptions {
         let suffix = self.suffix();
         let storage_env_var = env::var(format!("LINERA_STORAGE{suffix}")).ok();
         if let Some(config) = storage_env_var {
+            warn!("LINERA_STORAGE_* is deprecated. Use --with-wallet=NAME or --storage=CONFIG instead.");
             return config.parse();
         }
         cfg_if::cfg_if! {
             if #[cfg(feature = "rocksdb")] {
                 let spawn_mode =
                     linera_views::rocks_db::RocksDbSpawnMode::get_spawn_mode_from_runtime();
                 let inner_storage_config = linera_service::storage::InnerStorageConfig::RocksDb {
-                    path: Self::config_path()?.join("wallet.db"),
+                    path: self.config_path("wallet.db")?,
                     spawn_mode,
                 };
                 let namespace = "default".to_string();
@@ -1810,28 +1815,30 @@ impl ClientOptions {
 
     fn wallet_path(&self) -> Result<PathBuf, Error> {
         if let Some(path) = &self.context_options.wallet_state_path {
+            warn!("Option --wallet is deprecated. Use --with-wallet=NAME instead.");
             return Ok(path.clone());
         }
         let suffix = self.suffix();
         let wallet_env_var = env::var(format!("LINERA_WALLET{suffix}")).ok();
         if let Some(path) = wallet_env_var {
+            warn!("LINERA_WALLET_* is deprecated. Use --with-wallet=NAME instead.");
             return Ok(path.parse()?);
         }
-        let config_path = Self::config_path()?;
-        Ok(config_path.join("wallet.json"))
+        self.config_path("wallet.json")
     }
 
     fn keystore_path(&self) -> Result<PathBuf, Error> {
         if let Some(path) = &self.context_options.keystore_path {
+            warn!("Option --keystore is deprecated. Use --with-wallet=NAME instead.");
             return Ok(path.clone());
         }
         let suffix = self.suffix();
         let keystore_env_var = env::var(format!("LINERA_KEYSTORE{suffix}")).ok();
         if let Some(path) = keystore_env_var {
+            warn!("LINERA_KEYSTORE_* is deprecated. Use --with-wallet=NAME instead.");
             return Ok(path.parse()?);
         }
-        let config_path = Self::config_path()?;
-        Ok(config_path.join("keystore.json"))
+        self.config_path("keystore.json")
     }
 
     pub fn create_wallet(