Struct Config

Source

pub struct Config {
    pub server: ServerConfig,
    pub policy: PolicyConfig,
    pub keys: KeysConfig,
}

Expand description

Top-level configuration for the TxGate signing service.

This struct contains all configuration sections for the TxGate daemon:

Server: Unix socket path and request timeout settings
Keys: Key storage directory and default key name
Policy: Transaction approval rules (whitelist, blacklist, limits)

§Examples

use txgate_core::config::Config;

// Load from TOML string
let toml_str = r#"
[server]
socket_path = "/var/run/txgate.sock"
timeout_secs = 60

[keys]
directory = "/var/lib/txgate/keys"
default_key = "main"

[policy]
whitelist_enabled = true
whitelist = ["0x742d35Cc6634C0532925a3b844Bc454e7595f"]
"#;

let config: Config = toml::from_str(toml_str).expect("valid TOML");
assert_eq!(config.server.timeout_secs, 60);

Fields§

§server: ServerConfig

Server configuration for the TxGate daemon.

§policy: PolicyConfig

Policy configuration for transaction approval rules.

§keys: KeysConfig

Key storage configuration.

Implementations§

Source §

impl Config

Source

pub fn new() -> Self

Creates a new configuration with default values.

§Examples

use txgate_core::config::Config;

let config = Config::new();
assert_eq!(config.server.timeout_secs, 30);

Source

pub fn validate(&self) -> Result<(), ConfigError>

Validates the configuration.

This method checks for configuration errors such as:

Invalid socket path (empty)
Invalid timeout (zero)
Invalid keys directory (empty)
Invalid default key name (empty)
Invalid policy configuration (whitelist/blacklist overlap)

§Returns

Ok(()) if the configuration is valid, or a ConfigError describing the issue.

§Errors

Returns ConfigError::InvalidValue if:

server.socket_path is empty
server.timeout_secs is zero
keys.directory is empty
keys.default_key is empty

Returns a wrapped PolicyError (via ConfigError::ParseFailed) if:

An address appears in both the whitelist and blacklist

§Examples

use txgate_core::config::Config;

let config = Config::default();
assert!(config.validate().is_ok());

// Invalid: empty socket path
let mut invalid_config = Config::default();
invalid_config.server.socket_path = String::new();
assert!(invalid_config.validate().is_err());

Source

pub fn default_toml() -> String

Generates the default configuration as a TOML string.

This method produces a well-formatted TOML configuration file with comments explaining each section. It can be used to create an initial configuration file for new installations.

§Returns

A TOML-formatted string containing the default configuration.

§Examples

use txgate_core::config::Config;

let toml = Config::default_toml();
assert!(toml.contains("[server]"));
assert!(toml.contains("[keys]"));
assert!(toml.contains("[policy]"));

Source

pub fn builder() -> ConfigBuilder

Creates a configuration builder for customizing values.

§Examples

use txgate_core::config::Config;

let config = Config::builder()
    .socket_path("/var/run/txgate.sock")
    .timeout_secs(60)
    .build();

assert_eq!(config.server.socket_path, "/var/run/txgate.sock");