token
Namespace in @typemove/aptos/builtin/0x3
Defined in @typemove/aptos/builtin/0x3
Namespaces
Interfaces
Burn
Properties
| Property | Type |
|---|---|
account | string |
amount | bigint |
id | TokenId |
BurnToken
Properties
| Property | Type |
|---|---|
amount | bigint |
id | TokenId |
BurnTokenEvent
Properties
| Property | Type |
|---|---|
amount | bigint |
id | TokenId |
CollectionData
Properties
| Property | Type |
|---|---|
description | string |
maximum | bigint |
mutability_config | CollectionMutabilityConfig |
name | string |
supply | bigint |
uri | string |
CollectionMutabilityConfig
Properties
Collections
Properties
| Property | Type |
|---|---|
collection_data | Table<string, CollectionData> |
create_collection_events | EventHandle<CreateCollectionEvent> |
create_token_data_events | EventHandle<CreateTokenDataEvent> |
mint_token_events | EventHandle<MintTokenEvent> |
token_data | Table<TokenDataId, TokenData> |
CreateCollection
Properties
CreateCollectionEvent
Properties
CreateTokenData
Properties
| Property | Type |
|---|---|
description | string |
id | TokenDataId |
maximum | bigint |
mutability_config | TokenMutabilityConfig |
name | string |
property_keys | string[] |
property_types | string[] |
property_values | string[] |
royalty_payee_address | string |
royalty_points_denominator | bigint |
royalty_points_numerator | bigint |
uri | string |
CreateTokenDataEvent
Properties
| Property | Type |
|---|---|
description | string |
id | TokenDataId |
maximum | bigint |
mutability_config | TokenMutabilityConfig |
name | string |
property_keys | string[] |
property_types | string[] |
property_values | string[] |
royalty_payee_address | string |
royalty_points_denominator | bigint |
royalty_points_numerator | bigint |
uri | string |
Deposit
Properties
| Property | Type |
|---|---|
amount | bigint |
id | TokenId |
DepositEvent
Properties
| Property | Type |
|---|---|
amount | bigint |
id | TokenId |
Mint
Properties
| Property | Type |
|---|---|
amount | bigint |
creator | string |
id | TokenDataId |
MintToken
Properties
| Property | Type |
|---|---|
amount | bigint |
id | TokenDataId |
MintTokenEvent
Properties
| Property | Type |
|---|---|
amount | bigint |
id | TokenDataId |
MutatePropertyMap
Properties
MutateTokenPropertyMap
Properties
MutateTokenPropertyMapEvent
Properties
Royalty
Properties
Token
Properties
| Property | Type |
|---|---|
amount | bigint |
id | TokenId |
token_properties | PropertyMap |
TokenData
Properties
| Property | Type |
|---|---|
default_properties | PropertyMap |
description | string |
largest_property_version | bigint |
maximum | bigint |
mutability_config | TokenMutabilityConfig |
name | string |
royalty | Royalty |
supply | bigint |
uri | string |
TokenDataCreation
Properties
| Property | Type |
|---|---|
creator | string |
description | string |
id | TokenDataId |
maximum | bigint |
mutability_config | TokenMutabilityConfig |
name | string |
property_keys | string[] |
property_types | string[] |
property_values | string[] |
royalty_payee_address | string |
royalty_points_denominator | bigint |
royalty_points_numerator | bigint |
uri | string |
TokenDataId
Properties
TokenDeposit
Properties
| Property | Type |
|---|---|
account | string |
amount | bigint |
id | TokenId |
TokenId
Properties
| Property | Type |
|---|---|
property_version | bigint |
token_data_id | TokenDataId |
TokenMutabilityConfig
Properties
TokenStore
Properties
| Property | Type |
|---|---|
burn_events | EventHandle<BurnTokenEvent> |
deposit_events | EventHandle<DepositEvent> |
direct_transfer | boolean |
mutate_token_property_events | EventHandle<MutateTokenPropertyMapEvent> |
tokens | Table<TokenId, Token> |
withdraw_events | EventHandle<WithdrawEvent> |
TokenWithdraw
Properties
| Property | Type |
|---|---|
account | string |
amount | bigint |
id | TokenId |
Withdraw
Properties
| Property | Type |
|---|---|
amount | bigint |
id | TokenId |
WithdrawCapability
Properties
| Property | Type |
|---|---|
amount | bigint |
expiration_sec | bigint |
token_id | TokenId |
token_owner | string |
WithdrawEvent
Properties
| Property | Type |
|---|---|
amount | bigint |
id | TokenId |
Type Aliases
BurnInstance
type BurnInstance = TypedEventInstance<Burn> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | Burn |
type_arguments | [] |
BurnTokenEventInstance
type BurnTokenEventInstance = TypedEventInstance<BurnTokenEvent> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | BurnTokenEvent |
type_arguments | [] |
BurnTokenInstance
type BurnTokenInstance = TypedEventInstance<BurnToken> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | BurnToken |
type_arguments | [] |
CreateCollectionEventInstance
type CreateCollectionEventInstance = TypedEventInstance<CreateCollectionEvent> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | CreateCollectionEvent |
type_arguments | [] |
CreateCollectionInstance
type CreateCollectionInstance = TypedEventInstance<CreateCollection> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | CreateCollection |
type_arguments | [] |
CreateTokenDataEventInstance
type CreateTokenDataEventInstance = TypedEventInstance<CreateTokenDataEvent> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | CreateTokenDataEvent |
type_arguments | [] |
CreateTokenDataInstance
type CreateTokenDataInstance = TypedEventInstance<CreateTokenData> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | CreateTokenData |
type_arguments | [] |
DepositEventInstance
type DepositEventInstance = TypedEventInstance<DepositEvent> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | DepositEvent |
type_arguments | [] |
DepositInstance
type DepositInstance = TypedEventInstance<Deposit> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | Deposit |
type_arguments | [] |
MintInstance
type MintInstance = TypedEventInstance<Mint> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | Mint |
type_arguments | [] |
MintTokenEventInstance
type MintTokenEventInstance = TypedEventInstance<MintTokenEvent> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | MintTokenEvent |
type_arguments | [] |
MintTokenInstance
type MintTokenInstance = TypedEventInstance<MintToken> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | MintToken |
type_arguments | [] |
MutatePropertyMapInstance
type MutatePropertyMapInstance = TypedEventInstance<MutatePropertyMap> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | MutatePropertyMap |
type_arguments | [] |
MutateTokenPropertyMapEventInstance
type MutateTokenPropertyMapEventInstance = TypedEventInstance<MutateTokenPropertyMapEvent> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | MutateTokenPropertyMapEvent |
type_arguments | [] |
MutateTokenPropertyMapInstance
type MutateTokenPropertyMapInstance = TypedEventInstance<MutateTokenPropertyMap> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | MutateTokenPropertyMap |
type_arguments | [] |
TokenDataCreationInstance
type TokenDataCreationInstance = TypedEventInstance<TokenDataCreation> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | TokenDataCreation |
type_arguments | [] |
TokenDepositInstance
type TokenDepositInstance = TypedEventInstance<TokenDeposit> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | TokenDeposit |
type_arguments | [] |
TokenWithdrawInstance
type TokenWithdrawInstance = TypedEventInstance<TokenWithdraw> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | TokenWithdraw |
type_arguments | [] |
WithdrawCapabilityInstance
type WithdrawCapabilityInstance = TypedEventInstance<WithdrawCapability> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | WithdrawCapability |
type_arguments | [] |
WithdrawEventInstance
type WithdrawEventInstance = TypedEventInstance<WithdrawEvent> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | WithdrawEvent |
type_arguments | [] |
WithdrawInstance
type WithdrawInstance = TypedEventInstance<Withdraw> & object;Type Declaration
| Name | Type |
|---|---|
data_decoded | Withdraw |
type_arguments | [] |