{"id":20002078,"url":"https://github.com/pooltogether/aave-yield-source","last_synced_at":"2025-05-04T15:34:00.398Z","repository":{"id":41338496,"uuid":"345780072","full_name":"pooltogether/aave-yield-source","owner":"pooltogether","description":"Integration with Aave Protocol as a Yield Source","archived":false,"fork":false,"pushed_at":"2023-11-05T11:07:00.000Z","size":61908,"stargazers_count":11,"open_issues_count":1,"forks_count":10,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-04-23T21:42:34.667Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pooltogether.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-08T20:04:18.000Z","updated_at":"2024-03-26T19:46:34.000Z","dependencies_parsed_at":"2022-07-09T00:00:27.253Z","dependency_job_id":null,"html_url":"https://github.com/pooltogether/aave-yield-source","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Faave-yield-source","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Faave-yield-source/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Faave-yield-source/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Faave-yield-source/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pooltogether","download_url":"https://codeload.github.com/pooltogether/aave-yield-source/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224394443,"owners_count":17303916,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T05:19:41.220Z","updated_at":"2024-11-13T05:19:41.891Z","avatar_url":"https://github.com/pooltogether.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/pooltogether/pooltogether--brand-assets\"\u003e\n    \u003cimg src=\"https://github.com/pooltogether/pooltogether--brand-assets/blob/977e03604c49c63314450b5d432fe57d34747c66/logo/pooltogether-logo--purple-gradient.png?raw=true\" alt=\"PoolTogether Brand\" style=\"max-width:100%;\" width=\"200\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr /\u003e\n\n# PoolTogether Aave Yield Source 👻\n\n![Tests](https://github.com/pooltogether/aave-yield-source/actions/workflows/main.yml/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/pooltogether/aave-yield-source/badge.svg?branch=main)](https://coveralls.io/github/pooltogether/aave-yield-source?branch=main)\n[![built-with openzeppelin](https://img.shields.io/badge/built%20with-OpenZeppelin-3677FF)](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 \u003cnew_network_name\u003e`\n\nTo add a new lending market, update the appropriate network json at `./aave` and run: \n\n`yarn deploy \u003cnetwork_name\u003e`\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 \u0026\u0026 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 \u003cNETWORK_NAME\u003e\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpooltogether%2Faave-yield-source","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpooltogether%2Faave-yield-source","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpooltogether%2Faave-yield-source/lists"}