Struct CoinReadApi

pub struct CoinReadApi { /* private fields */ }

Defines methods that retrieve information from the IOTA network regarding the coins owned by an address.

Implementations

impl CoinReadApi

pub async fn get_coins( &self, owner: IotaAddress, coin_type: impl Into<Option<String>>, cursor: impl Into<Option<ObjectID>>, limit: impl Into<Option<usize>>, ) -> IotaRpcResult<CoinPage>

Get coins for the given address filtered by coin type. Results are paginated.

The coin type defaults to 0x2::iota::IOTA.

Examples

use std::str::FromStr;

use iota_sdk::{IotaClientBuilder, types::base_types::IotaAddress};

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default().build_testnet().await?;
    let address = IotaAddress::from_str("0x0000....0000")?;
    let coin_type = String::from("0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC");
    let coins = iota
        .coin_read_api()
        .get_coins(address, coin_type, None, None)
        .await?;
    Ok(())
}

pub async fn get_all_coins( &self, owner: IotaAddress, cursor: impl Into<Option<ObjectID>>, limit: impl Into<Option<usize>>, ) -> IotaRpcResult<CoinPage>

Get all the coins for the given address regardless of coin type. Results are paginated.

Examples

use std::str::FromStr;

use iota_sdk::{IotaClientBuilder, types::base_types::IotaAddress};

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

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

Get the coins for the given address filtered by coin type. Returns a stream.

The coin type defaults to 0x2::iota::IOTA.

Examples

use std::str::FromStr;

use iota_sdk::{IotaClientBuilder, types::base_types::IotaAddress};

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default().build_testnet().await?;
    let address = IotaAddress::from_str("0x0000....0000")?;
    let coin_type = String::from("0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC");
    let coins = iota.coin_read_api().get_coins_stream(address, coin_type);
    Ok(())
}

pub async fn select_coins( &self, address: IotaAddress, coin_type: impl Into<Option<String>>, amount: u128, exclude: Vec<ObjectID>, ) -> IotaRpcResult<Vec<Coin>>

Get a list of coins for the given address filtered by coin type with at least amount total value.

If it is not possible to select enough coins, this function will return an Error::InsufficientFunds.

The coin type defaults to 0x2::iota::IOTA.

Examples

use std::str::FromStr;

use iota_sdk::{IotaClientBuilder, types::base_types::IotaAddress};

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default().build_testnet().await?;
    let address = IotaAddress::from_str("0x0000....0000")?;
    let coin_type = String::from("0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC");
    let coins = iota
        .coin_read_api()
        .select_coins(address, coin_type, 5, vec![])
        .await?;
    Ok(())
}

pub async fn get_balance( &self, owner: IotaAddress, coin_type: impl Into<Option<String>>, ) -> IotaRpcResult<Balance>

Get the balance for the given address filtered by coin type.

The coin type defaults to 0x2::iota::IOTA.

Examples

use std::str::FromStr;

use iota_sdk::{IotaClientBuilder, types::base_types::IotaAddress};

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

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

Get a list of balances grouped by coin type and owned by the given address.

Examples

use std::str::FromStr;

use iota_sdk::{IotaClientBuilder, types::base_types::IotaAddress};

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

pub async fn get_coin_metadata( &self, coin_type: impl Into<String>, ) -> IotaRpcResult<Option<IotaCoinMetadata>>

Get the coin metadata (name, symbol, description, decimals, etc.) for a given coin type.

Examples

use iota_sdk::IotaClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default().build_testnet().await?;
    let coin_metadata = iota
        .coin_read_api()
        .get_coin_metadata("0x2::iota::IOTA")
        .await?;
    Ok(())
}

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

Get the total supply for a given coin type.

Examples

use iota_sdk::IotaClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default().build_testnet().await?;
    let total_supply = iota
        .coin_read_api()
        .get_total_supply("0x2::iota::IOTA")
        .await?;
    Ok(())
}

pub async fn get_circulating_supply( &self, ) -> IotaRpcResult<IotaCirculatingSupply>

Get the IOTA circulating supply summary.

Examples

use iota_sdk::IotaClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let iota = IotaClientBuilder::default().build_testnet().await?;
    let circulating_supply = iota.coin_read_api().get_circulating_supply().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.