mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-13 14:01:06 +00:00
Niklas Adolfsson
cb67f94455
* initial commit * update to reconnecting-ws-client v0.2 * re-export: reconnecting_rpc_client behind feature * add helper function for reconnect * fix nit in example * simplify code without weird error fmt * address grumbles * address grumbles * update reconnecting-ws-client 0.3 * cleanup error message
73 lines
2.4 KiB
Rust
73 lines
2.4 KiB
Rust
// Copyright 2019-2023 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 are used behind the scenes by Subxt backend implementations, for
|
|
//! example [`crate::backend::legacy::LegacyBackend`]. If you need an RPC client,
|
|
//! then you can manually instantiate one, and then hand it to Subxt if you'd like
|
|
//! to re-use it for the Subxt connection.
|
|
//!
|
|
//! - [`RpcClientT`] is the underlying dynamic RPC implementation. This provides
|
|
//! the low level [`RpcClientT::request_raw`] and [`RpcClientT::subscribe_raw`]
|
|
//! methods.
|
|
//! - [`RpcClient`] is the higher level wrapper around this, offering
|
|
//! the [`RpcClient::request`] and [`RpcClient::subscribe`] methods.
|
|
//!
|
|
//! # Example
|
|
//!
|
|
//! Fetching the genesis hash.
|
|
//!
|
|
//! ```no_run
|
|
//! # #[tokio::main]
|
|
//! # async fn main() {
|
|
//! use subxt::{
|
|
//! client::OnlineClient,
|
|
//! config::SubstrateConfig,
|
|
//! backend::rpc::RpcClient,
|
|
//! backend::legacy::LegacyRpcMethods,
|
|
//! };
|
|
//!
|
|
//! // Instantiate a default RPC client pointing at some URL.
|
|
//! let rpc_client = RpcClient::from_url("ws://localhost:9944")
|
|
//! .await
|
|
//! .unwrap();
|
|
//!
|
|
//! // Instantiate the legacy RPC interface, providing an appropriate
|
|
//! // config so that it uses the correct types for your chain.
|
|
//! let rpc_methods = LegacyRpcMethods::<SubstrateConfig>::new(rpc_client.clone());
|
|
//!
|
|
//! // Use it to make RPC calls, here using the legacy genesis_hash method.
|
|
//! let genesis_hash = rpc_methods
|
|
//! .genesis_hash()
|
|
//! .await
|
|
//! .unwrap();
|
|
//!
|
|
//! println!("{genesis_hash}");
|
|
//!
|
|
//! // Instantiate the Subxt interface using the same client and config if you
|
|
//! // want to reuse the same connection:
|
|
//! let client = OnlineClient::<SubstrateConfig>::from_rpc_client(rpc_client);
|
|
//! # }
|
|
//! ```
|
|
|
|
// Allow an `rpc.rs` file in the `rpc` folder to align better
|
|
// with other file names for their types.
|
|
#![allow(clippy::module_inception)]
|
|
|
|
crate::macros::cfg_jsonrpsee! {
|
|
mod jsonrpsee_impl;
|
|
}
|
|
|
|
crate::macros::cfg_reconnecting_rpc_client! {
|
|
mod reconnecting_jsonrpsee_impl;
|
|
pub use reconnecting_jsonrpsee_ws_client as reconnecting_rpc_client;
|
|
}
|
|
|
|
mod rpc_client;
|
|
mod rpc_client_t;
|
|
|
|
pub use rpc_client::{rpc_params, RpcClient, RpcParams, RpcSubscription};
|
|
pub use rpc_client_t::{RawRpcFuture, RawRpcSubscription, RawValue, RpcClientT};
|