https://github.com/pooltogether/pods-v3-contracts
Contracts for Pods (for v3 of the protocol)
https://github.com/pooltogether/pods-v3-contracts
Last synced: 1 day ago
JSON representation
Contracts for Pods (for v3 of the protocol)
- Host: GitHub
- URL: https://github.com/pooltogether/pods-v3-contracts
- Owner: pooltogether
- Created: 2021-03-25T20:32:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-02T18:30:05.000Z (about 4 years ago)
- Last Synced: 2025-05-04T15:40:39.628Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.44 MB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PoolTogether v3 - Pods Smart Contracts
[](https://circleci.com/gh/pooltogether/pods-v3-contracts) [](https://coveralls.io/github/pooltogether/pods-v3-contracts?branch=pod/tests) [](https://docs.openzeppelin.com/)
The Pods smart contracts are a periphery smart contract collection for PoolTogether
- Lower Gas Fees
- Increased Chances of Winning
## Setup
Install dependencies:
```bash
$ yarn
```
Make sure you have `direnv` installed and copy `.envrc.example` to `.envrc`:
```bash
$ cp .envrc.example .envrc
```
Fill in your own values for `.envrc`, then run:
```bash
$ direnv allow
```
To setup the local Hardhat EVM, run:
```
$ yarn hardhat node
```
Depending on the .enrvc setup the Hardhat EVM will be new blockchain or a mainnet fork.
## Overview
The smart contracts are categorized into multiple categories
### Primary
The primary smart contracts are responsible for handling collective deposits and issuing POOL rewards
- Pod
- TokenDrop
### Factories
The factory smart contracts are responsible for deploying new Pods associated TokenDrop
- PodFactory
- TokenDropFactory
### Periphery
The periphery smart contracts help handle secondary actions, like liquidating "bonus" rewards from LOOT boxes.
- PodManager
## Development
The development, testing and deployment is handled via `hardhat`
## Testing
Run All Tests
`yarn test`