Struct CoinReadApi

pub struct CoinReadApi { /* private fields */ }

Coin Read API provides the functionality needed to get information from the Sui network regarding the coins owned by an address.

Implementations

impl CoinReadApi

pub async fn get_coins( &self, owner: SuiAddress, coin_type: Option<String>, cursor: Option<String>, limit: Option<usize>, ) -> SuiRpcResult<CoinPage>

Return a paginated response with the coins for the given address, or an error upon failure.

The coins can be filtered by coin_type (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC) or use None for the default Coin<SUI>.

Examples

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

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default().build_localnet().await?;
    let address = SuiAddress::from_str("0x0000....0000")?;
    let coins = sui
        .coin_read_api()
        .get_coins(address, None, None, None)
        .await?;
    Ok(())
}

pub async fn get_all_coins( &self, owner: SuiAddress, cursor: Option<String>, limit: Option<usize>, ) -> SuiRpcResult<CoinPage>

Return a paginated response with all the coins for the given address, or an error upon failure.

This function includes all coins. If needed to filter by coin type, use the get_coins method instead.

Examples

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

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default().build_localnet().await?;
    let address = SuiAddress::from_str("0x0000....0000")?;
    let coins = sui
        .coin_read_api()
        .get_all_coins(address, None, None)
        .await?;
    Ok(())
}

pub fn get_coins_stream( &self, owner: SuiAddress, coin_type: Option<String>, ) -> impl Stream<Item = Coin> + '_

Return the coins for the given address as a stream.

The coins can be filtered by coin_type (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC) or use None for the default Coin<SUI>.

Examples

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

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default().build_localnet().await?;
    let address = SuiAddress::from_str("0x0000....0000")?;
    let coins = sui
        .coin_read_api()
        .get_coins_stream(address, None);
    Ok(())
}

pub async fn select_coins( &self, address: SuiAddress, coin_type: Option<String>, amount: u128, exclude: Vec<ObjectID>, ) -> SuiRpcResult<Vec<Coin>>

Return a list of coins for the given address, or an error upon failure.

Note that the function selects coins to meet or exceed the requested amount. If that it is not possible, it will fail with an insufficient fund error.

The coins can be filtered by coin_type (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC) or use None to use the default Coin<SUI>.

Examples

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

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default().build_localnet().await?;
    let address = SuiAddress::from_str("0x0000....0000")?;
    let coins = sui
        .coin_read_api()
        .select_coins(address, None, 5, vec![])
        .await?;
    Ok(())
}

pub async fn get_balance( &self, owner: SuiAddress, coin_type: Option<String>, ) -> SuiRpcResult<Balance>

Return the balance for the given coin type owned by address, or an error upon failure.

Note that this function sums up all the balances of all the coins matching the given coin type. By default, if coin_type is set to None, it will use the default Coin<SUI>.

Examples

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

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default().build_localnet().await?;
    let address = SuiAddress::from_str("0x0000....0000")?;
    let balance = sui
        .coin_read_api()
        .get_balance(address, None)
        .await?;
    Ok(())
}

pub async fn get_all_balances( &self, owner: SuiAddress, ) -> SuiRpcResult<Vec<Balance>>

Return a list of balances for each coin type owned by the given address, or an error upon failure.

Note that this function groups the coins by coin type, and sums up all their balances.

Examples

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

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default().build_localnet().await?;
    let address = SuiAddress::from_str("0x0000....0000")?;
    let all_balances = sui
        .coin_read_api()
        .get_all_balances(address)
        .await?;
    Ok(())
}

pub async fn get_coin_metadata( &self, coin_type: String, ) -> SuiRpcResult<Option<SuiCoinMetadata>>

Return the coin metadata (name, symbol, description, decimals, etc.) for a given coin type, or an error upon failure.

Examples

use sui_sdk::SuiClientBuilder;
#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default().build_localnet().await?;
    let coin_metadata = sui
        .coin_read_api()
        .get_coin_metadata("0x2::sui::SUI".to_string())
        .await?;
    Ok(())
}

pub async fn get_total_supply(&self, coin_type: String) -> SuiRpcResult<Supply>

Return the total supply for a given coin type, or an error upon failure.

Examples

use sui_sdk::SuiClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default().build_localnet().await?;
    let total_supply = sui
        .coin_read_api()
        .get_total_supply("0x2::sui::SUI".to_string())
        .await?;
    Ok(())
}

Trait Implementations

impl Clone for CoinReadApi

fn clone(&self) -> CoinReadApi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoinReadApi

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

Formats the value using the given formatter.