Search by name, SuiNS, address, digest, object ID, coin type or checkpoint.

API

coin

Module0x0000…0002
Move path
0x0000…0002::coin
Functions
5447 public, 7 entry
Structs
7
Friend modules
coin_registry
coin

Declarations

Rebuilt from the module interface. No verified source is published, and function bodies are only available as bytecode.

module coin;
struct Coin<phantom T0> has store, key {
id: UID,
balance: Balance<T0>,
}
struct CoinMetadata<phantom T0> has store, key {
id: UID,
decimals: u8,
name: String,
symbol: String,
description: String,
icon_url: Option<Url>,
}
struct CurrencyCreated<phantom T0> has copy, drop {
decimals: u8,
}
struct DenyCap<phantom T0> has store, key {
id: UID,
}
struct DenyCapV2<phantom T0> has store, key {
id: UID,
allow_global_pause: bool,
}
struct RegulatedCoinMetadata<phantom T0> has key {
id: UID,
coin_metadata_object: ID,
deny_cap_object: ID,
}
struct TreasuryCap<phantom T0> has store, key {
id: UID,
total_supply: Supply<T0>,
}
public(package) fun allow_global_pause<T0>(&DenyCapV2<T0>): bool
public fun balance<T0>(&Coin<T0>): &Balance<T0>
public fun balance_mut<T0>(&mut Coin<T0>): &mut Balance<T0>
public entry fun burn<T0>(&mut TreasuryCap<T0>,Coin<T0>): u64
public fun create_currency<T0: drop>(T0,u8,vector<u8>,vector<u8>,vector<u8>,Option<Url>): (TreasuryCap<T0>, CoinMetadata<T0>)
public fun create_regulated_currency<T0: drop>(T0,u8,vector<u8>,vector<u8>,vector<u8>,Option<Url>): (TreasuryCap<T0>, DenyCap<T0>, CoinMetadata<T0>)
public fun create_regulated_currency_v2<T0: drop>(T0,u8,vector<u8>,vector<u8>,vector<u8>,Option<Url>,bool): (TreasuryCap<T0>, DenyCapV2<T0>, CoinMetadata<T0>)
public(package) fun deny_cap_id<T0>(&RegulatedCoinMetadata<T0>): ID
public fun deny_list_add<T0>(&mut DenyList,&mut DenyCap<T0>,address)
public fun deny_list_contains<T0>(&DenyList,address): bool
public fun deny_list_remove<T0>(&mut DenyList,&mut DenyCap<T0>,address)
public fun deny_list_v2_add<T0>(&mut DenyList,&mut DenyCapV2<T0>,address)
public fun deny_list_v2_contains_current_epoch<T0>(&DenyList,address): bool
public fun deny_list_v2_contains_next_epoch<T0>(&DenyList,address): bool
public fun deny_list_v2_disable_global_pause<T0>(&mut DenyList,&mut DenyCapV2<T0>)
public fun deny_list_v2_enable_global_pause<T0>(&mut DenyList,&mut DenyCapV2<T0>)
public fun deny_list_v2_is_global_pause_enabled_current_epoch<T0>(&DenyList): bool
public fun deny_list_v2_is_global_pause_enabled_next_epoch<T0>(&DenyList): bool
public fun deny_list_v2_remove<T0>(&mut DenyList,&mut DenyCapV2<T0>,address)
public(package) fun destroy_metadata<T0>(CoinMetadata<T0>)
public fun destroy_zero<T0>(Coin<T0>)
public fun divide_into_n<T0>(&mut Coin<T0>, u64): vector<Coin<T0>>
public fun from_balance<T0>(Balance<T0>): Coin<T0>
public fun get_decimals<T0>(&CoinMetadata<T0>): u8
public fun get_description<T0>(&CoinMetadata<T0>): String
public fun get_icon_url<T0>(&CoinMetadata<T0>): Option<Url>
public fun get_name<T0>(&CoinMetadata<T0>): String
public fun get_symbol<T0>(&CoinMetadata<T0>): String
public fun into_balance<T0>(Coin<T0>): Balance<T0>
public entry fun join<T0>(&mut Coin<T0>,Coin<T0>)
public fun migrate_regulated_currency_to_v2<T0>(&mut DenyList,DenyCap<T0>,bool): DenyCapV2<T0>
public fun mint<T0>(&mut TreasuryCap<T0>,u64): Coin<T0>
public entry fun mint_and_transfer<T0>(&mut TreasuryCap<T0>,u64,address)
public fun mint_balance<T0>(&mut TreasuryCap<T0>,u64): Balance<T0>
public(package) fun new_coin_metadata<T0>(u8,String,String,String,String): CoinMetadata<T0>
public(package) fun new_deny_cap_v2<T0>(bool): DenyCapV2<T0>
public(package) fun new_treasury_cap<T0>(): TreasuryCap<T0>
public fun put<T0>(&mut Balance<T0>,Coin<T0>)
public fun redeem_funds<T0>(Withdrawal<Balance<T0>>): Coin<T0>
public fun send_funds<T0>(Coin<T0>, address)
public fun split<T0>(&mut Coin<T0>, u64): Coin<T0>
public fun supply<T0>(&mut TreasuryCap<T0>): &Supply<T0>
public fun supply_immut<T0>(&TreasuryCap<T0>): &Supply<T0>
public fun supply_mut<T0>(&mut TreasuryCap<T0>): &mut Supply<T0>
public fun take<T0>(&mut Balance<T0>,u64): Coin<T0>
public fun total_supply<T0>(&TreasuryCap<T0>): u64
public fun treasury_into_supply<T0>(TreasuryCap<T0>): Supply<T0>
public(package) fun update_coin_metadata<T0>(&mut CoinMetadata<T0>,String,String,String,String)
public entry fun update_description<T0>(&TreasuryCap<T0>,&mut CoinMetadata<T0>,String)
public entry fun update_icon_url<T0>(&TreasuryCap<T0>,&mut CoinMetadata<T0>,String)
public entry fun update_name<T0>(&TreasuryCap<T0>,&mut CoinMetadata<T0>,String)
public entry fun update_symbol<T0>(&TreasuryCap<T0>,&mut CoinMetadata<T0>,String)
public fun value<T0>(&Coin<T0>): u64
public fun zero<T0>(): Coin<T0>