# PoolTogether V4 Core Smart Contracts ![Tests](https://github.com/pooltogether/v4-core/actions/workflows/main.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/pooltogether/v4-core/badge.svg?branch=master)](https://coveralls.io/github/pooltogether/v4-core?branch=master) [![built-with openzeppelin](https://img.shields.io/badge/built%20with-OpenZeppelin-3677FF)](https://docs.openzeppelin.com/) [![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html) Have questions or want the latest news?
Join the PoolTogether Discord or follow us on Twitter: [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/JFBPMxv5tr) [![Twitter](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/PoolTogether_) **Documentation**
https://v4.docs.pooltogether.com **Deployments**
- [Ethereum](https://v4.docs.pooltogether.com/protocol/deployments/mainnet#mainnet) - [Polygon](https://v4.docs.pooltogether.com/protocol/deployments/mainnet#polygon) - [Avalanche](https://v4.docs.pooltogether.com/protocol/deployments/mainnet#avalanche) - [Optimism](https://v4.docs.pooltogether.com/protocol/deployments/mainnet/#optimism) # Overview - [ControlledToken](/contracts/ControlledToken.sol) - [DrawBeacon](/contracts/DrawBeacon.sol) - [DrawBuffer](/contracts/DrawBuffer.sol) - [DrawCalculator](/contracts/DrawCalculator.sol) - [EIP2612PermitAndDeposit](/contracts/permit/EIP2612PermitAndDeposit.sol) - [PrizeDistributionBuffer](/contracts/PrizeDistributionBuffer.sol) - [PrizeDistributor](/contracts/PrizeDistributor.sol) - [PrizeSplitStrategy](/contracts/prize-strategy/PrizeSplitStrategy.sol) - [Reserve](/contracts/Reserve.sol) - [StakePrizePool](/contracts/prize-pool/StakePrizePool.sol) - [Ticket](/contracts/Ticket.sol) - [YieldSourcePrizePool](/contracts/prize-pool/YieldSourcePrizePool.sol) Periphery and supporting contracts: - https://github.com/pooltogether/v4-periphery - https://github.com/pooltogether/v4-oracle-timelocks # Getting Started The project is made available as a NPM package. ```sh $ yarn add @pooltogether/pooltogether-contracts ``` The repo can be cloned from Github for contributions. ```sh $ git clone https://github.com/pooltogether/v4-core ``` ```sh $ yarn ``` We use [direnv](https://direnv.net/) to manage environment variables. You'll likely need to install it. ```sh cp .envrc.example .envrc ``` To run fork scripts, deploy or perform any operation with a mainnet/testnet node you will need an Infura API key. # Testing We use [Hardhat](https://hardhat.dev) and [hardhat-deploy](https://github.com/wighawag/hardhat-deploy) To run unit & integration tests: ```sh $ yarn test ``` To run coverage: ```sh $ yarn coverage ``` # Deployment ## Testnets Deployment is maintained in a different [repo](https://github.com/pooltogether/v4-testnet). ## Mainnet Deployment is maintained in a different [repo](https://github.com/pooltogether/v4-mainnet).