CryptoCats

Overview

CryptoCats is a decentralized application (Dapp) initially built as a part of the programming course “Ethereum Dapp Programming.” It is deployed on the Goerli network but is compatible with all EVM networks. The app allows users to design and create their own cats in the Cat Factory, display and breed cats, sell cats on the marketplace, and buy cats from the marketplace. The app is built with Solidity, Hardhat, Viem, Next.js, TypeScript, ChakraUI, Prettier, and ESLint. Users are required to have Node.JS, npm or yarn package manager, and Hardhat (v2.18.0) installed on their system. They also need a web3 wallet compatible with WalletConnect, such as MetaMask or Coinbase Wallet.

Features

• Factory: Design and create your own cat for free in the Cat Factory. Limited to 100 cats.
• MyCats/Show: Display all the cats present in your collection.
• MyCats/Breed: Select two parents, breed a sibling, and find out the inherited characteristics from each parent.
• MyCats/Sell: Create a sell offer to list your cat on the marketplace.
• Marketplace: Buy cats from the marketplace or remove your offers.

Installation

To install and run the CryptoCats Dapp, follow these steps:

1. Clone the repository using the following command:

git clone [repository url]

2. Navigate to the root directory of the project.
3. Install all dependencies by running the following command:

yarn install

4. Ensure you have the necessary API keys and private key for the networks you wish to use. Edit the .env.example file, removing the .example extension, and add your API keys and private key.
5. If needed, edit the hardhat.config.ts file and the “deploy” script in the package.json file to configure the network settings.
6. To deploy your own smart contracts, run the following command in the root directory:

yarn hardhat deploy

7. Replace the contract addresses and chain information in the src/data/constant.ts file. Make sure to change the values for CAT_CONTRACT_ADD and MARKETPLACE_CONTRACT_ADD.
8. Ensure you have funds available if you want to buy cats from the marketplace on the Goerli network. Use the provided faucet for the Goerli network.
9. After each deployment, update the contract addresses and ABI files if any changes were made to the smart contracts. Modify the values in the src/data/constant.ts file and enable/disable/update the ABI files in the src/data/abis/ directory.

Summary

CryptoCats is a decentralized application (Dapp) that allows users to design, create, breed, sell, and buy virtual cats. The app is built with various technologies such as Solidity, Hardhat, Viem, Next.js, TypeScript, ChakraUI, Prettier, and ESLint. To install and run the Dapp, users need to clone the repository, install dependencies, configure network settings, deploy smart contracts, and update contract addresses and ABI files. The app is compatible with all EVM networks but is initially deployed on the Goerli network.