mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-07 08:28:05 +00:00
Niklas Adolfsson
437ff7ee41
* generate docs for feature-gated items on crates.io * add newline in Cargo.toml * unify newlines * fix clippy * introduce macros for features * commit missing file * Update subxt/src/lib.rs * make it compile
54 lines
1.6 KiB
Rust
54 lines
1.6 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.
|
|
|
|
//! Low level light client implementation for RPC method and
|
|
//! subscriptions requests.
|
|
//!
|
|
//! The client implementation supports both native and wasm
|
|
//! environments.
|
|
//!
|
|
//! This leverages the smoldot crate to connect to the chain.
|
|
|
|
#![cfg_attr(docsrs, feature(doc_cfg))]
|
|
|
|
#[cfg(any(
|
|
all(feature = "web", feature = "native"),
|
|
not(any(feature = "web", feature = "native"))
|
|
))]
|
|
compile_error!("subxt: exactly one of the 'web' and 'native' features should be used.");
|
|
|
|
mod background;
|
|
mod client;
|
|
mod platform;
|
|
|
|
// Used to enable the js feature for wasm.
|
|
#[cfg(feature = "web")]
|
|
#[allow(unused_imports)]
|
|
pub use getrandom as _;
|
|
|
|
pub use client::{AddedChain, LightClientRpc, RawLightClientRpc};
|
|
|
|
/// Re-exports of the smoldot related objects.
|
|
pub mod smoldot {
|
|
pub use smoldot_light::{
|
|
platform::PlatformRef, AddChainConfig, AddChainConfigJsonRpc, ChainId, Client,
|
|
JsonRpcResponses,
|
|
};
|
|
|
|
#[cfg(feature = "native")]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "native")))]
|
|
pub use smoldot_light::platform::default::DefaultPlatform;
|
|
}
|
|
|
|
/// Light client error.
|
|
#[derive(Debug, thiserror::Error)]
|
|
pub enum LightClientRpcError {
|
|
/// Error encountered while adding the chain to the light-client.
|
|
#[error("Failed to add the chain to the light client: {0}.")]
|
|
AddChainError(String),
|
|
/// Error originated while trying to submit a RPC request.
|
|
#[error("RPC request cannot be sent: {0}.")]
|
|
Request(String),
|
|
}
|