Skip to main content

Interface: CoinManagerLike

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

Methods​

id()​

id(): ObjectIdLike;

The object's ID.

Returns​

ObjectIdLike

immutableMetadata()​

immutableMetadata(): 
  | ImmutableCoinMetadataLike
  | undefined;

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

Returns​

| ImmutableCoinMetadataLike | undefined

maximumSupply()​

maximumSupply(): bigint | undefined;

Optional maximum supply cap, in base units.

Returns​

bigint | undefined

metadata()​

metadata(): IotaCoinMetadataLike | undefined;

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

Returns​

IotaCoinMetadataLike | undefined

metadataImmutable()​

metadataImmutable(): boolean;

Whether the metadata is considered immutable.

Returns​

boolean

supplyImmutable()​

supplyImmutable(): boolean;

Whether the supply is considered immutable.

Returns​

boolean

treasuryCap()​

treasuryCap(): TreasuryCapLike;

The embedded TreasuryCap controlling the coin's supply.

Returns​

TreasuryCapLike