Skip to main content

CoinManagerInterface

interface CoinManagerInterface

A typed view of an on-chain 0x2::coin_manager::CoinManager<T> object.

Inheritors

CoinManager

Functions

NameSummary
idabstract fun id(): ObjectId
The object's ID.
immutableMetadataabstract fun immutableMetadata(): ImmutableCoinMetadata?
Frozen fallback metadata, used only if the original metadata has been frozen.
maximumSupplyabstract fun maximumSupply(): ULong?
Optional maximum supply cap, in base units.
metadataabstract fun metadata(): IotaCoinMetadata?
The coin's CoinMetadata, if still held by the manager.
metadataImmutableabstract fun metadataImmutable(): Boolean
Whether the metadata is considered immutable.
supplyImmutableabstract fun supplyImmutable(): Boolean
Whether the supply is considered immutable.
treasuryCapabstract fun treasuryCap(): TreasuryCap
The embedded TreasuryCap controlling the coin's supply.