KittensOnChain is a NFT project aim to fix the problem that there are not enough cats on the blockchain. This project was created while following the course "Cifryn Updraft: Advanced Foundry" [Reference]. The contracts were built using Foundry. The images were created with the help of the AI ChatGPT by OpenAI.
| Index |
|---|
| Project Layout |
| Deploy and interact |
| Tests |
There are three main folders:
src/- contains the solidity smart contractstest/- contains test for the solidity smart contract of the ERC721 tokensscript/- contains the script to deploy the smart contract for the ERC721 token
Note: You must import the account used to mint NFTs to your Metamask and set up Anvil before proceeding. Check and modify Makefile accordingly.
To deploy the contract
- In your web browser, open Metamask and ensure you are not on Anvil chain
- Download this repository, you can use the command
git clone https://github.com/seeu-inspace/KittensOnChain.git - Open a terminal from the directory
KittensOnChain - Run the command
make all - Run the command
make anvil - In another terminal in the same directory, run the command
make deploy
To see your NFT
- Mint your NFT with the command
make mint - Go to Metamask and import the Anvil private key used to mint the token
- Import your NFT using the contract address and the tokenId
To change the color of your NFT
- After you have imported the token, run the command
make changeColor - Remove the token
- Refresh Metamask
- Import the token again
In /test there are present
- KittensOnChain.t.sol and KittensOnChainIntegration.t.sol, integration tests: These tests focus on verifying interactions between different modules or components of the KittensOnChain contract to ensure they work together correctly as a whole.
- DeployKittensOnChain.t.sol unit test: This test concentrates on testing specific functionalities within the DeployKittensOnChain contract, such as the
svgToImageURIfunction, to ensure individual units of code behave correctly.
To run the tests, use the command
make test