Struct Client 

pub struct Client {
    pub rpc_client: RpcClient,
    /* private fields */
}

Primary entry point used throughout the SDK to interact with the node.

Fields

rpc_client: RpcClient

Implementations

impl Client

pub async fn new(endpoint: &str) -> Result<Client, Error>

Connects to an HTTP endpoint and returns a ready-to-use client.

Arguments

• endpoint - RPC URL (HTTP/S) exposed by an Avail node.

Returns

Returns a Client that clones its transports internally.

Errors

Returns Err(Error) if the HTTP transport cannot be initialized or the handshake fails.

Examples

let client = Client::new("https://turing-rpc.avail.so/rpc").await?;
let best = client.best().block_header().await?;
println!("Best block: {:?}", best.hash());

pub async fn new_ext(endpoint: &str, retry: bool) -> Result<Client, Error>

Connects to an endpoint with optional retry behaviour during startup.

Arguments

• endpoint - RPC URL (HTTP/S) exposed by an Avail node.
• retry - When true, transient connection failures are retried before giving up.

Returns

Returns a fully initialised Client.

Errors

Returns Err(Error) if the HTTP transport cannot be initialised or metadata bootstrap fails.

Examples

let client = Client::new_ext("http://127.0.0.1:9944", false).await?;
println!("Retries enabled? {}", client.is_global_retries_enabled());

pub async fn from_rpc_client(rpc_client: RpcClient) -> Result<Client, RpcError>

Builds a client from an existing RPC transport.

Arguments

• rpc_client - Transport implementing the JSON-RPC client trait.

Returns

Returns a Client sharing the provided transport.

Errors

Propagates any failure returned by OnlineClient::new.

pub async fn from_components( rpc_client: RpcClient, online_client: OnlineClient, ) -> Result<Client, RpcError>

Wraps pre-built components into a handy client handle.

Arguments

• rpc_client - Transport used for RPC calls.
• online_client - Metadata cache and retry configuration.

Returns

Returns a Client that reuses the provided components.

pub fn init_tracing(json_format: bool) -> Result<(), TryInitError>

Initialises tracing in plain text or JSON format.

Arguments

• json_format - When true, installs a JSON formatter; otherwise plain text.

Returns

Returns Ok(()) once the global subscriber is installed.

Errors

Returns Err(TryInitError) when tracing was already initialised elsewhere.

Examples

Client::init_tracing(false).expect("tracing already initialised");

pub fn online_client(&self) -> OnlineClient

Hands back the underlying OnlineClient for advanced uses.

Returns

Returns a clone of the cached online client state.

pub fn tx(&self) -> TransactionApi

Returns a transaction helper for crafting and submitting extrinsics.

Returns

Returns a TransactionApi that clones this client and issues RPCs lazily.

pub fn block(&self, block_id: impl Into<HashStringNumber>) -> Block

Builds a block helper rooted at the supplied height or hash.

Arguments

• block_id - Hash, height, or string convertible into a HashStringNumber.

Returns

Returns a Block helper exposing extrinsic, event, and metadata views.

pub fn chain(&self) -> Chain

Provides low-level RPC helpers when you need finer control.

Returns

Returns a Chain handle exposing retry controls and raw RPC wrappers.

pub fn best(&self) -> Best

Provides quick access to the best (head) block view.

Returns

Returns a Best helper optimised for repeated head queries.

pub fn finalized(&self) -> Finalized

Provides quick access to finalised block information.

Returns

Returns a Finalized helper mirroring Best convenience methods.

pub fn is_global_retries_enabled(&self) -> bool

Reports whether automatic retries are currently enabled.

Returns

Returns true when global retries are on, otherwise false.

pub fn set_global_retries_enabled(&self, value: bool)

Turns automatic retries on or off for new requests.

Arguments

• value - true to enable retries for new helpers, false to disable.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.