Module `0x4::token`

This defines an object-based Token. The key differentiating features from the Aptos standard token are:

Decoupled token ownership from token data.
Explicit data model for token metadata via adjacent resources
Extensible framework for tokens

Resource Token
Resource TokenIdentifiers
Resource ConcurrentTokenIdentifiers
Struct BurnRef
Struct MutatorRef
Struct MutationEvent
Struct Mutation
Constants
Function create_common
Function create_common_with_collection
Function create_common_with_collection_as_owner
Function create_common_with_collection_internal
Function create_token
Function create
Function create_token_as_collection_owner
Function create_numbered_token_object
Function create_numbered_token
Function create_numbered_token_as_collection_owner
Function create_named_token_object
Function create_named_token
Function create_named_token_as_collection_owner
Function create_named_token_from_seed
Function create_named_token_from_seed_as_collection_owner
Function create_from_account
Function create_token_address
Function create_token_address_with_seed
Function create_token_seed
Function create_token_name_with_seed
Function generate_mutator_ref
Function generate_burn_ref
Function address_from_burn_ref
Function borrow
Function creator
Function collection_name
Function collection_object
Function description
Function name
Function uri
Function royalty
Function index
Function borrow_mut
Function burn
Function set_description
Function set_name
Function set_uri

<pre><code>use <a href="../../aptos-framework/doc/aggregator_v2.md#0x1_aggregator_v2">0x1::aggregator_v2</a>; use <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/bcs.md#0x1_bcs">0x1::bcs</a>; use <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error">0x1::error</a>; use <a href="../../aptos-framework/doc/event.md#0x1_event">0x1::event</a>; use <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/features.md#0x1_features">0x1::features</a>; use <a href="../../aptos-framework/../aptos-stdlib/doc/from_bcs.md#0x1_from_bcs">0x1::from_bcs</a>; use <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/hash.md#0x1_hash">0x1::hash</a>; use <a href="../../aptos-framework/doc/object.md#0x1_object">0x1::object</a>; use <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option">0x1::option</a>; use <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">0x1::signer</a>; use <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string">0x1::string</a>; use <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/vector.md#0x1_vector">0x1::vector</a>; use <a href="collection.md#0x4_collection">0x4::collection</a>; use <a href="royalty.md#0x4_royalty">0x4::royalty</a>; </code></pre>

Resource `Token`

Represents the common fields to all tokens.

<pre><code>#[resource_group_member(#[group = <a href="../../aptos-framework/doc/object.md#0x1_object_ObjectGroup">0x1::object::ObjectGroup</a>])] struct <a href="token.md#0x4_token_Token">Token</a> has key </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code><a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>></code> </dt> <dd> The collection from which this token resides. </dd> <dt> <code>index: u64</code> </dt> <dd> Deprecated in favor of <code>index</code> inside TokenIdentifiers. Was populated until concurrent_token_v2_enabled feature flag was enabled.

Unique identifier within the collection, optional, 0 means unassigned

</dd> <dt> <code>description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a></code> </dt> <dd> A brief description of the token. </dd> <dt> <code>name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a></code> </dt> <dd> Deprecated in favor of <code>name</code> inside TokenIdentifiers. Was populated until concurrent_token_v2_enabled feature flag was enabled.

The name of the token, which should be unique within the collection; the length of name should be smaller than 128, characters, eg: "Aptos Animal #1234"

</dd> <dt> <code>uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a></code> </dt> <dd> The Uniform Resource Identifier (uri) pointing to the JSON file stored in off-chain storage; the URL length will likely need a maximum any suggestions? </dd> <dt> <code>mutation_events: <a href="../../aptos-framework/doc/event.md#0x1_event_EventHandle">event::EventHandle</a><<a href="token.md#0x4_token_MutationEvent">token::MutationEvent</a>></code> </dt> <dd> Emitted upon any mutation of the token. </dd> </dl> </details>

Resource `TokenIdentifiers`

Represents first addition to the common fields for all tokens Started being populated once aggregator_v2_api_enabled was enabled.

<pre><code>#[resource_group_member(#[group = <a href="../../aptos-framework/doc/object.md#0x1_object_ObjectGroup">0x1::object::ObjectGroup</a>])] struct <a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a> has key </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>index: <a href="../../aptos-framework/doc/aggregator_v2.md#0x1_aggregator_v2_AggregatorSnapshot">aggregator_v2::AggregatorSnapshot</a><u64></code> </dt> <dd> Unique identifier within the collection, optional, 0 means unassigned </dd> <dt> <code>name: <a href="../../aptos-framework/doc/aggregator_v2.md#0x1_aggregator_v2_DerivedStringSnapshot">aggregator_v2::DerivedStringSnapshot</a></code> </dt> <dd> The name of the token, which should be unique within the collection; the length of name should be smaller than 128, characters, eg: "Aptos Animal #1234" </dd> </dl> </details>

Resource `ConcurrentTokenIdentifiers`

<pre><code>#[resource_group_member(#[group = <a href="../../aptos-framework/doc/object.md#0x1_object_ObjectGroup">0x1::object::ObjectGroup</a>])] #[deprecated] struct <a href="token.md#0x4_token_ConcurrentTokenIdentifiers">ConcurrentTokenIdentifiers</a> has key </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>index: <a href="../../aptos-framework/doc/aggregator_v2.md#0x1_aggregator_v2_AggregatorSnapshot">aggregator_v2::AggregatorSnapshot</a><u64></code> </dt> <dd> </dd> <dt> <code>name: <a href="../../aptos-framework/doc/aggregator_v2.md#0x1_aggregator_v2_AggregatorSnapshot">aggregator_v2::AggregatorSnapshot</a><<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>></code> </dt> <dd> </dd> </dl> </details>

Struct `BurnRef`

This enables burning an NFT, if possible, it will also delete the object. Note, the data in inner and self occupies 32-bytes each, rather than have both, this data structure makes a small optimization to support either and take a fixed amount of 34-bytes.

<pre><code>struct <a href="token.md#0x4_token_BurnRef">BurnRef</a> has drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>inner: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="../../aptos-framework/doc/object.md#0x1_object_DeleteRef">object::DeleteRef</a>></code> </dt> <dd> </dd> <dt> <code>self: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><address></code> </dt> <dd> </dd> </dl> </details>

