Skip to content

Commit

Permalink
clean up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MattPereira committed Dec 1, 2023
1 parent 5a64612 commit e690775
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@

A contest where players compete for the highest return on investment over three rounds. Players deposit and withdraw ERC-20 tokens to and from ERC-4626 vaults. Each vault has a different risk/reward profile. Chainlink automation triggers a request to VRF Coordinator that ultimately determines the return on investment for each vault. Highest total assets at the end of round 3 is the champion.

## Notice

- If the contest is on round 3 and state is closed, [DM me on telegram](https://t.me/mattpereira) to reset the game. Only the owner of `Market` contract can call `resetContest`

## How to Play

1. Enter a contest to be airdropped 10,000 GODL tokens
Expand All @@ -17,16 +13,14 @@ A contest where players compete for the highest return on investment over three
5. At the end of each round, the market contract sends or takes GODL from the vaults based on the random numbers generated by VRF
6. The player with the most total assets at the end of round 3 is the winner

## Notice

- If the contest is on round 3 and state is closed, [DM me on telegram](https://t.me/mattpereira) to reset the game. Only the owner of `Market` contract can call `resetContest`

## Tech Stack

- ERC-20
- ERC-4626
- Chainlink VRF
- Chainlink Automation
- Scaffold ETH 2

## TODO

- Add the graph to impliment an all time leaderboard across games and rounds and built sort feature
- https://github.com/kmjones1979/full-stack-dapp-workshop
- Add dynamic svg nft that gets minted to the champion of each contest

0 comments on commit e690775

Please sign in to comment.