Struct grin_servers::common::types::ServerConfig

pub struct ServerConfig {

    pub db_root: String,
    pub api_http_addr: String,
    pub api_secret_path: Option<String>,
    pub foreign_api_secret_path: Option<String>,
    pub tls_certificate_file: Option<String>,
    pub tls_certificate_key: Option<String>,
    pub chain_type: ChainTypes,
    pub future_time_limit: u64,
    pub chain_validation_mode: ChainValidationMode,
    pub archive_mode: Option<bool>,
    pub skip_sync_wait: Option<bool>,
    pub run_tui: Option<bool>,
    pub run_test_miner: Option<bool>,
    pub test_miner_wallet_url: Option<String>,
    pub p2p_config: P2PConfig,
    pub pool_config: PoolConfig,
    pub dandelion_config: DandelionConfig,
    pub stratum_mining_config: Option<StratumServerConfig>,
    pub webhook_config: WebHooksConfig,
}

Full server configuration, aggregating configurations required for the different components.

Fields

db_root: String

Directory under which the rocksdb stores will be created

api_http_addr: String

Network address for the Rest API HTTP server.

api_secret_path: Option<String>

Location of secret for basic auth on Rest API HTTP and V2 Owner API server.

foreign_api_secret_path: Option<String>

Location of secret for basic auth on v2 Foreign API server.

tls_certificate_file: Option<String>

TLS certificate file

tls_certificate_key: Option<String>

TLS certificate private key file

chain_type: ChainTypes

Setup the server for tests, testnet or mainnet

future_time_limit: u64

Future Time Limit

chain_validation_mode: ChainValidationMode

Automatically run full chain validation during normal block processing?

archive_mode: Option<bool>

Whether this node is a full archival node or a fast-sync, pruned node

skip_sync_wait: Option<bool>

Whether to skip the sync timeout on startup (To assist testing on solo chains)

run_tui: Option<bool>

Whether to run the TUI if enabled, this will disable logging to stdout

run_test_miner: Option<bool>

Whether to run the test miner (internal, cuckoo 16)

test_miner_wallet_url: Option<String>

Test miner wallet URL

p2p_config: P2PConfig

Configuration for the peer-to-peer server

pool_config: PoolConfig

Transaction pool configuration

dandelion_config: DandelionConfig

Dandelion configuration

stratum_mining_config: Option<StratumServerConfig>

Configuration for the mining daemon

webhook_config: WebHooksConfig

Configuration for the webhooks that trigger on certain events

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> ServerConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ServerConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ServerConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ServerConfig