ows-core 1.2.1

Core types and traits for the Open Wallet Standard
Documentation
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::path::PathBuf;

/// Backup configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BackupConfig {
    pub path: PathBuf,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub auto_backup: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_backups: Option<u32>,
}

/// Application configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Config {
    pub vault_path: PathBuf,
    #[serde(default)]
    pub rpc: HashMap<String, String>,
    #[serde(default)]
    pub plugins: HashMap<String, serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub backup: Option<BackupConfig>,
}

impl Config {
    /// Returns the built-in default RPC endpoints for well-known chains.
    pub fn default_rpc() -> HashMap<String, String> {
        let mut rpc = HashMap::new();
        rpc.insert("eip155:1".into(), "https://eth.llamarpc.com".into());
        rpc.insert("eip155:137".into(), "https://polygon-rpc.com".into());
        rpc.insert("eip155:42161".into(), "https://arb1.arbitrum.io/rpc".into());
        rpc.insert("eip155:10".into(), "https://mainnet.optimism.io".into());
        rpc.insert("eip155:8453".into(), "https://mainnet.base.org".into());
        rpc.insert("eip155:9745".into(), "https://rpc.plasma.to".into());
        rpc.insert(
            "eip155:56".into(),
            "https://bsc-dataseed.binance.org".into(),
        );
        rpc.insert(
            "eip155:43114".into(),
            "https://api.avax.network/ext/bc/C/rpc".into(),
        );
        rpc.insert(
            "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp".into(),
            "https://api.mainnet-beta.solana.com".into(),
        );
        rpc.insert(
            "bip122:000000000019d6689c085ae165831e93".into(),
            "https://mempool.space/api".into(),
        );
        rpc.insert(
            "cosmos:cosmoshub-4".into(),
            "https://cosmos-rest.publicnode.com".into(),
        );
        rpc.insert("tron:mainnet".into(), "https://api.trongrid.io".into());
        rpc.insert("ton:mainnet".into(), "https://toncenter.com/api/v2".into());
        rpc.insert(
            "fil:mainnet".into(),
            "https://api.node.glif.io/rpc/v1".into(),
        );
        rpc.insert(
            "sui:mainnet".into(),
            "https://fullnode.mainnet.sui.io:443".into(),
        );
        rpc.insert("xrpl:mainnet".into(), "https://s1.ripple.com:51234".into());
        rpc.insert(
            "xrpl:testnet".into(),
            "https://s.altnet.rippletest.net:51234".into(),
        );
        rpc.insert(
            "xrpl:devnet".into(),
            "https://s.devnet.rippletest.net:51234".into(),
        );
        rpc
    }
}

impl Default for Config {
    fn default() -> Self {
        let home = std::env::var("HOME").unwrap_or_else(|_| "/tmp".to_string());
        Config {
            vault_path: PathBuf::from(home).join(".ows"),
            rpc: Self::default_rpc(),
            plugins: HashMap::new(),
            backup: None,
        }
    }
}

impl Config {
    /// Look up an RPC URL by chain identifier.
    pub fn rpc_url(&self, chain: &str) -> Option<&str> {
        self.rpc.get(chain).map(|s| s.as_str())
    }

    /// Load config from a file path, or return defaults if file doesn't exist.
    pub fn load(path: &std::path::Path) -> Result<Self, crate::error::OwsError> {
        if !path.exists() {
            return Ok(Config::default());
        }
        let contents =
            std::fs::read_to_string(path).map_err(|e| crate::error::OwsError::InvalidInput {
                message: format!("failed to read config: {}", e),
            })?;
        serde_json::from_str(&contents).map_err(|e| crate::error::OwsError::InvalidInput {
            message: format!("failed to parse config: {}", e),
        })
    }

    /// Load `~/.ows/config.json`, merging user overrides on top of defaults.
    /// If the file doesn't exist, returns the built-in defaults.
    pub fn load_or_default() -> Self {
        let home = std::env::var("HOME").unwrap_or_else(|_| "/tmp".to_string());
        let config_path = PathBuf::from(home).join(".ows/config.json");
        Self::load_or_default_from(&config_path)
    }

