The project revolves around Play2EarnX.sol, a Solidity-written Ethereum smart contract. It leverages the OpenZeppelin library to ensure secure and standardized development of the contract.
The core of the contract is defined by four primary structures: GameStruct, PlayerStruct, InvitationStruct, and ScoreStruct, representing a game, a player, an invitation, and a score, respectively.
createGame: Allows a user to create a new game.deleteGame: Allows the game owner to delete a game.invitePlayer: Allows a user to invite another player to a game.acceptInvitation: Allows a user to accept an invitation to a game.rejectInvitation: Allows a user to reject an invitation to a game.payout: Distributes payouts to the winners of a game.saveScore: Records a player's score in a game.
Supply the following keys in your .env variable:
NEXT_PUBLIC_RPC_URL=http://127.0.0.1:8545
NEXT_PUBLIC_ALCHEMY_ID=<YOUR_ALCHEMY_PROJECT_ID>
NEXT_PUBLIC_PROJECT_ID=<WALLET_CONNECT_PROJECT_ID>
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=somereallysecretsecretYOUR_ALCHEMY_PROJECT_ID: Get Key Here
WALLET_CONNECT_PROJECT_ID: Get Key Here
Follow these steps to run the application:
- Install the package modules by running the command:
yarn install - Start the Hardhat server:
yarn blockchain - Run the contract deployment script:
yarn deploy - Run the contract seeding script:
yarn seed - Spin up the Next.js development server:
yarn dev
Now, your application should be up and running.
- 🌐 Next.js: A React framework for building server-side rendered and static websites.
- 📘 TypeScript: A statically typed superset of JavaScript.
- 📦 Hardhat: A development environment for Ethereum smart contracts.
- 🌐 EthersJs: A library for interacting with Ethereum and Ethereum-like blockchains.
- 📚 Redux-Toolkit: A library for managing application state.
- 🎨 Tailwind CSS: A utility-first CSS framework.