JSON-RPC client generation (#2778)

* Bump jsonrpc & generate clients. * Initial version of JSON-RPC client. * Re-wort * Remove spurious `#[derive(Encode, Decode)]` They did not compile, since `Encode` and `Decode` are deliberately not implemented for `usize`. Fixes #2742. * Re-write rpc-client example. * Update to jsonrpc=12.0.0 * Remove unnecessary import * Bump version. * Revert version bump. * Bump again.
2026-04-26 20:27:58 +00:00 · 2019-06-04 18:43:55 +02:00
parent 5df89a8a6f
commit 6112f815b3
18 changed files with 289 additions and 103 deletions
@@ -0,0 +1,70 @@
+// 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/>.
+
+#![warn(missing_docs)]
+
+//! Example substrate RPC client code.
+//!
+//! This module shows how you can write a Rust RPC client that connects to a running
+//! substrate node and use staticly typed RPC wrappers.
+
+use futures::Future;
+use hyper::rt;
+use node_primitives::Hash;
+use substrate_rpc::author::{
+	AuthorClient,
+	hash::ExtrinsicOrHash,
+};
+use jsonrpc_core_client::{
+	transports::http,
+	RpcError,
+};
+
+fn main() {
+	env_logger::init();
+
+	rt::run(rt::lazy(|| {
+		let uri = "http://localhost:9933";
+
+		http::connect(uri)
+			.and_then(|client: AuthorClient<Hash, Hash>| {
+				remove_all_extrinsics(client)
+			})
+			.map_err(|e| {
+				println!("Error: {:?}", e);
+			})
+	}))
+}
+
+/// Remove all pending extrinsics from the node.
+///
+/// The example code takes `AuthorClient` and first:
+/// 1. Calls the `pending_extrinsics` method to get all extrinsics in the pool.
+/// 2. Then calls `remove_extrinsic` passing the obtained raw extrinsics.
+///
+/// As the resul of running the code the entire content of the transaction pool is going
+/// to be removed and the extrinsics are going to be temporarily banned.
+fn remove_all_extrinsics(client: AuthorClient<Hash, Hash>) -> impl Future<Item=(), Error=RpcError> {
+	client.pending_extrinsics()
+		.and_then(move |pending| {
+			client.remove_extrinsic(
+				pending.into_iter().map(|tx| ExtrinsicOrHash::Extrinsic(tx.into())).collect()
+			)
+		})
+		.map(|removed| {
+			println!("Removed extrinsics: {:?}", removed);
+		})
+}