CoveYearnGaugeFactory

Git Source

Inherits: AccessControlEnumerable, Multicall

Factory contract to deploy and manage Yearn gauge-related contracts for Cove protocol.

This contract allows for the creation of Yearn gauge strategies, auto-compounding gauges, and non-auto-compounding gauges. It also manages the reward forwarder implementations and various administrative roles.

State Variables

MANAGER_ROLE

Role identifier for the manager role, used for privileged functions.

bytes32 public constant MANAGER_ROLE = keccak256("MANAGER_ROLE");

PAUSER_ROLE

Role identifier for the pauser role, used to pause certain contract functionalities.

bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");

_DYFI

Address of the DYFI token, used within the contract for various functionalities.

address private constant _DYFI = 0x41252E8691e964f7DE35156B68493bAb6797a275;

YEARN_STAKING_DELEGATE

Address of the Yearn Staking Delegate, immutable for the lifetime of the contract.

address public immutable YEARN_STAKING_DELEGATE;

COVE

Address of the COVE token, immutable for the lifetime of the contract.

address public immutable COVE;

rewardForwarderImpl

Address of the current Reward Forwarder implementation.

address public rewardForwarderImpl;

erc20RewardsGaugeImpl

Address of the current ERC20 Rewards Gauge implementation.

address public erc20RewardsGaugeImpl;

ysdRewardsGaugeImpl

Address of the current YSD Rewards Gauge implementation.

address public ysdRewardsGaugeImpl;

gaugeAdmin

Address of the account with gauge admin privileges.

address public gaugeAdmin;

gaugeManager

Address of the account with gauge management privileges.

address public gaugeManager;

gaugePauser

Address of the account with gauge pausing privileges.

address public gaugePauser;

supportedYearnGauges

Array of addresses for supported Yearn Gauges.

address[] public supportedYearnGauges;

yearnGaugeInfoStored

Mapping of Yearn Gauge addresses to their stored information.

mapping(address => GaugeInfoStored) public yearnGaugeInfoStored;

Functions

constructor

Initializes the factory with the necessary contract implementations and administrative roles.

constructor(
    address factoryAdmin,
    address ysd,
    address cove,
    address rewardForwarderImpl_,
    address erc20RewardsGaugeImpl_,
    address ysdRewardsGaugeImpl_,
    address gaugeAdmin_,
    address gaugeManager_,
    address gaugePauser_
)
    payable;

Parameters

numOfSupportedYearnGauges

Returns the number of supported Yearn gauges.

function numOfSupportedYearnGauges() external view returns (uint256);

Returns

getAllGaugeInfo

Retrieves information for all supported Yearn gauges.

The usage of the limit and offset parameters matches the same pattern found in pagination/SQL queries.

function getAllGaugeInfo(uint256 limit, uint256 offset) external view returns (GaugeInfo[] memory);

Parameters

Returns

getGaugeInfo

Retrieves information for a specific Yearn gauge.

The unchecked block is used here because the loop index i is simply incremented in each iteration, ensuring that i will not exceed the length of the array and cause an overflow. Underflow is not a concern as i is initialized to 0 and only incremented.

Fetches gauge information from storage and attempts to determine the vault asset and version.

function getGaugeInfo(address yearnGauge) public view returns (GaugeInfo memory);

Parameters

Returns

deployCoveGauges

Deploys Cove gauges for a given Yearn strategy.

Creates new instances of auto-compounding and non-auto-compounding gauges, initializes them, and sets up reward forwarders.

function deployCoveGauges(address coveYearnStrategy) external onlyRole(MANAGER_ROLE);

Parameters

setRewardForwarderImplementation

Sets the implementation address for the RewardForwarder contract.

Can only be called by the admin role. Reverts if the new implementation address is the zero address.

function setRewardForwarderImplementation(address impl) external onlyRole(DEFAULT_ADMIN_ROLE);

Parameters

setYsdRewardsGaugeImplementation

Sets the implementation address for the YSDRewardsGauge contract.

Can only be called by the admin role. Reverts if the new implementation address is the zero address.

function setYsdRewardsGaugeImplementation(address impl) external onlyRole(DEFAULT_ADMIN_ROLE);

Parameters

setERC20RewardsGaugeImplementation

Sets the implementation address for the ERC20RewardsGauge contract.

Can only be called by the admin role. Reverts if the new implementation address is the zero address.

function setERC20RewardsGaugeImplementation(address impl) external onlyRole(DEFAULT_ADMIN_ROLE);

Parameters

setGaugeAdmin

Sets the gauge admin address.

Can only be called by the admin role. Reverts if the new gauge admin address is the zero address.

function setGaugeAdmin(address admin) external onlyRole(DEFAULT_ADMIN_ROLE);

Parameters

setGaugeManager

Sets the gauge manager address.

Can only be called by the admin role. Reverts if the new gauge manager address is the zero address.

function setGaugeManager(address manager) external onlyRole(DEFAULT_ADMIN_ROLE);

Parameters

setGaugePauser

Sets the gauge pauser address.

Can only be called by the admin role. Reverts if the new gauge pauser address is the zero address.

function setGaugePauser(address pauser) external onlyRole(DEFAULT_ADMIN_ROLE);

Parameters

_setRewardForwarderImplementation

function _setRewardForwarderImplementation(address impl) internal;

_setERC20RewardsGaugeImplementation

function _setERC20RewardsGaugeImplementation(address impl) internal;

_setYsdRewardsGaugeImplementation

function _setYsdRewardsGaugeImplementation(address impl) internal;

_setGaugeAdmin

function _setGaugeAdmin(address admin) internal;

_setGaugeManager

function _setGaugeManager(address manager) internal;

_setGaugePauser

function _setGaugePauser(address pauser) internal;

Events

CoveGaugesDeployed

Event emitted when Cove gauges are deployed.

event CoveGaugesDeployed(
    address yearnGauge, address coveYearnStrategy, address autoCompoundingGauge, address nonAutoCompoundingGauge
);

Parameters

Structs

GaugeInfoStored

struct GaugeInfoStored {
    address coveYearnStrategy;
    address autoCompoundingGauge;
    address nonAutoCompoundingGauge;
}

GaugeInfo

struct GaugeInfo {
    address yearnVaultAsset;
    address yearnVault;
    bool isVaultV2;
    address yearnGauge;
    address coveYearnStrategy;
    address autoCompoundingGauge;
    address nonAutoCompoundingGauge;
}