casper-node 2.0.3

The Casper blockchain node
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use datasize::DataSize;
use serde::{Deserialize, Serialize};
use tracing::error;

use casper_types::Chainspec;

use crate::{
    logging::LoggingConfig, types::NodeConfig, BinaryPortConfig, BlockAccumulatorConfig,
    BlockSynchronizerConfig, BlockValidatorConfig, ConsensusConfig, ContractRuntimeConfig,
    DiagnosticsPortConfig, EventStreamServerConfig, FetcherConfig, GossipConfig, NetworkConfig,
    RestServerConfig, StorageConfig, TransactionAcceptorConfig, TransactionBufferConfig,
    UpgradeWatcherConfig,
};

/// Root configuration.
#[derive(Clone, DataSize, Debug, Default, Serialize, Deserialize)]
// Disallow unknown fields to ensure config files and command-line overrides contain valid keys.
#[serde(deny_unknown_fields)]
pub struct Config {
    /// Config values for the node.
    pub node: NodeConfig,
    /// Config values for logging.
    pub logging: LoggingConfig,
    /// Config values for consensus.
    pub consensus: ConsensusConfig,
    /// Config values for network.
    pub network: NetworkConfig,
    /// Config values for the event stream server.
    pub event_stream_server: EventStreamServerConfig,
    /// Config values for the REST server.
    pub rest_server: RestServerConfig,
    /// Config values for storage.
    pub storage: StorageConfig,
    /// Config values for gossip.
    pub gossip: GossipConfig,
    /// Config values for fetchers.
    pub fetcher: FetcherConfig,
    /// Config values for the contract runtime.
    pub contract_runtime: ContractRuntimeConfig,
    /// Config values for the transaction acceptor.
    pub transaction_acceptor: TransactionAcceptorConfig,
    /// Config values for the transaction buffer.
    pub transaction_buffer: TransactionBufferConfig,
    /// Config values for the diagnostics port.
    pub diagnostics_port: DiagnosticsPortConfig,
    /// Config values for the block accumulator.
    pub block_accumulator: BlockAccumulatorConfig,
    /// Config values for the block synchronizer.
    pub block_synchronizer: BlockSynchronizerConfig,
    /// Config values for the block validator.
    pub block_validator: BlockValidatorConfig,
    /// Config values for the upgrade watcher.
    pub upgrade_watcher: UpgradeWatcherConfig,
    /// Config values for the BinaryPort server.
    pub binary_port_server: BinaryPortConfig,
}

impl Config {
    /// This modifies `self` so that all configured options are within the bounds set in the
    /// provided chainspec.
    pub(crate) fn ensure_valid(&mut self, chainspec: &Chainspec) {
        if self.transaction_acceptor.timestamp_leeway
            > chainspec.transaction_config.max_timestamp_leeway
        {
            error!(
                configured_timestamp_leeway = %self.transaction_acceptor.timestamp_leeway,
                max_timestamp_leeway = %chainspec.transaction_config.max_timestamp_leeway,
                "setting value for 'transaction_acceptor.timestamp_leeway' to maximum permitted by \
                chainspec 'transaction_config.max_timestamp_leeway'",
            );
            self.transaction_acceptor.timestamp_leeway =
                chainspec.transaction_config.max_timestamp_leeway;
        }
    }

    /// Set network config.
    #[cfg(test)]
    pub(crate) fn with_network_config(mut self, network_config: NetworkConfig) -> Self {
        self.network = network_config;
        self
    }
}