pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-07-19 21:35:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

rpc: Implement chainSpec RPC API (#12261)

Browse Source 
* rpc/chain_spec: Add traits for `chainSpec` API

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* rpc/chain_spec: Implement `chainSpec` RPC methods

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* rpc/chain_spec: Add tests

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* bin/node: Enable `chainSpec` API

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* rpc/chain_spec: Assume `genesis_hash` as non-empty

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* Update client/rpc-spec/Cargo.toml

Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>

* Update client/rpc-spec/src/lib.rs

Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>

* client/rpc_spec: Rename crate to `rpc_spec_v2`

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* rpc-servers: Remove the `version` field from `rpc_methods`

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

* rpc/chain_spec: Fix copyright years

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>

Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>
This commit is contained in:
Alexandru Vasile
2022-09-20 18:18:03 +03:00
committed by GitHub
parent ea1c8bd2db
commit 5f248e9b94
12 changed files with 286 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/client/rpc-spec-v2/src/chain_spec/api.rs
+53
View File
@@ -0,0 +1,53 @@
// This file is part of Substrate.
// Copyright (C) 2022 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/>.
//! API trait of the chain spec.
use jsonrpsee::{core::RpcResult, proc_macros::rpc};
use sc_chain_spec::Properties;
#[rpc(client, server)]
pub trait ChainSpecApi {
/// Get the chain name, as present in the chain specification.
///
/// # Unstable
///
/// This method is unstable and subject to change in the future.
#[method(name = "chainSpec_unstable_chainName")]
fn chain_spec_unstable_chain_name(&self) -> RpcResult<String>;
/// Get the chain's genesis hash.
///
/// # Unstable
///
/// This method is unstable and subject to change in the future.
#[method(name = "chainSpec_unstable_genesisHash")]
fn chain_spec_unstable_genesis_hash(&self) -> RpcResult<String>;
/// Get the properties of the chain, as present in the chain specification.
///
/// # Note
///
/// The json whitespaces are not guaranteed to persist.
///
/// # Unstable
///
/// This method is unstable and subject to change in the future.
#[method(name = "chainSpec_unstable_properties")]
fn chain_spec_unstable_properties(&self) -> RpcResult<Properties>;
}
substrate/client/rpc-spec-v2/src/chain_spec/chain_spec.rs
+60
View File
@@ -0,0 +1,60 @@
// This file is part of Substrate.
// Copyright (C) 2022 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/>.
//! API implementation for the specification of a chain.
use crate::chain_spec::api::ChainSpecApiServer;
use jsonrpsee::core::RpcResult;
use sc_chain_spec::Properties;
/// An API for chain spec RPC calls.
pub struct ChainSpec {
/// The name of the chain.
name: String,
/// The hexadecimal encoded hash of the genesis block.
genesis_hash: String,
/// Chain properties.
properties: Properties,
}
impl ChainSpec {
/// Creates a new [`ChainSpec`].
pub fn new<Hash: AsRef<[u8]>>(
name: String,
genesis_hash: Hash,
properties: Properties,
) -> Self {
let genesis_hash = format!("0x{}", hex::encode(genesis_hash));
Self { name, properties, genesis_hash }
}
}
impl ChainSpecApiServer for ChainSpec {
fn chain_spec_unstable_chain_name(&self) -> RpcResult<String> {
Ok(self.name.clone())
}
fn chain_spec_unstable_genesis_hash(&self) -> RpcResult<String> {
Ok(self.genesis_hash.clone())
}
fn chain_spec_unstable_properties(&self) -> RpcResult<Properties> {
Ok(self.properties.clone())
}
}
substrate/client/rpc-spec-v2/src/chain_spec/mod.rs
+38
View File
@@ -0,0 +1,38 @@
// This file is part of Substrate.
// Copyright (C) 2022 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/>.
//! Substrate chain specification API.
//!
//! The *chain spec* (short for *chain specification*) allows inspecting the content of
//! the specification of the chain that a JSON-RPC server is targeting.
//!
//! The values returned by the API are guaranteed to never change during the lifetime of the
//! JSON-RPC server.
//!
//! # Note
//!
//! Methods are prefixed by `chainSpec`.
#[cfg(test)]
mod tests;
pub mod api;
pub mod chain_spec;
pub use api::ChainSpecApiServer;
pub use chain_spec::ChainSpec;
substrate/client/rpc-spec-v2/src/chain_spec/tests.rs
+61
View File
@@ -0,0 +1,61 @@
// This file is part of Substrate.
// Copyright (C) 2022 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/>.
use super::*;
use jsonrpsee::{types::EmptyParams, RpcModule};
use sc_chain_spec::Properties;
const CHAIN_NAME: &'static str = "TEST_CHAIN_NAME";
const CHAIN_GENESIS: [u8; 32] = [0; 32];
const CHAIN_PROPERTIES: &'static str = r#"{"three": "123", "one": 1, "two": 12}"#;
fn api() -> RpcModule<ChainSpec> {
ChainSpec::new(
CHAIN_NAME.to_string(),
CHAIN_GENESIS,
serde_json::from_str(CHAIN_PROPERTIES).unwrap(),
)
.into_rpc()
}
#[tokio::test]
async fn chain_spec_chain_name_works() {
let name = api()
.call::<_, String>("chainSpec_unstable_chainName", EmptyParams::new())
.await
.unwrap();
assert_eq!(name, CHAIN_NAME);
}
#[tokio::test]
async fn chain_spec_genesis_hash_works() {
let genesis = api()
.call::<_, String>("chainSpec_unstable_genesisHash", EmptyParams::new())
.await
.unwrap();
assert_eq!(genesis, format!("0x{}", hex::encode(CHAIN_GENESIS)));
}
#[tokio::test]
async fn chain_spec_properties_works() {
let properties = api()
.call::<_, Properties>("chainSpec_unstable_properties", EmptyParams::new())
.await
.unwrap();
assert_eq!(properties, serde_json::from_str(CHAIN_PROPERTIES).unwrap());
}
substrate/client/rpc-spec-v2/src/lib.rs
+26
View File
@@ -0,0 +1,26 @@
// This file is part of Substrate.
// Copyright (C) 2022 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/>.
//! Substrate JSON-RPC interface v2.
//!
//! Specification [document](https://paritytech.github.io/json-rpc-interface-spec/).
#![warn(missing_docs)]
#![deny(unused_crate_dependencies)]
pub mod chain_spec;