Skip to main content

Minting

This is the first of many tutorials in a series where you'll be creating a complete NFT smart contract from scratch that conforms with all the NEAR NFT standards. Today you'll learn how to create the logic needed to mint NFTs and have them show up in your NEAR wallet. You will be modifying a bare-bones skeleton smart contract by filling in the necessary code snippets needed to add minting functionalities.

Introductionโ€‹

To get started, switch to the 1.skeleton branch in our repo. If you haven't cloned the repository, refer to the Contract Architecture to get started.

git checkout 1.skeleton

If you wish to see the finished code for the minting portion of the tutorial, that can be found on the 2.minting branch.

Modifications to the skeleton contractโ€‹

In order to implement the logic needed for minting, we should break it up into smaller tasks and handle those one-by-one. Let's step back and think about the best way to do this by asking ourselves a simple question: what does it mean to mint an NFT?

To mint a non-fungible token, in the most simple way possible, a contract needs to be able to associate a token with an owner on the blockchain. This means you'll need:

  • A way to keep track of tokens and other information on the contract.
  • A way to store information for each token such as metadata (more on that later).
  • A way to link a token with an owner.

That's it! We've now broken down the larger problem into some smaller, less daunting, subtasks. Let's start by tackling the first and work our way through the rest.

Storing information on the contractโ€‹

Start by navigating to nft-contract/src/index.ts and filling in some of the code blocks. You need to be able to store important information on the contract such as the list of tokens that an account has.

The first thing to do is add the information to the contract class.

This allows you to get the information stored in these data structures from anywhere in the contract. The code above has created 3 token specific storages:

  • tokensPerOwner: allows you to keep track of the tokens owned by any account. It will map the account address to a set of token ID strings owned by that account.
  • tokensById: returns all the information about a specific token. It will map a token ID string to a Token object.
  • tokenMetadataById: returns just the metadata for a specific token. It wil map a token ID string to a TokenMetadata object.

In addition, you'll keep track of the owner of the contract as well as the metadata for the contract.

Constructor Functionโ€‹

Next, you'll add the logic to the constructor function. This function needs to be invoked when you first deploy the contract. It will initialize all the contract's fields that you've defined above with default values. We've added the ownerId and metadata fields as parameters to the function because those are the only ones that can be customized.

This function will default all the collections to be empty and set the owner and metadata equal to what you pass in.

More often than not when doing development, you'll need to deploy contracts several times. You can imagine that it might get tedious to have to pass in metadata every single time you want to initialize the contract. For this reason, the metadata has been defaulted with some initial data if it wasn't passed in by the user.

Metadata and token informationโ€‹

Now that you've defined what information to store on the contract itself and you've defined some ways to initialize the contract, you need to define what information should go in the Token, TokenMetadata, and NFTContractMetadata data types.

Let's switch over to the nft-contract/src/metadata.ts file as this is where that information will go. If you look at the standards for metadata, you'll find all the necessary information that you need to store for both TokenMetadata and NFTContractMetadata. Simply fill in the following code.

This now leaves you with the Token struct and something called a JsonToken. The Token struct will hold all the information directly related to the token excluding the metadata. The metadata, if you remember, is stored in a map on the contract in a data structured called tokenMetadataById. This allows you to quickly get the metadata for any token by simply passing in the token's ID.

For the Token struct, you'll just keep track of the owner for now.

The purpose of the JsonToken is to hold all the information for an NFT that you want to send back as JSON whenever someone does a view call. This means you'll want to store the owner, token ID, and metadata.

tip

Some of you might be thinking "how come we don't just store all the information in the Token struct?". The reason behind this is that it's actually more efficient to construct the JSON token on the fly only when you need it rather than storing all the information in the token struct. In addition, some operations might only need the metadata for a token and so having the metadata in a separate data structure is more optimal.

Function for querying contract metadataโ€‹

Now that you've defined some of the types that were used in the previous section, let's move on and create the first view function internalNftMetadata. This will allow users to query for the contract's metadata as per the metadata standard.

This function will get the metadata object from the contract which is of type NFTContractMetadata and will return it.

Just like that, you've completed the first two tasks and are ready to move onto last part of the tutorial.

Minting Logicโ€‹

Now that all the information and types are defined, let's start brainstorming how the minting logic will play out. In the end, you need to link a Token and TokenId to a specific owner. Let's look back at a couple data structures that might be useful:

//keeps track of all the token IDs for a given account
tokensPerOwner: LookupMap<AccountId, UnorderedSet<TokenId>>;

//keeps track of the token struct for a given token ID
tokensById: LookupMap<TokenId, Token>;

//keeps track of the token metadata for a given token ID
tokenMetadataById: UnorderedMap<TokenId, TokenMetadata>;

