anegg0 / nft-toolkit

NFT toolkit: ERC721 with hardhat-deploy

This repo helps you learn to deploy and mint NFTs using Hardhat-deploy and ethers.js

Features

1. Requires minimal configuration

   Just set up your .env file.

2. Example ERC721

The included contract is barebone (for clarity) but functional.

ℹ️ the contract is intended for training purpose, it hasn't been vetted for production, use at your own risk.

3. Example scripts for minting and testing

4. Extra-functionalities thanks to Hardhat-deploy

   • npx hardhat deploy deploys only if your contract has changed
   • npx hardhat test enable test fixtures for faster tests
   • npx hardhat sourcify simplifies the process of contract verification with Sourcify.dev

Pre-requisites

1. Node.js 16 LTS

2. An INFURA account (optional)

   This repo has been pre-configured to use INFURA as a convenience but you can choose any provider you wish.

3. Basic understanding of Ethereum/Solidity

4. Basic understanding of Hardhat

   • Catch up with Hardhat here: Hardhat documentation
   • Since this repo relies heavily on hardhat-deploy, you might want to read their README, too.

Installation

    ```bash
    npm install
    ```

Configuration

Fill out your env values in .example-env then rename the file .env:

network specific node uri : "ETH_NODE_URI_" + networkName.toUpperCase()

ETH_NODE_URI_MAINNET=https://eth-mainnet.alchemyapi.io/v2/

generic node uri (if no specific found) :

ETH_NODE_URI=https://{{networkName}}.infura.io/v3/

network specific mnemonic : "MNEMONIC_ " + networkName.toUpperCase()

MNEMONIC_MAINNET=

generic mnemonic (if no specific found):

MNEMONIC=

Usage

Compile contract:

    ```bash
    npx hardhat compile
    ```

Deploy contract to Hardhat's dev network:

Start Hardhat's localhost network:

    ```bash
    npx hardhat node
    ```

Deploy on localhost network:

ℹ️ You can choose the network you want to interact with by using the --network suffix.

    ```bash
    npx hardhat deploy --network localhost
    ```

Deploy contract to mainnet:

    ```bash
    npx hardhat deploy --network production
    ```

Mint an NFT on Ethereum mainnet:

    ```bash
    npx hardhat mint-nft --token-uri "the-URI-of-your-NFT" --network production
    ```

Run test(s):

    ```bash
    npx hardhat test
    ```

Verify a contract with sourcify.dev:

    ```bash
    npx  hardhat --network mainnet sourcify
    ```

Credits to Ronan Sandford for creating Hardhat-deploy.

deploy-mainnet