Lottery 6

This project is a hardhat smartcontract lottery, but a little different than the tutorial projects. Only on Rinkeby for now.

Rules

• Choose 6 numbers from 45.
• Entry fee is configurable, by default 0.1 ETH
• By entering once the entry fee is paid, but the player is eligible to subsequent draws, until somebody wins.
• The prize pool is distributed in the following way:
  • 0% for 0 hits
  • 0% for 1 hits
  • 0% for 2 hits
  • 5% for 3 hits
  • 10% for 4 hits
  • 20% for 5 hits
  • 65% for 6 hits

The %-s are distributed between the addresses with the according amount of hits, and if there's at least one 6 hit, the players are removed from the lottery, so the state resets to STANDBY. In any other case, the state resets to OPEN, and the players are kept for the subsequent draws. The part of the prize pool which is not getting to distribution, accumulates for the following rounds.

Features

• Upkeep is done by Chainlink Keepers.
• Drawing random numbers is done by Chainlink VRF (Verifiable Randomness).
• Automatically verified contracts.
• Mocks are deployed on local chains.
• Contains an npm package under /package, which is installable by yarn add / npm install @nsorcell/protocol

Future ideas

• Add feature to distribute some % of the prizepool from up to 3 hits.
• Extend the draw interval to about a day or more, and stake the prizepool in a staking protocol
• Create an ERC20 token, which will be minted to players in-game, and could be used to e.g pay etry
• Betting on how many numbers, the players hit

Commands

yarn hardhat node #for local chain (runs all deployments, + mocks)
yarn hardhat deploy -- network [network] #(runs all deployments except mocks)
yarn typechain:package #generates typechain output for the @nsorcell/protocol package

cd package && yarn build #create a production build of the @nsorcell/protocol package
npm version [patch|minor|major] #upgrade the version of the @nsorcell/procotol package
npm publish --access public #publish npm package to npmjs