Struct subxt::client::OnlineClient

pub struct OnlineClient<T: Config> { /* private fields */ }

A client that can be used to perform API calls (that is, either those requiring an OfflineClientT or those requiring an OnlineClientT).

Implementations

impl<T: Config> OnlineClient<T>

pub async fn new() -> Result<OnlineClient<T>, Error>

Construct a new OnlineClient using default settings which point to a locally running node on ws://127.0.0.1:9944.

pub async fn from_url(url: impl AsRef<str>) -> Result<OnlineClient<T>, Error>

Construct a new OnlineClient, providing a URL to connect to.

impl<T: Config> OnlineClient<T>

pub async fn from_rpc_client<R: RpcClientT>( rpc_client: Arc<R> ) -> Result<OnlineClient<T>, Error>

Construct a new OnlineClient by providing an underlying RpcClientT implementation to drive the connection.

pub fn from_rpc_client_with<R: RpcClientT>( genesis_hash: T::Hash, runtime_version: RuntimeVersion, metadata: Metadata, rpc_client: Arc<R> ) -> Result<OnlineClient<T>, Error>

Construct a new OnlineClient by providing all of the underlying details needed to make it work.

Warning

This is considered the most primitive and also error prone way to instantiate a client; the genesis hash, metadata and runtime version provided will entirely determine which node and blocks this client will be able to interact with, and whether it will be able to successfully do things like submit transactions.

If you’re unsure what you’re doing, prefer one of the alternate methods to instantiate a client.

pub fn updater(&self) -> ClientRuntimeUpdater<T>

Create an object which can be used to keep the runtime up to date in a separate thread.

Example

use subxt::{ OnlineClient, PolkadotConfig };

let client = OnlineClient::<PolkadotConfig>::new().await.unwrap();

// high level API.

let update_task = client.updater();
tokio::spawn(async move {
    update_task.perform_runtime_updates().await;
});


// low level API.

let updater = client.updater();
tokio::spawn(async move {
    let mut update_stream = updater.runtime_updates().await.unwrap();

    while let Some(Ok(update)) = update_stream.next().await {
        let version = update.runtime_version().spec_version;

        match updater.apply_update(update) {
            Ok(()) => {
                println!("Upgrade to version: {} successful", version)
            }
            Err(e) => {
               println!("Upgrade to version {} failed {:?}", version, e);
            }
       };
    }
});

pub fn metadata(&self) -> Metadata

Return the Metadata used in this client.

pub fn set_metadata(&self, metadata: Metadata)

Change the Metadata used in this client.

Warning

Setting custom metadata may leave Subxt unable to work with certain blocks, subscribe to latest blocks or submit valid transactions.

pub fn genesis_hash(&self) -> T::Hash

Return the genesis hash.

pub fn set_genesis_hash(&self, genesis_hash: T::Hash)

Change the genesis hash used in this client.

Warning

Setting a custom genesis hash may leave Subxt unable to submit valid transactions.

pub fn runtime_version(&self) -> RuntimeVersion

Return the runtime version.

pub fn set_runtime_version(&self, runtime_version: RuntimeVersion)

Change the RuntimeVersion used in this client.

Warning

Setting a custom runtime version may leave Subxt unable to submit valid transactions.

pub fn rpc(&self) -> &Rpc<T>

Return an RPC client to make raw requests with.

pub fn offline(&self) -> OfflineClient<T>

Return an offline client with the same configuration as this.

pub fn tx(&self) -> TxClient<T, Self>

Work with transactions.

pub fn events(&self) -> EventsClient<T, Self>

Work with events.

pub fn storage(&self) -> StorageClient<T, Self>

Work with storage.

pub fn constants(&self) -> ConstantsClient<T, Self>

Access constants.

pub fn blocks(&self) -> BlocksClient<T, Self>

Work with blocks.

pub fn runtime_api(&self) -> RuntimeApiClient<T, Self>

Work with runtime API.

Trait Implementations

impl<T: Config> Clone for OnlineClient<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Config> Debug for OnlineClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> OfflineClientT<T> for OnlineClient<T>

fn metadata(&self) -> Metadata

Return the provided Metadata.

fn genesis_hash(&self) -> T::Hash

Return the provided genesis hash.

fn runtime_version(&self) -> RuntimeVersion

Return the provided RuntimeVersion.

fn tx(&self) -> TxClient<T, Self>

Work with transactions.

fn events(&self) -> EventsClient<T, Self>

Work with events.

fn storage(&self) -> StorageClient<T, Self>

Work with storage.

fn constants(&self) -> ConstantsClient<T, Self>

Access constants.

fn blocks(&self) -> BlocksClient<T, Self>

Work with blocks.

fn runtime_api(&self) -> RuntimeApiClient<T, Self>

Work with runtime API.

impl<T: Config> OnlineClientT<T> for OnlineClient<T>

fn rpc(&self) -> &Rpc<T>

Return an RPC client that can be used to communicate with a node.