Struct subxt_lightclient::LightClient

pub struct LightClient { /* private fields */ }

This represents a single light client connection to the network. Instantiate it with LightClient::relay_chain() to communicate with a relay chain, and then call LightClient::parachain() to establish connections to parachains.

Implementations

impl LightClient

pub fn relay_chain<'a>( chain_config: impl Into<ChainConfig<'a>> ) -> Result<(Self, LightClientRpc), LightClientError>

Given a chain spec, establish a connection to a relay chain. Any subsequent calls to LightClient::parachain() will set this as the relay chain.

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 parachain<'a>( &self, chain_config: impl Into<ChainConfig<'a>> ) -> Result<LightClientRpc, LightClientError>

Given a chain spec, establish a connection to a parachain.

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.

Trait Implementations

impl Clone for LightClient

fn clone(&self) -> LightClient

Returns a copy of the value.

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

Performs copy-assignment from source.