Looking at these data structures, you could do the following:

  • Add the token ID into the set of tokens that the receiver owns. This will be done on the tokensPerOwner field.
  • Create a token object and map the token ID to that token object in the tokensById field.
  • Map the token ID to it's metadata using the tokenMetadataById.

With those steps outlined, it's important to take into consideration the storage costs of minting NFTs. Since you're adding bytes to the contract by creating entries in the data structures, the contract needs to cover the storage costs. If you just made it so any user could go and mint an NFT for free, that system could easily be abused and users could essentially "drain" the contract of all it's funds by minting thousands of NFTs. For this reason, you'll make it so that users need to attach a deposit to the call to cover the cost of storage. You'll measure the initial storage usage before anything was added and you'll measure the final storage usage after all the logic is finished. Then you'll make sure that the user has attached enough $NEAR to cover that cost and refund them if they've attached too much.

Now that you've got a good understanding of how everything should play out, let's fill in the necessary code.

You'll notice that we're using some internal methods such as refundDeposit and internalAddTokenToOwner. We've described the function of refundDeposit and as for internalAddTokenToOwner, this will add a token to the set of tokens an account owns for the contract's tokensPerOwner data structure. You can create these functions in a file called internal.ts. Go ahead and create the file. Your new contract architecture should look as follows:

nft-contract
โ””โ”€โ”€ src
    โ”œโ”€โ”€ approval.ts
    โ”œโ”€โ”€ enumeration.ts
    โ”œโ”€โ”€ internal.ts
    โ”œโ”€โ”€ lib.ts
    โ”œโ”€โ”€ metadata.ts
    โ”œโ”€โ”€ mint.ts
    โ”œโ”€โ”€ nft_core.ts
    โ””โ”€โ”€ royalty.ts

Add the following to your newly created internal.ts file.

At this point, the core logic is all in place so that you can mint NFTs. You can use the function nft_mint which takes the following parameters:

  • token_id: the ID of the token you're minting (as a string).
  • metadata: the metadata for the token that you're minting (of type TokenMetadata which is found in the metadata.ts file).
  • receiver_id: specifies who the owner of the token will be.

Behind the scenes, the function will:

  1. Call the internal mint function.
  2. Calculate the initial storage before adding anything to the contract
  3. Create a Token object with the owner ID
  4. Link the token ID to the newly created token object by inserting them into the tokensById field.
  5. Link the token ID to the passed in metadata by inserting them into the tokenMetadataById field.
  6. Add the token ID to the list of tokens that the owner owns by calling the internalAddTokenToOwner function.
  7. Calculate the final and net storage to make sure that the user has attached enough NEAR to the call in order to cover those costs.

Querying for token informationโ€‹

If you were to go ahead and deploy this contract, initialize it, and mint an NFT, you would have no way of knowing or querying for the information about the token you just minted. Let's quickly add a way to query for the information of a specific NFT. You'll move to the nft-contract/src/nft_core.ts file and edit the internalNftToken function.

It will take a token ID as a parameter and return the information for that token. The JsonToken contains the token ID, the owner ID, and the token's metadata.

With that finished, it's finally time to build and deploy the contract so you can mint your first NFT.

Interacting with the contract on-chainโ€‹

Now that the logic for minting is complete and you've added a way to query for information about specific tokens, it's time to build and deploy your contract to the blockchain.

Deploying the contractโ€‹

We've included a very simple way to build the smart contracts throughout this tutorial using yarn. The following command will build the contract and copy over the .wasm file to a folder build/nft.wasm.

yarn build:nft

For deployment, you will need a NEAR account with the keys stored on your local machine. Navigate to the NEAR wallet site and create an account.

info

Please ensure that you deploy the contract to an account with no pre-existing contracts. It's easiest to simply create a new account or create a sub-account for this tutorial.

Log in to your newly created account with near-cli by running the following command in your terminal.

near login --networkId testnet

To make this tutorial easier to copy/paste, we're going to set an environment variable for your account ID. In the command below, replace YOUR_ACCOUNT_NAME with the account name you just logged in with including the .testnet portion:

export NFT_CONTRACT_ID="YOUR_ACCOUNT_NAME"

Test that the environment variable is set correctly by running:

echo $NFT_CONTRACT_ID

Verify that the correct account ID is printed in the terminal. If everything looks correct you can now deploy your contract. In the root of your NFT project run the following command to deploy your smart contract.

cargo near deploy $NFT_CONTRACT_ID

At this point, the contract should have been deployed to your account and you're ready to move onto testing and minting NFTs.

Initializing the contractโ€‹

The very first thing you need to do once the contract has been deployed is to initialize it. For simplicity, let's call the default metadata initialization function you wrote earlier so that you don't have to type the metadata manually in the CLI.

near call $NFT_CONTRACT_ID init '{"owner_id": "'$NFT_CONTRACT_ID'"}' --accountId $NFT_CONTRACT_ID

