💎 CodeUP Smart Contract 💎

Welcome to 💎 CodeUP 💎, your portal to Ethereum's rich history and promising future! 🏰🚀

🎮 Game Mechanics 🎮

More Details

🕵 Audit Report 🕵

Report

📜 Contracts 📜

Project smart contracts:

• Codeup.sol - Main contract of the game.
• CodeupERC20.sol - ERC20 token for game winner's. Name: CodeUP, Symbol: CUP.

📜 Deployments 📜

Codeup - 0x1B82536914F3fD162e1EDa12ddB2E05cd961Fe57.
codeUP(CUP) - 0xDE698Ef96434CE7b12eDdbCc92E12C0464c2E2Ed

📚 Technical Stack 📚

• Solidity 💪
• Hardhat 🎩
• JavaScript 🇯
• TypeScript 🇹
• Ethers.js ♢
• solidity-coverage 💯
• Mocha 🧑‍💻
• Chai 👨🏻‍💻

⌛ Installation ⌛

It is recommended to install Yarn through the npm package manager, which comes bundled with Node.js when you install it on your system. It is recommended to use a Node.js version >= 16.0.0.

Once you have npm installed, you can run the following both to install and upgrade Yarn:

npm install --global yarn

After having installed Yarn, simply run:

yarn install

🤫 .env File 🤫

In the .env file place the private key of your wallet in the PRIVATE_KEY section. This allows secure access to your wallet to use with both testnet and mainnet funds during Hardhat deployments. For more information on how this works, please read the documentation of the npm package dotenv.

.env variables list

• PRIVATE_KEY - Private key of wallet that will be used for deployment.
• [Network]_API_KEY - Api key for smart contracts auto verification on blockchain explorers.
• [Network]_MAINNET_URL - rpc for mainnet network.
• [Network]_TESTNET_URL - rpc for testnet network.

You can see an example of the .env file in the .env.example file.

✔️ Testing ✔️

1. To run TypeScript tests:

yarn test:hh

2. To run tests and view coverage :

yarn coverage

💽 Compilation 💽

yarn compile

🚀 Deployment CodeUp 🚀

To deploy contracts you need set up .env

• PRIVATE_KEY - Private key of wallet that will be used for deployment.
• [Network]_API_KEY - Api key for smart contracts auto verification on blockchain explorers.
• [Network]_MAINNET_URL - rpc for mainnet network.
• [Network]_TESTNET_URL - rpc for testnet network.

run:

yarn deploy:[network]

or

npx hardhat run --network [Network] scripts/deploy.ts

Contract Verification 「✔ ᵛᵉʳᶦᶠᶦᵉᵈ」

Change the contract address to your contract after the deployment has been successful. This works for both testnet and mainnet. You will need to get an API key from etherscan, snowtrace etc.

Example:

npx hardhat verify --network [network] --constructor-args [...args] <YOUR_CONTRACT_ADDRESS>