Struct CKBAppConfig

pub struct CKBAppConfig {

    pub bin_name: String,
    pub root_dir: PathBuf,
    pub data_dir: PathBuf,
    pub ancient: PathBuf,
    pub tmp_dir: Option<PathBuf>,
    pub logger: LogConfig,
    pub metrics: MetricsConfig,
    pub memory_tracker: MemoryTrackerConfig,
    pub chain: ChainConfig,
    pub block_assembler: Option<BlockAssemblerConfig>,
    pub db: DBConfig,
    pub network: NetworkConfig,
    pub rpc: RpcConfig,
    pub tx_pool: TxPoolConfig,
    pub store: StoreConfig,
    pub alert_signature: Option<NetworkAlertConfig>,
    pub notify: NotifyConfig,
    pub indexer: IndexerConfig,
    pub fee_estimator: FeeEstimatorConfig,
}

The main config file for the most subcommands. Usually it is the ckb.toml in the CKB root directory.

Attention: Changing the order of fields will break integration test, see module doc.

Fields

bin_name: String

The binary name.

root_dir: PathBuf

The root directory.

data_dir: PathBuf

The data directory.

ancient: PathBuf

freezer files path

tmp_dir: Option<PathBuf>

The directory to store temporary files.

logger: LogConfig

Logger config options.

metrics: MetricsConfig

Metrics options.

Developers can collect metrics for performance tuning and troubleshooting.

memory_tracker: MemoryTrackerConfig

Memory tracker options.

Developers can enable memory tracker to analyze the process memory usage.

chain: ChainConfig

Chain config options.

block_assembler: Option<BlockAssemblerConfig>

Block assembler options.

db: DBConfig

Database config options.

network: NetworkConfig

Network config options.

rpc: RpcConfig

RPC config options.

tx_pool: TxPoolConfig

Tx pool config options.

store: StoreConfig

Store config options.

alert_signature: Option<NetworkAlertConfig>

P2P alert config options.

notify: NotifyConfig

Notify config options.

indexer: IndexerConfig

Indexer config options.

fee_estimator: FeeEstimatorConfig

Fee estimator config options.

Implementations

impl CKBAppConfig

pub fn load_from_slice(slice: &[u8]) -> Result<Self, ExitCode>

Load a new instance from a file

Trait Implementations

impl Clone for CKBAppConfig

fn clone(&self) -> CKBAppConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CKBAppConfig

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

Formats the value using the given formatter.

impl Serialize for CKBAppConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.