PoolTogether V4 Periphery Contracts

!Fork
!Tests

Have questions or want the latest news?

Join the PoolTogether Discord or follow us on Twitter:


Documentation

https://v4.docs.pooltogether.com

Deployments

- Ethereum
- Polygon
- Avalanche

Overview

- PrizeDistributionFactory
- PrizeFlush
- PrizeTierHistory
- TwabRewards

Getting Started

The project is made available as a NPM package.

``sh
$ yarn add @pooltogether/v4-periphery
`

The repo can be cloned from Github for contributions.

`sh
$ git clone https://github.com/pooltogether/v4-periphery
`

`sh
$ yarn
`

We use direnv to manage environment variables. You'll likely need to install it.

`sh
cp .envrc.example .envrc
`

Testing

We use Hardhat and hardhat-deploy

To run unit tests:

`sh
$ yarn test
`

To run coverage:

`sh
$ yarn coverage
`

Forking

Mainnet fork tests have been implemented to test the functionalities of the TWAB Rewards contract.

To start the mainnet fork RPC server, run:

`sh
$ yarn start-fork
`

To run the mainnet fork tests for the TWAB Rewards contract, run:

`sh
$ yarn twab-rewards-fork
`

If you wish to run both at the same time, run:

`sh
$ yarn run-twab-rewards-fork
`

This command is used in the Github Actions workflow located in .github/workflows/fork.yml`.

Deployment

Testnets

Deployment is maintained in a different repo.

Mainnet

Deployment is maintained in a different repo.