Skip to content

Latest commit

 

History

History
158 lines (102 loc) · 2.42 KB

README.md

File metadata and controls

158 lines (102 loc) · 2.42 KB
Raw

Foundry NFT

This Repo contains 2 different kinds of NFTs.

  1. An IPFS Hosted NFT
  2. An SVG NFT (Hosted 100% on-chain)

NFT Pug NFT Happy NFT Frown


Getting Started

Quickstart

git clone https://github.com/allwin199/foundry-Nfts-v3.git
cd foundry-Nfts-v3
forge build

Usage

Start a local node

make anvil

Deploy to Anvil

IPFS hosted NFT

This will default to your local node. You need to have it running in another terminal in order for it to deploy.

make deployBasicNftToAnvil
  • To Mint an NFT
make mintBasicNftOnAnvil

On Chain NFT

make deployMoodNftToAnvil
  • To Mint an NFT
make mintMoodNftOnAnvil

Deployment to a testnet or mainnet

  1. Setup environment variables

  • You'll want to set your SEPOLIA_RPC_URL in environment variables. You can add them to a .env file, similar to what you see in .env.example.

  • SEPOLIA_RPC_URL: This is url of the sepolia testnet node you're working with. You can get setup with one for free from Alchemy

  1. Use wallet options to Encrypt Private Keys

Optionally, add your ETHERSCAN_API_KEY if you want to verify your contract on Etherscan.

  1. Get testnet ETH

Head over to faucets.chain.link and get some testnet ETH. You should see the ETH show up in your metamask.

  1. Deploy

IPFS hosted NFT

make deployBasicNftToSepolia
  • To Interact with it
make mintBasicNftOnAnvil

On Chain NFT

make deployMoodNftToSepolia
  • To Interact with it
make mintMoodNftOnSepolia

Testing

  1. Unit
  2. Integration
  3. Forked
forge test

or

forge test --fork-url $SEPOLIA_RPC_URL

Test Coverage

forge coverage
forge coverage --report debug > coverage.txt
  • To generate lcov report
make generateTestReport

Estimate gas

You can estimate how much gas things cost by running:

forge snapshot

And you'll see an output file called .gas-snapshot

Formatting

To run code formatting:

forge fmt

Thank you!