Your First NFT
Last updated
Last updated
This tutorial describes how to create and transfer NFTs on the Aptos blockchain. The Aptos implementation for core NFTs can be found in the Move module.
Install your preferred SDK from the below list:
Each SDK provides an examples directory. This tutorial covers the simple-nft example.
Clone the aptos-core repo:
Typescript
Python
Rust
Navigate to the Typescript SDK examples directory:
Install the necessary dependencies:
The following output should appear after executing the simple-nft example, though some values will be different:
This example demonstrates:
Initializing the REST and faucet clients.
The creation of two accounts: Alice and Bob.
The funding and creation of Alice and Bob's accounts.
The creation of a collection and a token using Alice's account.
Alice offering a token and Bob claiming it.
Bob unilaterally sending the token to Alice via a multiagent transaction.
Typescript
Python
Rust
SEE THE FULL CODE
In the first step the example initializes both the API and faucet clients.
The API client interacts with the REST API, and
The faucet client interacts with the devnet Faucet service for creating and funding accounts.
Typescript
Python
Rust
Using the API client we can create a TokenClient, which we use for common token operations such as creating collections and tokens, transferring them, claiming them, and so on.
common.ts initializes the URL values as such:
TIP
By default the URLs for both the services point to Aptos devnet services. However, they can be configured with the following environment variables:
APTOS_NODE_URL
APTOS_FAUCET_URL
Typescript
Python
Rust
In Aptos, each account must have an on-chain representation in order to support receive tokens and coins as well as interacting in other dApps. An account represents a medium for storing assets, hence it must be explicitly created. This example leverages the Faucet to create Alice and Bob's accounts:
Typescript
Python
Rust
Now begins the process of creating tokens. First, the creator must create a collection to store tokens. A collection can contain zero, one, or many distinct tokens within it. The collection does not restrict the attributes of the tokens, as it is only a container.
Typescript
Python
Rust
Your application will call createCollection:
The function signature of createCollection. It returns a transaction hash:
To create a token, the creator must specify an associated collection. A token must be associated with a collection and that collection must have remaining tokens that can be minted. There are many attributes associated with a token, but the helper API only exposes the minimal amount required to create static content.
Typescript
Python
Rust
Your application will call createToken:
The function signature of createToken. It returns a transaction hash:
Both the collection and token metadata are stored on the creator's account within their Collections in a table. The SDKs provide convenience wrappers around querying these specific tables:
Typescript
Python
Rust
To read a collection's metadata:
To read a token's metadata:
Here's how getTokenData queries the token metadata:
Each token within Aptos is a distinct asset, the assets owned by the user are stored within their TokenStore. To get the balance:
Typescript
Python
Rust
Many users have received unwanted tokens that may cause minimally embarrassment to serious ramifications. Aptos gives the rights to each owner of an account to dictate whether or not to receive unilateral transfers. By default, unilateral transfers are unsupported. So Aptos provides a framework for offering and claiming tokens.
To offer a token:
Typescript
Python
Rust
To claim a token:
Typescript
Python
Rust
To support safe unilateral transfers of a token, the sender may first ask the recipient to acknowledge off-chain about a pending transfer. This comes in the form of a multiagent transaction request. Multiagent transactions contain multiple signatures, one for each on-chain account. Move then can leverage this to give signer level permissions to all that signed. For token transfers, this ensures that the receiving party does indeed desire to receive this token without requiring the use of the token transfer framework described above.
Typescript
Python
Rust
Coming soon.
Python
Rust
Typescript
Coming soon.
Run the Typescript example:
See for the complete code as you follow the below steps.
The next step is to create two accounts locally. represent both on and off-chain state. Off-chain state consists of an address and the public, private key pair used to authenticate ownership. This step demonstrates how to generate that off-chain state.