Jumper591a/NFTMaker

Generate an NFT with an IPFS CID

NFTMaker

Table of Contents

• Download and Setup
• API Routes

Setup Guide

Download and install dependencies

git clone https://github.com/SkyTradeInc/NFTMaker.git

cd NFTMaker

npm i

touch .env

Hardhat is a development environment to compile, deploy, test, and debug your Ethereum software. It helps developers when building smart contracts and dApps locally before deploying to the live chain.

npm install --save-dev hardhat

Adding required environment variables

Edit the .env file and add the following

SERVER_PORT=
API_URL=
WEB3_PUBLIC_KEY=
WEB3_PRIVATE_KEY=
CONTRACT_ADDRESS=
IPFS_API_KEY=
IPFS_SECRET_KEY=

• SERVER_PORT (OPTIONAL) Default is 4000
• API_URL Alchemy Ropsten API Key
• WEB3_PUBLIC_KEY Ropsten Address Public Key
• WEB3_PRIVATE_KEY Ropsten Address Private Key
• CONTRACT_ADDRESS NFT Creator contract deployed on Ropsten (see below to deploy)
• IPFS_API_KEY Pinata.cloud API Key
• IPFS_SECRET_KEY Pinata.cloud Secret Key

Note: The Ropsten address requires a some balance

• Ropsten Faucet #1
• Ropsten Faucet #2

Starting Service

Run npx hardhat run scripts/deploy.js --network ropsten to create the NFT Factory contract on Ropsten and add this to the CONTRACT_ADDRESS environment variable

Run node service.js to begin the service

API

Test connectivity

/api/ping

Test connectivity to the Rest API.

Parameters: NONE

Create Invoice NFT with IPFS URI

POST /api/mint

Parameters:

Object Name	Type	Mandatory
address	STRING	YES
tokenURI	STRING	YES

Upload JSON payload to IPFS and return hash

POST /api/ipfsUpload

Parameters:

Object Name	Type	Mandatory
json	STRING	YES

Look up data in IPFS hash

/api/ipfs/{hash}

Parameters:

Query Param Name	Type	Mandatory
hash	STRING	YES

Create Invoice NFT with JSON Payload

POST /api/ipfsUploadAndMint

Parameters:

Object Name	Type	Mandatory
address	STRING	YES
json	STRING	YES