ShapeCraft NFT Collection Test for Hom3Town

This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, and a Hardhat Ignition module that deploys that contract.

This contract is deployed on the Sepolia testnet at contract address: 0xf6e224cCF996Ab01d089e1cA43aD1F5dD47344B4

Steps to run the project:

1. Clone the repository
2. Install dependencies
3. Configure environment variables
4. Run the project

// Environment variables
ALCHEMY_API_KEY, PINATA_METADATA_CID, PINATA_IMAGE_CID, PINATA_GATEWAY_URL

// Start the Hardhat network
npx hardhat node

// Deploy the contracts
npx hardhat ignition deploy ignition/modules/<file.ts> 
npx hardhat ignition deploy ignition/modules/<file.ts> --network <network_name>

// Run the scripts
npx hardhat run scripts/<scripts_file.ts> 
npx hardhat run scripts/<scripts_file.ts> --network <network_name>

// Run the tests
npx hardhat test <test_file.ts> 
npx hardhat test <test_file.ts> --network <network_name>

// For more help
npx hardhat help 

Features

Contracts

• Avatar.sol

  Avatar.sol is the contract that implements the ERC1155 standard and includes the following features:

  • Owner Roles:

    Owner can mint past max mint limits --> "ownerMint()"
    Owner can mint tokens to any address --> "ownerMint(<EOA_ADDRESS>)"
    Owner can update the mint limit --> "setMintLimit()"
    Owner can udpate the metadata URI for the entire collection --> "setBaseURI()"
    Owner can update the metadata URI for a specific tokenId --> "setTokenURI(tokenId, newURI)"
    

  • Public Mint:

    Public can mint up to the mint limit --> "mint()" "avatar.connect(<YOUR_ADDRESS>).mint()"
    

  • NFT Info:

    Free NFT automatically minted when an account is created
    There is a default image and metadata URI for each NFT --> baseURI()
    Each NFT has a unique ID assigned to it --> tokenId()
    Each NFT is assigned to the address that minted it --> ownerOf()
    Default mint limit is 1 NFT per address
    NFT holders can update the metadata URI for specific NFTs --> "setTokenURI(tokenId, newURI)"
    

• World.sol

  World.sol is the contract that implements the ERC1155 standard and includes the following features:

  ```
  NFT can import into other worlds --> "importNFT()"
  NFT can be exported from other worlds --> "exportNFT()"
  Transactions can be gas sponsored by the Contract Owner
  ```