Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/generationsoftware/pt-v5-prize-pool
https://github.com/generationsoftware/pt-v5-prize-pool
pooltogether solidity
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/generationsoftware/pt-v5-prize-pool
- Owner: GenerationSoftware
- License: mit
- Created: 2023-07-05T01:02:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-18T17:35:29.000Z (6 months ago)
- Last Synced: 2024-07-18T23:36:17.010Z (6 months ago)
- Topics: pooltogether, solidity
- Language: Solidity
- Homepage:
- Size: 841 KB
- Stars: 49
- Watchers: 2
- Forks: 30
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PoolTogether V5 Prize Pool
[](https://github.com/generationsoftware/pt-v5-prize-pool/actions/workflows/coverage.yml)
[](https://docs.openzeppelin.com/)
Have questions or want the latest news?
Join the PoolTogether Discord or follow us on Twitter:
[](https://pooltogether.com/discord)
[](https://twitter.com/PoolTogether_)
## Overview
In PoolTogether V5 prizes are distributed through the Prize Pool contract. There is one Prize Pool deployed on each chain on which PT is deployed. The Prize Pool receives POOL tokens from Vaults, and releases the tokens as prizes in daily Draws. In this way, prize liquidity is isolated to a chain.
- Accrued yield is sold by the Liquidator and sent to the Prize Pool.
- Every "Draw" a random number is provided and given to the Prize Pool and the next set of prizes are available.
- The Prize Pool determines a users chance of winning by reading historic data from the TWAB Controller.
> [!important]
> Only WETH has been audited as the `prizeToken` for the prize pool. Other prize tokens may lead to unknown complications due to differences in precision or mathematical limitations.
## Development
### Installation
You may have to install the following tools to use this repository:
- [Foundry](https://github.com/foundry-rs/foundry) to compile and test contracts
- [direnv](https://direnv.net/) to handle environment variables
- [lcov](https://github.com/linux-test-project/lcov) to generate the code coverage report
Install dependencies:
```
npm i
```
### Env
Copy `.envrc.example` and write down the env variables needed to run this project.
```
cp .envrc.example .envrc
```
Once your env variables are setup, load them with:
```
direnv allow
```
### Compile
Run the following command to compile the contracts:
```
npm run compile
```
### Coverage
Forge is used for coverage, run it with:
```
npm run coverage
```
You can then consult the report by opening `coverage/index.html`:
```
open coverage/index.html
```
### Code quality
[Husky](https://typicode.github.io/husky/#/) is used to run [lint-staged](https://github.com/okonet/lint-staged) and tests when committing.
[Prettier](https://prettier.io) is used to format TypeScript and Solidity code. Use it by running:
```
npm run format
```
[Solhint](https://protofire.github.io/solhint/) is used to lint Solidity files. Run it with:
```
npm run hint
```
### Tests
Test names including `SLOW` will be skipped on default test runs and need to be explicitly run.
### CI
A default Github Actions workflow is setup to execute on push and pull request.
It will build the contracts and run the test coverage.
You can modify it here: [.github/workflows/coverage.yml](.github/workflows/coverage.yml)
For the coverage to work, you will need to setup the `MAINNET_RPC_URL` repository secret in the settings of your Github repository.