You've just initialized the contract with some default metadata and set your account ID as the owner. At this point, you're ready to call your first view function.

Viewing the contract's metadataโ€‹

Now that the contract has been initialized, you can call some of the functions you wrote earlier. More specifically, let's test out the function that returns the contract's metadata:

near view $NFT_CONTRACT_ID nft_metadata

This should return an output similar to the following:

{ spec: 'nft-1.0.0', name: 'NFT Tutorial Contract', symbol: 'GOTEAM' }

At this point, you're ready to move on and mint your first NFT.

Minting our first NFTโ€‹

Let's now call the minting function that you've created. This requires a token_id and metadata. If you look back at the TokenMetadata struct you created earlier, there are many fields that could potentially be stored on-chain:

Let's mint an NFT with a title, description, and media to start. The media field can be any URL pointing to a media file. We've got an excellent GIF to mint but if you'd like to mint a custom NFT, simply replace our media link with one of your choosing. If you run the following command, it will mint an NFT with the following parameters:

  • token_id: "token-1"
  • metadata:
    • title: "My Non Fungible Team Token"
    • description: "The Team Most Certainly Goes :)"
    • media: https://bafybeiftczwrtyr3k7a2k4vutd3amkwsmaqyhrdzlhvpt33dyjivufqusq.ipfs.dweb.link/goteam-gif.gif
  • receiver_id: "'$NFT_CONTRACT_ID'"
near call $NFT_CONTRACT_ID nft_mint '{"token_id": "token-1", "metadata": {"title": "My Non Fungible Team Token", "description": "The Team Most Certainly Goes :)", "media": "https://bafybeiftczwrtyr3k7a2k4vutd3amkwsmaqyhrdzlhvpt33dyjivufqusq.ipfs.dweb.link/goteam-gif.gif"}, "receiver_id": "'$NFT_CONTRACT_ID'"}' --accountId $NFT_CONTRACT_ID --amount 0.1
info

The amount flag is specifying how much NEAR to attach to the call. Since you need to pay for storage, 0.1 NEAR is attached and you'll get refunded any excess that is unused at the end.

Viewing information about the NFTโ€‹

Now that the NFT has been minted, you can check and see if everything went correctly by calling the nft_token function. This should return a JsonToken which should contain the token_id, owner_id, and metadata.

near view $NFT_CONTRACT_ID nft_token '{"token_id": "token-1"}'
Example response: 

{
  token_id: 'token-1',
  owner_id: 'goteam.examples.testnet',
  metadata: {
    title: 'My Non Fungible Team Token',
    description: 'The Team Most Certainly Goes :)',
    media: 'https://bafybeiftczwrtyr3k7a2k4vutd3amkwsmaqyhrdzlhvpt33dyjivufqusq.ipfs.dweb.link/goteam-gif.gif'
  }
}

Go team! You've now verified that everything works correctly and it's time to view your freshly minted NFT in the NEAR wallet's collectibles tab!

Viewing your NFTs in the walletโ€‹

If you navigate to the collectibles tab in the NEAR wallet, this should list all the NFTs that you own. Currently, It should be empty.

We've got a problem. The wallet correctly picked up that you minted an NFT, however, the contract doesn't implement the specific view function that is being called. Behind the scenes, the wallet is trying to call nft_tokens_for_owner to get a list of all the NFTs owned by your account on the contract. The only function you've created, however, is the nft_token function. It wouldn't be very efficient for the wallet to call nft_token for every single NFT that a user has to get information and so they try to call the nft_tokens_for_owner function instead.

In the next tutorial, you'll learn about how to deploy a patch fix to a pre-existing contract so that you can view the NFT in the wallet.

Conclusionโ€‹

In this tutorial, you went through the basics of setting up and understand the logic behind minting NFTs on the blockchain using a skeleton contract.

You first looked at what it means to mint NFTs and how to break down the problem into more feasible chunks. You then started modifying the skeleton contract chunk by chunk starting with solving the problem of storing information / state on the contract. You then looked at what to put in the metadata and token information. Finally, you looked at the logic necessary for minting NFTs.

After the contract was written, it was time to deploy to the blockchain. You deployed the contract and initialized it. Finally, you minted your very first NFT and saw that some changes are needed before you can view it in the wallet.

Next Stepsโ€‹

In the next tutorial, you'll find out how to deploy a patch fix and what that means so that you can view your NFTs in the wallet.

Versioning for this article

At the time of this writing, this example works with the following versions:

  • near-cli: 3.0.0
  • NFT standard: NEP171, version 1.0.0
  • Metadata standard: NEP177, version 2.1.0
Was this page helpful?
Need some help? Chat with us or check our Dev Resources!
Twitter
Telegram
Discord
Zulip