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.
rpc: Implement
chainSpec RPC API (#12261)
* 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>
- Loading branch information
2 people
authored and
Mira Ressel
committed
Sep 20, 2022
1 parent
97ad64b
commit 39625c1
Showing
14 changed files
with
300 additions
and
521 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,23 @@ | ||
| [package] | ||
| name = "sc-rpc-spec-v2" | ||
| version = "0.10.0-dev" | ||
| authors = ["Parity Technologies <admin@parity.io>"] | ||
| edition = "2021" | ||
| license = "GPL-3.0-or-later WITH Classpath-exception-2.0" | ||
| homepage = "https://substrate.io" | ||
| repository = "https://github.com/paritytech/substrate/" | ||
| description = "Substrate RPC interface v2." | ||
| readme = "README.md" | ||
|
|
||
| [package.metadata.docs.rs] | ||
| targets = ["x86_64-unknown-linux-gnu"] | ||
|
|
||
| [dependencies] | ||
| jsonrpsee = { version = "0.15.1", features = ["server", "macros"] } | ||
| # Internal chain structures for "chain_spec". | ||
| sc-chain-spec = { version = "4.0.0-dev", path = "../chain-spec" } | ||
| hex = "0.4" | ||
|
|
||
| [dev-dependencies] | ||
| serde_json = "1.0" | ||
| tokio = { version = "1.17.0", features = ["macros"] } |
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,5 @@ | ||
| Substrate RPC interfaces. | ||
|
|
||
| A collection of RPC methods and subscriptions supported by all substrate clients. | ||
|
|
||
| License: GPL-3.0-or-later WITH Classpath-exception-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,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>; | ||
| } |
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,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()) | ||
| } | ||
| } |
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,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; |
Oops, something went wrong.