th3nolo / v4-core

Core contracts for PoolTogether v4 🌊 🏆

PoolTogether V4 Core Smart Contracts

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

• ControlledToken
• DrawBeacon
• DrawBuffer
• DrawCalculator
• EIP2612PermitAndDeposit
• PrizeDistributionBuffer
• PrizeDistributor
• PrizeSplitStrategy
• Reserve
• StakePrizePool
• Ticket
• YieldSourcePrizePool

Periphery and supporting contracts:

• https://github.com/pooltogether/v4-periphery
• https://github.com/pooltogether/v4-oracle-timelocks

Getting Started

The project is made available as a NPM package.

$ yarn add @pooltogether/pooltogether-contracts

The repo can be cloned from Github for contributions.

$ git clone https://github.com/pooltogether/v4-core

$ yarn

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

cp .envrc.example .envrc

To run fork scripts, deploy or perform any operation with a mainnet/testnet node you will need an Infura API key.

Testing

We use Hardhat and hardhat-deploy

To run unit & integration tests:

$ yarn test

To run coverage:

$ yarn coverage

Deployment

Testnets

Deployment is maintained in a different repo.

Mainnet

Deployment is maintained in a different repo.