Struct Config 

pub struct Config {

    pub proxy_app: Address,
    pub moniker: Moniker,
    pub fast_sync: bool,
    pub db_backend: DbBackend,
    pub db_dir: PathBuf,
    pub log_level: LogLevel,
    pub log_format: LogFormat,
    pub genesis_file: PathBuf,
    pub priv_validator_key_file: Option<PathBuf>,
    pub priv_validator_state_file: PathBuf,
    pub priv_validator_laddr: Option<Address>,
    pub node_key_file: PathBuf,
    pub abci: AbciMode,
    pub filter_peers: bool,
    pub rpc: RpcConfig,
    pub p2p: P2PConfig,
    pub mempool: MempoolConfig,
    pub consensus: ConsensusConfig,
    pub storage: StorageConfig,
    pub tx_index: TxIndexConfig,
    pub instrumentation: InstrumentationConfig,
    pub statesync: StatesyncConfig,
    pub fastsync: FastsyncConfig,
}

CometBFT config.toml file

Fields

proxy_app: Address

TCP or UNIX socket address of the ABCI application, or the name of an ABCI application compiled in with the CometBFT binary.

moniker: Moniker

A custom human readable name for this node

fast_sync: bool

If this node is many blocks behind the tip of the chain, FastSync allows them to catchup quickly by downloading blocks in parallel and verifying their commits

db_backend: DbBackend

Database backend: goleveldb | cleveldb | boltdb | rocksdb | badgerdb

db_dir: PathBuf

Database directory

log_level: LogLevel

Output level for logging, including package level options

log_format: LogFormat

Output format: ‘plain’ (colored text) or ‘json’

genesis_file: PathBuf

Path to the JSON file containing the initial validator set and other meta data

priv_validator_key_file: Option<PathBuf>

Path to the JSON file containing the private key to use as a validator in the consensus protocol

priv_validator_state_file: PathBuf

Path to the JSON file containing the last sign state of a validator

priv_validator_laddr: Option<Address>

TCP or UNIX socket address for CometBFT to listen on for connections from an external PrivValidator process

node_key_file: PathBuf

Path to the JSON file containing the private key to use for node authentication in the p2p protocol

abci: AbciMode

Mechanism to connect to the ABCI application: socket | grpc

filter_peers: bool

If true, query the ABCI app on connecting to a new peer so the app can decide if we should keep the connection or not

rpc: RpcConfig

rpc server configuration options

p2p: P2PConfig

peer to peer configuration options

mempool: MempoolConfig

mempool configuration options

consensus: ConsensusConfig

consensus configuration options

storage: StorageConfig

Storage configuration options. This section was only first made available in Tendermint Core v0.34.21.

tx_index: TxIndexConfig

transactions indexer configuration options

instrumentation: InstrumentationConfig

instrumentation configuration options

statesync: StatesyncConfig

statesync configuration options

fastsync: FastsyncConfig

fastsync configuration options

Implementations

impl Config

pub fn parse_toml<T: AsRef<str>>(toml_string: T) -> Result<Self, Error>

Parse CometBFT config.toml

pub fn load_toml_file<P>(path: &P) -> Result<Self, Error>

where P: AsRef<Path>,

Load config.toml from a file

pub fn load_genesis_file( &self, home: impl AsRef<Path>, ) -> Result<Genesis, Error>

Load genesis.json file from the configured location

pub fn load_node_key(&self, home: impl AsRef<Path>) -> Result<NodeKey, Error>

Load node_key.json file from the configured location

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config