Allow generalising over RPC implementation (#634)

* WIP generalising RPC client * WIP: non-object-safe RpcClientT.. aah generics everywhere * WIP object-safe RpcClientT trait and no more extra generics * Get core things compiling again with object-safe RpcClientT trait * Make jsonrpsee optional and get test-runtime working again * cargo fmt * add RpcParams object to enforce correct formatting of rps params * Wee tweaks * clippy fixes * cargo fmt * TWeak a few types * make sure we get jsonrpsee-types, too * Add examples for rpc_params/RpcParams * more doc tweaks * remove a now unneeded dev note * Option<Box<RawValue>> instead to avoid allocations in some cases * update docs * tweak RpcClientT trait docs * Tweak docs around RpcClient and RpcClientT. Don't expose RpcClientT directly * more doc tweaking about RpcParams and undo decision not to expose RpcParamsT * Doc tweak Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com> * more doc tweaks * Fix doc thing * Add an example of injecting a custom RPC client * Fix a typo * Address clippy things in example * Fix a silly typo * another clippy fix * rpc_params to panic instead of returning a result, like serde_json::json, and deref on Rpc<T> * fix docs Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com>
2026-06-13 22:11:06 +00:00 · 2022-08-31 10:00:49 +01:00
parent 5ff849318b
commit 599107b432
17 changed files with 737 additions and 143 deletions
@@ -0,0 +1,77 @@
+// Copyright 2019-2022 Parity Technologies (UK) Ltd.
+// This file is dual-licensed as Apache-2.0 or GPL-3.0.
+// see LICENSE for license details.
+
+//! RPC types and client for interacting with a substrate node.
+//!
+//! These is used behind the scenes by various `subxt` APIs, but can
+//! also be used directly.
+//!
+//! - [`Rpc`] is the highest level wrapper, and the one you will run into
+//!   first. It contains the higher level methods for interacting with a node.
+//! - [`RpcClient`] is what [`Rpc`] uses to actually talk to a node, offering
+//!   a [`RpcClient::request`] and [`RpcClient::subscribe`] method to do so.
+//! - [`RpcClientT`] is the underlying dynamic RPC implementation. This provides
+//!   the low level [`RpcClientT::request_raw`] and [`RpcClientT::subscribe_raw`]
+//!   methods. This can be swapped out for a custom implementation, but by default
+//!   we'll rely on `jsonrpsee` for this.
+//!
+//! # Example
+//!
+//! Fetching storage keys
+//!
+//! ```no_run
+//! use subxt::{ PolkadotConfig, OnlineClient, storage::StorageKey };
+//!
+//! #[subxt::subxt(runtime_metadata_path = "../artifacts/polkadot_metadata.scale")]
+//! pub mod polkadot {}
+//!
+//! # #[tokio::main]
+//! # async fn main() {
+//! let api = OnlineClient::<PolkadotConfig>::new().await.unwrap();
+//!
+//! let key = polkadot::storage()
+//!     .xcm_pallet()
+//!     .version_notifiers_root()
+//!     .to_bytes();
+//!
+//! // Fetch up to 10 keys.
+//! let keys = api
+//!     .rpc()
+//!     .storage_keys_paged(&key, 10, None, None)
+//!     .await
+//!     .unwrap();
+//!
+//! for key in keys.iter() {
+//!     println!("Key: 0x{}", hex::encode(&key));
+//! }
+//! # }
+//! ```
+
+// Allow an `rpc.rs` file in the `rpc` folder to align better
+// with other file names for their types.
+#![allow(clippy::module_inception)]
+
+#[cfg(feature = "jsonrpsee")]
+mod jsonrpsee_impl;
+
+mod rpc;
+mod rpc_client;
+mod rpc_client_t;
+
+// Expose the `Rpc` struct and any associated types.
+pub use rpc::*;
+
+pub use rpc_client_t::{
+    RawValue,
+    RpcClientT,
+    RpcFuture,
+    RpcSubscription,
+};
+
+pub use rpc_client::{
+    rpc_params,
+    RpcClient,
+    RpcParams,
+    Subscription,
+};