Skip to main content

CoinManager

CoinManager Objects

class CoinManager(CoinManagerProtocol)

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

try_from_bcs

@classmethod
def try_from_bcs(cls, bytes: bytes) -> CoinManager

Decode from BCS bytes, without validating the on-chain type tag.

try_from_object_with_type

@classmethod
def try_from_object_with_type(cls, object: Object,
type_param: TypeTag) -> CoinManager

Decode from an on-chain object, validating its Move type tag, including that its type parameter equals type_param.

id

def id() -> ObjectId

The object's ID.

immutable_metadata

def immutable_metadata() -> typing.Optional[ImmutableCoinMetadata]

Frozen fallback metadata, used only if the original metadata has been frozen.

maximum_supply

def maximum_supply() -> typing.Optional[int]

Optional maximum supply cap, in base units.

metadata

def metadata() -> typing.Optional[IotaCoinMetadata]

The coin's CoinMetadata, if still held by the manager.

metadata_immutable

def metadata_immutable() -> bool

Whether the metadata is considered immutable.

supply_immutable

def supply_immutable() -> bool

Whether the supply is considered immutable.

treasury_cap

def treasury_cap() -> TreasuryCap

The embedded TreasuryCap controlling the coin's supply.