Sui Framework
token
- Move path
- 0x0000…0002::token
- Functions
- 4544 public, 0 entry
- Structs
- 6
- Friend modules
- None
token
- 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
Functions45
- public fun action<T0>(&ActionRequest<T0>): String
- public fun add_approval<T0, T1: drop>(T1,&mut ActionRequest<T0>)
- public fun add_rule_config<T0, T1: drop, T2: store>(T1,&mut TokenPolicy<T0>,&TokenPolicyCap<T0>,T2)
- public fun add_rule_for_action<T0, T1: drop>(&mut TokenPolicy<T0>,&TokenPolicyCap<T0>,String)
- public fun allow<T0>(&mut TokenPolicy<T0>,&TokenPolicyCap<T0>,String)
- public fun amount<T0>(&ActionRequest<T0>): u64
- public fun approvals<T0>(&ActionRequest<T0>): VecSet<TypeName>
- public fun burn<T0>(&mut TreasuryCap<T0>,Token<T0>)
- public fun confirm_request<T0>(&TokenPolicy<T0>,ActionRequest<T0>): (String, u64, address, Option<address>)
- public fun confirm_request_mut<T0>(&mut TokenPolicy<T0>,ActionRequest<T0>): (String, u64, address, Option<address>)
- public fun confirm_with_policy_cap<T0>(&TokenPolicyCap<T0>,ActionRequest<T0>): (String, u64, address, Option<address>)
- public fun confirm_with_treasury_cap<T0>(&mut TreasuryCap<T0>,ActionRequest<T0>): (String, u64, address, Option<address>)
- public fun destroy_zero<T0>(Token<T0>)
- public fun disallow<T0>(&mut TokenPolicy<T0>,&TokenPolicyCap<T0>,String)
- public fun flush<T0>(&mut TokenPolicy<T0>,&mut TreasuryCap<T0>): u64
- public fun from_coin<T0>(Coin<T0>): (Token<T0>, ActionRequest<T0>)
- public fun from_coin_action(): String
- public fun has_rule_config<T0, T1>(&TokenPolicy<T0>): bool
- public fun has_rule_config_with_type<T0, T1, T2: store>(&TokenPolicy<T0>): bool
- public fun is_allowed<T0>(&TokenPolicy<T0>,&String): bool
- public fun join<T0>(&mut Token<T0>,Token<T0>)
- public fun keep<T0>(Token<T0>)
- public fun mint<T0>(&mut TreasuryCap<T0>,u64): Token<T0>
- public fun new_policy<T0>(&TreasuryCap<T0>): (TokenPolicy<T0>, TokenPolicyCap<T0>)
- public fun new_request<T0>(String,u64,Option<address>,Option<Balance<T0>>): ActionRequest<T0>
- public fun recipient<T0>(&ActionRequest<T0>): Option<address>
- public fun remove_rule_config<T0, T1, T2: store>(&mut TokenPolicy<T0>,&TokenPolicyCap<T0>): T2
- public fun remove_rule_for_action<T0, T1: drop>(&mut TokenPolicy<T0>,&TokenPolicyCap<T0>,String)
- public fun rule_config<T0, T1: drop, T2: store>(T1,&TokenPolicy<T0>): &T2
- public fun rule_config_mut<T0, T1: drop, T2: store>(T1,&mut TokenPolicy<T0>,&TokenPolicyCap<T0>): &mut T2
Structs6
key is an object with an id. store can be kept inside other objects. copy can be duplicated. drop can be thrown away.
name String amount u64 sender address recipient Option<address> spent_balance Option<Balance<T0>> approvals VecSet<TypeName> - RuleKey<phantom T0>copydropstore
is_protected bool id UID balance Balance<T0> id UID spent_balance Balance<T0> rules VecMap<String, VecSet<TypeName>> - TokenPolicyCap<phantom T0>storekey
id UID for ID - TokenPolicyCreated<phantom T0>copydrop
id ID is_mutable bool
Constants12
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 | confirm_requestconfirm_request_mut |
| 1 | 1 | u64 | Abort code | confirm_request |
| 2 | 2 | u64 | Abort code | add_rule_configrule_config_mutremove_rule_configallowand 3 more |
| 3 | 3 | u64 | Abort code | split |
| 4 | 4 | u64 | Abort code | destroy_zero |
| 5 | 5 | u64 | Abort code | confirm_requestconfirm_with_policy_cap |
| 6 | 6 | u64 | Abort code | rule_configrule_config_mutremove_rule_config |
| 7 | 7 | u64 | Abort code | confirm_request_mut |
| 8 | "spend" // interpreted as UTF8 string | vector<u8> | Value | spend_action |
| 9 | "transfer" // interpreted as UTF8 string | vector<u8> | Value | transfer_action |
| 10 | "to_coin" // interpreted as UTF8 string | vector<u8> | Value | to_coin_action |
| 11 | "from_coin" // interpreted as UTF8 string | vector<u8> | Value | from_coin_action |