{"repo":"GenerationSoftware/pt-v5-vault","free":true,"listed":false,"github":"https://github.com/GenerationSoftware/pt-v5-vault","clone":"git clone https://github.com/GenerationSoftware/pt-v5-vault.git","description":null,"language":"Solidity","stars":71,"topics":["pooltogether","solidity"],"license":"MIT","category":"blockchain-web3","readme_excerpt":"PoolTogether V5 Vault Have questions or want the latest news? Join the PoolTogether Discord or follow us on Twitter: Overview In PoolTogether V5 deposits are held in prize vaults. Prize vaults are ERC4626 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. - Balances are stored in a TWAB Controller. - Yield is forwarded to the Liquidator to be sold. Development Installation You may have to install the following tools to use this repository: - Foundry to compile and test contracts - direnv to handle environment variables - lcov to generate the code coverage report Install dependencies: Env Copy .envrc.example and write down the env variables needed to run this project. Once your env variables are setup, load them with: Compile Run the following command to compile the contracts: Coverage Forge is used for coverage, run it with: You can then consult the report by opening coverage/index.html : Code quality Husky is used to run lint-staged and tests when committing. Prettier is used to format TypeScript and Solidity code. Use it by running: Solhint is used to lint Solidity files. Run it with: Tests You can run tests with the following commands: - unit tests: npm run test - fuzz tests: npm run fuzz - invariant tests: npm run invariant - integration","default_branch":null,"files":null,"tree":[],"storefront":"/r/GenerationSoftware","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/GenerationSoftware/pt-v5-vault/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}