Struct sui_sdk::SuiClientBuilder

pub struct SuiClientBuilder { /* private fields */ }

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_sdk::SuiClientBuilder;
#[tokio::main]
async fn main() -> Result<(), anyhow::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 fn request_timeout(self, request_timeout: Duration) -> Self

Set the request timeout to the specified duration

pub fn max_concurrent_requests(self, max_concurrent_requests: usize) -> Self

Set the max concurrent requests allowed

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

Set the WebSocket URL for the Sui network

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

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(self, http: impl AsRef<str>) -> SuiRpcResult<SuiClient>

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

Examples

use sui_sdk::SuiClientBuilder;

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

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

pub async fn build_localnet(self) -> SuiRpcResult<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).

For connecting to a custom URI, use the build function instead.

Examples

use sui_sdk::SuiClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default()
        .build_localnet()
        .await?;

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

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

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

For connecting to a custom URI, use the build function instead..

Examples

use sui_sdk::SuiClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default()
        .build_devnet()
        .await?;

    println!("{:?}", sui.api_version());
    Ok(())
}

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

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

For connecting to a custom URI, use the build function instead.

Examples

use sui_sdk::SuiClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default()
        .build_testnet()
        .await?;

    println!("{:?}", sui.api_version());
    Ok(())
}

pub async fn build_mainnet(self) -> SuiRpcResult<SuiClient>

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

For connecting to a custom URI, use the build function instead.

Examples

use sui_sdk::SuiClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default()
        .build_mainnet()
        .await?;

    println!("{:?}", sui.api_version());
    Ok(())
}

Trait Implementations

impl Default for SuiClientBuilder

fn default() -> Self

Returns the “default value” for a type.