Struct subxt_lightclient::LightClientRpc

pub struct LightClientRpc { /* private fields */ }

The light-client RPC implementation that is used to connect with the chain.

Implementations

impl LightClientRpc

pub fn new( config: AddChainConfig<'_, (), impl IntoIterator<Item = ChainId>> ) -> Result<LightClientRpc, LightClientRpcError>

Constructs a new LightClientRpc, providing the chain specification.

The chain specification can be downloaded from a trusted network via the sync_state_genSyncSpec RPC method. This parameter expects the chain spec in text format (ie not in hex-encoded scale-encoded as RPC methods will provide).

Panics

The panic behaviour depends on the feature flag being used:

Native

Panics when called outside of a tokio runtime context.

Web

If smoldot panics, then the promise created will be leaked. For more details, see https://docs.rs/wasm-bindgen-futures/latest/wasm_bindgen_futures/fn.future_to_promise.html.

pub fn new_from_client<TPlat>( client: Client<TPlat>, chains: impl IntoIterator<Item = AddedChain> ) -> RawLightClientRpc

where TPlat: PlatformRef + Clone,

Constructs a new RawLightClientRpc from the raw smoldot client.

Receives a list of RPC objects as a result of calling smoldot_light::Client::add_chain. This RawLightClientRpc can target different chains using RawLightClientRpc::for_chain method.

Panics

The panic behaviour depends on the feature flag being used:

Native

Panics when called outside of a tokio runtime context.

Web

If smoldot panics, then the promise created will be leaked. For more details, see https://docs.rs/wasm-bindgen-futures/latest/wasm_bindgen_futures/fn.future_to_promise.html.

pub fn chain_id(&self) -> ChainId

Returns the chain ID of the current light-client.

pub fn method_request( &self, method: String, params: String ) -> Result<Receiver<Result<Box<RawValue>, LightClientRpcError>>, SendError<FromSubxt>>

Submits an RPC method request to the light-client.

This method sends a request to the light-client to execute an RPC method with the provided parameters. The parameters are parsed into a valid JSON object in the background.

pub fn subscription_request( &self, method: String, params: String ) -> Result<(Receiver<Result<Box<RawValue>, LightClientRpcError>>, UnboundedReceiver<Box<RawValue>>), SendError<FromSubxt>>

Makes an RPC subscription call to the light-client.

This method sends a request to the light-client to establish an RPC subscription with the provided parameters. The parameters are parsed into a valid JSON object in the background.

Trait Implementations

impl Clone for LightClientRpc

fn clone(&self) -> LightClientRpc

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.