CoinMetadata

interface CoinMetadata

Metadata for a coin type

Types

Link copied to clipboard
sealed class MetadataCapState

Information about the state of the coin's MetadataCap

Properties

Link copied to clipboard
abstract val decimals: <Error class: unknown class>?

Number of decimal places to coin uses.

Link copied to clipboard
abstract val description: String?

Description of the token

Link copied to clipboard
abstract val iconUrl: String?

URL for the token logo

Link copied to clipboard
abstract val id: String?

ObjectId of the 0x2::coin::CoinMetadata object or 0x2::sui::coin_registry::Currency object (when registered with CoinRegistry).

Link copied to clipboard
abstract val metadataCapId: String?

The MetadataCap ID if it has been claimed for this coin type. This capability allows updating the coin's metadata fields. Only populated when metadata is from CoinRegistry.

Link copied to clipboard

State of the MetadataCap for this coin type.

Link copied to clipboard
abstract val name: String?

Name for the token

Link copied to clipboard

Returns the field-presence view for this CoinMetadata instance.

Link copied to clipboard
abstract val symbol: String?

Symbol for the token

Functions

Link copied to clipboard
Link copied to clipboard
fun CoinMetadata.copy(body: <Error class: unknown class>.() -> Unit = {}): CoinMetadata

Copies the original message, including unknown fields.