Struct ZebradConfig 

pub struct ZebradConfig {
    pub consensus: Config,
    pub metrics: Config,
    pub network: Config,
    pub state: Config,
    pub tracing: Config,
    pub sync: Config,
    pub mempool: Config,
    pub rpc: Config,
    pub mining: Config,
    pub health: Config,
}

Configuration for zebrad.

The zebrad config is a TOML-encoded version of this structure. The meaning of each field is described in the documentation, although it may be necessary to click through to the sub-structures for each section.

The path to the configuration file can also be specified with the --config flag when running Zebra.

The default path to the zebrad config is platform dependent, based on dirs::preference_dir:

Platform	Value	Example
Linux	$XDG_CONFIG_HOME or $HOME/.config	/home/alice/.config/zebrad.toml
macOS	$HOME/Library/Preferences	/Users/Alice/Library/Preferences/zebrad.toml
Windows	{FOLDERID_RoamingAppData}	C:\Users\Alice\AppData\Local\zebrad.toml

Fields

consensus: Config

Consensus configuration

metrics: Config

Metrics configuration

network: Config

Networking configuration

state: Config

State configuration

tracing: Config

Tracing configuration

sync: Config

Sync configuration

mempool: Config

Mempool configuration

rpc: Config

RPC configuration

mining: Config

Mining configuration

health: Config

Health check HTTP server configuration.

See the Zebra Book for details and examples: https://zebra.zfnd.org/user/health.html

Implementations

impl ZebradConfig

pub fn load(config_path: Option<PathBuf>) -> Result<Self, ConfigError>

Loads the configuration from the conventional sources.

Configuration is loaded from three sources, in order of precedence:

1. Environment variables with ZEBRA_ prefix (highest precedence)
2. TOML configuration file (if provided)
3. Hard-coded defaults (lowest precedence)

Environment variables use the format ZEBRA_SECTION__KEY where:

• SECTION is the configuration section (e.g., network, rpc)
• KEY is the configuration key within that section
• Double underscores (__) separate nested keys

Security

Environment variables whose leaf key names end with sensitive suffixes (case-insensitive) will cause configuration loading to fail with an error: password, secret, token, cookie, private_key. This prevents both silent misconfigurations and process table exposure of sensitive values.

See DENY_CONFIG_KEY_SUFFIX_LIST and is_sensitive_leaf_key() above

Examples

• ZEBRA_NETWORK__NETWORK=Testnet sets network.network = "Testnet"
• ZEBRA_RPC__LISTEN_ADDR=127.0.0.1:8232 sets rpc.listen_addr = "127.0.0.1:8232"

pub fn load_with_env( config_path: Option<PathBuf>, env_prefix: &str, ) -> Result<Self, ConfigError>

Loads configuration using a caller-provided environment variable prefix.

This allows callers that need multiple configs in the same process (e.g., the copy-state command) to keep overrides separate. For example:

• Source/base config uses ZEBRA_... env vars (default prefix)
• Target config uses ZEBRA_TARGET_... env vars

The nested key separator remains __, e.g., ZEBRA_TARGET_STATE__CACHE_DIR.

Trait Implementations

impl Clone for ZebradConfig

fn clone(&self) -> ZebradConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Configurable<ZebradConfig> for EntryPoint

fn config_path(&self) -> Option<PathBuf>

Path to the command’s configuration file

fn process_config( &self, config: ZebradConfig, ) -> Result<ZebradConfig, FrameworkError>

Process the configuration after it has been loaded, potentially modifying it or returning an error if options are incompatible

impl Configurable<ZebradConfig> for ZebradCmd

This trait allows you to define how application configuration is loaded.

fn config_path(&self) -> Option<PathBuf>

Location of the configuration file

fn process_config( &self, config: ZebradConfig, ) -> Result<ZebradConfig, FrameworkError>

Apply changes to the config after it’s been loaded, e.g. overriding values in a config file using command-line options.

This can be safely deleted if you don’t want to override config settings from command-line options.

impl Debug for ZebradConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ZebradConfig

fn default() -> ZebradConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ZebradConfig

where ZebradConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Override<ZebradConfig> for CopyStateCmd

fn override_config( &self, config: ZebradConfig, ) -> Result<ZebradConfig, FrameworkError>

Process the given command line options, overriding settings from a configuration file using explicit flags taken from command-line arguments.

impl Override<ZebradConfig> for StartCmd

fn override_config( &self, config: ZebradConfig, ) -> Result<ZebradConfig, FrameworkError>

Process the given command line options, overriding settings from a configuration file using explicit flags taken from command-line arguments.

impl PartialEq for ZebradConfig

fn eq(&self, other: &ZebradConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ZebradConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ZebradConfig

impl StructuralPartialEq for ZebradConfig

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 976 bytes