Struct SuiClientBuilder 

pub struct SuiClientBuilder { /* private fields */ }

Available on crate feature client only.

A Sui client builder for connecting to the Sui network

By default the maximum concurrent requests is set to 256 and the request timeout is set to 60 seconds. These can be adjusted using the max_concurrent_requests function, and the request_timeout function. If you use the WebSocket, consider setting the ws_ping_interval field to a value of your choice to prevent the inactive WS subscription being disconnected due to proxy timeout.

Examples

use sui_jsonrpc::client::SuiClientBuilder;
#[tokio::main]
async fn main() -> Result<(), color_eyre::eyre::Error> {
    let sui = SuiClientBuilder::default()
        .build("http://127.0.0.1:9000")
        .await?;

    println!("Sui local network version: {:?}", sui.api_version());
    Ok(())
}

Implementations

impl SuiClientBuilder

pub const fn request_timeout(self, request_timeout: Duration) -> Self

Set the request timeout to the specified duration

pub fn ws_url(self, url: impl AsRef<str>) -> Self

👎Deprecated: JSON-RPC subscriptions have been deprecated since at least mainnet-v1.28.3. See https://github.com/MystenLabs/sui/releases/tag/mainnet-v1.28.3

Set the WebSocket URL for the Sui network

pub const fn ws_ping_interval(self, duration: Duration) -> Self

👎Deprecated: JSON-RPC subscriptions have been deprecated since at least mainnet-v1.28.3. See https://github.com/MystenLabs/sui/releases/tag/mainnet-v1.28.3

Set the WebSocket ping interval

pub fn basic_auth( self, username: impl AsRef<str>, password: impl AsRef<str>, ) -> Self

Set the basic auth credentials for the HTTP client

pub async fn build_localnet(self) -> SuiClientResult<SuiClient>

Returns a SuiClient object that is ready to interact with the local development network (by default it expects the Sui network to be up and running at 127.0.0.1:9000).

pub async fn build_devnet(self) -> SuiClientResult<SuiClient>

Returns a SuiClient object that is ready to interact with the Sui devnet.

pub async fn build_testnet(self) -> SuiClientResult<SuiClient>

Returns a SuiClient object that is ready to interact with the Sui testnet.

pub async fn build(self, http: impl AsRef<str>) -> SuiClientResult<SuiClient>

Returns a SuiClient object connected to the Sui network running at the URI provided.

Trait Implementations

impl Default for SuiClientBuilder

fn default() -> Self

Returns the “default value” for a type.