Struct sui_sdk::SuiClient

pub struct SuiClient { /* private fields */ }

SuiClient is the basic type that provides all the necessary abstractions for interacting with the Sui network.

Usage

Use SuiClientBuilder to build a SuiClient.

Examples

use sui_sdk::types::base_types::SuiAddress;
use sui_sdk::SuiClientBuilder;
use std::str::FromStr;

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

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

    let address = SuiAddress::from_str("0x0000....0000")?;
    let owned_objects = sui
       .read_api()
       .get_owned_objects(address, None, None, None)
       .await?;

    println!("{:?}", owned_objects);

    Ok(())
}

Implementations

impl SuiClient

pub fn available_rpc_methods(&self) -> &Vec<String>

Returns a list of RPC methods supported by the node the client is connected to.

pub fn available_subscriptions(&self) -> &Vec<String>

Returns a list of streaming/subscription APIs supported by the node the client is connected to.

pub fn api_version(&self) -> &str

Returns the API version information as a string.

The format of this string is <major>.<minor>.<patch>, e.g., 1.6.0, and it is retrieved from the OpenRPC specification via the discover service method.

pub fn check_api_version(&self) -> SuiRpcResult<()>

Verifies if the API version matches the server version and returns an error if they do not match.

pub fn coin_read_api(&self) -> &CoinReadApi

Returns a reference to the coin read API.

pub fn event_api(&self) -> &EventApi

Returns a reference to the event API.

pub fn governance_api(&self) -> &GovernanceApi

Returns a reference to the governance API.

pub fn quorum_driver_api(&self) -> &QuorumDriverApi

Returns a reference to the quorum driver API.

pub fn read_api(&self) -> &ReadApi

Returns a reference to the read API.

pub fn transaction_builder(&self) -> &TransactionBuilder

Returns a reference to the transaction builder API.

pub fn http(&self) -> &HttpClient

Returns a reference to the underlying http client.

pub fn ws(&self) -> Option<&WsClient>

Returns a reference to the underlying WebSocket client, if any.

Trait Implementations

impl Clone for SuiClient

fn clone(&self) -> SuiClient

Returns a copy of the value.

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

Performs copy-assignment from source.