Module config

Source
Expand description

Configuration system for OpenZeppelin Relayer.

This module handles:

  • Loading and parsing config files
  • Environment variable integration
  • Configuration validation
  • Type-safe config access

§Structure

Configuration is organized into sections:

  • Relayers: Network-specific relayer configurations
  • Signers: Key management and signing configurations
  • Notifications: Alert and monitoring configurations
  • Networks: Custom and overridden network definitions

Modules§

network
Network Configuration Module

Structs§

AllowedToken
AllowedTokenSwapConfig
ApiKeyRateLimit
AwsKmsSignerFileConfig
Config
ConfigFileRelayerEvmPolicy
ConfigFileRelayerSolanaPolicy
ConfigFileRelayerSolanaSwapPolicy
ConfigFileRelayerStellarPolicy
EvmNetworkConfig
Configuration specific to EVM-compatible networks.
GoogleCloudKmsSignerFileConfig
JupiterSwapOptions
KmsKeyConfig
LocalSignerFileConfig
NetworkConfigCommon
NetworksFileConfig
Represents the complete configuration for all defined networks.
NotificationFileConfig
Represents the type of notification configuration.
NotificationsFileConfig
Manages a collection of notification configurations.
PluginFileConfig
PluginsFileConfig
RelayerFileConfig
RelayersFileConfig
ServerConfig
ServiceAccountConfig
SignerFileConfig
SignersFileConfig
SolanaNetworkConfig
Configuration specific to Solana networks.
StellarNetworkConfig
Configuration specific to Stellar networks.
TestSignerFileConfig
TurnkeySignerFileConfig
VaultCloudSignerFileConfig
VaultSignerFileConfig
VaultTransitSignerFileConfig

Enums§

ConfigFileError
ConfigFileNetworkType
ConfigFileRelayerNetworkPolicy
ConfigFileRelayerSolanaFeePaymentStrategy
ConfigFileRelayerSolanaSwapStrategy
NetworkFileConfig
Represents the configuration for a specific network, which can be EVM, Solana, or Stellar.
NotificationFileConfigType
SignerFileConfigEnum
SignerFileConfigPassphrase

Traits§

SignerConfigValidate

Functions§

default_auth_uri
default_token_uri
load_config
Loads and validates a configuration file from the specified path.
validate_with_validator
Validates a signer config using validator::Validate