\n\n \n\n# PoolTogether Aave Yield Source 👻\n\n\n[](https://coveralls.io/github/pooltogether/aave-yield-source?branch=main)\n[](https://docs.openzeppelin.com/)\n\nPoolTogether Yield Source that uses [Aave](https://aave.com/) V2 to generate yield by lending any ERC20 token supported by Aave and deposited into the Aave Yield Source.\n\n# Usage\n\n## Adding a new Aave Lending Pool\n\nFirst make sure the Aave json config (`aave/aaveMainnet.json`, etc) includes the lending pool.\n\nThen, add the token symbol to the list in `aave.config.ts`.\n\n## Deployment\n\nFollow Installation instructions.\n\nAave provides a json blob per network of the files in the [docs](https://docs.aave.com/developers/deployed-contracts/deployed-contracts)\nThe deploy script parses this and deploys a proxy contract if the aToken file does exist in the deployments directory.\n\nEnsure the `lendingPoolAddressesProviderRegistry` is up to date in the namedAccounts field of `hardhat.config.ts` .\n\nTo add a new network, add a json file in the `./aave` directory then run:\n\n`yarn deploy `\n\nTo add a new lending market, update the appropriate network json at `./aave` and run: \n\n`yarn deploy `\n\nThe deployment script can be found in `deploy/deploy.ts`.\n\n## Development\n\nClone this repository and enter the directory.\n\n### Installation\n\nInstall dependencies:\n\n```\nyarn\n```\n\nThis project uses [Yarn 2](https://yarnpkg.com), dependencies should get installed pretty quickly.\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### Test\n\nWe use the [Hardhat](https://hardhat.org) ecosystem to test and deploy our contracts.\n\nTo run unit tests:\n\n```\nyarn test\n```\n\nTo run [solhint](https://protofire.github.io/solhint/) and tests:\n\n```\nyarn verify\n```\n\nTo run coverage:\n\n```\nyarn coverage\n```\n\n### Mainnet fork\n\nBefore deploying, you can make sure your implementation works by deploying a Yield Source Prize Pool on a fork of Mainnet.\n\nStart Mainnet fork in a terminal window with the command:\n\n```\nyarn start-fork\n```\n\nIn another window, start the scripts to deploy and create a Aave Yield Source Prize Pool, deposit Dai into it, award the prize and withdraw.\n\n```\nyarn deploy-fork && yarn run-fork\n```\n\n### Contract Verification\n\nOnce deployment is done, you can verify your contracts on [Etherscan](https://etherscan.io) by typing:\n\n```\nyarn verify \n```\n\n### Code quality\n\n[Prettier](https://prettier.io) is used to format TypeScript 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