Struct OnlineClient 

pub struct OnlineClient<T>
where
    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> OnlineClient<T>

where T: Config,

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.

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

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

Allows insecure URLs without SSL encryption, e.g. (http:// and ws:// URLs).

impl<T> OnlineClient<T>

where T: Config,

pub async fn from_rpc_client( rpc_client: impl Into<RpcClient>, ) -> Result<OnlineClient<T>, Error>

Construct a new OnlineClient by providing an RpcClient to drive the connection. This will use the current default Backend, which may change in future releases.

pub fn from_rpc_client_with( genesis_hash: <<T as Config>::Hasher as Hasher>::Output, runtime_version: RuntimeVersion, metadata: impl Into<Metadata>, rpc_client: impl Into<RpcClient>, ) -> Result<OnlineClient<T>, Error>

Construct a new OnlineClient by providing an RPC client along with the other necessary details. This will use the current default Backend, which may change in future releases.

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 async fn from_backend<B>(backend: Arc<B>) -> Result<OnlineClient<T>, Error>

where B: Backend<T>,

Construct a new OnlineClient by providing an underlying Backend implementation to power it. Other details will be obtained from the chain.

pub fn from_backend_with<B>( genesis_hash: <<T as Config>::Hasher as Hasher>::Output, runtime_version: RuntimeVersion, metadata: impl Into<Metadata>, backend: Arc<B>, ) -> Result<OnlineClient<T>, Error>

where B: Backend<T>,

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 hasher(&self) -> <T as Config>::Hasher

Return the hasher configured for hashing blocks and extrinsics.

pub fn metadata(&self) -> Metadata

Return the Metadata used in this client.

pub fn set_metadata(&self, metadata: impl Into<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 as Config>::Hasher as Hasher>::Output

Return the genesis hash.

pub fn set_genesis_hash( &self, genesis_hash: <<T as Config>::Hasher as Hasher>::Output, )

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 backend(&self) -> &(dyn Backend<T> + 'static)

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, OnlineClient<T>>

Work with transactions.

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

Work with events.

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

Work with storage.

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

Access constants.

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

Work with blocks.

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

Work with runtime API.

pub fn view_functions(&self) -> ViewFunctionsClient<T, OnlineClient<T>>

Work with View Functions.

pub fn custom_values(&self) -> CustomValuesClient<T, OnlineClient<T>>

Access custom types.

Trait Implementations

impl<Config> ClientFromUrl for OnlineClient<Config>

where Config: Config + Send + Sync,

fn from_secure_url<'life0, 'async_trait>( url: &'life0 str, ) -> Pin<Box<dyn Future<Output = Result<OnlineClient<Config>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, OnlineClient<Config>: 'async_trait,

fn from_insecure_url<'life0, 'async_trait>( url: &'life0 str, ) -> Pin<Box<dyn Future<Output = Result<OnlineClient<Config>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, OnlineClient<Config>: 'async_trait,

impl<T> Clone for OnlineClient<T>

where T: Config,

fn clone(&self) -> OnlineClient<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for OnlineClient<T>

where T: Config,

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

Formats the value using the given formatter.

impl<T> OfflineClientT<T> for OnlineClient<T>

where T: Config,

fn metadata(&self) -> Metadata

Return the provided Metadata.

fn genesis_hash(&self) -> <<T as Config>::Hasher as Hasher>::Output

Return the provided genesis hash.

fn runtime_version(&self) -> RuntimeVersion

Return the provided RuntimeVersion.

fn hasher(&self) -> <T as Config>::Hasher

Return the hasher used on the chain.

fn client_state(&self) -> ClientState<T>

Return the subxt_core::client::ClientState (metadata, runtime version and genesis hash).

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 APIs.

fn view_functions(&self) -> ViewFunctionsClient<T, Self>

Work with View Functions.

fn custom_values(&self) -> CustomValuesClient<T, Self>

Work this custom types.

impl<T> OnlineClientT<T> for OnlineClient<T>

where T: Config,

fn backend(&self) -> &(dyn Backend<T> + 'static)

Return a backend that can be used to communicate with a node.