Gitcoin NFT Tournament

Warning: this code has not been audited and may contain bugs and/or vulnerabilities

To build a fun NFT Tournament that raises money for Gitcoin Grants. The Gitcoin team will solicit eight prominent players in the Ethereum community to provide a dancing gif URL. These gifs will be minted as NFTs and submitted in a bracket tournament where people can vote for the NFTs in 3 rounds. Players vote with crypto, which will all go to the Gitcoin matching pool.

The following bracket represents an NFT tournament with participants from A to H.

In order to optimize the use of gas, the bracket above is stored in a array respecting the order of matches. In each round, the same array is ​​updated with the winners (in green) of the round, replacing the positions of the first one up to the maximum number of players allowed for that round. Note that the maximum number of players allowed in each round can be defined as 2^n, where n is the round number, that is the reason why we started counting in round 3 instead of round 1.

🏃 How to run

Open your terminal in the folder you want to clone the project

# Clone this repo
git clone https://github.com/upstateinteractive/gitcoin-nft-tournament

# Go to the project folder
cd gitcoin-nft-tournament

# Install dependencies
npm install

📜 Scripts

# Clean and compile
npm run build

# Run and fix linting issues
npm run lint

# Run tests
npm run test

# Run test coverage
npm run coverage

🚀 Deploy

In this project, infura was used as a provider. Make sure to create a .env file in the root with the following content, without < >

INFURA_ID=<your_infura_id>
MNEMONIC=<your_menemonic>

Finally, run:

npx hardhat run scripts/deploy.ts --network <network_name>

The Tournament contract is already deployed in the following tesnets:

Testnet	Addresses
Ropsten	0xb59c749ac5AB76473E913044602141566516E936
Rinkeby	0x5eE8017D91756edc622f2EC0Df0618dEBdD64C87
Kovan	0xb5f11eaFed5cde14E6311926E193ebA0999D5B15
Goerli	0xF9723fE6020DF06F3f9069dE9c5B47AF3dC57C2B

📖 Resources and technologies 💻

1. Smart Contract

   • Solidity - smart contract programming language
   • Hardhat - dApp environment
   • Open Zeppelin Contracts - a library for secure smart contract development

2. Testing

   • Typescript - superset of JS programming language static typed
   • Ethers.js - interact with smart contracts
   • Chai - library for tests
   • Typechain - generate TypeScipt bindings

🍪 About

Brought to you by your friends at Upstate Interactive