exonum-cli 1.0.0

Helper crate for secure and convenient configuration of the Exonum nodes.
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

// Copyright 2020 The Exonum Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Contains various config structures used during configuration process.

use exonum::{
    blockchain::{ConsensusConfig, ValidatorKeys},
    crypto::PublicKey,
    merkledb::DbOptions,
};
use exonum_node::{
    ConnectListConfig, MemoryPoolConfig, NetworkConfiguration, NodeApiConfig,
    NodeConfig as CoreNodeConfig,
};
use exonum_supervisor::mode::Mode as SupervisorMode;
use serde_derive::{Deserialize, Serialize};

use std::{net::SocketAddr, path::PathBuf};

/// Part of the template configuration.
#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
pub struct GeneralConfig {
    /// Count of the validator nodes in the network.
    pub validators_count: u32,
    /// Supervisor service mode.
    pub supervisor_mode: SupervisorMode,
}

/// Public configuration of the node. Is shared among validators.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct NodePublicConfig {
    /// Consensus configuration.
    pub consensus: ConsensusConfig,
    /// General configuration.
    pub general: GeneralConfig,
    /// Public keys of the node.
    ///
    /// `None` when not yet generated. The keys are generated at
    /// `generate-config` configuration step. The keys are required for the
    /// `finalize` step.
    pub validator_keys: Option<ValidatorKeys>,
    /// Network address for connections from other nodes.
    pub address: Option<String>,
}

/// Private configuration of the node.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct NodePrivateConfig {
    /// Network listening address.
    pub listen_address: SocketAddr,
    /// The address advertised by the node for peers to connect to.
    pub external_address: String,
    /// Path to the master key file.
    pub master_key_path: PathBuf,
    /// API configuration.
    pub api: NodeApiConfig,
    /// Network configuration.
    pub network: NetworkConfiguration,
    /// Memory pool configuration.
    pub mempool: MemoryPoolConfig,
    /// Optional database configuration.
    #[serde(default)]
    pub database: DbOptions,
    /// Amount of threads used for transactions verification.
    pub thread_pool_size: Option<u8>,
    /// Information about peers within network.
    pub connect_list: ConnectListConfig,
    /// Consensus public key of the node.
    pub consensus_public_key: PublicKey,
}

/// Configuration for the `Node`.
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
pub struct NodeConfig {
    /// Private configuration of the node.
    pub private_config: NodePrivateConfig,
    /// Public configuration of the node.
    pub public_config: NodePublicConfig,
}

impl Into<CoreNodeConfig> for NodeConfig {
    fn into(self) -> CoreNodeConfig {
        CoreNodeConfig {
            consensus: self.public_config.consensus,
            listen_address: self.private_config.listen_address,
            external_address: self.private_config.external_address,
            network: self.private_config.network,
            api: self.private_config.api,
            mempool: self.private_config.mempool,
            connect_list: self.private_config.connect_list,
            thread_pool_size: self.private_config.thread_pool_size,
        }
    }
}