Migration testing runtime API/Bot

frame/support/src/traits.rs

@@ -1553,17 +1553,15 @@ pub trait OnRuntimeUpgrade {
 
 	/// Execute some pre-checks prior to a runtime upgrade.
 	///
-	/// These hooks are never meant to be executed on-chain, instead only be used by 3rd party tools
-	/// for testing.
+	/// This hook is never meant to be executed on-chain but is meant to be used by testing tools.
 	#[cfg(feature = "try-runtime")]
 	fn pre_upgrade() -> Result<(), &'static str> {
 		Ok(())
 	}
 
-	/// Execute some post-checks prior to a runtime upgrade.
+	/// Execute some post-checks after a runtime upgrade.
 	///
-	/// These hooks are never meant to be executed on-chain, instead only be used by 3rd party tools
-	/// for testing.
+	/// This hook is never meant to be executed on-chain but is meant to be used by testing tools.
 	#[cfg(feature = "try-runtime")]
 	fn post_upgrade() -> Result<(), &'static str> {
 		Ok(())

frame/try-runtime/Cargo.toml

@@ -16,7 +16,7 @@ targets = ["x86_64-unknown-linux-gnu"]
 codec = { package = "parity-scale-codec", version = "2.0.0", default-features = false }
 
 sp-api = { version = "3.0.0", path = "../../primitives/api", default-features = false }
-sp-std = { version = "3.0.0", default-features = false, path = "../../primitives/std" }
+sp-std = { version = "3.0.0", path = "../../primitives/std" , default-features = false }
 
 frame-support = { version = "3.0.0", path = "../support", default-features = false }
 

frame/try-runtime/src/lib.rs

@@ -15,7 +15,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! Supporting types for try-runtime, testing and dry-run commands.
+//! Supporting types for try-runtime, testing and dry-running commands.
 
 #![cfg_attr(not(feature = "std"), no_std)]
 
@@ -25,8 +25,8 @@ use sp_std::prelude::*;
 #[doc(hidden)]
 pub use frame_support as _support;
 
-/// Helper macro to generate the match expression needed to match pallet name to their
-/// `on_runtime_upgrade()` implementation.
+/// Helper macro to generate the match expression needed to match a pallet name to
+/// its `on_runtime_upgrade()` implementation.
 #[macro_export]
 macro_rules! match_pallet_on_runtime_upgrade {
 	($name:ident, $($pallet:ty),* $(,)*) => {
@@ -66,7 +66,7 @@ impl sp_std::str::FromStr for Target {
 }
 
 sp_api::decl_runtime_apis! {
-	/// Runtime api for testing the execution of an upcoming runtime upgrade.
+	/// Runtime api for testing the execution of a runtime upgrade.
 	pub trait TryRuntime {
 		/// dry-run runtime upgrades, returning the total weight consumed.
 		///

utils/frame/try-runtime/cli/src/lib.rs

@@ -28,10 +28,9 @@ use sp_runtime::traits::{Block as BlockT, NumberFor};
 use sp_core::storage::{StorageData, StorageKey, well_known_keys};
 use frame_try_runtime::Target;
 
-/// Various commands to try-out (similar to `TryFrom`, `TryInto`) the new runtime, over configurable
-/// states.
+/// Various commands to try out the new runtime, over configurable states.
 ///
-/// For now this only assumes running the runtime-upgrade hooks.
+/// For now this only assumes running the `on_runtime_upgrade` hooks.
 #[derive(Debug, structopt::StructOpt)]
 pub struct TryRuntimeCmd {
 	/// The shared parameters
@@ -51,7 +50,7 @@ pub struct TryRuntimeCmd {
 /// The state to use for a migration dry-run.
 #[derive(Debug)]
 pub enum State {
-	/// A snapshot. Inner value is file path.
+	/// A snapshot. Inner value is a file path.
 	Snap(String),
 
 	/// A live chain. Inner value is the HTTP uri.
@@ -81,10 +80,6 @@ impl TryRuntimeCmd {
 		B: BlockT,
 		ExecDispatch: NativeExecutionDispatch + 'static,
 	{
-		// // prevent a potentially confusing MethodNotFound error from state machine.
-		// if !cfg!(feature = "try-runtime") {
-		// 	panic!("`TryRuntime` api is not enabled without `try-runtime` feature. Compile with this feature.")
-		// }
 
 		let spec = config.chain_spec;
 		let genesis_storage = spec.build_storage()?;