Struct aptos_config::config::NodeConfig

pub struct NodeConfig {

    pub base: BaseConfig,
    pub consensus: ConsensusConfig,
    pub debug_interface: DebugInterfaceConfig,
    pub execution: ExecutionConfig,
    pub full_node_networks: Vec<NetworkConfig>,
    pub logger: LoggerConfig,
    pub mempool: MempoolConfig,
    pub metrics: DeprecatedConfig,
    pub peer_monitoring_service: PeerMonitoringServiceConfig,
    pub api: ApiConfig,
    pub state_sync: StateSyncConfig,
    pub storage: StorageConfig,
    pub test: Option<TestConfig>,
    pub validator_network: Option<NetworkConfig>,
    pub failpoints: Option<HashMap<String, String>>,
}

Config pulls in configuration information from the config file. This is used to set up the nodes and configure various parameters. The config file is broken up into sections for each module so that only that module can be passed around

Fields

base: BaseConfig

consensus: ConsensusConfig

debug_interface: DebugInterfaceConfig

execution: ExecutionConfig

full_node_networks: Vec<NetworkConfig>

logger: LoggerConfig

mempool: MempoolConfig

metrics: DeprecatedConfig

peer_monitoring_service: PeerMonitoringServiceConfig

api: ApiConfig

state_sync: StateSyncConfig

storage: StorageConfig

test: Option<TestConfig>

validator_network: Option<NetworkConfig>

failpoints: Option<HashMap<String, String>>

Implementations

impl NodeConfig

pub fn data_dir(&self) -> &Path

pub fn set_data_dir(&mut self, data_dir: PathBuf)

pub fn load<P: AsRef<Path>>(input_path: P) -> Result<Self, Error>

Reads the config file and returns the configuration object in addition to doing some post-processing of the config Paths used in the config are either absolute or relative to the config location

pub fn peer_id(&self) -> Option<PeerId>

pub fn save<P: AsRef<Path>>(&mut self, output_path: P) -> Result<(), Error>

pub fn randomize_ports(&mut self)

pub fn random() -> Self

pub fn random_with_template(
    _idx: u32,
    template: &Self,
    rng: &mut StdRng
) -> Self

pub fn default_for_public_full_node() -> Self

pub fn default_for_validator() -> Self

pub fn default_for_validator_full_node() -> Self

Trait Implementations

impl Clone for NodeConfig

fn clone(&self) -> NodeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeConfig

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

Formats the value using the given formatter.

impl Default for NodeConfig

fn default() -> NodeConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NodeConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<NodeConfig> for NodeConfig

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

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

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

This method tests for !=.

impl Serialize for NodeConfig

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 NodeConfig