    /// Load config from a specific path, merging user overrides on top of defaults.
    pub fn load_or_default_from(path: &std::path::Path) -> Self {
        let mut config = Config::default();
        if path.exists() {
            if let Ok(contents) = std::fs::read_to_string(path) {
                if let Ok(user_config) = serde_json::from_str::<Config>(&contents) {
                    // User overrides take priority
                    for (k, v) in user_config.rpc {
                        config.rpc.insert(k, v);
                    }
                    config.plugins = user_config.plugins;
                    config.backup = user_config.backup;
                    if user_config.vault_path.as_path() != std::path::Path::new("/tmp/.ows")
                        && user_config.vault_path.to_string_lossy() != ""
                    {
                        config.vault_path = user_config.vault_path;
                    }
                }
            }
        }
        config
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_default_vault_path() {
        let config = Config::default();
        let path_str = config.vault_path.to_string_lossy();
        assert!(path_str.ends_with(".ows"));
    }

    #[test]
    fn test_serde_roundtrip() {
        let mut rpc = HashMap::new();
        rpc.insert(
            "eip155:1".to_string(),
            "https://eth.rpc.example".to_string(),
        );

        let config = Config {
            vault_path: PathBuf::from("/home/test/.ows"),
            rpc,
            plugins: HashMap::new(),
            backup: None,
        };
        let json = serde_json::to_string(&config).unwrap();
        let config2: Config = serde_json::from_str(&json).unwrap();
        assert_eq!(config.vault_path, config2.vault_path);
        assert_eq!(config.rpc, config2.rpc);
    }

    #[test]
    fn test_rpc_lookup_hit() {
        let mut config = Config::default();
        config.rpc.insert(
            "eip155:1".to_string(),
            "https://eth.rpc.example".to_string(),
        );
        assert_eq!(config.rpc_url("eip155:1"), Some("https://eth.rpc.example"));
    }

    #[test]
    fn test_default_rpc_endpoints() {
        let config = Config::default();
        assert_eq!(config.rpc_url("eip155:1"), Some("https://eth.llamarpc.com"));
        assert_eq!(
            config.rpc_url("eip155:137"),
            Some("https://polygon-rpc.com")
        );
        assert_eq!(config.rpc_url("eip155:9745"), Some("https://rpc.plasma.to"));
        assert_eq!(
            config.rpc_url("solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp"),
            Some("https://api.mainnet-beta.solana.com")
        );
        assert_eq!(
            config.rpc_url("bip122:000000000019d6689c085ae165831e93"),
            Some("https://mempool.space/api")
        );
        assert_eq!(
            config.rpc_url("cosmos:cosmoshub-4"),
            Some("https://cosmos-rest.publicnode.com")
        );
        assert_eq!(
            config.rpc_url("tron:mainnet"),
            Some("https://api.trongrid.io")
        );
        assert_eq!(
            config.rpc_url("ton:mainnet"),
            Some("https://toncenter.com/api/v2")
        );
    }

    #[test]
    fn test_rpc_lookup_miss() {
        let config = Config::default();
        assert_eq!(config.rpc_url("eip155:999"), None);
    }

    #[test]
    fn test_optional_backup() {
        let config = Config::default();
        let json = serde_json::to_value(&config).unwrap();
        assert!(json.get("backup").is_none());
    }

    #[test]
    fn test_backup_config_serde() {
        let config = Config {
            vault_path: PathBuf::from("/tmp/.ows"),
            rpc: HashMap::new(),
            plugins: HashMap::new(),
            backup: Some(BackupConfig {
                path: PathBuf::from("/tmp/backup"),
                auto_backup: Some(true),
                max_backups: Some(5),
            }),
        };
        let json = serde_json::to_value(&config).unwrap();
        assert!(json.get("backup").is_some());
        assert_eq!(json["backup"]["auto_backup"], true);
    }

    #[test]
    fn test_load_nonexistent_returns_default() {
        let config = Config::load(std::path::Path::new("/nonexistent/path/config.json")).unwrap();
        assert!(config.vault_path.to_string_lossy().ends_with(".ows"));
    }

    #[test]
    fn test_load_or_default_nonexistent() {
        let config = Config::load_or_default_from(std::path::Path::new("/nonexistent/config.json"));
        // Should have all default RPCs
        assert_eq!(config.rpc.len(), 18);
        assert_eq!(config.rpc_url("eip155:1"), Some("https://eth.llamarpc.com"));
    }

    #[test]
    fn test_load_or_default_merges_overrides() {
        let dir = tempfile::tempdir().unwrap();
        let config_path = dir.path().join("config.json");
        let user_config = serde_json::json!({
            "vault_path": "/tmp/custom-vault",
            "rpc": {
                "eip155:1": "https://custom-eth.rpc",
                "eip155:11155111": "https://sepolia.rpc"
            }
        });
        std::fs::write(&config_path, serde_json::to_string(&user_config).unwrap()).unwrap();

        let config = Config::load_or_default_from(&config_path);
        // User override replaces default
        assert_eq!(config.rpc_url("eip155:1"), Some("https://custom-eth.rpc"));
        // User-added chain
        assert_eq!(
            config.rpc_url("eip155:11155111"),
            Some("https://sepolia.rpc")
        );
        // Defaults preserved
        assert_eq!(
            config.rpc_url("eip155:137"),
            Some("https://polygon-rpc.com")
        );
        // Custom vault path
        assert_eq!(config.vault_path, PathBuf::from("/tmp/custom-vault"));
    }
}