This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
State migration rpc #10981
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| [package] | ||
| name = "sc-state-trie-migration-rpc" | ||
| version = "4.0.0-dev" | ||
| authors = ["Parity Technologies <admin@parity.io>"] | ||
| edition = "2021" | ||
| license = "Apache-2.0" | ||
| homepage = "https://substrate.io" | ||
| repository = "https://github.com/paritytech/substrate/" | ||
| description = "Node-specific RPC methods for interaction with state trie migration." | ||
| readme = "README.md" | ||
|
|
||
| [package.metadata.docs.rs] | ||
| targets = ["x86_64-unknown-linux-gnu"] | ||
|
|
||
| [dependencies] | ||
| codec = { package = "parity-scale-codec", version = "3" } | ||
| jsonrpc-core = "18.0.0" | ||
| jsonrpc-core-client = "18.0.0" | ||
| jsonrpc-derive = "18.0.0" | ||
| serde = { version = "1", features = ["derive"] } | ||
| sp-state-trie-migration = { version = "4.0.0-dev", path = "../../primitives/state-trie-migration" } | ||
|
|
||
| # Substrate Dependencies | ||
| sc-client-api = { version = "4.0.0-dev", path = "../api" } | ||
| sc-rpc-api = { version = "0.10.0-dev", path = "../rpc-api" } | ||
| sp-runtime = { version = "6.0.0", path = "../../primitives/runtime" } | ||
|
|
||
| [dev-dependencies] | ||
| serde_json = "1" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Node-specific RPC methods for interaction with trie migration. | ||
|
|
||
| License: Apache-2.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| // This file is part of Substrate. | ||
|
|
||
| // Copyright (C) 2019-2022 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. | ||
|
|
||
| //! Rpc for state migration. | ||
|
|
||
| use jsonrpc_core::{Error, ErrorCode, Result}; | ||
| use jsonrpc_derive::rpc; | ||
| use sc_rpc_api::DenyUnsafe; | ||
| use serde::{Deserialize, Serialize}; | ||
| use sp_runtime::{generic::BlockId, traits::Block as BlockT}; | ||
| use std::sync::Arc; | ||
|
|
||
| #[derive(Serialize, Deserialize)] | ||
| #[serde(rename_all = "camelCase")] | ||
| #[serde(deny_unknown_fields)] | ||
| pub struct MigrationStatusResult { | ||
| top_remaining_to_migrate: u64, | ||
| child_remaining_to_migrate: u64, | ||
| } | ||
|
|
||
| /// Migration RPC methods. | ||
| #[rpc] | ||
| pub trait StateMigrationApi<BlockHash> { | ||
| /// Check current migration state. | ||
| /// | ||
| /// This call is performed locally without submitting any transactions. Thus executing this | ||
| /// won't change any state. Nonetheless it is a VERY costy call that should be | ||
| /// only exposed to trusted peers. | ||
| #[rpc(name = "state_trieMigrationStatus")] | ||
| fn call(&self, at: Option<BlockHash>) -> Result<MigrationStatusResult>; | ||
| } | ||
|
|
||
| /// An implementation of state migration specific RPC methods. | ||
| pub struct MigrationRpc<C, B, BA> { | ||
| client: Arc<C>, | ||
| backend: Arc<BA>, | ||
| deny_unsafe: DenyUnsafe, | ||
| _marker: std::marker::PhantomData<(B, BA)>, | ||
| } | ||
|
|
||
| impl<C, B, BA> MigrationRpc<C, B, BA> { | ||
| /// Create new state migration rpc for the given reference to the client. | ||
| pub fn new(client: Arc<C>, backend: Arc<BA>, deny_unsafe: DenyUnsafe) -> Self { | ||
| MigrationRpc { client, backend, deny_unsafe, _marker: Default::default() } | ||
| } | ||
| } | ||
|
|
||
| impl<C, B, BA> StateMigrationApi<<B as BlockT>::Hash> for MigrationRpc<C, B, BA> | ||
| where | ||
| B: BlockT, | ||
| C: Send + Sync + 'static + sc_client_api::HeaderBackend<B>, | ||
| BA: 'static + sc_client_api::backend::Backend<B>, | ||
| { | ||
| fn call(&self, at: Option<<B as BlockT>::Hash>) -> Result<MigrationStatusResult> { | ||
| if let Err(err) = self.deny_unsafe.check_if_safe() { | ||
| return Err(err.into()) | ||
| } | ||
|
|
||
| let block_id = BlockId::hash(at.unwrap_or_else(|| self.client.info().best_hash)); | ||
| let state = self.backend.state_at(block_id).map_err(error_into_rpc_err)?; | ||
| let (top, child) = | ||
| sp_state_trie_migration::migration_status(&state).map_err(error_into_rpc_err)?; | ||
|
|
||
| Ok(MigrationStatusResult { | ||
| top_remaining_to_migrate: top, | ||
| child_remaining_to_migrate: child, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| fn error_into_rpc_err(err: impl std::fmt::Display) -> Error { | ||
| Error { | ||
| code: ErrorCode::ServerError(0), // TODO check errors code | ||
|
|
||
| message: "Error while checking migration state".into(), | ||
| data: Some(err.to_string().into()), | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This crate should also be moved under the pallet. We already have multiple of these pallet rpc crates.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had it under pallet at first but the dependencies from client crate sc-service to pallet was rejected.
Wait, I don't have this dependency anymore, think I can move all under pallet now (even move primitive to rpc as suggested) 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, actually rpc requires dependency to clients crate, which is not allowed (other frame crate can do without because they are using the RuntimeApi interface).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then please move it to the
utils/frame/rpcfolderThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's cheating, but yes it results in one less crate, I'm happy with it.