Curve liquidity gauge manager

This repository contains rewards manager for Curve Liquidity Gauge. The manager simplifies reward distribution operations by DAO voting and Easy Track.

Optimism Curve Liquidity Gauge

Arbitrum Curve Liquidity Gauge

Environment preparation with Poetry

Step 1. Install dependencies

poetry install

Step 2. Install Ganache locally

Simply run the following command from the project's directory

yarn

Step 3. Import network config to connect brownie with local Ganache

poetry run brownie networks import network-config.yaml True

Step 4. Activate virtual environment

poetry shell

Testing

Testing environment is provided for Optimism and Arbitrum networks

Alchemy API key should be provided for testing

export WEB3_ALCHEMY_APY_KEY=

Running test suites

brownie test -s --network optimism-fork

brownie test -s --network arbitrum-fork

Acceptance tests

Require contracts addresses in deployed-{network_name}.json

brownie test -s tests/test_accetance.py --network optimism-fork

brownie test -s tests/test_accetance.py --network arbitrum-fork

Deploying Environment

The deploy.py script is in charge of the RewardsManager contract on-chain deployment. The following environment variables needs to be set for the script's execution:

• DEPLOYER - deployer account

Deployed tx, contract address and deploy params will be placed in deployed-{network_name}.json

Specification

RewardsManager.vy

def period_finish() -> uint256: view

Returns estimated date of last rewards period start date

CLG.periodFinish + (WEEKS_PER_PERIOD - self.rewards_iteration ) % WEEKS_PER_PERIOD * SECONDS_PER_WEEK

def start_next_rewards_period()

Permissionless method, allows to start new weekly rewards period at Curve Liquidity Gauge

If contact has enough assets in it (LDO.balanceOf(self) >= self.weekly_amount), and the CLG period is finished, it will start a new period by calling deposit_reward_token(_reward_token: address, _amount: uint256): nonpayable with self.weekly_amount as amount of LDO

Recalculates self.weekly_amount every 4 calls, requires balance to be not less then self.min_rewards_amount

Events:

event NewRewardsPeriodStarted:
    amount: uint256

event WeeklyRewardsAmountUpdated:
    newWeeklyRewardsAmount: uint256

def replace_me_by_other_distributor(_to: address):

Transfers permission to start new rewards period form self.

Events:

event RewardsContractTransferred:
    newDistributor: indexed(address)

def recover_erc20(_token: address, _amount: uint256, _recipient: address = msg.sender):

Transfers the amount of the given ERC20 token to the recipient. Can be called by owner only.

Events:

event ERC20TokenRecovered:
    token: indexed(address)
    amount: uint256
    recipient: indexed(address)