\n\n \n\n# PoolTogether Aave V3 Yield Source 👻\n\n\n\n[](https://coveralls.io/github/pooltogether/aave-v3-yield-source)\n[](https://docs.openzeppelin.com/)\n[](http://perso.crans.org/besson/LICENSE.html)\n\nPoolTogether Yield Source that uses [Aave](https://aave.com) V3 to generate yield by lending any ERC20 token deposited into the Yield Source to Aave.\n\n## Development\n\nClone this repository and enter the directory:\n```\ncd aave-v3-yield-source\n```\n\n### Installation\n\nInstall dependencies:\n\n```\nyarn\n```\n\n\n### Env\n\nWe use [direnv](https://direnv.net) to manage environment variables. You'll likely need to install it.\n\nCopy `.envrc.example` and write down the env variables needed to run this project.\n```\ncp .envrc.example .envrc\n```\n\nOnce your env variables are setup, load them with:\n```\ndirenv allow\n```\n\n### Compile\n\nRun the following command to compile the contract:\n```\nyarn compile\n```\n\n### Test\n\nWe use the [Hardhat](https://hardhat.org) ecosystem to test our contracts.\n\nTo run unit tests:\n\n```\nyarn test\n```\n\nTo run coverage:\n\n```\nyarn coverage\n```\n\n### Polygon fork\n\nBefore deploying, you can make sure your implementation works by deploying a Yield Source Prize Pool on a fork of Polygon.\n\nTo do so, run the following command:\n```\nyarn run-yield-source-fork\n```\n\n\n### Code quality\n\n[Prettier](https://prettier.io) is used to format TypeScript and Solidity code. Use it by running:\n\n```\nyarn format\n```\n\n[Solhint](https://protofire.github.io/solhint/) is used to lint Solidity files. Run it with:\n```\nyarn hint\n```\n\n[TypeChain](https://github.com/ethereum-ts/Typechain) is used to generates types for scripts and tests. Generate types by running:\n```\nyarn typechain\n```\n","readmeFilename":"README.md"}
![\"PoolTogether](\"https://github.com/pooltogether/pooltogether--brand-assets/blob/977e03604c49c63314450b5d432fe57d34747c66/logo/pooltogether-logo--purple-gradient.png?raw=true\"){kind=logo}
\n \n