Struct ckb_app_config::Setup

pub struct Setup {
    pub subcommand_name: String,
    pub config: AppConfig,
}

A struct including all the informations to start the ckb process.

Fields

subcommand_name: String

Subcommand name.

For example, this is set to run when ckb is executed with ckb run.

config: AppConfig

The config file for the current subcommand.

Implementations

impl Setup

pub fn from_matches(
    bin_name: String,
    matches: &ArgMatches<'_>
) -> Result<Setup, ExitCode>

Boots the ckb process by parsing the command line arguments and loading the config file.

pub fn run(self, matches: &ArgMatches<'_>) -> Result<RunArgs, ExitCode>

Executes ckb run.

pub fn migrate(self, matches: &ArgMatches<'_>) -> Result<MigrateArgs, ExitCode>

migrate subcommand has one flags arg, trigger this arg with “–check”

pub fn db_repair(
    self,
    _matches: &ArgMatches<'_>
) -> Result<RepairArgs, ExitCode>

db-repair subcommand

pub fn miner(self, matches: &ArgMatches<'_>) -> Result<MinerArgs, ExitCode>

Executes ckb miner.

pub fn replay(self, matches: &ArgMatches<'_>) -> Result<ReplayArgs, ExitCode>

Executes ckb replay.

pub fn stats(self, matches: &ArgMatches<'_>) -> Result<StatsArgs, ExitCode>

Executes ckb stats.

pub fn import(self, matches: &ArgMatches<'_>) -> Result<ImportArgs, ExitCode>

Executes ckb import.

pub fn export(self, matches: &ArgMatches<'_>) -> Result<ExportArgs, ExitCode>

Executes ckb export.

pub fn init(matches: &ArgMatches<'_>) -> Result<InitArgs, ExitCode>

Executes ckb init.

pub fn reset_data(
    self,
    matches: &ArgMatches<'_>
) -> Result<ResetDataArgs, ExitCode>

Executes ckb reset-data.

pub fn root_dir_from_matches(
    matches: &ArgMatches<'_>
) -> Result<PathBuf, ExitCode>

Resolves the root directory for ckb from the command line arguments.

pub fn consensus(&self) -> Result<Consensus, ExitCode>

Gets the consensus.

pub fn peer_id(matches: &ArgMatches<'_>) -> Result<PeerIDArgs, ExitCode>

Gets the network peer id by reading the network secret key.

pub fn gen(matches: &ArgMatches<'_>) -> Result<(), ExitCode>

Generates the network secret key.