Add missing fields to the light sync state (#7225)

* Initial draft * Add an iterator that helps us get most items * Revert changes to grandpa * Change fields to just be the grandpa authority set and babe epoch changes * Only use the fields we need from the shared authority set * Switch to RPC call * Revert "Only use the fields we need from the shared authority set" This reverts commit 6ede87b0c5fe53f251d7cb45951006a7dc8f9b83. * Add babe_finalized_block_weight from `ashley-improve-sync-state-WIP-loading` * Fix rpc test * Move sync state rpc stuff into sc-sync-state-rpc * Remove as_json_value and remove unwraps from sc-sync-state-rpc * Add clone_inner to SharedAuthoritySet
2026-06-12 13:31:10 +00:00 · 2020-10-15 12:10:43 +02:00
parent a297e447f2
commit d1ef8507d7
22 changed files with 263 additions and 195 deletions
@@ -0,0 +1,27 @@
+[package]
+name = "sc-sync-state-rpc"
+version = "0.8.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+description = "A RPC handler to create sync states for light clients."
+edition = "2018"
+license = "Apache-2.0"
+homepage = "https://substrate.dev"
+repository = "https://github.com/paritytech/substrate/"
+readme = "README.md"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+jsonrpc-core = "15.0"
+jsonrpc-core-client = "15.0"
+jsonrpc-derive = "15.0"
+sc-chain-spec = { version = "2.0.0", path = "../chain-spec" }
+sc-client-api = { version = "2.0.0", path = "../api" }
+sc-consensus-babe = { version = "0.8.0", path = "../consensus/babe" }
+sc-consensus-epochs = { version = "0.8.0", path = "../consensus/epochs" }
+sc-finality-grandpa = { version = "0.8.0", path = "../finality-grandpa" }
+sc-rpc-api = { version = "0.8.0", path = "../rpc-api" }
+serde_json = "1.0.58"
+sp-blockchain = { version = "2.0.0", path = "../../primitives/blockchain" }
+sp-runtime = { version = "2.0.0", path = "../../primitives/runtime" }
@@ -0,0 +1,128 @@
+// Copyright 2020 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate 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.
+
+// Substrate 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 Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+//! A RPC handler to create sync states for light clients.
+//! Currently only usable with BABE + GRANDPA.
+
+use sp_runtime::traits::{Block as BlockT, NumberFor};
+use sp_blockchain::HeaderBackend;
+use std::sync::Arc;
+use sp_runtime::generic::BlockId;
+
+use jsonrpc_derive::rpc;
+
+type SharedAuthoritySet<TBl> =
+	sc_finality_grandpa::SharedAuthoritySet<<TBl as BlockT>::Hash, NumberFor<TBl>>;
+type SharedEpochChanges<TBl> = sc_consensus_epochs::SharedEpochChanges<TBl, sc_consensus_babe::Epoch>;
+
+struct Error(sp_blockchain::Error);
+
+impl From<Error> for jsonrpc_core::Error {
+	fn from(error: Error) -> Self {
+		jsonrpc_core::Error {
+			message: error.0.to_string(),
+			code:  jsonrpc_core::ErrorCode::ServerError(1),
+			data: None,
+		}
+	}
+}
+
+/// An api for sync state RPC calls.
+#[rpc]
+pub trait SyncStateRpcApi {
+	/// Returns the json-serialized chainspec running the node, with a sync state.
+	#[rpc(name = "sync_state_genSyncSpec", returns = "jsonrpc_core::Value")]
+	fn system_gen_sync_spec(&self, raw: bool)
+		-> jsonrpc_core::Result<jsonrpc_core::Value>;
+}
+
+/// The handler for sync state RPC calls.
+pub struct SyncStateRpcHandler<TBl: BlockT, TCl> {
+	chain_spec: Box<dyn sc_chain_spec::ChainSpec>,
+	client: Arc<TCl>,
+	shared_authority_set: SharedAuthoritySet<TBl>,
+	shared_epoch_changes: SharedEpochChanges<TBl>,
+	deny_unsafe: sc_rpc_api::DenyUnsafe,
+}
+
+impl<TBl, TCl> SyncStateRpcHandler<TBl, TCl>
+	where
+		TBl: BlockT,
+		TCl: HeaderBackend<TBl> + sc_client_api::AuxStore + 'static,
+{
+	/// Create a new handler.
+	pub fn new(
+		chain_spec: Box<dyn sc_chain_spec::ChainSpec>,
+		client: Arc<TCl>,
+		shared_authority_set: SharedAuthoritySet<TBl>,
+		shared_epoch_changes: SharedEpochChanges<TBl>,
+		deny_unsafe: sc_rpc_api::DenyUnsafe,
+	) -> Self {
+		Self {
+			chain_spec, client, shared_authority_set, shared_epoch_changes, deny_unsafe,
+		}
+	}
+	
+	fn build_sync_state(&self) -> Result<sc_chain_spec::LightSyncState<TBl>, sp_blockchain::Error> {
+		let finalized_hash = self.client.info().finalized_hash;
+		let finalized_header = self.client.header(BlockId::Hash(finalized_hash))?
+			.ok_or_else(|| sp_blockchain::Error::Msg(
+				format!("Failed to get the header for block {:?}", finalized_hash)
+			))?;
+
+		let finalized_block_weight = sc_consensus_babe::aux_schema::load_block_weight(
+			&*self.client,
+			finalized_hash,
+		)?
+			.ok_or_else(|| sp_blockchain::Error::Msg(
+				format!("Failed to load the block weight for block {:?}", finalized_hash)
+			))?;
+
+		Ok(sc_chain_spec::LightSyncState {
+			finalized_block_header: finalized_header,
+			babe_epoch_changes: self.shared_epoch_changes.lock().clone(),
+			babe_finalized_block_weight: finalized_block_weight,
+			grandpa_authority_set: self.shared_authority_set.clone_inner(),
+		})
+	}
+}
+
+impl<TBl, TCl> SyncStateRpcApi for SyncStateRpcHandler<TBl, TCl>
+	where
+		TBl: BlockT,
+		TCl: HeaderBackend<TBl> + sc_client_api::AuxStore + 'static,
+{
+	fn system_gen_sync_spec(&self, raw: bool)
+		-> jsonrpc_core::Result<jsonrpc_core::Value>
+	{
+		if let Err(err) = self.deny_unsafe.check_if_safe() {
+			return Err(err.into());
+		}
+
+		let mut chain_spec = self.chain_spec.cloned_box();
+
+		let sync_state = self.build_sync_state().map_err(Error)?;
+
+		chain_spec.set_light_sync_state(sync_state.to_serializable());
+		let string = chain_spec.as_json(raw).map_err(map_error)?;
+
+		serde_json::from_str(&string).map_err(|err| map_error(err.to_string()))
+	}
+}
+
+fn map_error(error: String) -> jsonrpc_core::Error {
+	Error(sp_blockchain::Error::Msg(error)).into()
+}