Coin

interface Coin

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

Inheritors

Functions

Link copied to clipboard
abstract suspend fun getAllBalances(address: <Error class: unknown class>, limit: Int? = null, cursor: String? = null): <Error class: unknown class><GetAllBalancesQuery.Data?, <Error class: unknown class>>

Fetches all coin balances for a given Sui address.

Link copied to clipboard
abstract suspend fun getBalance(address: <Error class: unknown class>, coinType: String? = null): <Error class: unknown class><GetBalanceQuery.Data?, <Error class: unknown class>>

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

Link copied to clipboard
abstract suspend fun getCoinMetadata(type: String): <Error class: unknown class><GetCoinMetadataQuery.Data?, <Error class: unknown class>>

Fetches the metadata for a specific coin type.

Link copied to clipboard
abstract suspend fun getCoins(address: <Error class: unknown class>, first: Int? = null, cursor: String? = null, type: String? = null): <Error class: unknown class><GetCoinsQuery.Data?, <Error class: unknown class>>

Fetches coin objects owned by a given address.

Link copied to clipboard
abstract suspend fun getTotalSupply(type: String): <Error class: unknown class><GetTotalSupplyQuery.Data?, <Error class: unknown class>>

Fetches the total supply for a given coin type.