Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/max-tonny8/raffle_site
This project is raffle site.
https://github.com/max-tonny8/raffle_site
blockchain dapp hardhat metamask-wallet nextjs react solidity typescript vercel wagmi
Last synced: 29 days ago
JSON representation
This project is raffle site.
- Host: GitHub
- URL: https://github.com/max-tonny8/raffle_site
- Owner: max-tonny8
- License: mit
- Created: 2024-05-28T09:27:45.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-05-28T09:28:55.000Z (9 months ago)
- Last Synced: 2024-11-23T09:34:32.729Z (3 months ago)
- Topics: blockchain, dapp, hardhat, metamask-wallet, nextjs, react, solidity, typescript, vercel, wagmi
- Language: TypeScript
- Homepage:
- Size: 1.27 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rafflebot.xyz
This repo contains the source code for [rafflebot.xyz](https://rafflebot.xyz), a smart contract based daily raffle platform. Rafflebot is secured by [WorldID](https://id.worldcoin.org), which ensures that participants can only enter each raffle once. Deployed to the [Goerli testnet](https://goerli.etherscan.io/address/0x411A84893aEd4fD5495e210A9f11FA009757fb98).
[](https://rafflebot.xyz)
## Tech Stack
Built with the following technologies:
* [WorldID](https://id.worldcoin.org): Privacy preserving, proof-of-personhood protocol
* [Hardhat](https://hardhat.org/): Smart contract development and testing
* [wagmi.sh](https://wagmi.sh/): React hooks for Ethereum
* [ConnectKit](https://docs.family.co/connectkit): React components for connecting wallets
* [Next.js](https://nextjs.org/): Static site builds and routing
* [Tailwind](https://tailwindcss.com/): Adaptive CSS page styling
* [Vercel](https://vercel.com/): Web hosting and automatic deployments
### TODOs
Rafflebot is currently in MVP stage. There are a number of features to be added before the app could be considered complete:
1. Fully integrate with WorldID at the smart contract level. The current implementation could be gamed by a malicious user, which would violate the one-person, one-entry rule
2. Morph the smart contract into a NFT dispenser, giving the raffle winner a token for their prize
- It might also be worth considering an integration with [POAP](https://poap.xyz/), in lieu of custom NFTs
3. Notify winners using [Push Protocol](https://push.org/), in case they are not chain-savvy
4. Make the raffle reusable and user-contributable, allowing users to add their own tokens/NFTs/etc. to a shared pot
5. Add a full suite of tests covering all smart contract functions
## Installation
### Prereqs
To build your own copy of rafflebot, you will first need:
* [Infura API key(s)](https://infura.io/) for your chosen networks
* [Etherscan API key](https://etherscan.io/apis) for contract verification
* Deployer wallet private key with some [(test) ETH](https://faucet.paradigm.xyz/)
Clone the repo locally with the following commands:
```
git clone https://github.com/maxpetretta/rafflebot.xyz
cd rafflebot.xyz/hardhat
npm install
```
Place all of the above secrets in the [.env file](./hardhat/.env.example)
### Smart Contract
You can deploy the contract with the included script file, use these commands:
```
npx hardhat run scripts/deploy.js --network
npx hardhat verify --network
```
If running locally, you may skip the `verify` step. A local testnet can be started with `npx hardhat node`.
### Frontend
The website UI needs the contract to exist before it will function correctly. After you've completed the above, you should update the contract details in [contract.ts](./react/lib/contract.ts). Make sure the address and [ABI](./react/lib/abi/Rafflebot.json) are in-sync with the live deployment. To start the frontend, run:
```
cd ../react
npm install
npm run dev
open http://localhost:3000
```
## Tests
As mentioned above, Rafflebot is currently a MVP. Basic scaffolding for contract tests can be found in [tests.ts](./hardhat/test/tests.ts). Before a mainnet deployment, a comprehensive suite of tests should be written.
Running tests is done by:
```
cd ./hardhat
npx hardhat test
```