@pooltogether/v4-periphery
v1.4.0
Published
PoolTogether V4 Periphery
Downloads
628
Readme
PoolTogether V4 Periphery Contracts
Have questions or want the latest news? Join the PoolTogether Discord or follow us on Twitter:
Documentation https://v4.docs.pooltogether.com
Deployments
Overview
Getting Started
The project is made available as a NPM package.
$ yarn add @pooltogether/v4-periphery
The repo can be cloned from Github for contributions.
$ git clone https://github.com/pooltogether/v4-periphery
$ yarn
We use direnv to manage environment variables. You'll likely need to install it.
cp .envrc.example .envrc
Testing
We use Hardhat and hardhat-deploy
To run unit tests:
$ yarn test
To run coverage:
$ 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:
$ yarn start-fork
To run the mainnet fork tests for the TWAB Rewards contract, run:
$ yarn twab-rewards-fork
If you wish to run both at the same time, run:
$ 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.