https://github.com/pooltogether/pooltogether-reserve-contracts

Configurable Reserve contracts for PoolTogether prize pools
https://github.com/pooltogether/pooltogether-reserve-contracts

Last synced: about 2 months ago
JSON representation

Configurable Reserve contracts for PoolTogether prize pools

• Host: GitHub
• URL: https://github.com/pooltogether/pooltogether-reserve-contracts
• Owner: pooltogether
• Created: 2021-03-22T18:07:40.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-11T22:57:00.000Z (over 3 years ago)
• Last Synced: 2024-04-23T21:42:38.972Z (9 months ago)
• Language: JavaScript
• Homepage:
• Size: 688 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PoolTogether Reserve

[![Coverage Status](https://coveralls.io/repos/github/pooltogether/pooltogether-reserve-contracts/badge.svg?branch=main)](https://coveralls.io/github/pooltogether/pooltogether-reserve-contracts?branch=main)

[![CircleCI](https://circleci.com/gh/pooltogether/pooltogether-reserve-contracts.svg?style=svg)](https://circleci.com/gh/pooltogether/pooltogether-reserve-contracts)

PoolTogether captures a portion of the yield produced by the prize pools as "reserve".  The percentage of yield that is captured is called the "reserve rate".

Currently (before this implementation) there is a single, global reserve rate that is applied to all pools.  However, PoolTogether governance will like to set a higher reserve rate for governance-managed pools, and do not wish to affect community pools.

The Configurable Reserve contracts outline a new Reserve interface that will allow governance to configure a reserve rate for each pool separately, as well as setting an opt-out default rate across all prize pools.

# Interface

A prize pools reserve rate can be set by calling:

```solidity

function setReserveRateMantissa(address[] calldata sources,  uint224[] calldata _reserveRates, bool[] calldata useCustom) external;

```

The `useCustom` boolean flag overrides the use of the default pool-wide reserve rate. 

Note that only the owner of the contract can call this function. In the case of PoolTogether the owner will be the governance (timelock) contract.

A prize pools reserve rate can be viewed by calling:

```solidity

function reserveRateMantissa(address source) external view returns (uint256);

```

The default reserve rate across all prize pools can be set with: 

```solidity

function setDefaultReserveRateMantissa(uint224 _reserveRateMantissa) external override

```

Note: only the contract owner can call this function. 

The concept of a withdrawStrategist allows the reserve to be withdrawn by a custom `withdrawStrategist` address. This can be set by calling:

```solidity

function setWithdrawStrategist(address _strategist) external override onlyOwner{

```

Note: only the contract ower can call this function. 

The actual reserve amount can be withdrawn from a prize pool by either the contract owner or the `withdrawStrategist` by calling:

```solidity

 function withdrawReserve(address prizePool, address to) external override onlyOwnerOrWithdrawStrategist returns (uint256)

```

# Setup

To setup repo install with:

`yarn`

Setup environmental variables with:

`cp .envrc.example .envrc`

and fill `.envrc` with your own variables and api keys.

Import the environmental variables with:

`direnv allow`

# To deploy

## Locally

To deploy locally for development run:

`yarn deploy localhost`

## To a network

Ensure HDWALLET_MNEMONIC is set in .envrc and run:

`yarn deploy `

### To verify

Ensure ETHERSCAN_API_KEY is set in .envrc and run:

`yarn verify `

# Testing

## Locally

To test the contracts locally run:

`yarn && yarn test`

## Coverage

To display contract coverage run: 

`yarn coverage`

## To fork test

After specifying the fork block in `hardhat.networks.js`, start the mainnet fork with:

 `yarn start-fork`

In another terminal window run:

`yarn fork-run ./scripts/setupReserve.js`

# Connecting the ConfigurableReserve to the Prize Pools

The prize pools lookup where the reserve rates are set at the ReserveRegistry (https://etherscan.io/address/0x3e8b9901dbfe766d3fe44b36c180a1bca2b9a295).

This Registry contract is owned by the PoolTogether governance system (specifically the timelock contract).

This Registry can now be updated to instead point at the ConfigurableReserve (https://etherscan.io/address/0xd1797D46C3E825fce5215a0259D3426a5c49455C) by the timelock calling:

```solidity

function register(address _pointer) external onlyOwner

```