\r\n\r\n \r\n\r\n# PoolTogether Prize Savings Protocol\r\n\r\n[](https://circleci.com/gh/pooltogether/pooltogether-pool-contracts) [](https://coveralls.io/github/pooltogether/pooltogether-pool-contracts?branch=master) [](https://docs.openzeppelin.com/)\r\n\r\nThe [PoolTogether](https://www.pooltogether.com/) Prize Savings Protocol Ethereum smart contracts.\r\n\r\nFor an overview of the concepts and API please see the [documentation](https://docs.pooltogether.com/)\r\n\r\n# Setup\r\n\r\nThis project is available as an NPM package:\r\n\r\n```bash\r\n$ yarn add @pooltogether/pooltogether-contracts\r\n```\r\n\r\n# Usage\r\n\r\n## Artifacts\r\n\r\nThere are deployment artifacts available in the `deployments/` directory. For example, to pull in the PoolWithMultipleWinnersBuilder artifact:\r\n\r\n```javascript\r\nconst PoolWithMultipleWinnersBuilder = require('@pooltogether/pooltogether-contracts/deployments/rinkeby/PoolWithMultipleWinnersBuilder.json')\r\nconst {\r\n abi, \r\n address, \r\n receipt\r\n } = PoolWithMultipleWinnersBuilder\r\n```\r\n\r\n## ABIs\r\n\r\nApplication Binary Interfaces for all PoolTogether contracts and related contracts are available in the `abis/` directory.\r\n\r\nFor example, to pull in the PrizePool ABI:\r\n\r\n```javascript\r\nconst PrizePool = require('@pooltogether/pooltogether-contracts/abis/PrizePool.json')\r\n```\r\n\r\n# Development\r\n\r\nFirst clone this repository and enter the directory.\r\n\r\nInstall dependencies:\r\n\r\n```\r\n$ yarn\r\n```\r\n\r\nWe use [direnv](https://direnv.net/) to manage environment variables. You'll likely need to install it.\r\n\r\n# Testing\r\n\r\nWe use [Hardhat](https://hardhat.dev) and [hardhat-deploy](https://github.com/wighawag/hardhat-deploy)\r\n\r\nTo run unit & integration tests:\r\n\r\n```sh\r\n$ yarn test\r\n```\r\n\r\nTo run coverage:\r\n\r\n```sh\r\n$ yarn coverage\r\n```\r\n\r\nTo run fuzz tests:\r\n\r\n```sh\r\n$ yarn echidna\r\n```\r\n\r\n# Fork Testing\r\n\r\nEnsure your environment variables are set up. Make sure your Alchemy URL is set. Now start a local fork:\r\n\r\n```sh\r\n$ yarn start-fork\r\n```\r\n\r\nSetup account impersonation and transfer eth:\r\n\r\n```sh\r\n$ ./scripts/setup.sh\r\n```\r\n\r\n# Deployment\r\n\r\n## Deploy Locally\r\n\r\nStart a local node and deploy the top-level contracts:\r\n\r\n```bash\r\n$ yarn start\r\n```\r\n\r\nNOTE: When you run this command it will reset the local blockchain.\r\n\r\n## Connect Locally\r\n\r\nStart up a [Hardhat Console](https://hardhat.dev/guides/hardhat-console.html):\r\n\r\n```bash\r\n$ hardhat console --network localhost\r\n```\r\n\r\nNow you can load up the deployed contracts using [hardhat-deploy](https://github.com/wighawag/hardhat-deploy):\r\n\r\n```javascript\r\n> await deployments.all()\r\n```\r\n\r\nIf you want to send transactions, you can get the signers like so:\r\n\r\n```javascript\r\n> let signers = await ethers.getSigners()\r\n```\r\n\r\nLet's mint some Dai for ourselves:\r\n\r\n```javascript\r\n> let dai = await ethers.getContractAt('ERC20Mintable', (await deployments.get('Dai')).address, signers[0])\r\n> await dai.mint(signers[0]._address, ethers.utils.parseEther('10000'))\r\n> ethers.utils.formatEther(await dai.balanceOf(signers[0]._address))\r\n```\r\n\r\n## Deploy to Live Networks\r\n\r\nCopy over .envrc.example to .envrc\r\n\r\n```\r\n$ cp .envrc.example .envrc\r\n```\r\n\r\nMake sure to update the enviroment variables with suitable values.\r\n\r\nNow enable the env vars using [direnv](https://direnv.net/docs/installation.html)\r\n\r\n```\r\n$ direnv allow\r\n```\r\n\r\nNow deploy to a network like so:\r\n\r\n```\r\n$ yarn deploy rinkeby\r\n```\r\n\r\nIt will update the `deployments/` dir.\r\n","readmeFilename":"README.md"}
![\"PoolTogether](\"https://github.com/pooltogether/pooltogether--brand-assets/blob/977e03604c49c63314450b5d432fe57d34747c66/logo/pooltogether-logo--purple-gradient.png?raw=true\"){kind=logo}
\r\n \r\n