Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Add chain-info Subcommand #11250

Merged
merged 13 commits into from
Apr 25, 2022
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions bin/node-template/node/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,7 @@ pub enum Subcommand {
/// Try some command against runtime state. Note: `try-runtime` feature must be enabled.
#[cfg(not(feature = "try-runtime"))]
TryRuntime,

/// Db meta columns information.
BlockchainInfo(sc_cli::BlockchainInfoCmd),
}
4 changes: 4 additions & 0 deletions bin/node-template/node/src/command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,10 @@ pub fn run() -> sc_cli::Result<()> {
Some(Subcommand::TryRuntime) => Err("TryRuntime wasn't enabled when building the node. \
You can enable it with `--features try-runtime`."
.into()),
Some(Subcommand::BlockchainInfo(cmd)) => {
let runner = cli.create_runner(cmd)?;
runner.sync_run(|config| cmd.run::<Block>(&config))
},
None => {
let runner = cli.create_runner(&cli.run)?;
runner.run_node_until_exit(|config| async move {
Expand Down
3 changes: 3 additions & 0 deletions bin/node/cli/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,7 @@ pub enum Subcommand {

/// Revert the chain to a previous state.
Revert(sc_cli::RevertCmd),

/// Db meta columns information.
BlockchainInfo(sc_cli::BlockchainInfoCmd),
}
4 changes: 4 additions & 0 deletions bin/node/cli/src/command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -206,5 +206,9 @@ pub fn run() -> Result<()> {
Some(Subcommand::TryRuntime) => Err("TryRuntime wasn't enabled when building the node. \
You can enable it with `--features try-runtime`."
.into()),
Some(Subcommand::BlockchainInfo(cmd)) => {
let runner = cli.create_runner(cmd)?;
runner.sync_run(|config| cmd.run::<Block>(&config))
},
}
}
1 change: 1 addition & 0 deletions client/cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ tokio = { version = "1.17.0", features = ["signal", "rt-multi-thread", "parking_

parity-scale-codec = "3.0.0"
sc-client-api = { version = "4.0.0-dev", path = "../api" }
sc-client-db = { version = "0.10.0-dev", path = "../db" }
sc-keystore = { version = "4.0.0-dev", path = "../keystore" }
sc-network = { version = "0.10.0-dev", path = "../network" }
sc-service = { version = "0.10.0-dev", default-features = false, path = "../service" }
Expand Down
88 changes: 88 additions & 0 deletions client/cli/src/commands/blockchain_info_cmd.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
// This file is part of Substrate.

// Copyright (C) 2018-2022 Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

use parity_scale_codec::{Decode, Encode};
use crate::{CliConfiguration, PruningParams, Result as CliResult, SharedParams};
use sc_client_api::{backend::Backend as BackendT, blockchain::HeaderBackend};
use sp_runtime::traits::{Block as BlockT, Header as HeaderT};
use std::{fmt::Debug, io};

/// The `blockchain-info` subcommand used to output db meta columns information.
#[derive(Debug, Clone, clap::Parser)]
pub struct BlockchainInfoCmd {
#[allow(missing_docs)]
#[clap(flatten)]
pub pruning_params: PruningParams,

#[allow(missing_docs)]
#[clap(flatten)]
pub shared_params: SharedParams,
}

/// Serializable `blockchain-info` subcommand output.
#[derive(Clone, Eq, PartialEq, Debug, Encode, Decode, serde::Serialize)]
struct BlockchainInfo<B: BlockT> {
/// Best block hash.
best_hash: B::Hash,
/// Best block number.
best_number: <<B as BlockT>::Header as HeaderT>::Number,
/// Genesis block hash.
genesis_hash: B::Hash,
/// The head of the finalized chain.
finalized_hash: B::Hash,
/// Last finalized block number.
finalized_number: <<B as BlockT>::Header as HeaderT>::Number,
}

impl BlockchainInfoCmd {
/// Run the `blockchain-info` subcommand
pub fn run<B>(&self, config: &sc_service::Configuration) -> CliResult<()>
where
B: BlockT,
{
let db_config = sc_client_db::DatabaseSettings {
state_cache_size: config.state_cache_size,
state_cache_child_ratio: config.state_cache_child_ratio.map(|v| (v, 100)),
state_pruning: config.state_pruning.clone(),
source: config.database.clone(),
keep_blocks: config.keep_blocks.clone(),
};
let backend = sc_service::new_db_backend::<B>(db_config)?;
let blockchain_info = backend.blockchain().info();
let info = BlockchainInfo::<B> {
tgmichel marked this conversation as resolved.
Show resolved Hide resolved
best_hash: blockchain_info.best_hash,
best_number: blockchain_info.best_number,
genesis_hash: blockchain_info.genesis_hash,
finalized_hash: blockchain_info.finalized_hash,
finalized_number: blockchain_info.finalized_number,
};
let mut out = io::stdout();
serde_json::to_writer_pretty(&mut out, &info).map_err(|e| format!("Error writing JSON: {}", e))?;
Ok(())
}
}

impl CliConfiguration for BlockchainInfoCmd {
fn shared_params(&self) -> &SharedParams {
&self.shared_params
}

fn pruning_params(&self) -> Option<&PruningParams> {
Some(&self.pruning_params)
}
}
3 changes: 2 additions & 1 deletion client/cli/src/commands/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
mod blockchain_info_cmd;
mod build_spec_cmd;
mod check_block_cmd;
mod export_blocks_cmd;
Expand All @@ -35,7 +36,7 @@ mod vanity;
mod verify;

pub use self::{
build_spec_cmd::BuildSpecCmd, check_block_cmd::CheckBlockCmd,
blockchain_info_cmd::BlockchainInfoCmd, build_spec_cmd::BuildSpecCmd, check_block_cmd::CheckBlockCmd,
export_blocks_cmd::ExportBlocksCmd, export_state_cmd::ExportStateCmd, generate::GenerateCmd,
generate_node_key::GenerateNodeKeyCmd, import_blocks_cmd::ImportBlocksCmd,
insert_key::InsertKeyCmd, inspect_key::InspectKeyCmd, inspect_node_key::InspectNodeKeyCmd,
Expand Down