{"id":20030760,"url":"https://github.com/generationsoftware/pt-v5-vault","last_synced_at":"2025-05-05T03:33:02.869Z","repository":{"id":178991570,"uuid":"662304832","full_name":"GenerationSoftware/pt-v5-vault","owner":"GenerationSoftware","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-18T00:31:50.000Z","size":825,"stargazers_count":60,"open_issues_count":0,"forks_count":36,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-09-19T02:57:47.999Z","etag":null,"topics":["pooltogether","solidity"],"latest_commit_sha":null,"homepage":"","language":"Solidity","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GenerationSoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-04T20:38:01.000Z","updated_at":"2024-09-18T00:31:51.000Z","dependencies_parsed_at":"2023-10-04T04:58:52.077Z","dependency_job_id":"ee945efb-ab27-4560-8661-7a1c0d10e7f5","html_url":"https://github.com/GenerationSoftware/pt-v5-vault","commit_stats":null,"previous_names":["generationsoftware/pt-v5-vault"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenerationSoftware%2Fpt-v5-vault","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenerationSoftware%2Fpt-v5-vault/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenerationSoftware%2Fpt-v5-vault/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenerationSoftware%2Fpt-v5-vault/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GenerationSoftware","download_url":"https://codeload.github.com/GenerationSoftware/pt-v5-vault/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224423192,"owners_count":17308660,"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":["pooltogether","solidity"],"created_at":"2024-11-13T09:28:09.510Z","updated_at":"2024-11-13T09:28:10.108Z","avatar_url":"https://github.com/GenerationSoftware.png","language":"Solidity","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=\"400\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n# PoolTogether V5 Vault\n\n[![Code Coverage](https://github.com/GenerationSoftware/pt-v5-vault/actions/workflows/coverage.yml/badge.svg)](https://github.com/GenerationSoftware/pt-v5-vault/actions/workflows/coverage.yml)\n[![built-with openzeppelin](https://img.shields.io/badge/built%20with-OpenZeppelin-3677FF)](https://docs.openzeppelin.com/)\n![MIT license](https://img.shields.io/badge/license-MIT-blue)\n\n\u003cstrong\u003eHave questions or want the latest news?\u003c/strong\u003e\n\u003cbr/\u003eJoin the PoolTogether Discord or follow us on Twitter:\n\n[![Discord](https://badgen.net/badge/icon/discord?icon=discord\u0026label)](https://pooltogether.com/discord)\n[![Twitter](https://badgen.net/badge/icon/twitter?icon=twitter\u0026label)](https://twitter.com/PoolTogether_)\n\n## Overview\n\nIn PoolTogether V5 deposits are held in prize vaults. Prize vaults are [ERC4626](https://eips.ethereum.org/EIPS/eip-4626) compatible and are the entry point for users interacting with the PoolTogether protocol. Users deposit an underlying asset (i.e. USDC) in this contract which is then funnelled to a yield source and in exchange users receive an ERC20 token representing their share of deposits in the vault.\n\n- Balances are stored in a TWAB Controller.\n- Yield is forwarded to the Liquidator to be sold.\n\n## Development\n\n### Installation\n\nYou may have to install the following tools to use this repository:\n\n- [Foundry](https://github.com/foundry-rs/foundry) to compile and test contracts\n- [direnv](https://direnv.net/) to handle environment variables\n- [lcov](https://github.com/linux-test-project/lcov) to generate the code coverage report\n\nInstall dependencies:\n\n```\nnpm i\n```\n\n### Env\n\nCopy `.envrc.example` and write down the env variables needed to run this project.\n\n```\ncp .envrc.example .envrc\n```\n\nOnce your env variables are setup, load them with:\n\n```\ndirenv allow\n```\n\n### Compile\n\nRun the following command to compile the contracts:\n\n```\nnpm run compile\n```\n\n### Coverage\n\nForge is used for coverage, run it with:\n\n```\nnpm run coverage\n```\n\nYou can then consult the report by opening `coverage/index.html`:\n\n```\nopen coverage/index.html\n```\n\n### Code quality\n\n[Husky](https://typicode.github.io/husky/#/) is used to run [lint-staged](https://github.com/okonet/lint-staged) and tests when committing.\n\n[Prettier](https://prettier.io) is used to format TypeScript and Solidity code. Use it by running:\n\n```\nnpm run format\n```\n\n[Solhint](https://protofire.github.io/solhint/) is used to lint Solidity files. Run it with:\n\n```\nnpm run hint\n```\n\n### Tests\n\nYou can run tests with the following commands:\n\n- **unit tests:** `npm run test`\n- **fuzz tests:** `npm run fuzz`\n- **invariant tests:** `npm run invariant`\n- **integration tests:** `npm run integration` (*informative for which integrations have potential issues*)\n\n### CI\n\nA default Github Actions workflow is setup to execute on push and pull request.\n\nIt will build the contracts and run the test coverage.\n\nYou can modify it here: [.github/workflows/coverage.yml](.github/workflows/coverage.yml)\n\nFor the coverage to work, you will need to setup the relevant `{X}_RPC_URL` repository secrets in the settings of your Github repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerationsoftware%2Fpt-v5-vault","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenerationsoftware%2Fpt-v5-vault","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerationsoftware%2Fpt-v5-vault/lists"}