A collection of scripts which you configure with JSON files that help you interface with the NFT-MAKER PRO API to accomplish tasks in bulk without having to write any code
NFT-MAKER PRO is a toolset consisting of a web app and accompanying API that enables you to create, manage, and sell NFTs at scale on the Cardano blockchain.
For some projects, there are actions that must be done in bulk like managing thousands of NFTs. Doing this manually with the web app is time-consuming.
These scripts can solve any of these complexities (and more) that you may face when using the API for NFT-MAKER PRO at scale.
- Creating a large number of NFTs from a single image/file
- Creating a large number of NFTs from individually unique images/files
- Customizing the metadata for each individual NFT in bulk
- Deleting a large number of NFTs that are already created
Used to manage the NFTs for Cardano Caricatures, Cardano Waifus, Stik Friks, and Old Money.
Follow these steps before attempting to use any of the scripts
- Ensure you have node and git installed
- Download this repository using the command line (recommended) with
git clone
or directly from GitHub - Navigate to the root directory of the repository and run
npm install
to set up the libraries required - Create a new file named
.env
in the root directory and add your API Key from NFT-MAKER PRONFT_MAKER_PRO_API_KEY=33a33345e32c46d33e5783ec4aa5c333
- Copy one of the
.json
examples from/configuration
any of the scripts
Takes information such as metadata, formats, quantity, image/file URLs, and more then interfaces with NFT-MAKER PRO to create the number of NFTs configured
- This script takes a
.json
file that outlines what the NFT details are like what image/files to use and how many NFTs to create for each - Each
.json
file must be an array and therefore it can contain one or many NFTs to upload at once - If it encounters an error from NFT-MAKER PRO then it will wait 15 and try again
- If it encounters over 10 errors from NFT-MAKER PRO then it will stop the script
- It checks for duplicate assets from NFT-MAKER PRO so you can restart the script at any point without creating duplicates
- Upload your NFT files (png, jpg, gif, mp4, etc) to a publicly accessible URL (S3, Google Drive, Dropbox, etc)
- Create your NFT Project in the NFT-MAKER PRO Dashboard
- Create a
.json
configuration file in the/configuration/uploadNFTs
folder - Run using
node uploadNFTs.js NAME_OF_JSON_FILE_WITH_NO_EXTENSION
Each .json
file in the /configuration/uploadNFTs
folder must be an array and therefore it can contain one or many NFTs to upload
Required configuration values:
- asset_name
- min 3 characters, max 30 characters, no spaces or special characters
- it will append the NFT number to the end so leave room for mint number to be associated with it
- ex: if your
asset_name
isLoganHoskinson
and you have thequantity
set to500
then your assets will be individually named fromLoganHoskinson001
toLoganHoskinson500
- quantity
- how many NFTs to create
- ex:
500
- nft_maker_project_id
- the NFT Project ID from NFT-MAKER PRO to create the NFTs under
- get from the Dashboard under
NFT Projects
or from the API using/ListProjects
- ex:
18000
- file
- a JSON object with the NFT image/file URL and the associated MIME type of the file
- the image/file must be publicly accessible with the specified URL
- the required keys are
url
andmime_type
in the JSON object forfile
- if you have individually unique files for your NFTs then you can name them a certain way to have it dynamically set the URL for each NFT
- the
$
is a reserved character in theurl
value, if it's found then it will be replaced with the number of the NFT (including the padding) - ex for
url
:https://cardano-caricatures-nfts.s3.amazonaws.com/LoganHoskinson/LoganHoskinson.jpg
- ex for
url
with$
:https://old-money-nfts.s3.amazonaws.com/TheInflationTimesLXI/TheInflationTimesLXI$.jpg
- this would generate URLs like
https://old-money-nfts.s3.amazonaws.com/TheInflationTimesLXI/TheInflationTimesLXI001.jpg
- this would generate URLs like
- ex for
mime_type
:image/png
,image/gif
,video/mp4
,image/jpeg
Optional configuration values:
-
metadata
- a JSON object with matching keys of the metadata placeholders configured in NFT-MAKER PRO and their matching values
- there are dynamic formats you can use by also specifying the
metadata_format
-
metadata_format
- a JSON object with matching keys of the metadata placeholders configured in NFT-MAKER PRO and the name of the supported format
- supported formats
edition
- used to dynamically set the NFT's unique number and total number of NFTs in any possible way
- the format is using
$
for the NFT's unique number and$$
for the total number of NFTs that matches thequantity
- ex:
$ of $$
,$/$$
,$
,$ of $$ total
-
subfiles
- an array with additional JSON objects with the NFT image/file URL and the associated MIME type of the file
- the image/file must be publicly accessible with the specified URL
- the required keys are
url
andmime_type
in each JSON object in thesubfiles
array - the
$
is a reserved character in theurl
value, the same as it is used infile
- ex for
url
:https://cardano-caricatures-nfts.s3.amazonaws.com/LoganHoskinson/LoganHoskinson.jpg
- ex for
mime_type
:image/png
,image/gif
,video/mp4
,image/jpeg
Optional helper configuration values:
- enabled
- a boolean to decide to process this NFT or skip it, defaults to
true
- ex:
false
- a boolean to decide to process this NFT or skip it, defaults to
- dryRun
- a boolean to decide to disable any calls to NFT MAKER PRO API just test everything else by logging the data, defaults to
false
- ex:
true
- a boolean to decide to disable any calls to NFT MAKER PRO API just test everything else by logging the data, defaults to
- limitedQuantity
- the number of NFTs to create before stopping
- created so you don't have to modify the total
quantity
when testing - ex:
2
- startingNumber
- a number to start the process with so it attempt to create every NFT possible
- used when the script stops and you want to restart part of the way through
- ex:
205
Here are some example .json
configuration files:
[
{
"asset_name": "LoganHoskinson",
"quantity": 500,
"nft_maker_project_id": "10000",
"file": {
"url": "https://cardano-caricatures-nfts.s3.amazonaws.com/LoganHoskinson/LoganHoskinson.jpg",
"mime_type": "image/jpeg"
}
}
]
[
{
"asset_name": "LoganHoskinson",
"enabled": true,
"quantity": 500,
"nft_maker_project_id": "10000",
"file": {
"url": "https://cardano-caricatures-nfts.s3.amazonaws.com/LoganHoskinson/LoganHoskinson.jpg",
"mime_type": "image/gif"
},
"subfiles": [
{
"url": "https://cardano-caricatures-nfts.s3.amazonaws.com/LoganHoskinson/LoganHoskinson.mp4",
"mime_type": "video/mp4"
}
]
}
]
Takes information about which NFTs you want to delete from a specific NFT Project then interfaces with NFT-MAKER PRO to delete NFTs configured
- This script takes a
.json
file that outlines which NFTs to delete from an NFT Project either by theid
or anid_range
- If you use
id
then look on the Dashboard or use the API to get each of the IDs of the NFTs to put in the configuration manually - If you use
id_range
then it will likely attempt to delete an NFT that you do NOT own since everyone shares the same autoincrement ID for NFTs - If it encounters someone else's NFT then it will log it and move on
- It will not be able to delete any NFT that NFT-MAKER doesn't allow such as minted or reserved NFTs
- It doesn't do any harm to attempt to delete any that have already been deleted so you can restart the script at any point
- Find out the
ids
orid_range
from your NFT Project in the NFT-MAKER PRO Dashboard or using theGetNfts
API - Create a
.json
configuration file in the/configuration/deleteNFTs
folder - Run using
node uploadNFTs.js NAME_OF_JSON_FILE_WITH_NO_EXTENSION
Each .json
file in the /configuration/deleteNFTs
folder must be an object and therefore it can only delete NFTs under a single project at a time
Required configuration values:
- nft_maker_project_id
- the NFT Project ID from NFT-MAKER PRO to create the NFTs under
- get from the Dashboard under
NFT Projects
or from the API using/ListProjects
- ex:
18000
Optional configuration values:
- id
- an array of Integer IDs to delete from an NFT project
- get from the Dashboard under
NFT Projects
then click theManage NFT
icon or from the API using/GetNfts
- ex:
[11111, 22222, 33333]
- id_range
- an object with a
max
andmin
key/value set with Integers of the IDs to delete from an NFT project - get from the Dashboard under
NFT Projects
then click theManage NFT
icon or from the API using/GetNfts
- individually attempts to delete each NFT from the min to the max (inclusive)
- ex:
{ "min": 22222, "max": 33333 }
- an object with a
- all
- a boolean to indicate to delete all of the NFTs in an NFT Project
- ex:
true
Here are some example .json
configuration files:
{
"nft_maker_project_id": "10000",
"ids": [11111, 22222, 33333]
}
{
"nft_maker_project_id": "10000",
"id_range": {
"min": 22222,
"max": 33333
}
}
{
"nft_maker_project_id": "10000",
"all": true
}
- Added additional optional configuration options to
uploadNFTs.js
- Added
metadata
to set custom metadata placeholders values for each NFT - Added
metadata_format
to set dynamic custom metadata placeholders values for each NFT - Added
startingNumber
to set the number to start the process with instead of at 1 - Added
limitedQuantity
to set the number of NFTs to upload before it stops - Added
dryRun
to disable any API calls to NFT MAKER PRO
- Added
- Added the ability to include a
$
wildcard in theurl
of thefile
to dynamically generate URLs for projects with individually unique images/files - Created the initial version of
deleteNFTs.js
to delete NFTs in an NFT Project byid
,id_range
, andall
- Organized the
README.md
to include a larger description, purpose, and use cases
- Introduced breaking change in the JSON configuration on how we deal with files in order to introduce the subfiles concept
- Organized the
README.md
to add more details on setup and configuration examples
- Initialized the repo/codebase
- Created the initial version of
uploadNFTs.js
- Created a basic
README.md
- Create
filesToURLs.js
which accepts a directory and uploads the contents to a public location and returns the URLs to use with other scripts
- Setup
configuration
folder underscripts
directory with examples, update README to point to example files instead of embedding in the page - Update
uploadNFTs.js
to have a way to not include the NFT number appended to the asset name like LoganHoskinson001 - Log the execution time in minutes with the processed console logs for each script
- Add validation to finding the
.json
configuration file instead of throwing exception - Add validation to the
.json
configuration files required and optional fields - Handle the errors with NFT-MAKER PRO auth, missing API key, missing config file
- Write process that allows you to write a custom function to process any of the metadata values easily that isn't in revision control
- Reconfigure to be an
npm
package so users just need to create.json
files instead of needing to download the repository
Have questions or suggestions? Want to get paid to contribute? Reach out to @AdaCaricatures or [email protected]