Struct FireblocksConfig

Source

pub struct FireblocksConfig {
    pub api_key: String,
    pub url: String,
    pub secret_path: Option<PathBuf>,
    pub secret: Option<String>,
    pub display_config: DisplayConfig,
    pub signer: Signer,
    pub extra: HashMap<String, Value>,
    pub debug: bool,
    pub mainnet: bool,
}

Fields§

§api_key: String§url: String§secret_path: Option<PathBuf>§secret: Option<String>§display_config: DisplayConfig§signer: Signer§extra: HashMap<String, Value>

Arbitrary extra configuration values

§debug: bool

Enable debug mode

§mainnet: bool

Implementations§

Source §

impl FireblocksConfig

Source

pub fn get_extra<T, K>(&self, key: K) -> Result<T>
where T: DeserializeOwned, K: AsRef<str>,

Get an extra configuration value as any deserializable type

Source

pub fn get_extra_duration<K>(&self, key: K) -> Result<Duration>
where K: AsRef<str>,

Get an extra configuration value as a Duration from seconds

This function retrieves a numeric value from the extra configuration and converts it to a std::time::Duration using Duration::from_secs().

§Arguments

key - The configuration key to look up (can be &str, String, etc.)

§Returns

Ok(Duration) - The duration value if the key exists and can be parsed as u64
Err(Error::NotPresent) - If the key doesn’t exist in the configuration
Err(Error::ConfigParseError) - If the value cannot be deserialized as u64

§Examples

use {fireblocks_config::FireblocksConfig, std::time::Duration};

let config = FireblocksConfig::new("config.toml", &[])?;

// Get timeout as Duration (assuming config has: timeout = 30)
let timeout: Duration = config.get_extra_duration("timeout")?;
assert_eq!(timeout, Duration::from_secs(30));

Source

pub fn has_extra<K>(&self, key: K) -> bool
where K: AsRef<str>,

Check if an extra configuration key exists

Source

pub fn with_overrides<P: AsRef<Path>>( cfg: P, overrides: impl IntoIterator<Item = P>, ) -> Result<Self>

Source

pub fn init() -> Result<Self>

Load configuration from XDG config directory (~/.config/fireblocks/default.toml)

Source

pub fn init_with_profiles<S: AsRef<str>>(profiles: &[S]) -> Result<Self>

Load configuration from XDG config directory with additional profile overrides

Loads ~/.config/fireblocks/default.toml as base config, then applies each profile from ~/.config/fireblocks/{profile}.toml in order.

§Example

use fireblocks_config::FireblocksConfig;

// Load default config only
let config = FireblocksConfig::init()?;

// Load default + production profile
let config = FireblocksConfig::init_with_profiles(&["production"])?;

// Load default + staging + production (layered)
let config = FireblocksConfig::init_with_profiles(&["staging", "production"])?;