mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-09 20:11:09 +00:00
Typed chain state queries over rpc. (#4079)
* Create typed client helpers for querying chain state storage items declared by 'decl_storage!'. * Update substrate-rpc-custom functions to use async await syntax. * The implementation of substrate-rpc-custom was a bit verbose and repetitive. This commit makes the implementation simpler by intruducing a struct which represents query for a typed value in storage. The new struct is called StorageQuery. A StorageQuery wraps a raw StorageKey but is not directy constructable. To construct a StorageQuery, the user must supply an implementation of a srml_support::storage::generator trait such as StorageValue or StorageMap. A type implementing one of the generator traits can be aquired by: A) marking a storage item as pub within a call to decl_storage (recommended) or B) implementing one of the generator types manually. While option B may sometimes me necessary, it's not recommended because separate manual implementaions may lose sync with the original definition. * drop unused dependency * fmt * Remove unnecessary pub from Authorities field in test-runtime storage declaration. This field was added to support a test in an earlier commit. The test no longer relies on test-runtime so the change can be reverted. * Move it to srml as support extension. * Fix long lines. * Fix.
This commit is contained in:
Tomasz Drwięga
committed by
Bastian Köcher
Bastian Köcher
parent
bb0736cdba
commit
57ab3aeb82
Generated
+31
@@ -1354,6 +1354,7 @@ name = "futures-util"
|
||||
version = "0.3.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
dependencies = [
|
||||
"futures 0.1.29 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"futures-channel 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"futures-core 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"futures-io 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
@@ -1682,6 +1683,18 @@ dependencies = [
|
||||
"webpki-roots 0.17.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "hyper-tls"
|
||||
version = "0.3.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
dependencies = [
|
||||
"bytes 0.4.12 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"futures 0.1.29 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"hyper 0.12.35 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"native-tls 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"tokio-io 0.1.12 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "idna"
|
||||
version = "0.1.5"
|
||||
@@ -1803,6 +1816,7 @@ dependencies = [
|
||||
"failure 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"futures 0.1.29 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"hyper 0.12.35 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"hyper-tls 0.3.2 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"jsonrpc-core 14.0.3 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"jsonrpc-pubsub 14.0.3 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"log 0.4.8 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
@@ -4895,6 +4909,22 @@ dependencies = [
|
||||
"syn 1.0.7 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "srml-support-rpc"
|
||||
version = "2.0.0"
|
||||
dependencies = [
|
||||
"futures 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"jsonrpc-client-transports 14.0.3 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"jsonrpc-core 14.0.3 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"parity-scale-codec 1.0.6 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"serde 1.0.102 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"srml-support 2.0.0",
|
||||
"srml-system 2.0.0",
|
||||
"substrate-primitives-storage 2.0.0",
|
||||
"substrate-rpc-api 2.0.0",
|
||||
"tokio 0.1.22 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "srml-support-test"
|
||||
version = "2.0.0"
|
||||
@@ -7612,6 +7642,7 @@ dependencies = [
|
||||
"checksum hyper 0.10.16 (registry+https://github.com/rust-lang/crates.io-index)" = "0a0652d9a2609a968c14be1a9ea00bf4b1d64e2e1f53a1b51b6fff3a6e829273"
|
||||
"checksum hyper 0.12.35 (registry+https://github.com/rust-lang/crates.io-index)" = "9dbe6ed1438e1f8ad955a4701e9a944938e9519f6888d12d8558b645e247d5f6"
|
||||
"checksum hyper-rustls 0.17.1 (registry+https://github.com/rust-lang/crates.io-index)" = "719d85c7df4a7f309a77d145340a063ea929dcb2e025bae46a80345cffec2952"
|
||||
"checksum hyper-tls 0.3.2 (registry+https://github.com/rust-lang/crates.io-index)" = "3a800d6aa50af4b5850b2b0f659625ce9504df908e9733b635720483be26174f"
|
||||
"checksum idna 0.1.5 (registry+https://github.com/rust-lang/crates.io-index)" = "38f09e0f0b1fb55fdee1f17470ad800da77af5186a1a76c026b679358b7e844e"
|
||||
"checksum idna 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)" = "02e2673c30ee86b5b96a9cb52ad15718aa1f966f5ab9ad54a8b95d5ca33120a9"
|
||||
"checksum impl-codec 0.4.1 (registry+https://github.com/rust-lang/crates.io-index)" = "3fa0086251524c50fd53b32e7b05eb6d79e2f97221eaf0c53c0ca9c3096f21d3"
|
||||
|
||||
@@ -57,6 +57,7 @@ members = [
|
||||
"core/utils/wasm-builder-runner",
|
||||
"core/wasm-interface",
|
||||
"srml/support",
|
||||
"srml/support/rpc",
|
||||
"srml/support/procedural",
|
||||
"srml/support/procedural/tools",
|
||||
"srml/support/procedural/tools/derive",
|
||||
@@ -112,4 +113,3 @@ members = [
|
||||
[profile.release]
|
||||
# Substrate runtime requires unwinding.
|
||||
panic = "unwind"
|
||||
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
[package]
|
||||
name = "srml-support-rpc"
|
||||
version = "2.0.0"
|
||||
authors = ["Parity Technologies <admin@parity.io>", "Andrew Dirksen <andrew@dirksen.com>"]
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
futures = { version = "0.3.0", features = ["compat"] }
|
||||
jsonrpc-client-transports = "14"
|
||||
jsonrpc-core = "14"
|
||||
parity-scale-codec = "1"
|
||||
serde = "1"
|
||||
srml-support = { path = "../" }
|
||||
substrate-primitives-storage = { path = "../../../core/primitives/storage" }
|
||||
substrate-rpc-api = { path = "../../../core/rpc/api" }
|
||||
|
||||
[dev-dependencies]
|
||||
srml-system = { path = "../../system" }
|
||||
tokio = "0.1"
|
||||
@@ -0,0 +1,155 @@
|
||||
// Copyright 2019 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/>.
|
||||
|
||||
//! Combines [substrate_rpc_api::state::StateClient] with [srml_support::storage::generator] traits
|
||||
//! to provide strongly typed chain state queries over rpc.
|
||||
|
||||
#![warn(missing_docs)]
|
||||
|
||||
use core::marker::PhantomData;
|
||||
use futures::compat::Future01CompatExt;
|
||||
use jsonrpc_client_transports::RpcError;
|
||||
use parity_scale_codec::{DecodeAll, FullCodec, FullEncode};
|
||||
use serde::{de::DeserializeOwned, Serialize};
|
||||
use srml_support::storage::generator::{
|
||||
StorageDoubleMap, StorageLinkedMap, StorageMap, StorageValue
|
||||
};
|
||||
use substrate_primitives_storage::{StorageData, StorageKey};
|
||||
use substrate_rpc_api::state::StateClient;
|
||||
|
||||
/// A typed query on chain state usable from an RPC client.
|
||||
///
|
||||
/// ```no_run
|
||||
/// # use futures::compat::Compat;
|
||||
/// # use futures::compat::Future01CompatExt;
|
||||
/// # use futures::future::FutureExt;
|
||||
/// # use jsonrpc_client_transports::RpcError;
|
||||
/// # use jsonrpc_client_transports::transports::http;
|
||||
/// # use parity_scale_codec::Encode;
|
||||
/// # use srml_support::{decl_storage, decl_module};
|
||||
/// # use srml_support_rpc::StorageQuery;
|
||||
/// # use srml_system::Trait;
|
||||
/// # use substrate_rpc_api::state::StateClient;
|
||||
/// #
|
||||
/// # // Hash would normally be <TestRuntime as srml_system::Trait>::Hash, but we don't have
|
||||
/// # // srml_system::Trait implemented for TestRuntime. Here we just pretend.
|
||||
/// # type Hash = ();
|
||||
/// #
|
||||
/// # fn main() -> Result<(), RpcError> {
|
||||
/// # tokio::runtime::Runtime::new().unwrap().block_on(Compat::new(test().boxed()))
|
||||
/// # }
|
||||
/// #
|
||||
/// # struct TestRuntime;
|
||||
/// #
|
||||
/// # decl_module! {
|
||||
/// # pub struct Module<T: Trait> for enum Call where origin: T::Origin {}
|
||||
/// # }
|
||||
/// #
|
||||
/// pub type Loc = (i64, i64, i64);
|
||||
/// pub type Block = u8;
|
||||
///
|
||||
/// // Note that all fields are marked pub.
|
||||
/// decl_storage! {
|
||||
/// trait Store for Module<T: Trait> as TestRuntime {
|
||||
/// pub LastActionId: u64;
|
||||
/// pub Voxels: map Loc => Block;
|
||||
/// pub Actions: linked_map u64 => Loc;
|
||||
/// pub Prefab: double_map u128, blake2_256((i8, i8, i8)) => Block;
|
||||
/// }
|
||||
/// }
|
||||
///
|
||||
/// # async fn test() -> Result<(), RpcError> {
|
||||
/// let conn = http::connect("http://[::1]:9933").compat().await?;
|
||||
/// let cl = StateClient::<Hash>::new(conn);
|
||||
///
|
||||
/// let q = StorageQuery::value::<LastActionId>();
|
||||
/// let _: Option<u64> = q.get(&cl, None).await?;
|
||||
///
|
||||
/// let q = StorageQuery::map::<Voxels, _>((0, 0, 0));
|
||||
/// let _: Option<Block> = q.get(&cl, None).await?;
|
||||
///
|
||||
/// let q = StorageQuery::linked_map::<Actions, _>(12);
|
||||
/// let _: Option<Loc> = q.get(&cl, None).await?;
|
||||
///
|
||||
/// let q = StorageQuery::double_map::<Prefab, _, _>(3, (0, 0, 0));
|
||||
/// let _: Option<Block> = q.get(&cl, None).await?;
|
||||
/// #
|
||||
/// # Ok(())
|
||||
/// # }
|
||||
/// ```
|
||||
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
|
||||
pub struct StorageQuery<V> {
|
||||
key: StorageKey,
|
||||
_spook: PhantomData<V>,
|
||||
}
|
||||
|
||||
impl<V: FullCodec> StorageQuery<V> {
|
||||
/// Create a storage query for a StorageValue.
|
||||
pub fn value<St: StorageValue<V>>() -> Self {
|
||||
Self {
|
||||
key: StorageKey(St::storage_value_final_key().to_vec()),
|
||||
_spook: PhantomData,
|
||||
}
|
||||
}
|
||||
|
||||
/// Create a storage query for a value in a StorageMap.
|
||||
pub fn map<St: StorageMap<K, V>, K: FullEncode>(key: K) -> Self {
|
||||
Self {
|
||||
key: StorageKey(St::storage_map_final_key(key).as_ref().to_vec()),
|
||||
_spook: PhantomData,
|
||||
}
|
||||
}
|
||||
|
||||
/// Create a storage query for a value in a StorageLinkedMap.
|
||||
pub fn linked_map<St: StorageLinkedMap<K, V>, K: FullCodec>(key: K) -> Self {
|
||||
Self {
|
||||
key: StorageKey(St::storage_linked_map_final_key(key).as_ref().to_vec()),
|
||||
_spook: PhantomData,
|
||||
}
|
||||
}
|
||||
|
||||
/// Create a storage query for a value in a StorageDoubleMap.
|
||||
pub fn double_map<St: StorageDoubleMap<K1, K2, V>, K1: FullEncode, K2: FullEncode>(
|
||||
key1: K1,
|
||||
key2: K2,
|
||||
) -> Self {
|
||||
Self {
|
||||
key: StorageKey(St::storage_double_map_final_key(key1, key2)),
|
||||
_spook: PhantomData,
|
||||
}
|
||||
}
|
||||
|
||||
/// Send this query over RPC, await the typed result.
|
||||
///
|
||||
/// Hash should be <YourRuntime as srml::Trait>::Hash.
|
||||
///
|
||||
/// # Arguments
|
||||
///
|
||||
/// state_client represents a connection to the RPC server.
|
||||
///
|
||||
/// block_index indicates the block for which state will be queried. A value of None indicates
|
||||
/// the latest block.
|
||||
pub async fn get<Hash: Send + Sync + 'static + DeserializeOwned + Serialize>(
|
||||
self,
|
||||
state_client: &StateClient<Hash>,
|
||||
block_index: Option<Hash>,
|
||||
) -> Result<Option<V>, RpcError> {
|
||||
let opt: Option<StorageData> = state_client.storage(self.key, block_index).compat().await?;
|
||||
opt.map(|encoded| V::decode_all(&encoded.0))
|
||||
.transpose()
|
||||
.map_err(|decode_err| RpcError::Other(decode_err.into()))
|
||||
}
|
||||
}
|
||||
@@ -262,16 +262,21 @@ mod tests {
|
||||
|
||||
decl_storage! {
|
||||
trait Store for Module<T: Trait> as Example {
|
||||
pub Data get(fn data) build(|_| vec![(15u32, 42u64)]): linked_map hasher(twox_64_concat) u32 => u64;
|
||||
pub Data get(fn data) build(|_| vec![(15u32, 42u64)]):
|
||||
linked_map hasher(twox_64_concat) u32 => u64;
|
||||
pub OptionLinkedMap: linked_map u32 => Option<u32>;
|
||||
pub GenericData get(fn generic_data): linked_map hasher(twox_128) T::BlockNumber => T::BlockNumber;
|
||||
pub GenericData2 get(fn generic_data2): linked_map T::BlockNumber => Option<T::BlockNumber>;
|
||||
pub GenericData get(fn generic_data):
|
||||
linked_map hasher(twox_128) T::BlockNumber => T::BlockNumber;
|
||||
pub GenericData2 get(fn generic_data2):
|
||||
linked_map T::BlockNumber => Option<T::BlockNumber>;
|
||||
pub GetterNoFnKeyword get(no_fn): Option<u32>;
|
||||
|
||||
pub DataDM config(test_config) build(|_| vec![(15u32, 16u32, 42u64)]):
|
||||
double_map hasher(twox_64_concat) u32, blake2_256(u32) => u64;
|
||||
pub GenericDataDM: double_map T::BlockNumber, twox_128(T::BlockNumber) => T::BlockNumber;
|
||||
pub GenericData2DM: double_map T::BlockNumber, twox_256(T::BlockNumber) => Option<T::BlockNumber>;
|
||||
pub GenericDataDM:
|
||||
double_map T::BlockNumber, twox_128(T::BlockNumber) => T::BlockNumber;
|
||||
pub GenericData2DM:
|
||||
double_map T::BlockNumber, twox_256(T::BlockNumber) => Option<T::BlockNumber>;
|
||||
pub AppendableDM: double_map u32, blake2_256(T::BlockNumber) => Vec<u32>;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user