Co #12341: Use try-runtime feature (#1759)

* Add try-runtime feature Signed-off-by: Oliver Tale-Yazdi <[email protected]> * More feature gates Signed-off-by: Oliver Tale-Yazdi <[email protected]> * Add dummy command Signed-off-by: Oliver Tale-Yazdi <[email protected]> * update lockfile for {"polkadot", "substrate"} * Fix code * Remove unused import Signed-off-by: Oliver Tale-Yazdi <[email protected]> * Imports... Signed-off-by: Oliver Tale-Yazdi <[email protected]> * fmt Signed-off-by: Oliver Tale-Yazdi <[email protected]> * fmt Signed-off-by: Oliver Tale-Yazdi <[email protected]> Signed-off-by: Oliver Tale-Yazdi <[email protected]> Co-authored-by: parity-processbot <>
paritytech · Oct 20, 2022 · 1219981 · 1219981
1 parent 43bec36
commit 1219981
Show file tree

Hide file tree

Showing 15 changed files with 348 additions and 321 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/parachain-template/node/Cargo.toml b/parachain-template/node/Cargo.toml
@@ -51,7 +51,7 @@ sp-timestamp = { git = "https://github.com/paritytech/substrate", branch = "mast
 sp-transaction-pool = { git = "https://github.com/paritytech/substrate", branch = "master" }
 substrate-frame-rpc-system = { git = "https://github.com/paritytech/substrate", branch = "master" }
 substrate-prometheus-endpoint = { git = "https://github.com/paritytech/substrate", branch = "master" }
-try-runtime-cli = { git = "https://github.com/paritytech/substrate", branch = "master" }
+try-runtime-cli = { git = "https://github.com/paritytech/substrate", branch = "master", optional = true }
 
 # Polkadot
 polkadot-cli = { git = "https://github.com/paritytech/polkadot", branch = "master" }
@@ -78,7 +78,11 @@ substrate-build-script-utils = { git = "https://github.com/paritytech/substrate"
 [features]
 default = []
 runtime-benchmarks = [
+	"try-runtime-cli/try-runtime",
 	"parachain-template-runtime/runtime-benchmarks",
 	"polkadot-cli/runtime-benchmarks",
 ]
-try-runtime = ["parachain-template-runtime/try-runtime"]
+try-runtime = [
+	"try-runtime-cli/try-runtime",
+	"parachain-template-runtime/try-runtime"
+]
diff --git a/parachain-template/node/src/cli.rs b/parachain-template/node/src/cli.rs
@@ -36,7 +36,12 @@ pub enum Subcommand {
 	Benchmark(frame_benchmarking_cli::BenchmarkCmd),
 
 	/// Try some testing command against a specified runtime state.
+	#[cfg(feature = "try-runtime")]
 	TryRuntime(try_runtime_cli::TryRuntimeCmd),
+
+	/// Errors since the binary was not build with `--features try-runtime`.
+	#[cfg(not(feature = "try-runtime"))]
+	TryRuntime,
 }
 
 #[derive(Debug, clap::Parser)]

diff --git a/parachain-template/node/src/command.rs b/parachain-template/node/src/command.rs
@@ -10,10 +10,7 @@ use sc_cli::{
 	ChainSpec, CliConfiguration, DefaultConfigurationValues, ImportParams, KeystoreParams,
 	NetworkParams, Result, RuntimeVersion, SharedParams, SubstrateCli,
 };
-use sc_service::{
-	config::{BasePath, PrometheusConfig},
-	TaskManager,
-};
+use sc_service::config::{BasePath, PrometheusConfig};
 use sp_core::hexdisplay::HexDisplay;
 use sp_runtime::traits::{AccountIdConversion, Block as BlockT};
 
@@ -231,23 +228,24 @@ pub fn run() -> Result<()> {
 				_ => Err("Benchmarking sub-command unsupported".into()),
 			}
 		},
+		#[cfg(feature = "try-runtime")]
 		Some(Subcommand::TryRuntime(cmd)) => {
-			if cfg!(feature = "try-runtime") {
-				let runner = cli.create_runner(cmd)?;
-
-				// grab the task manager.
-				let registry = &runner.config().prometheus_config.as_ref().map(|cfg| &cfg.registry);
-				let task_manager =
-					TaskManager::new(runner.config().tokio_handle.clone(), *registry)
-						.map_err(|e| format!("Error: {:?}", e))?;
-
-				runner.async_run(|config| {
-					Ok((cmd.run::<Block, ParachainNativeExecutor>(config), task_manager))
-				})
-			} else {
-				Err("Try-runtime must be enabled by `--features try-runtime`.".into())
-			}
+			let runner = cli.create_runner(cmd)?;
+
+			// grab the task manager.
+			let registry = &runner.config().prometheus_config.as_ref().map(|cfg| &cfg.registry);
+			let task_manager =
+				sc_service::TaskManager::new(runner.config().tokio_handle.clone(), *registry)
+					.map_err(|e| format!("Error: {:?}", e))?;
+
+			runner.async_run(|config| {
+				Ok((cmd.run::<Block, ParachainNativeExecutor>(config), task_manager))
+			})
 		},
+		#[cfg(not(feature = "try-runtime"))]
+		Some(Subcommand::TryRuntime) => Err("Try-runtime was not enabled when building the node. \
+			You can enable it with `--features try-runtime`."
+			.into()),
 		None => {
 			let runner = cli.create_runner(&cli.run.normalize())?;
 			let collator_options = cli.run.collator_options();

diff --git a/parachain-template/runtime/Cargo.toml b/parachain-template/runtime/Cargo.toml
@@ -148,7 +148,7 @@ try-runtime = [
 	"cumulus-pallet-xcmp-queue/try-runtime",
 	"frame-executive/try-runtime",
 	"frame-system/try-runtime",
-	"frame-try-runtime",
+	"frame-try-runtime/try-runtime",
 	"pallet-aura/try-runtime",
 	"pallet-authorship/try-runtime",
 	"pallet-balances/try-runtime",

diff --git a/parachains/runtimes/assets/statemine/Cargo.toml b/parachains/runtimes/assets/statemine/Cargo.toml
@@ -109,7 +109,7 @@ try-runtime = [
 	"cumulus-pallet-xcmp-queue/try-runtime",
 	"frame-executive/try-runtime",
 	"frame-system/try-runtime",
-	"frame-try-runtime",
+	"frame-try-runtime/try-runtime",
 	"pallet-asset-tx-payment/try-runtime",
 	"pallet-assets/try-runtime",
 	"pallet-aura/try-runtime",

diff --git a/parachains/runtimes/assets/statemint/Cargo.toml b/parachains/runtimes/assets/statemint/Cargo.toml
@@ -108,7 +108,7 @@ try-runtime = [
 	"cumulus-pallet-xcmp-queue/try-runtime",
 	"frame-executive/try-runtime",
 	"frame-system/try-runtime",
-	"frame-try-runtime",
+	"frame-try-runtime/try-runtime",
 	"pallet-asset-tx-payment/try-runtime",
 	"pallet-assets/try-runtime",
 	"pallet-aura/try-runtime",

diff --git a/parachains/runtimes/assets/westmint/Cargo.toml b/parachains/runtimes/assets/westmint/Cargo.toml
@@ -108,7 +108,7 @@ try-runtime = [
 	"cumulus-pallet-xcmp-queue/try-runtime",
 	"frame-executive/try-runtime",
 	"frame-system/try-runtime",
-	"frame-try-runtime",
+	"frame-try-runtime/try-runtime",
 	"pallet-asset-tx-payment/try-runtime",
 	"pallet-assets/try-runtime",
 	"pallet-aura/try-runtime",

diff --git a/parachains/runtimes/collectives/collectives-polkadot/Cargo.toml b/parachains/runtimes/collectives/collectives-polkadot/Cargo.toml
@@ -104,7 +104,7 @@ try-runtime = [
 	"cumulus-pallet-xcmp-queue/try-runtime",
 	"frame-executive/try-runtime",
 	"frame-system/try-runtime",
-	"frame-try-runtime",
+	"frame-try-runtime/try-runtime",
 	"pallet-alliance/try-runtime",
 	"pallet-aura/try-runtime",
 	"pallet-authorship/try-runtime",

diff --git a/parachains/runtimes/contracts/contracts-rococo/Cargo.toml b/parachains/runtimes/contracts/contracts-rococo/Cargo.toml
@@ -157,7 +157,7 @@ try-runtime = [
 	"cumulus-pallet-xcmp-queue/try-runtime",
 	"frame-executive/try-runtime",
 	"frame-system/try-runtime",
-	"frame-try-runtime",
+	"frame-try-runtime/try-runtime",
 	"pallet-aura/try-runtime",
 	"pallet-authorship/try-runtime",
 	"pallet-balances/try-runtime",

diff --git a/parachains/runtimes/starters/shell/Cargo.toml b/parachains/runtimes/starters/shell/Cargo.toml
@@ -68,5 +68,5 @@ std = [
 ]
 try-runtime = [
 	"frame-executive/try-runtime",
-	"frame-try-runtime",
+	"frame-try-runtime/try-runtime",
 ]
diff --git a/parachains/runtimes/testing/penpal/Cargo.toml b/parachains/runtimes/testing/penpal/Cargo.toml
@@ -150,7 +150,7 @@ try-runtime = [
 	"cumulus-pallet-xcmp-queue/try-runtime",
 	"frame-executive/try-runtime",
 	"frame-system/try-runtime",
-	"frame-try-runtime",
+	"frame-try-runtime/try-runtime",
 	"pallet-aura/try-runtime",
 	"pallet-authorship/try-runtime",
 	"pallet-balances/try-runtime",

diff --git a/polkadot-parachain/Cargo.toml b/polkadot-parachain/Cargo.toml
@@ -60,7 +60,7 @@ sp-consensus-aura = { git = "https://github.com/paritytech/substrate", branch =
 sc-sysinfo = { git = "https://github.com/paritytech/substrate", branch = "master" }
 sp-serializer = { git = "https://github.com/paritytech/substrate", branch = "master" }
 substrate-prometheus-endpoint = { git = "https://github.com/paritytech/substrate", branch = "master" }
-try-runtime-cli = { git = "https://github.com/paritytech/substrate", branch = "master" }
+try-runtime-cli = { git = "https://github.com/paritytech/substrate", branch = "master", optional = true }
 sc-transaction-pool-api = { git = "https://github.com/paritytech/substrate", branch = "master" }
 frame-rpc-system = { package = "substrate-frame-rpc-system", git = "https://github.com/paritytech/substrate", branch = "master" }
 pallet-transaction-payment-rpc = { git = "https://github.com/paritytech/substrate", branch = "master" }
@@ -110,4 +110,5 @@ try-runtime = [
 	"statemine-runtime/try-runtime",
 	"westmint-runtime/try-runtime",
 	"shell-runtime/try-runtime",
+	"try-runtime-cli/try-runtime",
 ]
diff --git a/polkadot-parachain/src/cli.rs b/polkadot-parachain/src/cli.rs
@@ -56,7 +56,12 @@ pub enum Subcommand {
 	Benchmark(frame_benchmarking_cli::BenchmarkCmd),
 
 	/// Try some testing command against a specified runtime state.
+	#[cfg(feature = "try-runtime")]
 	TryRuntime(try_runtime_cli::TryRuntimeCmd),
+
+	/// Errors since the binary was not build with `--features try-runtime`.
+	#[cfg(not(feature = "try-runtime"))]
+	TryRuntime,
 }
 
 #[derive(Debug, clap::Parser)]

diff --git a/polkadot-parachain/src/command.rs b/polkadot-parachain/src/command.rs
@@ -18,8 +18,8 @@ use crate::{
 	chain_spec,
 	cli::{Cli, RelayChainCli, Subcommand},
 	service::{
-		new_partial, Block, CollectivesPolkadotRuntimeExecutor, ShellRuntimeExecutor,
-		StatemineRuntimeExecutor, StatemintRuntimeExecutor, WestmintRuntimeExecutor,
+		new_partial, Block, CollectivesPolkadotRuntimeExecutor, StatemineRuntimeExecutor,
+		StatemintRuntimeExecutor, WestmintRuntimeExecutor,
 	},
 };
 use codec::Encode;
@@ -32,10 +32,7 @@ use sc_cli::{
 	ChainSpec, CliConfiguration, DefaultConfigurationValues, ImportParams, KeystoreParams,
 	NetworkParams, Result, RuntimeVersion, SharedParams, SubstrateCli,
 };
-use sc_service::{
-	config::{BasePath, PrometheusConfig},
-	TaskManager,
-};
+use sc_service::config::{BasePath, PrometheusConfig};
 use sp_core::hexdisplay::HexDisplay;
 use sp_runtime::traits::{AccountIdConversion, Block as BlockT};
 use std::{net::SocketAddr, path::PathBuf};
@@ -597,41 +594,45 @@ pub fn run() -> Result<()> {
 				_ => Err("Benchmarking sub-command unsupported".into()),
 			}
 		},
+		#[cfg(feature = "try-runtime")]
 		Some(Subcommand::TryRuntime(cmd)) => {
-			if cfg!(feature = "try-runtime") {
-				// grab the task manager.
-				let runner = cli.create_runner(cmd)?;
-				let registry = &runner.config().prometheus_config.as_ref().map(|cfg| &cfg.registry);
-				let task_manager =
-					TaskManager::new(runner.config().tokio_handle.clone(), *registry)
-						.map_err(|e| format!("Error: {:?}", e))?;
-
-				match runner.config().chain_spec.runtime() {
-					Runtime::Statemine => runner.async_run(|config| {
-						Ok((cmd.run::<Block, StatemineRuntimeExecutor>(config), task_manager))
-					}),
-					Runtime::Westmint => runner.async_run(|config| {
-						Ok((cmd.run::<Block, WestmintRuntimeExecutor>(config), task_manager))
-					}),
-					Runtime::Statemint => runner.async_run(|config| {
-						Ok((cmd.run::<Block, StatemintRuntimeExecutor>(config), task_manager))
-					}),
-					Runtime::CollectivesPolkadot | Runtime::CollectivesWestend =>
-						runner.async_run(|config| {
-							Ok((
-								cmd.run::<Block, CollectivesPolkadotRuntimeExecutor>(config),
-								task_manager,
-							))
-						}),
-					Runtime::Shell => runner.async_run(|config| {
-						Ok((cmd.run::<Block, ShellRuntimeExecutor>(config), task_manager))
+			// grab the task manager.
+			let runner = cli.create_runner(cmd)?;
+			let registry = &runner.config().prometheus_config.as_ref().map(|cfg| &cfg.registry);
+			let task_manager =
+				sc_service::TaskManager::new(runner.config().tokio_handle.clone(), *registry)
+					.map_err(|e| format!("Error: {:?}", e))?;
+
+			match runner.config().chain_spec.runtime() {
+				Runtime::Statemine => runner.async_run(|config| {
+					Ok((cmd.run::<Block, StatemineRuntimeExecutor>(config), task_manager))
+				}),
+				Runtime::Westmint => runner.async_run(|config| {
+					Ok((cmd.run::<Block, WestmintRuntimeExecutor>(config), task_manager))
+				}),
+				Runtime::Statemint => runner.async_run(|config| {
+					Ok((cmd.run::<Block, StatemintRuntimeExecutor>(config), task_manager))
+				}),
+				Runtime::CollectivesPolkadot | Runtime::CollectivesWestend =>
+					runner.async_run(|config| {
+						Ok((
+							cmd.run::<Block, CollectivesPolkadotRuntimeExecutor>(config),
+							task_manager,
+						))
 					}),
-					_ => Err("Chain doesn't support try-runtime".into()),
-				}
-			} else {
-				Err("Try-runtime must be enabled by `--features try-runtime`.".into())
+				Runtime::Shell => runner.async_run(|config| {
+					Ok((
+						cmd.run::<Block, crate::service::ShellRuntimeExecutor>(config),
+						task_manager,
+					))
+				}),
+				_ => Err("Chain doesn't support try-runtime".into()),
 			}
 		},
+		#[cfg(not(feature = "try-runtime"))]
+		Some(Subcommand::TryRuntime) => Err("Try-runtime was not enabled when building the node. \
+			You can enable it with `--features try-runtime`."
+			.into()),
 		Some(Subcommand::Key(cmd)) => Ok(cmd.run(&cli)?),
 		None => {
 			let runner = cli.create_runner(&cli.run.normalize())?;