Coin

interface Coin

Defines the API for interacting with coin-related data on the Sui network.

Functions

abstract suspend fun getAllBalances(address: AccountAddress, limit: Int? = null, cursor: String? = null): Result<GetAllBalancesQuery.Data?, SuiError>

Fetches all coin balances for a given Sui address.

abstract suspend fun getBalance(address: AccountAddress, coinType: String? = null): Result<GetBalanceQuery.Data?, SuiError>

Fetches the balance of a specific coin type for a given address.

abstract suspend fun getCoinMetadata(type: String): Result<GetCoinMetadataQuery.Data?, SuiError>

Fetches the metadata for a specific coin type.

abstract suspend fun getCoins(address: AccountAddress, first: Int? = null, cursor: String? = null, type: String? = null): Result<GetCoinsQuery.Data?, SuiError>

Fetches coin objects owned by a given address.

abstract suspend fun getTotalSupply(type: String): Result<GetTotalSupplyQuery.Data?, SuiError>

Fetches the total supply for a given coin type.