Please use this code at your own risk. By using this code you agree to take full responsibility for any damage or loss of data that may occur. This code is provided as-is with no warranty or guarantee of any kind. You are responsible for testing this code in a non-production environment before using it in production.
Initially forked from HSuite, this is a collection of tools for working with NFTs on the Hedera Hashgraph.
First install Node from here.
Then you can install the dependencies and devDependencies by running:
$ npm installor if you use yarn:
$ yarnTo run any of the scripts you will need to create an environment file in the root of the project.
This file is used to store all the environment variables that are used by the scripts.
You will create 2 new files, one for development and one for production. Name them:
-
.env.developmentThis is where you will store all your testnet account details. -
.env.productionThis is where you will store all your mainnet account details.
Copy the contents of the env_example to your new files and update all the values as detailed below.
This command will create the new files for you:
$ cp env_example .env.development && cp env_example .env.productionHEDERA_NETWORK = <testnet OR mainnet>
NFT_STORAGE_KEY = <your nft.storage key>
OPERATOR_ACCOUNT_ID = <your operator account id>
OPERATOR_PRIVATE_KEY = <your operator private key>
TREASURY_ACCOUNT_ID = <your treasury account id>
TREASURY_PRIVATE_KEY = <your treasury private key>
AUTO_RENEW_ACCOUNT_ID = <your auto renew account id>
AUTO_RENEW_PRIVATE_KEY = <your auto renew private key>
NFT_TOKEN_ID = <your nft token id>
NFT_SUPPLY_PRIVATE_KEY = <your nft supply private key>
MERGE_ATTRIBUTES_TO_PROPERTIES = <true or false>This is used to upload the NFT metadata and images to IPFS (Interplanetary File System). Sign up for a free NFT Storage account here: https://nft.storage/login/ to get your API key.
The Hedera account ID that will pay for all the transactions, this is different to the treasury account id that will hold the NFTs.
The private key for the operator account.
The Hedera account ID that will hold the NFTs.
The private key for the treasury account.
The Hedera account ID that will be used to auto renew the NFT token. If no account is provided, the treasury account will be used.
The private key for the auto renew account.
The token ID that the mint command will mint NFTs to.
The private key for the NFT supply account.
If you set MERGE_ATTRIBUTES_TO_PROPERTIES to true then any attributes that you add to your NFT will be duplicated to the properties field as key value pairs, example:
{
"name": "My NFT",
"description": "My NFT description",
"image": "ipfs://<CID>/image.jpeg",
"attributes": [
{
"trait_type": "Background",
"value": "Blue"
},
{
"trait_type": "Eyes",
"value": "Green"
},
{
"trait_type": "Mouth",
"value": "Smile"
}
],
"properties": {
"Background": "Blue",
"Eyes": "Green",
"Mouth": "Smile"
}
}Create a folder called input at the root of this project. Add a file in this input folder called tokenInfo.json with the following format and update the values to suit your needs.
{
"tokenName": "Token Name",
"tokenSymbol": "SYMBOL",
"royalties": [
{
"recipient": "0.0.123456",
"percentage": 10,
"fallbackFeeInHbar": 50
},
{
"recipient": "0.0.234567",
"percentage": 2
}
]
}Run the following command to create the token:
Decide whether you would like a new Supply Key to be generated for you or if you would like to use an existing one.
If you would like to use an existing key, then add the private key to the SUPPLY_PRIVATE_KEY environment variable in your .env.development file for Testnet or your .env.production file for mainnet.
For Testnet
$ npm run token:create
or
$ yarn token:createFor Mainnet
$ NODE_ENV=production npm run token:create
or
$ NODE_ENV=production yarn token:createThis will output a new file at ./output/token-secrets-0.0.000000.json. This file contains the token ID and the private key for the token supply account. You will need to add these to your .env.development file for Testnet or your .env.production file for mainnet in order to mint NFTs.
Make sure to set the NFT_TOKEN_ID and NFT_SUPPLY_PRIVATE_KEY in your .env.development file.
Modify the mintQueue.json file, by filling the array with the NFTs you would like to mint.
The format should be like this example:
[
{
"quantity": 1,
"name": "Name of the first NFT",
"description": "A description of the first NFT",
"creator": "Name of the creator",
"image": "preview/previewImage1.jpeg",
"type": "image/jpeg",
"files": [
{
"uri": "highres/highResolutionImage1.jpeg",
"type": "image/jpeg",
"is_default_file": true,
"metadata": {
"name": "High Resolution Image 1",
"description": "A high resolution image"
}
}
],
"properties": {
"collection": "Name of the collection"
},
"attributes": [
{ "trait_type": "species", "value": "Human" },
{ "trait_type": "clan", "value": "Vikings" },
{ "trait_type": "attack", "value": 89 },
{ "trait_type": "defence", "value": 70 },
{ "trait_type": "speed", "value": 76 },
{ "trait_type": "agility", "value": 68 },
{ "trait_type": "intelligence", "value": 32 },
{ "trait_type": "magic", "value": 43 },
{ "trait_type": "total", "value": 378 }
]
},
{
"quantity": 5,
"name": "Name of the second NFT",
"description": "A description of the second NFT",
"creator": "Name of the creator",
"image": "preview/previewImage2.jpeg",
"type": "image/jpeg",
"files": [
{
"uri": "highres/highResolutionImage2.jpeg",
"type": "image/jpeg"
}
]
},
{
"quantity": 500,
"name": "Hello Future Live Let's Go!",
"creator": "dragmaLABS",
"description": "Hello Future Live is here! Embrace the Future Today!",
"image": "hfl2023/image.png",
"type": "image/png",
"format": "[email protected]",
"files": [
{
"uri": "hfl2023/hfl.glb",
"type": "model/gltf-binary",
"is_default_file": true,
"metadata": {
"name": "Rocket HFL 3D Model"
}
}
]
}
]The above example will mint 3 different NFTs into your token across 506 serials, the first NFT has 1 copy, the second NFT has 5 copies and the third NFT has 500 copies. These will all be created under the token ID set in the environment variable NFT_TOKEN_ID in your .env.development file for Testnet or your .env.production file for mainnet.
The mint script will automatically upload all your media assets to IPFS. All you need to do is copy your files to the ./input/media folder and then reference them in the mintQueue.json file as shown above. It's important to note that the image and uri fields should be relative paths to the ./input/media folder and should match the file names exactly.
To mint your collection, be sure your operator has got enough HBAR to mint them all, then simply run:
For Testnet
$ npm run token:mint
or
$ yarn token:mintFor Mainnet
$ NODE_ENV=production npm run token:mint
or
$ NODE_ENV=production yarn token:mintOnce minted, you can check your collection out using any good NFT explorer. A few examples being:
Occasionally you may want to burn an NFT, for example if you have made a mistake during a mint and want to remove it from your collection.
You can only burn NFTs that currently sit in the treasury account, so you will need to be the owner of the NFT.
To burn specific NFTs from your token collection, simply create a new file at ./input/serialsToBurn.json and add the serial numbers of the NFTs you want to burn including the token ID and supply private key.
{
"tokenId": "0.0.1234567",
"serials": [4, 7, 8],
"privateSupplyKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}Then run the following command:
For Testnet
$ npm run token:burn
or
$ yarn token:burnFor Mainnet
$ NODE_ENV=production npm run token:burn
or
$ NODE_ENV=production yarn token:burnHedera have begun resetting the testnet every quarter, which means that all the tokens and NFTs that you have created will be deleted. It can be a pain if you have to recreate all your tokens and NFTs every time.
The token:clone script will allow you to clone an existing token from mainnet and all of its NFTs to a new token on testnet.
You'll need to fill the following fields in your .env.development file for Testnet or your .env.production file for mainnet:
OPERATOR_ACCOUNT_ID=0.0.xxxxxx
OPERATOR_PRIVATE_KEY=0.0.xxxxxx
TREASURY_ACCOUNT_ID=0.0.xxxxxx
TREASURY_PRIVATE_KEY=0.0.xxxxxx
AUTO_RENEW_ACCOUNT_ID=0.0.xxxxxxThe new tokens will be cloned to the TREASURY_ACCOUNT_ID
Just run the following command, replacing the token ID with the ID of the token you want to clone:
$ npm run token:clone 0.0.1234567
or
$ yarn token:clone 0.0.1234567