Struct `MutatorRef`

This enables mutating description and URI by higher level services.

<pre><code>struct <a href="token.md#0x4_token_MutatorRef">MutatorRef</a> has drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>self: address</code> </dt> <dd> </dd> </dl> </details>

Struct `MutationEvent`

Contains the mutated fields name. This makes the life of indexers easier, so that they can directly understand the behavior in a writeset.

<pre><code>struct <a href="token.md#0x4_token_MutationEvent">MutationEvent</a> has drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>mutated_field_name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a></code> </dt> <dd> </dd> <dt> <code>old_value: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a></code> </dt> <dd> </dd> <dt> <code>new_value: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a></code> </dt> <dd> </dd> </dl> </details>

Struct `Mutation`

<pre><code>#[<a href="../../aptos-framework/doc/event.md#0x1_event">event</a>] struct <a href="token.md#0x4_token_Mutation">Mutation</a> has drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>token_address: address</code> </dt> <dd> </dd> <dt> <code>mutated_field_name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a></code> </dt> <dd> </dd> <dt> <code>old_value: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a></code> </dt> <dd> </dd> <dt> <code>new_value: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a></code> </dt> <dd> </dd> </dl> </details>

Constants

The URI is over the maximum length

<pre><code>const <a href="token.md#0x4_token_EURI_TOO_LONG">EURI_TOO_LONG</a>: u64 = 5; </code></pre>

<pre><code>const <a href="token.md#0x4_token_MAX_URI_LENGTH">MAX_URI_LENGTH</a>: u64 = 512; </code></pre>

The calling signer is not the owner

<pre><code>const <a href="token.md#0x4_token_ENOT_OWNER">ENOT_OWNER</a>: u64 = 8; </code></pre>

The collection owner feature is not supported

<pre><code>const <a href="token.md#0x4_token_ECOLLECTION_OWNER_NOT_SUPPORTED">ECOLLECTION_OWNER_NOT_SUPPORTED</a>: u64 = 9; </code></pre>

The description is over the maximum length

<pre><code>const <a href="token.md#0x4_token_EDESCRIPTION_TOO_LONG">EDESCRIPTION_TOO_LONG</a>: u64 = 6; </code></pre>

<pre><code>const <a href="token.md#0x4_token_MAX_DESCRIPTION_LENGTH">MAX_DESCRIPTION_LENGTH</a>: u64 = 2048; </code></pre>

The field being changed is not mutable

<pre><code>const <a href="token.md#0x4_token_EFIELD_NOT_MUTABLE">EFIELD_NOT_MUTABLE</a>: u64 = 3; </code></pre>

The provided signer is not the creator

<pre><code>const <a href="token.md#0x4_token_ENOT_CREATOR">ENOT_CREATOR</a>: u64 = 2; </code></pre>

The seed is over the maximum length

<pre><code>const <a href="token.md#0x4_token_ESEED_TOO_LONG">ESEED_TOO_LONG</a>: u64 = 7; </code></pre>

The token does not exist

<pre><code>const <a href="token.md#0x4_token_ETOKEN_DOES_NOT_EXIST">ETOKEN_DOES_NOT_EXIST</a>: u64 = 1; </code></pre>

The token name is over the maximum length

<pre><code>const <a href="token.md#0x4_token_ETOKEN_NAME_TOO_LONG">ETOKEN_NAME_TOO_LONG</a>: u64 = 4; </code></pre>

<pre><code>const <a href="token.md#0x4_token_MAX_TOKEN_NAME_LENGTH">MAX_TOKEN_NAME_LENGTH</a>: u64 = 128; </code></pre>

<pre><code>const <a href="token.md#0x4_token_MAX_TOKEN_SEED_LENGTH">MAX_TOKEN_SEED_LENGTH</a>: u64 = 128; </code></pre>

Function `create_common`

<pre><code>fun <a href="token.md#0x4_token_create_common">create_common</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, constructor_ref: &<a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a>, collection_name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_prefix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_with_index_suffix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>inline fun <a href="token.md#0x4_token_create_common">create_common</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, constructor_ref: &ConstructorRef, collection_name: String, description: String, name_prefix: String, // If <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>, numbered <a href="token.md#0x4_token">token</a> is created - i.e. index is appended to the name. // If <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>, name_prefix is the full name of the <a href="token.md#0x4_token">token</a>. name_with_index_suffix: Option<String>, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ) { let creator_address = <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(creator); let collection_addr = <a href="collection.md#0x4_collection_create_collection_address">collection::create_collection_address</a>(&creator_address, &collection_name); let <a href="collection.md#0x4_collection">collection</a> = <a href="../../aptos-framework/doc/object.md#0x1_object_address_to_object">object::address_to_object</a><Collection>(collection_addr); <a href="token.md#0x4_token_create_common_with_collection">create_common_with_collection</a>( creator, constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name_prefix, name_with_index_suffix, <a href="royalty.md#0x4_royalty">royalty</a>, uri ) } </code></pre> </details>

Function `create_common_with_collection`

<pre><code>fun <a href="token.md#0x4_token_create_common_with_collection">create_common_with_collection</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, constructor_ref: &<a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_prefix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_with_index_suffix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>inline fun <a href="token.md#0x4_token_create_common_with_collection">create_common_with_collection</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, constructor_ref: &ConstructorRef, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name_prefix: String, // If <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>, numbered <a href="token.md#0x4_token">token</a> is created - i.e. index is appended to the name. // If <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>, name_prefix is the full name of the <a href="token.md#0x4_token">token</a>. name_with_index_suffix: Option<String>, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ) { assert!(<a href="collection.md#0x4_collection_creator">collection::creator</a>(<a href="collection.md#0x4_collection">collection</a>) == <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(creator), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_unauthenticated">error::unauthenticated</a>(<a href="token.md#0x4_token_ENOT_CREATOR">ENOT_CREATOR</a>)); <a href="token.md#0x4_token_create_common_with_collection_internal">create_common_with_collection_internal</a>( constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name_prefix, name_with_index_suffix, <a href="royalty.md#0x4_royalty">royalty</a>, uri ); } </code></pre> </details>

Function `create_common_with_collection_as_owner`

