follow-chain testing mode for try-runtime (and revamp CLI configs). (#9788)

* deadlock, need to ask someone to help now * Finally it seems to be working.. at least for a few blocks * self-review * major mega revamp * some small fixes * another mega refactor * add license * Apply suggestions from code review * hack around signature verification * Some fixes * Update utils/frame/try-runtime/cli/src/lib.rs Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com> * Update utils/frame/try-runtime/cli/src/lib.rs Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com> * Update utils/frame/try-runtime/cli/src/lib.rs Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com> * final tweaks, hopefully. * a little self-review * Add the ext root check Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com>
2026-07-08 03:07:22 +00:00 · 2021-09-21 16:04:28 +01:00
parent 94635218af
commit 8f5f89324d
14 changed files with 1237 additions and 379 deletions
@@ -0,0 +1,176 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2021 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use crate::{
+	build_executor, ensure_matching_spec, extract_code, full_extensions, local_spec, parse,
+	state_machine_call, SharedParams, LOG_TARGET,
+};
+use jsonrpsee_ws_client::{
+	types::{traits::SubscriptionClient, v2::params::JsonRpcParams, Subscription},
+	WsClientBuilder,
+};
+use parity_scale_codec::Decode;
+use remote_externalities::{rpc_api, Builder, Mode, OnlineConfig};
+use sc_executor::NativeExecutionDispatch;
+use sc_service::Configuration;
+use sp_core::H256;
+use sp_runtime::traits::{Block as BlockT, Header, NumberFor};
+use std::{fmt::Debug, str::FromStr};
+
+const SUB: &'static str = "chain_subscribeFinalizedHeads";
+const UN_SUB: &'static str = "chain_unsubscribeFinalizedHeads";
+
+/// Configurations of the [`Command::FollowChain`].
+#[derive(Debug, Clone, structopt::StructOpt)]
+pub struct FollowChainCmd {
+	/// The url to connect to.
+	#[structopt(
+			short,
+			long,
+			parse(try_from_str = parse::url),
+		)]
+	uri: String,
+}
+
+pub(crate) async fn follow_chain<Block, ExecDispatch>(
+	shared: SharedParams,
+	command: FollowChainCmd,
+	config: Configuration,
+) -> sc_cli::Result<()>
+where
+	Block: BlockT<Hash = H256> + serde::de::DeserializeOwned,
+	Block::Hash: FromStr,
+	Block::Header: serde::de::DeserializeOwned,
+	<Block::Hash as FromStr>::Err: Debug,
+	NumberFor<Block>: FromStr,
+	<NumberFor<Block> as FromStr>::Err: Debug,
+	ExecDispatch: NativeExecutionDispatch + 'static,
+{
+	let mut maybe_state_ext = None;
+
+	let client = WsClientBuilder::default()
+		.connection_timeout(std::time::Duration::new(20, 0))
+		.max_notifs_per_subscription(1024)
+		.max_request_body_size(u32::MAX)
+		.build(&command.uri)
+		.await
+		.unwrap();
+
+	log::info!(target: LOG_TARGET, "subscribing to {:?} / {:?}", SUB, UN_SUB);
+	let mut subscription: Subscription<Block::Header> =
+		client.subscribe(&SUB, JsonRpcParams::NoParams, &UN_SUB).await.unwrap();
+
+	let (code_key, code) = extract_code(&config.chain_spec)?;
+	let executor = build_executor::<ExecDispatch>(&shared, &config);
+	let execution = shared.execution;
+
+	loop {
+		let header = match subscription.next().await {
+			Ok(Some(header)) => header,
+			Ok(None) => {
+				log::warn!("subscription returned `None`. Probably decoding has failed.");
+				break
+			},
+			Err(why) => {
+				log::warn!("subscription returned error: {:?}.", why);
+				continue
+			},
+		};
+
+		let hash = header.hash();
+		let number = header.number();
+
+		let block = rpc_api::get_block::<Block, _>(&command.uri, hash).await.unwrap();
+
+		log::debug!(
+			target: LOG_TARGET,
+			"new block event: {:?} => {:?}, extrinsics: {}",
+			hash,
+			number,
+			block.extrinsics().len()
+		);
+
+		// create an ext at the state of this block, whatever is the first subscription event.
+		if maybe_state_ext.is_none() {
+			let builder = Builder::<Block>::new().mode(Mode::Online(OnlineConfig {
+				transport: command.uri.clone().into(),
+				at: Some(header.parent_hash().clone()),
+				..Default::default()
+			}));
+
+			let new_ext =
+				builder.inject_key_value(&[(code_key.clone(), code.clone())]).build().await?;
+			log::info!(
+				target: LOG_TARGET,
+				"initialized state externalities at {:?}, storage root {:?}",
+				number,
+				new_ext.as_backend().root()
+			);
+
+			let (expected_spec_name, expected_spec_version) =
+				local_spec::<Block, ExecDispatch>(&new_ext, &executor);
+			ensure_matching_spec::<Block>(
+				command.uri.clone(),
+				expected_spec_name,
+				expected_spec_version,
+				shared.no_spec_name_check,
+			)
+			.await;
+
+			maybe_state_ext = Some(new_ext);
+		}
+
+		let state_ext =
+			maybe_state_ext.as_mut().expect("state_ext either existed or was just created");
+
+		let (mut changes, encoded_result) = state_machine_call::<Block, ExecDispatch>(
+			&state_ext,
+			&executor,
+			execution,
+			"TryRuntime_execute_block_no_check",
+			block.encode().as_ref(),
+			full_extensions(),
+		)?;
+
+		let consumed_weight = <u64 as Decode>::decode(&mut &*encoded_result)
+			.map_err(|e| format!("failed to decode output: {:?}", e))?;
+
+		let storage_changes = changes
+			.drain_storage_changes::<_, _, NumberFor<Block>>(
+				&state_ext.backend,
+				None,
+				Default::default(),
+				&mut Default::default(),
+			)
+			.unwrap();
+		state_ext.backend.apply_transaction(
+			storage_changes.transaction_storage_root,
+			storage_changes.transaction,
+		);
+
+		log::info!(
+			target: LOG_TARGET,
+			"executed block {}, consumed weight {}, new storage root {:?}",
+			number,
+			consumed_weight,
+			state_ext.as_backend().root(),
+		);
+	}
+
+	log::error!(target: LOG_TARGET, "ws subscription must have terminated.");
+	Ok(())
+}