Sui Framework
coin
- Move path
- 0x0000…0002::coin
- Functions
- 5447 public, 7 entry
- Structs
- 7
- Friend modules
- coin_registry
coin
- accumulator18
- accumulator_metadata2
- accumulator_settlement8
- address10
- address_alias5
- allowance40
- authenticator_state13
- bag10
- balance18
- bcs30
- bls1238143
- borrow4
- clock3
- coin54
- coin_registry43
- config11
- deny_list21
- derived_object3
- display14
- display_registry18
- dynamic_field19
- dynamic_object_field15
- ecdsa_k13
- ecdsa_r12
- ecvrf1
- ed255191
- event3
- forwarding_address1
- funds_accumulator12
- groth1610
- group_ops23
- hash2
- hex3
- hmac1
- kiosk41
- kiosk_extension14
- linked_table19
- math7
- nitro_attestation11
- object32
- object_bag11
- object_table10
- package26
- party5
- pay8
- poseidon2
- priority_queue8
- protocol_config1
- prover0
- random20
- rangeproofs3
- ristretto25518
- scratch18
- sui2
- table10
- table_vec12
- token45
- transfer16
- transfer_policy18
- tx_context19
- types1
- url4
- vdf4
- vec_map20
- vec_set11
- versioned7
- zklogin_verified_id9
- zklogin_verified_issuer6
Functions54
- 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 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 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)
Structs7
key is an object with an id. store can be kept inside other objects. copy can be duplicated. drop can be thrown away.
- Coin<phantom T0>storekey
id UID balance Balance<T0> - CoinMetadata<phantom T0>storekey
id UID decimals u8 name String symbol String description String icon_url Option<Url> - CurrencyCreated<phantom T0>copydrop
decimals u8 - DenyCap<phantom T0>storekey
id UID - DenyCapV2<phantom T0>storekey
id UID allow_global_pause bool id UID coin_metadata_object ID deny_cap_object ID - TreasuryCap<phantom T0>storekey
id UID total_supply Supply<T0>
Constants4
Constants are shown the way the code loads them. Bytecode does not keep their names.
| Slot | Value | Type | Use | Used in |
|---|---|---|---|---|
| 0 | 0 | u64 | Abort code | create_currencymigrate_regulated_currency_to_v2deny_list_v2_adddeny_list_v2_removeand 9 more |
| 1 | 1 | u64 | Abort code | divide_into_n |
| 2 | 2 | u64 | Abort code | divide_into_n |
| 3 | 3 | u64 | Abort code | deny_list_v2_enable_global_pausedeny_list_v2_disable_global_pause |