<pre><code>fun <a href="token.md#0x4_token_create_common_with_collection_as_owner">create_common_with_collection_as_owner</a>(owner: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, constructor_ref: &<a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_prefix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_with_index_suffix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>inline fun <a href="token.md#0x4_token_create_common_with_collection_as_owner">create_common_with_collection_as_owner</a>( owner: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, constructor_ref: &ConstructorRef, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name_prefix: String, // If <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>, numbered <a href="token.md#0x4_token">token</a> is created - i.e. index is appended to the name. // If <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>, name_prefix is the full name of the <a href="token.md#0x4_token">token</a>. name_with_index_suffix: Option<String>, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ) { assert!(<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/features.md#0x1_features_is_collection_owner_enabled">features::is_collection_owner_enabled</a>(), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_unavailable">error::unavailable</a>(<a href="token.md#0x4_token_ECOLLECTION_OWNER_NOT_SUPPORTED">ECOLLECTION_OWNER_NOT_SUPPORTED</a>)); assert!(<a href="collection.md#0x4_collection">collection</a>.owner() == <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(owner), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_unauthenticated">error::unauthenticated</a>(<a href="token.md#0x4_token_ENOT_OWNER">ENOT_OWNER</a>)); <a href="token.md#0x4_token_create_common_with_collection_internal">create_common_with_collection_internal</a>( constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name_prefix, name_with_index_suffix, <a href="royalty.md#0x4_royalty">royalty</a>, uri ); } </code></pre> </details>

Function `create_common_with_collection_internal`

<pre><code>fun <a href="token.md#0x4_token_create_common_with_collection_internal">create_common_with_collection_internal</a>(constructor_ref: &<a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_prefix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_with_index_suffix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>inline fun <a href="token.md#0x4_token_create_common_with_collection_internal">create_common_with_collection_internal</a>( constructor_ref: &ConstructorRef, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name_prefix: String, // If <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>, numbered <a href="token.md#0x4_token">token</a> is created - i.e. index is appended to the name. // If <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>, name_prefix is the full name of the <a href="token.md#0x4_token">token</a>. name_with_index_suffix: Option<String>, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ) { if (name_with_index_suffix.is_some()) { // Be conservative, as we don't know what length the index will be, and assume worst case (20 chars in MAX_U64) assert!( name_prefix.length() + 20 + name_with_index_suffix.<a href="token.md#0x4_token_borrow">borrow</a>().length() <= <a href="token.md#0x4_token_MAX_TOKEN_NAME_LENGTH">MAX_TOKEN_NAME_LENGTH</a>, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_out_of_range">error::out_of_range</a>(<a href="token.md#0x4_token_ETOKEN_NAME_TOO_LONG">ETOKEN_NAME_TOO_LONG</a>) ); } else { assert!(name_prefix.length() <= <a href="token.md#0x4_token_MAX_TOKEN_NAME_LENGTH">MAX_TOKEN_NAME_LENGTH</a>, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_out_of_range">error::out_of_range</a>(<a href="token.md#0x4_token_ETOKEN_NAME_TOO_LONG">ETOKEN_NAME_TOO_LONG</a>)); }; assert!(description.length() <= <a href="token.md#0x4_token_MAX_DESCRIPTION_LENGTH">MAX_DESCRIPTION_LENGTH</a>, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_out_of_range">error::out_of_range</a>(<a href="token.md#0x4_token_EDESCRIPTION_TOO_LONG">EDESCRIPTION_TOO_LONG</a>)); assert!(uri.length() <= <a href="token.md#0x4_token_MAX_URI_LENGTH">MAX_URI_LENGTH</a>, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_out_of_range">error::out_of_range</a>(<a href="token.md#0x4_token_EURI_TOO_LONG">EURI_TOO_LONG</a>)); let object_signer = constructor_ref.generate_signer(); let index = <a href="collection.md#0x4_collection_increment_supply">collection::increment_supply</a>(&<a href="collection.md#0x4_collection">collection</a>, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(&object_signer)).destroy_with_default( <a href="../../aptos-framework/doc/aggregator_v2.md#0x1_aggregator_v2_create_snapshot">aggregator_v2::create_snapshot</a><u64>(0) ); // If create_numbered_token called us, add index to the name. let name = if (name_with_index_suffix.is_some()) { <a href="../../aptos-framework/doc/aggregator_v2.md#0x1_aggregator_v2_derive_string_concat">aggregator_v2::derive_string_concat</a>(name_prefix, &index, name_with_index_suffix.extract()) } else { <a href="../../aptos-framework/doc/aggregator_v2.md#0x1_aggregator_v2_create_derived_string">aggregator_v2::create_derived_string</a>(name_prefix) }; let deprecated_index = 0; let deprecated_name = <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_utf8">string::utf8</a>(b""); let token_concurrent = <a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a> { index, name, }; move_to(&object_signer, token_concurrent); let <a href="token.md#0x4_token">token</a> = <a href="token.md#0x4_token_Token">Token</a> { <a href="collection.md#0x4_collection">collection</a>, index: deprecated_index, description, name: deprecated_name, uri, mutation_events: <a href="../../aptos-framework/doc/object.md#0x1_object_new_event_handle">object::new_event_handle</a>(&object_signer), }; move_to(&object_signer, <a href="token.md#0x4_token">token</a>); if (<a href="royalty.md#0x4_royalty">royalty</a>.is_some()) { <a href="royalty.md#0x4_royalty_init">royalty::init</a>(constructor_ref, <a href="royalty.md#0x4_royalty">royalty</a>.extract()) }; } </code></pre> </details>

Function `create_token`

Creates a new token object with a unique address and returns the ConstructorRef for additional specialization. This takes in the collection object instead of the collection name. This function must be called if the collection name has been previously changed.

<pre><code>public fun <a href="token.md#0x4_token_create_token">create_token</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_token">create_token</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let creator_address = <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(creator); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_object">object::create_object</a>(creator_address); <a href="token.md#0x4_token_create_common_with_collection">create_common_with_collection</a>( creator, &constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create`

Creates a new token object with a unique address and returns the ConstructorRef for additional specialization.

<pre><code>public fun <a href="token.md#0x4_token_create">create</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, collection_name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create">create</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, collection_name: String, description: String, name: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let creator_address = <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(creator); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_object">object::create_object</a>(creator_address); <a href="token.md#0x4_token_create_common">create_common</a>( creator, &constructor_ref, collection_name, description, name, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create_token_as_collection_owner`

Same functionality as <code>create_token</code>, but the token can only be created by the collection owner.

<pre><code>public fun <a href="token.md#0x4_token_create_token_as_collection_owner">create_token_as_collection_owner</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_token_as_collection_owner">create_token_as_collection_owner</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let creator_address = <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(creator); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_object">object::create_object</a>(creator_address); <a href="token.md#0x4_token_create_common_with_collection_as_owner">create_common_with_collection_as_owner</a>( creator, &constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create_numbered_token_object`

Creates a new token object with a unique address and returns the ConstructorRef for additional specialization. The name is created by concatenating the (name_prefix, index, name_suffix). This function allows creating tokens in parallel, from the same collection, while providing sequential names.

This takes in the collection object instead of the collection name. This function must be called if the collection name has been previously changed.

<pre><code>public fun <a href="token.md#0x4_token_create_numbered_token_object">create_numbered_token_object</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_with_index_prefix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_with_index_suffix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_numbered_token_object">create_numbered_token_object</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name_with_index_prefix: String, name_with_index_suffix: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let creator_address = <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(creator); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_object">object::create_object</a>(creator_address); <a href="token.md#0x4_token_create_common_with_collection">create_common_with_collection</a>( creator, &constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name_with_index_prefix, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(name_with_index_suffix), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create_numbered_token`

Creates a new token object with a unique address and returns the ConstructorRef for additional specialization. The name is created by concatenating the (name_prefix, index, name_suffix). This function will allow creating tokens in parallel, from the same collection, while providing sequential names.

<pre><code>public fun <a href="token.md#0x4_token_create_numbered_token">create_numbered_token</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, collection_name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_with_index_prefix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_with_index_suffix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_numbered_token">create_numbered_token</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, collection_name: String, description: String, name_with_index_prefix: String, name_with_index_suffix: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let creator_address = <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(creator); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_object">object::create_object</a>(creator_address); <a href="token.md#0x4_token_create_common">create_common</a>( creator, &constructor_ref, collection_name, description, name_with_index_prefix, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(name_with_index_suffix), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create_numbered_token_as_collection_owner`

Same functionality as <code>create_numbered_token_object</code>, but the token can only be created by the collection owner.

<pre><code>public fun <a href="token.md#0x4_token_create_numbered_token_as_collection_owner">create_numbered_token_as_collection_owner</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_with_index_prefix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name_with_index_suffix: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_numbered_token_as_collection_owner">create_numbered_token_as_collection_owner</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name_with_index_prefix: String, name_with_index_suffix: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let creator_address = <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer_address_of">signer::address_of</a>(creator); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_object">object::create_object</a>(creator_address); <a href="token.md#0x4_token_create_common_with_collection_as_owner">create_common_with_collection_as_owner</a>( creator, &constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name_with_index_prefix, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(name_with_index_suffix), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create_named_token_object`

Creates a new token object from a token name and returns the ConstructorRef for additional specialization. This function must be called if the collection name has been previously changed.

<pre><code>public fun <a href="token.md#0x4_token_create_named_token_object">create_named_token_object</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_named_token_object">create_named_token_object</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let seed = <a href="token.md#0x4_token_create_token_seed">create_token_seed</a>(&<a href="collection.md#0x4_collection_name">collection::name</a>(<a href="collection.md#0x4_collection">collection</a>), &name); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_named_object">object::create_named_object</a>(creator, seed); <a href="token.md#0x4_token_create_common_with_collection">create_common_with_collection</a>( creator, &constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create_named_token`

Creates a new token object from a token name and returns the ConstructorRef for additional specialization.

<pre><code>public fun <a href="token.md#0x4_token_create_named_token">create_named_token</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, collection_name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_named_token">create_named_token</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, collection_name: String, description: String, name: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let seed = <a href="token.md#0x4_token_create_token_seed">create_token_seed</a>(&collection_name, &name); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_named_object">object::create_named_object</a>(creator, seed); <a href="token.md#0x4_token_create_common">create_common</a>( creator, &constructor_ref, collection_name, description, name, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create_named_token_as_collection_owner`

Same functionality as <code>create_named_token_object</code>, but the token can only be created by the collection owner.

<pre><code>public fun <a href="token.md#0x4_token_create_named_token_as_collection_owner">create_named_token_as_collection_owner</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_named_token_as_collection_owner">create_named_token_as_collection_owner</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let seed = <a href="token.md#0x4_token_create_token_seed">create_token_seed</a>(&<a href="collection.md#0x4_collection_name">collection::name</a>(<a href="collection.md#0x4_collection">collection</a>), &name); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_named_object">object::create_named_object</a>(creator, seed); <a href="token.md#0x4_token_create_common_with_collection_as_owner">create_common_with_collection_as_owner</a>( creator, &constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create_named_token_from_seed`

Creates a new token object from a token name and seed. Returns the ConstructorRef for additional specialization. This function must be called if the collection name has been previously changed.

<pre><code>public fun <a href="token.md#0x4_token_create_named_token_from_seed">create_named_token_from_seed</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, seed: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_named_token_from_seed">create_named_token_from_seed</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name: String, seed: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let seed = <a href="token.md#0x4_token_create_token_name_with_seed">create_token_name_with_seed</a>(&<a href="collection.md#0x4_collection_name">collection::name</a>(<a href="collection.md#0x4_collection">collection</a>), &name, &seed); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_named_object">object::create_named_object</a>(creator, seed); <a href="token.md#0x4_token_create_common_with_collection">create_common_with_collection</a>(creator, &constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="royalty.md#0x4_royalty">royalty</a>, uri); constructor_ref } </code></pre> </details>

Function `create_named_token_from_seed_as_collection_owner`

Same functionality as <code>create_named_token_from_seed</code>, but the token can only be created by the collection owner.

<pre><code>public fun <a href="token.md#0x4_token_create_named_token_from_seed_as_collection_owner">create_named_token_from_seed_as_collection_owner</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, seed: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_named_token_from_seed_as_collection_owner">create_named_token_from_seed_as_collection_owner</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, <a href="collection.md#0x4_collection">collection</a>: Object<Collection>, description: String, name: String, seed: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let seed = <a href="token.md#0x4_token_create_token_name_with_seed">create_token_name_with_seed</a>(&<a href="collection.md#0x4_collection_name">collection::name</a>(<a href="collection.md#0x4_collection">collection</a>), &name, &seed); let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_named_object">object::create_named_object</a>(creator, seed); <a href="token.md#0x4_token_create_common_with_collection_as_owner">create_common_with_collection_as_owner</a>( creator, &constructor_ref, <a href="collection.md#0x4_collection">collection</a>, description, name, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create_from_account`

DEPRECATED: Use <code>create</code> instead for identical behavior.

Creates a new token object from an account GUID and returns the ConstructorRef for additional specialization.

<pre><code>#[deprecated] public fun <a href="token.md#0x4_token_create_from_account">create_from_account</a>(creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, collection_name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, <a href="royalty.md#0x4_royalty">royalty</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_from_account">create_from_account</a>( creator: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/signer.md#0x1_signer">signer</a>, collection_name: String, description: String, name: String, <a href="royalty.md#0x4_royalty">royalty</a>: Option<Royalty>, uri: String, ): ConstructorRef { let constructor_ref = <a href="../../aptos-framework/doc/object.md#0x1_object_create_object_from_account">object::create_object_from_account</a>(creator); <a href="token.md#0x4_token_create_common">create_common</a>( creator, &constructor_ref, collection_name, description, name, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="royalty.md#0x4_royalty">royalty</a>, uri ); constructor_ref } </code></pre> </details>

Function `create_token_address`

Generates the token's address based upon the creator's address, the collection's name and the token's name.

<pre><code>public fun <a href="token.md#0x4_token_create_token_address">create_token_address</a>(creator: &address, <a href="collection.md#0x4_collection">collection</a>: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): address </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_token_address">create_token_address</a>(creator: &address, <a href="collection.md#0x4_collection">collection</a>: &String, name: &String): address { <a href="../../aptos-framework/doc/object.md#0x1_object_create_object_address">object::create_object_address</a>(creator, <a href="token.md#0x4_token_create_token_seed">create_token_seed</a>(<a href="collection.md#0x4_collection">collection</a>, name)) } </code></pre> </details>

Function `create_token_address_with_seed`

Generates the token's address based upon the creator's address, the collection object and the token's name and seed.

<pre><code>#[view] public fun <a href="token.md#0x4_token_create_token_address_with_seed">create_token_address_with_seed</a>(creator: address, <a href="collection.md#0x4_collection">collection</a>: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, seed: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): address </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_token_address_with_seed">create_token_address_with_seed</a>(creator: address, <a href="collection.md#0x4_collection">collection</a>: String, name: String, seed: String): address { let seed = <a href="token.md#0x4_token_create_token_name_with_seed">create_token_name_with_seed</a>(&<a href="collection.md#0x4_collection">collection</a>, &name, &seed); <a href="../../aptos-framework/doc/object.md#0x1_object_create_object_address">object::create_object_address</a>(&creator, seed) } </code></pre> </details>

Function `create_token_seed`

Named objects are derived from a seed, the token's seed is its name appended to the collection's name.

<pre><code>public fun <a href="token.md#0x4_token_create_token_seed">create_token_seed</a>(<a href="collection.md#0x4_collection">collection</a>: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/vector.md#0x1_vector">vector</a><u8> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_token_seed">create_token_seed</a>(<a href="collection.md#0x4_collection">collection</a>: &String, name: &String): <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/vector.md#0x1_vector">vector</a><u8> { assert!(name.length() <= <a href="token.md#0x4_token_MAX_TOKEN_NAME_LENGTH">MAX_TOKEN_NAME_LENGTH</a>, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_out_of_range">error::out_of_range</a>(<a href="token.md#0x4_token_ETOKEN_NAME_TOO_LONG">ETOKEN_NAME_TOO_LONG</a>)); let seed = *<a href="collection.md#0x4_collection">collection</a>.bytes(); seed.append(b"::"); seed.append(*name.bytes()); seed } </code></pre> </details>

Function `create_token_name_with_seed`

<pre><code>public fun <a href="token.md#0x4_token_create_token_name_with_seed">create_token_name_with_seed</a>(<a href="collection.md#0x4_collection">collection</a>: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, name: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>, seed: &<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>): <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/vector.md#0x1_vector">vector</a><u8> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_create_token_name_with_seed">create_token_name_with_seed</a>(<a href="collection.md#0x4_collection">collection</a>: &String, name: &String, seed: &String): <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/vector.md#0x1_vector">vector</a><u8> { assert!(seed.length() <= <a href="token.md#0x4_token_MAX_TOKEN_SEED_LENGTH">MAX_TOKEN_SEED_LENGTH</a>, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_out_of_range">error::out_of_range</a>(<a href="token.md#0x4_token_ESEED_TOO_LONG">ESEED_TOO_LONG</a>)); let seeds = <a href="token.md#0x4_token_create_token_seed">create_token_seed</a>(<a href="collection.md#0x4_collection">collection</a>, name); seeds.append(*seed.bytes()); seeds } </code></pre> </details>

Function `generate_mutator_ref`

Creates a MutatorRef, which gates the ability to mutate any fields that support mutation.

<pre><code>public fun <a href="token.md#0x4_token_generate_mutator_ref">generate_mutator_ref</a>(ref: &<a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a>): <a href="token.md#0x4_token_MutatorRef">token::MutatorRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_generate_mutator_ref">generate_mutator_ref</a>(ref: &ConstructorRef): <a href="token.md#0x4_token_MutatorRef">MutatorRef</a> { let <a href="../../aptos-framework/doc/object.md#0x1_object">object</a> = ref.object_from_constructor_ref<<a href="token.md#0x4_token_Token">Token</a>>(); <a href="token.md#0x4_token_MutatorRef">MutatorRef</a> { self: <a href="../../aptos-framework/doc/object.md#0x1_object">object</a>.object_address() } } </code></pre> </details>

Function `generate_burn_ref`

Creates a BurnRef, which gates the ability to burn the given token.

<pre><code>public fun <a href="token.md#0x4_token_generate_burn_ref">generate_burn_ref</a>(ref: &<a href="../../aptos-framework/doc/object.md#0x1_object_ConstructorRef">object::ConstructorRef</a>): <a href="token.md#0x4_token_BurnRef">token::BurnRef</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_generate_burn_ref">generate_burn_ref</a>(ref: &ConstructorRef): <a href="token.md#0x4_token_BurnRef">BurnRef</a> { let (inner, self) = if (ref.can_generate_delete_ref()) { let delete_ref = ref.generate_delete_ref(); (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(delete_ref), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>()) } else { let addr = ref.address_from_constructor_ref(); (<a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_none">option::none</a>(), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(addr)) }; <a href="token.md#0x4_token_BurnRef">BurnRef</a> { self, inner } } </code></pre> </details>

Function `address_from_burn_ref`

Extracts the tokens address from a BurnRef.

<pre><code>public fun <a href="token.md#0x4_token_address_from_burn_ref">address_from_burn_ref</a>(ref: &<a href="token.md#0x4_token_BurnRef">token::BurnRef</a>): address </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_address_from_burn_ref">address_from_burn_ref</a>(ref: &<a href="token.md#0x4_token_BurnRef">BurnRef</a>): address { if (ref.inner.is_some()) { ref.inner.<a href="token.md#0x4_token_borrow">borrow</a>().address_from_delete_ref() } else { *ref.self.<a href="token.md#0x4_token_borrow">borrow</a>() } } </code></pre> </details>

Function `borrow`

<pre><code>fun <a href="token.md#0x4_token_borrow">borrow</a><T: key>(<a href="token.md#0x4_token">token</a>: &<a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><T>): &<a href="token.md#0x4_token_Token">token::Token</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>inline fun <a href="token.md#0x4_token_borrow">borrow</a><T: key>(<a href="token.md#0x4_token">token</a>: &Object<T>): &<a href="token.md#0x4_token_Token">Token</a> { let token_address = <a href="token.md#0x4_token">token</a>.object_address(); assert!( exists<<a href="token.md#0x4_token_Token">Token</a>>(token_address), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_not_found">error::not_found</a>(<a href="token.md#0x4_token_ETOKEN_DOES_NOT_EXIST">ETOKEN_DOES_NOT_EXIST</a>), ); &<a href="token.md#0x4_token_Token">Token</a>[token_address] } </code></pre> </details>

Function `creator`

<pre><code>#[view] public fun <a href="token.md#0x4_token_creator">creator</a><T: key>(<a href="token.md#0x4_token">token</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><T>): address </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_creator">creator</a><T: key>(<a href="token.md#0x4_token">token</a>: Object<T>): address acquires <a href="token.md#0x4_token_Token">Token</a> { <a href="collection.md#0x4_collection_creator">collection::creator</a>(<a href="token.md#0x4_token_borrow">borrow</a>(&<a href="token.md#0x4_token">token</a>).<a href="collection.md#0x4_collection">collection</a>) } </code></pre> </details>

Function `collection_name`

<pre><code>#[view] public fun <a href="token.md#0x4_token_collection_name">collection_name</a><T: key>(<a href="token.md#0x4_token">token</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><T>): <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_collection_name">collection_name</a><T: key>(<a href="token.md#0x4_token">token</a>: Object<T>): String acquires <a href="token.md#0x4_token_Token">Token</a> { <a href="collection.md#0x4_collection_name">collection::name</a>(<a href="token.md#0x4_token_borrow">borrow</a>(&<a href="token.md#0x4_token">token</a>).<a href="collection.md#0x4_collection">collection</a>) } </code></pre> </details>

Function `collection_object`

<pre><code>#[view] public fun <a href="token.md#0x4_token_collection_object">collection_object</a><T: key>(<a href="token.md#0x4_token">token</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><T>): <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_collection_object">collection_object</a><T: key>(<a href="token.md#0x4_token">token</a>: Object<T>): Object<Collection> acquires <a href="token.md#0x4_token_Token">Token</a> { <a href="token.md#0x4_token_borrow">borrow</a>(&<a href="token.md#0x4_token">token</a>).<a href="collection.md#0x4_collection">collection</a> } </code></pre> </details>

Function `description`

<pre><code>#[view] public fun <a href="token.md#0x4_token_description">description</a><T: key>(<a href="token.md#0x4_token">token</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><T>): <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_description">description</a><T: key>(<a href="token.md#0x4_token">token</a>: Object<T>): String acquires <a href="token.md#0x4_token_Token">Token</a> { <a href="token.md#0x4_token_borrow">borrow</a>(&<a href="token.md#0x4_token">token</a>).description } </code></pre> </details>

Function `name`

Avoid this method in the same transaction as the token is minted as that would prohibit transactions to be executed in parallel.

<pre><code>#[view] public fun <a href="token.md#0x4_token_name">name</a><T: key>(<a href="token.md#0x4_token">token</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><T>): <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_name">name</a><T: key>(<a href="token.md#0x4_token">token</a>: Object<T>): String acquires <a href="token.md#0x4_token_Token">Token</a>, <a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a> { let token_address = <a href="token.md#0x4_token">token</a>.object_address(); if (exists<<a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a>>(token_address)) { <a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a>[token_address].name.read_derived_string() } else { <a href="token.md#0x4_token_borrow">borrow</a>(&<a href="token.md#0x4_token">token</a>).name } } </code></pre> </details>

Function `uri`

<pre><code>#[view] public fun <a href="token.md#0x4_token_uri">uri</a><T: key>(<a href="token.md#0x4_token">token</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><T>): <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_uri">uri</a><T: key>(<a href="token.md#0x4_token">token</a>: Object<T>): String acquires <a href="token.md#0x4_token_Token">Token</a> { <a href="token.md#0x4_token_borrow">borrow</a>(&<a href="token.md#0x4_token">token</a>).uri } </code></pre> </details>

Function `royalty`

<pre><code>#[view] public fun <a href="royalty.md#0x4_royalty">royalty</a><T: key>(<a href="token.md#0x4_token">token</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><T>): <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_Option">option::Option</a><<a href="royalty.md#0x4_royalty_Royalty">royalty::Royalty</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="royalty.md#0x4_royalty">royalty</a><T: key>(<a href="token.md#0x4_token">token</a>: Object<T>): Option<Royalty> acquires <a href="token.md#0x4_token_Token">Token</a> { <a href="token.md#0x4_token_borrow">borrow</a>(&<a href="token.md#0x4_token">token</a>); let <a href="royalty.md#0x4_royalty">royalty</a> = <a href="royalty.md#0x4_royalty_get">royalty::get</a>(<a href="token.md#0x4_token">token</a>); if (<a href="royalty.md#0x4_royalty">royalty</a>.is_some()) { <a href="royalty.md#0x4_royalty">royalty</a> } else { let creator = <a href="token.md#0x4_token_creator">creator</a>(<a href="token.md#0x4_token">token</a>); let collection_name = <a href="token.md#0x4_token_collection_name">collection_name</a>(<a href="token.md#0x4_token">token</a>); let collection_address = <a href="collection.md#0x4_collection_create_collection_address">collection::create_collection_address</a>(&creator, &collection_name); let <a href="collection.md#0x4_collection">collection</a> = <a href="../../aptos-framework/doc/object.md#0x1_object_address_to_object">object::address_to_object</a><<a href="collection.md#0x4_collection_Collection">collection::Collection</a>>(collection_address); <a href="royalty.md#0x4_royalty_get">royalty::get</a>(<a href="collection.md#0x4_collection">collection</a>) } } </code></pre> </details>

Function `index`

Avoid this method in the same transaction as the token is minted as that would prohibit transactions to be executed in parallel.

<pre><code>#[view] public fun <a href="token.md#0x4_token_index">index</a><T: key>(<a href="token.md#0x4_token">token</a>: <a href="../../aptos-framework/doc/object.md#0x1_object_Object">object::Object</a><T>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_index">index</a><T: key>(<a href="token.md#0x4_token">token</a>: Object<T>): u64 acquires <a href="token.md#0x4_token_Token">Token</a>, <a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a> { let token_address = <a href="token.md#0x4_token">token</a>.object_address(); if (exists<<a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a>>(token_address)) { <a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a>[token_address].index.read_snapshot() } else { <a href="token.md#0x4_token_borrow">borrow</a>(&<a href="token.md#0x4_token">token</a>).index } } </code></pre> </details>

Function `borrow_mut`

<pre><code>fun <a href="token.md#0x4_token_borrow_mut">borrow_mut</a>(mutator_ref: &<a href="token.md#0x4_token_MutatorRef">token::MutatorRef</a>): &mut <a href="token.md#0x4_token_Token">token::Token</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>inline fun <a href="token.md#0x4_token_borrow_mut">borrow_mut</a>(mutator_ref: &<a href="token.md#0x4_token_MutatorRef">MutatorRef</a>): &mut <a href="token.md#0x4_token_Token">Token</a> { assert!( exists<<a href="token.md#0x4_token_Token">Token</a>>(mutator_ref.self), <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_not_found">error::not_found</a>(<a href="token.md#0x4_token_ETOKEN_DOES_NOT_EXIST">ETOKEN_DOES_NOT_EXIST</a>), ); &mut <a href="token.md#0x4_token_Token">Token</a>[mutator_ref.self] } </code></pre> </details>

Function `burn`

<pre><code>public fun <a href="token.md#0x4_token_burn">burn</a>(burn_ref: <a href="token.md#0x4_token_BurnRef">token::BurnRef</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_burn">burn</a>(burn_ref: <a href="token.md#0x4_token_BurnRef">BurnRef</a>) acquires <a href="token.md#0x4_token_Token">Token</a>, <a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a> { let (addr, previous_owner) = if (burn_ref.inner.is_some()) { let delete_ref = burn_ref.inner.extract(); let addr = delete_ref.address_from_delete_ref(); let previous_owner = <a href="../../aptos-framework/doc/object.md#0x1_object_address_to_object">object::address_to_object</a><<a href="token.md#0x4_token_Token">Token</a>>(addr).owner(); delete_ref.delete(); (addr, previous_owner) } else { let addr = burn_ref.self.extract(); let previous_owner = <a href="../../aptos-framework/doc/object.md#0x1_object_address_to_object">object::address_to_object</a><<a href="token.md#0x4_token_Token">Token</a>>(addr).owner(); (addr, previous_owner) }; if (<a href="royalty.md#0x4_royalty_exists_at">royalty::exists_at</a>(addr)) { <a href="royalty.md#0x4_royalty_delete">royalty::delete</a>(addr) }; let <a href="token.md#0x4_token_Token">Token</a> { <a href="collection.md#0x4_collection">collection</a>, index: deprecated_index, description: _, name: _, uri: _, mutation_events, } = move_from<<a href="token.md#0x4_token_Token">Token</a>>(addr); let index = if (exists<<a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a>>(addr)) { let <a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a> { index, name: _, } = move_from<<a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a>>(addr); index.read_snapshot() } else { deprecated_index }; <a href="../../aptos-framework/doc/event.md#0x1_event_destroy_handle">event::destroy_handle</a>(mutation_events); <a href="collection.md#0x4_collection_decrement_supply">collection::decrement_supply</a>(&<a href="collection.md#0x4_collection">collection</a>, addr, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/option.md#0x1_option_some">option::some</a>(index), previous_owner); } </code></pre> </details>

Function `set_description`

<pre><code>public fun <a href="token.md#0x4_token_set_description">set_description</a>(mutator_ref: &<a href="token.md#0x4_token_MutatorRef">token::MutatorRef</a>, description: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_set_description">set_description</a>(mutator_ref: &<a href="token.md#0x4_token_MutatorRef">MutatorRef</a>, description: String) acquires <a href="token.md#0x4_token_Token">Token</a> { assert!(description.length() <= <a href="token.md#0x4_token_MAX_DESCRIPTION_LENGTH">MAX_DESCRIPTION_LENGTH</a>, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_out_of_range">error::out_of_range</a>(<a href="token.md#0x4_token_EDESCRIPTION_TOO_LONG">EDESCRIPTION_TOO_LONG</a>)); let <a href="token.md#0x4_token">token</a> = <a href="token.md#0x4_token_borrow_mut">borrow_mut</a>(mutator_ref); <a href="../../aptos-framework/doc/event.md#0x1_event_emit">event::emit</a>(<a href="token.md#0x4_token_Mutation">Mutation</a> { token_address: mutator_ref.self, mutated_field_name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_utf8">string::utf8</a>(b"description"), old_value: <a href="token.md#0x4_token">token</a>.description, new_value: description }); <a href="token.md#0x4_token">token</a>.description = description; } </code></pre> </details>

Function `set_name`

<pre><code>public fun <a href="token.md#0x4_token_set_name">set_name</a>(mutator_ref: &<a href="token.md#0x4_token_MutatorRef">token::MutatorRef</a>, name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_set_name">set_name</a>(mutator_ref: &<a href="token.md#0x4_token_MutatorRef">MutatorRef</a>, name: String) acquires <a href="token.md#0x4_token_Token">Token</a>, <a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a> { assert!(name.length() <= <a href="token.md#0x4_token_MAX_TOKEN_NAME_LENGTH">MAX_TOKEN_NAME_LENGTH</a>, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_out_of_range">error::out_of_range</a>(<a href="token.md#0x4_token_ETOKEN_NAME_TOO_LONG">ETOKEN_NAME_TOO_LONG</a>)); let <a href="token.md#0x4_token">token</a> = <a href="token.md#0x4_token_borrow_mut">borrow_mut</a>(mutator_ref); let old_name = if (exists<<a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a>>(mutator_ref.self)) { let token_concurrent = &mut <a href="token.md#0x4_token_TokenIdentifiers">TokenIdentifiers</a>[mutator_ref.self]; let old_name = token_concurrent.name.read_derived_string(); token_concurrent.name = <a href="../../aptos-framework/doc/aggregator_v2.md#0x1_aggregator_v2_create_derived_string">aggregator_v2::create_derived_string</a>(name); old_name } else { let old_name = <a href="token.md#0x4_token">token</a>.name; <a href="token.md#0x4_token">token</a>.name = name; old_name }; <a href="../../aptos-framework/doc/event.md#0x1_event_emit">event::emit</a>(<a href="token.md#0x4_token_Mutation">Mutation</a> { token_address: mutator_ref.self, mutated_field_name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_utf8">string::utf8</a>(b"name"), old_value: old_name, new_value: name }); } </code></pre> </details>

Function `set_uri`

<pre><code>public fun <a href="token.md#0x4_token_set_uri">set_uri</a>(mutator_ref: &<a href="token.md#0x4_token_MutatorRef">token::MutatorRef</a>, uri: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_String">string::String</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="token.md#0x4_token_set_uri">set_uri</a>(mutator_ref: &<a href="token.md#0x4_token_MutatorRef">MutatorRef</a>, uri: String) acquires <a href="token.md#0x4_token_Token">Token</a> { assert!(uri.length() <= <a href="token.md#0x4_token_MAX_URI_LENGTH">MAX_URI_LENGTH</a>, <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/error.md#0x1_error_out_of_range">error::out_of_range</a>(<a href="token.md#0x4_token_EURI_TOO_LONG">EURI_TOO_LONG</a>)); let <a href="token.md#0x4_token">token</a> = <a href="token.md#0x4_token_borrow_mut">borrow_mut</a>(mutator_ref); <a href="../../aptos-framework/doc/event.md#0x1_event_emit">event::emit</a>(<a href="token.md#0x4_token_Mutation">Mutation</a> { token_address: mutator_ref.self, mutated_field_name: <a href="../../aptos-framework/../aptos-stdlib/../move-stdlib/doc/string.md#0x1_string_utf8">string::utf8</a>(b"uri"), old_value: <a href="token.md#0x4_token">token</a>.uri, new_value: uri, }); <a href="token.md#0x4_token">token</a>.uri = uri; } </code></pre> </details>

Module `0x4::token`

Module 0x4::token

Resource Token

Resource TokenIdentifiers

Resource ConcurrentTokenIdentifiers

Struct BurnRef

Struct MutatorRef

Struct MutationEvent

Struct Mutation

Constants

Function create_common

Function create_common_with_collection

Function create_common_with_collection_as_owner

Function create_common_with_collection_internal

Function create_token

Function create

Function create_token_as_collection_owner

Function create_numbered_token_object

Function create_numbered_token

Function create_numbered_token_as_collection_owner

Function create_named_token_object

Function create_named_token

Function create_named_token_as_collection_owner

Function create_named_token_from_seed

Function create_named_token_from_seed_as_collection_owner

Function create_from_account

Function create_token_address

Function create_token_address_with_seed

Function create_token_seed

Function create_token_name_with_seed

Function generate_mutator_ref

Function generate_burn_ref

Function address_from_burn_ref

Function borrow

Function creator

Function collection_name

Function collection_object

Function description

Function name

Function uri

Function royalty

Function index

Function borrow_mut

Function burn

Function set_description

Function set_name

Function set_uri

Module `0x4::token`

Resource `Token`

Resource `TokenIdentifiers`

Resource `ConcurrentTokenIdentifiers`

Struct `BurnRef`

Struct `MutatorRef`

Struct `MutationEvent`

Struct `Mutation`

Function `create_common`

Function `create_common_with_collection`

Function `create_common_with_collection_as_owner`

Function `create_common_with_collection_internal`

Function `create_token`

Function `create`

Function `create_token_as_collection_owner`

Function `create_numbered_token_object`

Function `create_numbered_token`

Function `create_numbered_token_as_collection_owner`

Function `create_named_token_object`

Function `create_named_token`

Function `create_named_token_as_collection_owner`

Function `create_named_token_from_seed`

Function `create_named_token_from_seed_as_collection_owner`

Function `create_from_account`

Function `create_token_address`

Function `create_token_address_with_seed`

Function `create_token_seed`

Function `create_token_name_with_seed`

Function `generate_mutator_ref`

Function `generate_burn_ref`

Function `address_from_burn_ref`

Function `borrow`

Function `creator`

Function `collection_name`

Function `collection_object`

Function `description`

Function `name`

Function `uri`

Function `royalty`

Function `index`

Function `borrow_mut`

Function `burn`

Function `set_description`

Function `set_name`

Function `set_uri`