https://github.com/generationsoftware/pt-v5-builder-code-examples
A collection of code examples for builders looking to build on top of PoolTogether V5.
https://github.com/generationsoftware/pt-v5-builder-code-examples
examples pooltogether solidity
Last synced: 2 months ago
JSON representation
A collection of code examples for builders looking to build on top of PoolTogether V5.
- Host: GitHub
- URL: https://github.com/generationsoftware/pt-v5-builder-code-examples
- Owner: GenerationSoftware
- License: mit
- Created: 2023-11-08T15:27:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T20:03:39.000Z (over 1 year ago)
- Last Synced: 2025-01-12T17:47:20.442Z (about 1 year ago)
- Topics: examples, pooltogether, solidity
- Language: Solidity
- Homepage:
- Size: 136 KB
- Stars: 3
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PoolTogether V5 Builder Code Examples
A collection of code examples for builders looking to build with the PoolTogether V5 protocol.
## Directory
### Vault Prize Hook Examples
- [Awarding Prizes to NFT Holders](./src/prize-hooks/examples/prize-to-nft-holder/README.md)
- [Boosting Prizes on a Vault](./src/prize-hooks/examples/prize-boost/README.md)
- [Minting Tokens to Prize Winners](./src/prize-hooks/examples/prize-pixels/README.md)
- [Donating Prizes back to the Prize Pool](./src/prize-hooks/examples/prize-recycle/README.md)
> For more info on prize hooks, see the [guide to prize hooks](https://dev.pooltogether.com/protocol/guides/prize-hooks).
### Custom Vault Examples
- [Creating a Custom Vault](./src/custom-vaults/examples/sponsored-vault/README.md)
> For more info on custom vaults, see the [guide to creating a vault](https://dev.pooltogether.com/protocol/guides/creating-vaults#non-standard-vaults).
### Liquidation Examples and Guides
- [Router Liquidations](./src/liquidations/examples/router-liquidations/README.md)
- [Direct Liquidations](./src/liquidations/examples/direct-liquidations/README.md)
- [Flashswap Liquidations](./src/liquidations/examples/flash-swap-liquidations/README.md)
> For more info on how to liquidate yield, see the [guide to liquidating yield](https://dev.pooltogether.com/protocol/guides/liquidating-yield).
## Repository - Development & Testing
### 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
```
### 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.