This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chainHead_storage: Backport queries for value types (#14551)
* chainHead/events: Add storage params and events Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead/tests: Check storage events serialization / deserialization Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead/error: Add error for invalid WaitForContinue storage call Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead/storage: Use new items params Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead/tests: Adjust storage tests to the new API Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead/events: Generalize StorageQuery by provided key Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chain_head: Add dedicated ChainHeadStorage client for queries Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead/storage: Implement queries for hashes of values Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead/tests: Check storage queries for hashes of values Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead: Improve API documentation wrt multiple entries Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead/event: Rename StorageQueue ty to queue_ty Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chianHead: Add helper to encode chainHead results as hex str Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * Update client/rpc-spec-v2/src/chain_head/error.rs Co-authored-by: Sebastian Kunert <skunert49@gmail.com> * chainHead: Change the `queryResult` to a plain `Result` Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead: Stop producing events after the first error Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> * chainHead: Change child_key to child_trie API param Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> --------- Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io> Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
- Loading branch information
Showing
7 changed files
with
703 additions
and
110 deletions.
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
184 changes: 184 additions & 0 deletions
184
client/rpc-spec-v2/src/chain_head/chain_head_storage.rs
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,184 @@ | ||
| // This file is part of Substrate. | ||
|
|
||
| // Copyright (C) Parity Technologies (UK) Ltd. | ||
| // SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0 | ||
|
|
||
| // This program 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. | ||
|
|
||
| // This program 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 this program. If not, see <https://www.gnu.org/licenses/>. | ||
|
|
||
| //! Implementation of the `chainHead_storage` method. | ||
|
|
||
| use std::{marker::PhantomData, sync::Arc}; | ||
|
|
||
| use jsonrpsee::SubscriptionSink; | ||
| use sc_client_api::{Backend, ChildInfo, StorageKey, StorageProvider}; | ||
| use sp_api::BlockT; | ||
| use sp_core::storage::well_known_keys; | ||
|
|
||
| use super::{ | ||
| event::{ | ||
| ChainHeadStorageEvent, ItemsEvent, StorageQuery, StorageQueryType, StorageResult, | ||
| StorageResultType, | ||
| }, | ||
| hex_string, ErrorEvent, | ||
| }; | ||
|
|
||
| /// Generates the events of the `chainHead_storage` method. | ||
| pub struct ChainHeadStorage<Client, Block, BE> { | ||
| /// Substrate client. | ||
| client: Arc<Client>, | ||
| _phantom: PhantomData<(Block, BE)>, | ||
| } | ||
|
|
||
| impl<Client, Block, BE> ChainHeadStorage<Client, Block, BE> { | ||
| /// Constructs a new [`ChainHeadStorage`]. | ||
| pub fn new(client: Arc<Client>) -> Self { | ||
| Self { client, _phantom: PhantomData } | ||
| } | ||
| } | ||
|
|
||
| /// Checks if the provided key (main or child key) is valid | ||
| /// for queries. | ||
| /// | ||
| /// Keys that are identical to `:child_storage:` or `:child_storage:default:` | ||
| /// are not queryable. | ||
| fn is_key_queryable(key: &[u8]) -> bool { | ||
| !well_known_keys::is_default_child_storage_key(key) && | ||
| !well_known_keys::is_child_storage_key(key) | ||
| } | ||
|
|
||
| /// The result of making a query call. | ||
| type QueryResult = Result<StorageResult<String>, ChainHeadStorageEvent<String>>; | ||
|
|
||
| impl<Client, Block, BE> ChainHeadStorage<Client, Block, BE> | ||
| where | ||
| Block: BlockT + 'static, | ||
| BE: Backend<Block> + 'static, | ||
| Client: StorageProvider<Block, BE> + 'static, | ||
| { | ||
| /// Fetch the value from storage. | ||
| fn query_storage_value( | ||
| &self, | ||
| hash: Block::Hash, | ||
| key: &StorageKey, | ||
| child_key: Option<&ChildInfo>, | ||
| ) -> Option<QueryResult> { | ||
| let result = if let Some(child_key) = child_key { | ||
| self.client.child_storage(hash, child_key, key) | ||
| } else { | ||
| self.client.storage(hash, key) | ||
| }; | ||
|
|
||
| result | ||
| .map(|opt| { | ||
| opt.map(|storage_data| { | ||
| QueryResult::Ok(StorageResult::<String> { | ||
| key: hex_string(&key.0), | ||
| result: StorageResultType::Value(hex_string(&storage_data.0)), | ||
| }) | ||
| }) | ||
| }) | ||
| .unwrap_or_else(|err| { | ||
| Some(QueryResult::Err(ChainHeadStorageEvent::<String>::Error(ErrorEvent { | ||
| error: err.to_string(), | ||
| }))) | ||
| }) | ||
| } | ||
|
|
||
| /// Fetch the hash of a value from storage. | ||
| fn query_storage_hash( | ||
| &self, | ||
| hash: Block::Hash, | ||
| key: &StorageKey, | ||
| child_key: Option<&ChildInfo>, | ||
| ) -> Option<QueryResult> { | ||
| let result = if let Some(child_key) = child_key { | ||
| self.client.child_storage_hash(hash, child_key, key) | ||
| } else { | ||
| self.client.storage_hash(hash, key) | ||
| }; | ||
|
|
||
| result | ||
| .map(|opt| { | ||
| opt.map(|storage_data| { | ||
| QueryResult::Ok(StorageResult::<String> { | ||
| key: hex_string(&key.0), | ||
| result: StorageResultType::Hash(hex_string(&storage_data.as_ref())), | ||
| }) | ||
| }) | ||
| }) | ||
| .unwrap_or_else(|err| { | ||
| Some(QueryResult::Err(ChainHeadStorageEvent::<String>::Error(ErrorEvent { | ||
| error: err.to_string(), | ||
| }))) | ||
| }) | ||
| } | ||
|
|
||
| /// Make the storage query. | ||
| fn query_storage( | ||
| &self, | ||
| hash: Block::Hash, | ||
| query: &StorageQuery<StorageKey>, | ||
| child_key: Option<&ChildInfo>, | ||
| ) -> Option<QueryResult> { | ||
| if !is_key_queryable(&query.key.0) { | ||
| return None | ||
| } | ||
|
|
||
| match query.queue_type { | ||
| StorageQueryType::Value => self.query_storage_value(hash, &query.key, child_key), | ||
| StorageQueryType::Hash => self.query_storage_hash(hash, &query.key, child_key), | ||
| _ => None, | ||
| } | ||
| } | ||
|
|
||
| /// Generate the block events for the `chainHead_storage` method. | ||
| pub fn generate_events( | ||
| &self, | ||
| mut sink: SubscriptionSink, | ||
| hash: Block::Hash, | ||
| items: Vec<StorageQuery<StorageKey>>, | ||
| child_key: Option<ChildInfo>, | ||
| ) { | ||
| if let Some(child_key) = child_key.as_ref() { | ||
| if !is_key_queryable(child_key.storage_key()) { | ||
| let _ = sink.send(&ChainHeadStorageEvent::<String>::Done); | ||
| return | ||
| } | ||
| } | ||
|
|
||
| let mut storage_results = Vec::with_capacity(items.len()); | ||
| for item in items { | ||
| let Some(result) = self.query_storage(hash, &item, child_key.as_ref()) else { | ||
| continue | ||
| }; | ||
|
|
||
| match result { | ||
| QueryResult::Ok(storage_result) => storage_results.push(storage_result), | ||
| QueryResult::Err(event) => { | ||
| let _ = sink.send(&event); | ||
| // If an error is encountered for any of the query items | ||
| // do not produce any other events. | ||
| return | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| if !storage_results.is_empty() { | ||
| let event = ChainHeadStorageEvent::Items(ItemsEvent { items: storage_results }); | ||
| let _ = sink.send(&event); | ||
| } | ||
|
|
||
| let _ = sink.send(&ChainHeadStorageEvent::<String>::Done); | ||
| } | ||
| } |
Oops, something went wrong.