use crate::{
benchmarking::{inherent_benchmark_data, BenchmarkExtrinsicBuilder},
chain_spec,
cli::{Cli, RelayChainCli, Subcommand},
service::{new_partial, Block},
};
use cumulus_primitives_core::ParaId;
use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE};
use futures::executor::block_on;
use log::info;
use sc_cli::{
ChainSpec, CliConfiguration, DefaultConfigurationValues, ImportParams, KeystoreParams,
NetworkParams, Result, SharedParams, SubstrateCli,
};
use sc_executor::{WasmExecutor, DEFAULT_HEAP_ALLOC_STRATEGY};
use sc_service::config::{BasePath, PrometheusConfig};
use sp_runtime::traits::AccountIdConversion;
use std::{
cell::RefCell, convert::TryInto, net::SocketAddr, path::PathBuf, rc::Rc, time::Duration,
};
#[derive(Debug, PartialEq, Default)]
enum Runtime {
#[default]
Default,
Rococo,
Kusama,
}
trait RuntimeResolver {
fn runtime(&self) -> Runtime;
}
impl RuntimeResolver for dyn ChainSpec {
fn runtime(&self) -> Runtime {
runtime(self.id())
}
}
impl RuntimeResolver for PathBuf {
fn runtime(&self) -> Runtime {
#[derive(Debug, serde::Deserialize)]
struct EmptyChainSpecWithId {
id: String,
}
let file = std::fs::File::open(self).expect("Failed to open file");
let reader = std::io::BufReader::new(file);
let chain_spec: EmptyChainSpecWithId = serde_json::from_reader(reader)
.expect("Failed to read 'json' file with ChainSpec configuration");
runtime(&chain_spec.id)
}
}
fn runtime(id: &str) -> Runtime {
let id = id.replace('_', "-");
if id.contains("rococo") || id.contains("testnet") {
Runtime::Rococo
} else if id.contains("kusama") {
Runtime::Kusama
} else {
log::warn!("No specific runtime was recognized for ChainSpec's id: '{}', so Runtime::default() will be used", id);
Runtime::default()
}
}
fn load_spec(id: &str) -> std::result::Result<Box<dyn ChainSpec>, String> {
Ok(match id {
"mangata-rococo-local" =>
Box::new(chain_spec::mangata_rococo::mangata_rococo_local_config()),
"mangata-rococo" => Box::new(chain_spec::mangata_rococo::mangata_rococo_prod_config()),
"mangata-kusama-local" =>
Box::new(chain_spec::mangata_kusama::mangata_kusama_local_config()),
"mangata-kusama" => Box::new(chain_spec::mangata_kusama::mangata_kusama_prod_config()),
"" => {
log::warn!("No ChainSpec.id specified, so using default one, based on rococo-parachain runtime");
Box::new(chain_spec::mangata_rococo::mangata_rococo_local_config())
},
path => {
let path: PathBuf = path.into();
match path.runtime() {
Runtime::Rococo =>
Box::new(chain_spec::mangata_rococo::ChainSpec::from_json_file(path)?),
Runtime::Kusama =>
Box::new(chain_spec::mangata_kusama::ChainSpec::from_json_file(path)?),
Runtime::Default =>
Box::new(chain_spec::mangata_rococo::ChainSpec::from_json_file(path)?),
}
},
})
}
impl SubstrateCli for Cli {
fn impl_name() -> String {
"Mangata Parachain".into()
}
fn impl_version() -> String {
env!("SUBSTRATE_CLI_IMPL_VERSION").into()
}
fn description() -> String {
format!(
"Mangata Parachain Collator\n\nThe command-line arguments provided first will be \
passed to the parachain node, while the arguments provided after -- will be passed \
to the relay chain node.\n\n\
{} <parachain-args> -- <relay-chain-args>",
Self::executable_name()
)
}
fn author() -> String {
env!("CARGO_PKG_AUTHORS").into()
}
fn support_url() -> String {
"https://github.com/managata-finance/mangata-node/issues/new".into()
}
fn copyright_start_year() -> i32 {
2020
}
fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn ChainSpec>, String> {
load_spec(id)
}
}
impl SubstrateCli for RelayChainCli {
fn impl_name() -> String {
"Mangata Parachain".into()
}
fn impl_version() -> String {
env!("SUBSTRATE_CLI_IMPL_VERSION").into()
}
fn description() -> String {
format!(
"Mangata Parachain\n\nThe command-line arguments provided first will be \
passed to the parachain node, while the arguments provided after -- will be passed \
to the relay chain node.\n\n\
{} <parachain-args> -- <relay-chain-args>",
Self::executable_name()
)
}
fn author() -> String {
env!("CARGO_PKG_AUTHORS").into()
}
fn support_url() -> String {
"https://github.com/paritytech/cumulus/issues/new".into()
}
fn copyright_start_year() -> i32 {
2020
}
fn load_spec(&self, id: &str) -> std::result::Result<Box<dyn ChainSpec>, String> {
polkadot_cli::Cli::from_iter([RelayChainCli::executable_name()].iter()).load_spec(id)
}
}
macro_rules! construct_benchmark_partials {
($config:expr, |$partials:ident| $code:expr) => {
match $config.chain_spec.runtime() {
Runtime::Rococo => {
let $partials = new_partial::<mangata_rococo_runtime::RuntimeApi>(&$config)?;
$code
},
Runtime::Kusama => {
let $partials = new_partial::<mangata_kusama_runtime::RuntimeApi>(&$config)?;
$code
},
_ => Err("The chain is not supported".into()),
}
};
}
macro_rules! construct_async_run {
(|$components:ident, $cli:ident, $cmd:ident, $config:ident| $( $code:tt )* ) => {{
let runner = $cli.create_runner($cmd)?;
match runner.config().chain_spec.runtime() {
Runtime::Rococo | Runtime::Default => {
runner.async_run(|$config| {
let $components = new_partial::<mangata_rococo_runtime::RuntimeApi>(
&$config,
)?;
let task_manager = $components.task_manager;
{ $( $code )* }.map(|v| (v, task_manager))
})
},
Runtime::Kusama => {
runner.async_run(|$config| {
let $components = new_partial::<mangata_kusama_runtime::RuntimeApi>(
&$config,
)?;
let task_manager = $components.task_manager;
{ $( $code )* }.map(|v| (v, task_manager))
})
},
}
}}
}
pub fn run() -> Result<()> {
let cli = Cli::from_args();
match &cli.subcommand {
Some(Subcommand::BuildSpec(cmd)) => {
let runner = cli.create_runner(cmd)?;
runner.sync_run(|config| cmd.run(config.chain_spec, config.network))
},
Some(Subcommand::CheckBlock(cmd)) => {
construct_async_run!(|components, cli, cmd, config| {
Ok(cmd.run(components.client, components.import_queue))
})
},
Some(Subcommand::ExportBlocks(cmd)) => {
construct_async_run!(|components, cli, cmd, config| {
Ok(cmd.run(components.client, config.database))
})
},
Some(Subcommand::ExportState(cmd)) => {
construct_async_run!(|components, cli, cmd, config| {
Ok(cmd.run(components.client, config.chain_spec))
})
},
Some(Subcommand::ImportBlocks(cmd)) => {
construct_async_run!(|components, cli, cmd, config| {
Ok(cmd.run(components.client, components.import_queue))
})
},
Some(Subcommand::Revert(cmd)) => construct_async_run!(|components, cli, cmd, config| {
Ok(cmd.run(components.client, components.backend, None))
}),
Some(Subcommand::PurgeChain(cmd)) => {
let runner = cli.create_runner(cmd)?;
runner.sync_run(|config| {
let polkadot_cli = RelayChainCli::new(
&config,
[RelayChainCli::executable_name()].iter().chain(cli.relay_chain_args.iter()),
);
let polkadot_config = SubstrateCli::create_configuration(
&polkadot_cli,
&polkadot_cli,
config.tokio_handle.clone(),
)
.map_err(|err| format!("Relay chain argument error: {}", err))?;
cmd.run(config, polkadot_config)
})
},
Some(Subcommand::ExportGenesisState(cmd)) =>{
let runner = cli.create_runner(cmd)?;
match runner.config().chain_spec.runtime() {
Runtime::Rococo | Runtime::Default => {
runner.sync_run(|config| {
let components = new_partial::<mangata_rococo_runtime::RuntimeApi>(
&config,
)?;
cmd.run(&*config.chain_spec, &*components.client)
})
},
Runtime::Kusama => {
runner.sync_run(|config| {
let components = new_partial::<mangata_rococo_runtime::RuntimeApi>(
&config,
)?;
cmd.run(&*config.chain_spec, &*components.client)
})
},
}
},
Some(Subcommand::ExportGenesisWasm(cmd)) => {
let runner = cli.create_runner(cmd)?;
runner.sync_run(|_config| {
let spec = cli.load_spec(&cmd.shared_params.chain.clone().unwrap_or_default())?;
cmd.run(&*spec)
})
},
Some(Subcommand::Benchmark(cmd)) => {
let runner = cli.create_runner(cmd)?;
match cmd {
BenchmarkCmd::Pallet(cmd) =>
if cfg!(feature = "runtime-benchmarks") {
runner.sync_run(|config| cmd.run::<Block, ()>(config))
} else {
Err("Benchmarking wasn't enabled when building the node. \
You can enable it with `--features runtime-benchmarks`."
.into())
},
BenchmarkCmd::Block(cmd) => runner.sync_run(|config| {
construct_benchmark_partials!(config, |partials| cmd.run(partials.client))
}),
#[cfg(not(feature = "runtime-benchmarks"))]
BenchmarkCmd::Storage(_) =>
return Err(sc_cli::Error::Input(
"Compile with --features=runtime-benchmarks \
to enable storage benchmarks."
.into(),
)
.into()),
#[cfg(feature = "runtime-benchmarks")]
BenchmarkCmd::Storage(cmd) => runner.sync_run(|config| {
construct_benchmark_partials!(config, |partials| {
let db = partials.backend.expose_db();
let storage = partials.backend.expose_storage();
cmd.run(config, partials.client.clone(), db, storage)
})
}),
BenchmarkCmd::Machine(cmd) =>
runner.sync_run(|config| cmd.run(&config, SUBSTRATE_REFERENCE_HARDWARE.clone())),
BenchmarkCmd::Overhead(cmd) => runner.sync_run(|config| {
match config.chain_spec.runtime() {
Runtime::Rococo | Runtime::Default => Err("Benchmarking sub-command unsupported".into()),
Runtime::Kusama => {
let executor = WasmExecutor::builder()
.with_execution_method(config.wasm_method)
.with_onchain_heap_alloc_strategy(DEFAULT_HEAP_ALLOC_STRATEGY)
.with_offchain_heap_alloc_strategy(DEFAULT_HEAP_ALLOC_STRATEGY)
.with_max_runtime_instances(config.max_runtime_instances)
.with_runtime_cache_size(config.runtime_cache_size)
.build();
let (c, _, _, _) = sc_service::new_full_parts::<Block, mangata_kusama_runtime::RuntimeApi, _>(
&config,
None,
executor,
)?;
let client = Rc::new(RefCell::new(c));
let ext_builder = BenchmarkExtrinsicBuilder::new(client.clone());
let first_block_inherent =
block_on(inherent_benchmark_data([0u8; 32], Duration::from_millis(0)))
.unwrap();
let first_block_seed = sp_ver::extract_inherent_data(&first_block_inherent)
.map_err(|_| {
sp_blockchain::Error::Backend(String::from(
"cannot read random seed from inherents data",
))
})?;
let second_block_inherent = block_on(inherent_benchmark_data(
first_block_seed.seed.as_bytes().try_into().unwrap(),
Duration::from_millis(12000),
))
.unwrap();
cmd.run_ver(config, client, (first_block_inherent, second_block_inherent), &ext_builder)
},
}
}),
#[allow(unreachable_patterns)]
_ => Err("Benchmarking sub-command unsupported".into()),
}
},
Some(Subcommand::TryRuntime) => Err("The `try-runtime` subcommand has been migrated to a standalone CLI (https://github.com/paritytech/try-runtime-cli). It is no longer being maintained here and will be removed entirely some time after January 2024. Please remove this subcommand from your runtime and use the standalone CLI.".into()),
Some(Subcommand::Key(cmd)) => Ok(cmd.run(&cli)?),
None => {
let runner = cli.create_runner(&cli.run.normalize())?;
let collator_options = cli.run.collator_options();
runner.run_node_until_exit(|config| async move {
let hwbench = (!cli.no_hardware_benchmarks).then_some(
config.database.path().map(|database_path| {
let _ = std::fs::create_dir_all(database_path);
sc_sysinfo::gather_hwbench(Some(database_path))
})).flatten();
let para_id = chain_spec::Extensions::try_get(&*config.chain_spec)
.map(|e| e.para_id)
.ok_or("Could not find parachain extension in chain-spec.")?;
let polkadot_cli = RelayChainCli::new(
&config,
[RelayChainCli::executable_name()].iter().chain(cli.relay_chain_args.iter()),
);
let id = ParaId::from(para_id);
let parachain_account =
AccountIdConversion::<polkadot_primitives::AccountId>::into_account_truncating(&id);
let tokio_handle = config.tokio_handle.clone();
let polkadot_config =
SubstrateCli::create_configuration(&polkadot_cli, &polkadot_cli, tokio_handle)
.map_err(|err| format!("Relay chain argument error: {}", err))?;
info!("Parachain id: {:?}", id);
info!("Parachain Account: {}", parachain_account);
info!("Is collating: {}", if config.role.is_authority() { "yes" } else { "no" });
match config.chain_spec.runtime() {
Runtime::Rococo | Runtime::Default => crate::service::start_parachain_node::<
mangata_rococo_runtime::RuntimeApi,
>(config, polkadot_config, collator_options, id, hwbench)
.await
.map(|r| r.0)
.map_err(Into::into),
Runtime::Kusama => crate::service::start_parachain_node::<
mangata_kusama_runtime::RuntimeApi,
>(config, polkadot_config, collator_options, id, hwbench)
.await
.map(|r| r.0)
.map_err(Into::into),
}
})
},
}
}
impl DefaultConfigurationValues for RelayChainCli {
fn p2p_listen_port() -> u16 {
30334
}
fn rpc_listen_port() -> u16 {
9945
}
fn prometheus_listen_port() -> u16 {
9616
}
}
impl CliConfiguration<Self> for RelayChainCli {
fn shared_params(&self) -> &SharedParams {
self.base.base.shared_params()
}
fn import_params(&self) -> Option<&ImportParams> {
self.base.base.import_params()
}
fn network_params(&self) -> Option<&NetworkParams> {
self.base.base.network_params()
}
fn keystore_params(&self) -> Option<&KeystoreParams> {
self.base.base.keystore_params()
}
fn base_path(&self) -> Result<Option<BasePath>> {
Ok(self
.shared_params()
.base_path()?
.or_else(|| self.base_path.clone().map(Into::into)))
}
fn rpc_addr(&self, default_listen_port: u16) -> Result<Option<SocketAddr>> {
self.base.base.rpc_addr(default_listen_port)
}
fn prometheus_config(
&self,
default_listen_port: u16,
chain_spec: &Box<dyn ChainSpec>,
) -> Result<Option<PrometheusConfig>> {
self.base.base.prometheus_config(default_listen_port, chain_spec)
}
fn init<F>(
&self,
_support_url: &String,
_impl_version: &String,
_logger_hook: F,
_config: &sc_service::Configuration,
) -> Result<()>
where
F: FnOnce(&mut sc_cli::LoggerBuilder, &sc_service::Configuration),
{
unreachable!("PolkadotCli is never initialized; qed");
}
fn chain_id(&self, is_dev: bool) -> Result<String> {
let chain_id = self.base.base.chain_id(is_dev)?;
Ok(if chain_id.is_empty() { self.chain_id.clone().unwrap_or_default() } else { chain_id })
}
fn role(&self, is_dev: bool) -> Result<sc_service::Role> {
self.base.base.role(is_dev)
}
fn transaction_pool(&self, is_dev: bool) -> Result<sc_service::config::TransactionPoolOptions> {
self.base.base.transaction_pool(is_dev)
}
fn trie_cache_maximum_size(&self) -> Result<Option<usize>> {
self.base.base.trie_cache_maximum_size()
}
fn rpc_methods(&self) -> Result<sc_service::config::RpcMethods> {
self.base.base.rpc_methods()
}
fn rpc_max_connections(&self) -> Result<u32> {
self.base.base.rpc_max_connections()
}
fn rpc_cors(&self, is_dev: bool) -> Result<Option<Vec<String>>> {
self.base.base.rpc_cors(is_dev)
}
fn default_heap_pages(&self) -> Result<Option<u64>> {
self.base.base.default_heap_pages()
}
fn force_authoring(&self) -> Result<bool> {
self.base.base.force_authoring()
}
fn disable_grandpa(&self) -> Result<bool> {
self.base.base.disable_grandpa()
}
fn max_runtime_instances(&self) -> Result<Option<usize>> {
self.base.base.max_runtime_instances()
}
fn announce_block(&self) -> Result<bool> {
self.base.base.announce_block()
}
fn telemetry_endpoints(
&self,
chain_spec: &Box<dyn ChainSpec>,
) -> Result<Option<sc_telemetry::TelemetryEndpoints>> {
self.base.base.telemetry_endpoints(chain_spec)
}
fn node_name(&self) -> Result<String> {
self.base.base.node_name()
}
}
#[cfg(test)]
mod tests {
use crate::{
chain_spec::{get_account_id_from_seed, get_collator_keys_from_seed},
command::{Runtime, RuntimeResolver},
};
use sc_chain_spec::{ChainSpec, ChainSpecExtension, ChainSpecGroup, ChainType, Extension};
use serde::{Deserialize, Serialize};
use sp_core::sr25519;
use std::path::PathBuf;
use tempfile::TempDir;
#[derive(
Debug, Clone, PartialEq, Serialize, Deserialize, ChainSpecGroup, ChainSpecExtension, Default,
)]
#[serde(deny_unknown_fields)]
pub struct Extensions1 {
pub attribute1: String,
pub attribute2: u32,
}
#[derive(
Debug, Clone, PartialEq, Serialize, Deserialize, ChainSpecGroup, ChainSpecExtension, Default,
)]
#[serde(deny_unknown_fields)]
pub struct Extensions2 {
pub attribute_x: String,
pub attribute_y: String,
pub attribute_z: u32,
}
fn store_configuration(dir: &TempDir, spec: Box<dyn ChainSpec>) -> PathBuf {
let raw_output = true;
let json = sc_service::chain_ops::build_spec(&*spec, raw_output)
.expect("Failed to build json string");
let mut cfg_file_path = dir.path().to_path_buf();
cfg_file_path.push(spec.id());
cfg_file_path.set_extension("json");
std::fs::write(&cfg_file_path, json).expect("Failed to write to json file");
cfg_file_path
}
pub type DummyChainSpec<E> =
sc_service::GenericChainSpec<mangata_rococo_runtime::RuntimeGenesisConfig, E>;
pub fn create_default_with_extensions<E: Extension>(
id: &str,
extension: E,
) -> DummyChainSpec<E> {
DummyChainSpec::from_genesis(
"Dummy local testnet",
id,
ChainType::Local,
move || {
crate::chain_spec::mangata_rococo::mangata_genesis(
vec![
(
get_account_id_from_seed::<sr25519::Public>("Alice"),
get_collator_keys_from_seed("Alice"),
),
(
get_account_id_from_seed::<sr25519::Public>("Bob"),
get_collator_keys_from_seed("Bob"),
),
],
get_account_id_from_seed::<sr25519::Public>("Relay"),
get_account_id_from_seed::<sr25519::Public>("Alice"),
vec![],
vec![],
vec![],
1000.into(),
)
},
Vec::new(),
None,
None,
None,
None,
extension,
)
}
#[test]
fn test_resolve_runtime_for_different_configuration_files() {
let temp_dir = tempfile::tempdir().expect("Failed to access tempdir");
let path = store_configuration(
&temp_dir,
Box::new(create_default_with_extensions("mangata-rococo-1", Extensions1::default())),
);
assert_eq!(Runtime::Rococo, path.runtime());
let path = store_configuration(
&temp_dir,
Box::new(create_default_with_extensions("default", Extensions2::default())),
);
assert_eq!(Runtime::Default, path.runtime());
let path = store_configuration(
&temp_dir,
Box::new(crate::chain_spec::mangata_kusama::mangata_kusama_local_config()),
);
assert_eq!(Runtime::Kusama, path.runtime());
}
}