Infrared Protocol

The Infrared Protocol revolutionizes the way users engage with the Berachain ecosystem, particularly in how they stake consensus assets and receive the Proof-of-Liquidity inflation. It enables users to stake their assets effortlessly and receive IBGT, a liquid staked representation of BGT, significantly enhancing BGT's utility. Additionally, Infrared democratizes access to Validator staking through the IBERA contract suite, a liquid staking token tightly integrated with Proof-of-Liquidity (POL) and the Infrared ecosystem.

Learn More

• Architecture
• Deployed Addresses
• Audits

Contract Architecture

https://link.excalidraw.com/l/1Tuu8vTTCh1/1f3jMvwGuuS

Core Contracts

• full overview here

• IBERA.sol: Main liquid staking token contract. Handles minting/burning of iBERA, facilitates POL rewards and manages validators.

• InfraredVault.sol: Manages staking pools and reward distribution. Integrates with Berachain's POL system.

• InfraredDistributor.sol: Handles distribution of validator rewards and commission management.

• BribeCollector.sol: Collects and auctions bribes from Berachain reward vaults.

Staking Contracts

• full overview here

• IBERADepositor.sol: Handles deposits to CL through Berachain beacon deposit contract.

• IBERAWithdrawor.sol: Manages withdrawals from CL through Berachain precompiles.

• IBERAClaimor.sol: Processes user claims for withdrawn funds.

• IBERAFeeReceivor.sol: Receives and processes validator rewards from EL.

Voting Contracts

• full overview here

• VotingEscrow.sol: Implementation of vote-escrowed NFTs (veNFTs) for protocol governance.

• Voter.sol: Manages voting logic for POL cutting board allocation.

• MultiRewards.sol: Base contract for reward distribution across multiple tokens.

Getting Started

Prerequisites

# Install Foundry
curl -L https://foundry.paradigm.xyz | bash
foundryup

Quick Start

# Clone the repository
git clone https://github.com/infrared-dao/infrared-contracts.git
cd infrared-protocol

# Install dependencies
forge install

# Build contracts
forge build

# Run tests
forge test

Integration Guide

Developers who want to integrate with InfraredVault and IBGTVault can do so by following these steps:

Installation

Add the infrared-contracts to your Foundry project:

forge install infrared-dao/infrared-contracts

Update your foundry.toml with the following remapping:

@infrared/=lib/infrared-contracts/contracts

Example Usage

import {IInfrared} from '@infrared/interfaces/IInfrared.sol';
import {IInfraredVault} from '@infrared/interfaces/IInfraredVault.sol';
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";

// Query InfraredVault
IInfraredVault infraredVault = IInfrared(infrared).vaultRegistry(asset);

// Stake into InfraredVault
IERC20(asset).approve(address(infraredVault), amount);
infraredVault.stake(amount);

// Check earned rewards
IInfraredVault.RewardData[] memory rTs = infraredVault.getUserRewardsEarned(user);

// Harvest rewards
infraredVault.getReward();

// Withdraw assets and harvest remaining rewards
infraredVault.exit();

Contents

• IRateProvider
• InfraredBERARateProvider

IRateProvider

Git Source

Functions

getRate

getRate()

Returns the current rate of a given asset.

function getRate() external view returns (uint256);

Returns

InfraredBERARateProvider

Git Source

Inherits: IRateProvider

Returns the value of iBERA in terms of BERA

State Variables

ibera

The address of the ibera contract

IInfraredBERA public immutable ibera;

Functions

constructor

Constructs the MevETHRateProvider contract, setting the mevETH address

constructor(IInfraredBERA _ibera);

getRate

Returns the value of iBERA in terms of BERA

function getRate() external view override returns (uint256);

Returns

Contents

• libraries
• upgrades
• BribeCollector
• Infrared
• InfraredBGT
• InfraredDistributor
• InfraredGovernanceToken
• InfraredUpgradeable
• InfraredVault
• MultiRewards
• WrappedVault

Contents

• ConfigTypes
• RewardsLib
• ValidatorManagerLib
• ValidatorTypes
• VaultManagerLib

ConfigTypes

Git Source

Enums

FeeType

Fee type enum for determining rates to charge on reward distribution.

enum FeeType {
    HarvestOperatorFeeRate,
    HarvestOperatorProtocolRate,
    HarvestVaultFeeRate,
    HarvestVaultProtocolRate,
    HarvestBribesFeeRate,
    HarvestBribesProtocolRate,
    HarvestBoostFeeRate,
    HarvestBoostProtocolRate
}

RewardsLib

Git Source

State Variables

UNIT_DENOMINATOR

Unit denominotor for calculating all fees and rates in the system

All fees and rates are calculated out of 1e6

uint256 internal constant UNIT_DENOMINATOR = 1e6;

Functions

harvestOperatorRewards

Harvest rewards given to our operators for setting their cuttingboard weights ref - https://github.com/infrared-dao/infrared-contracts/blob/develop/src/staking/InfraredBERAFeeReceivor.sol#L83

function harvestOperatorRewards(
    RewardsStorage storage $,
    address ibera,
    address voter,
    address distributor
) external returns (uint256 _amt);

Parameters

Returns

chargedFeesOnRewards

The amount of rewards going to the protocol treasury

Generic function to calculate the fees charged on rewards, returning the amount owed to the recipient, protocol, and voter.

the recepient is the amount of rewards being sent forward into the protocol for example a vault

function chargedFeesOnRewards(
    uint256 amount,
    uint256 totalFeeRate,
    uint256 protocolFeeRate
)
    public
    pure
    returns (uint256 recepient, uint256 voterFees, uint256 protocolFees);

Parameters

Returns

_distributeFeesOnRewards

Distributes fees on rewards to the protocol, voter, and recipient.

_protocolFeeAmounts The accumulator for protocol fees per token

_voter The address of the voter

_token The address of the reward token

_amtVoter The amount of rewards for the voter

_amtProtocol The amount of rewards for the protocol

function _distributeFeesOnRewards(
    mapping(address => uint256) storage protocolFeeAmounts,
    address _voter,
    address _token,
    uint256 _amtVoter,
    uint256 _amtProtocol
) internal;

_handleTokenRewardsForVault

Handles non-InfraredBGT token rewards to the vault.

function _handleTokenRewardsForVault(
    RewardsStorage storage $,
    IInfraredVault _vault,
    address _token,
    address voter,
    uint256 _amount,
    uint256 _feeTotal,
    uint256 _feeProtocol,
    uint256 rewardsDuration
) internal;

Parameters

updateIRMintRate

Update the IR minting rate for the protocol.

This rate determines how many IR tokens are minted whenever BGT rewards are harvested.

For example, if the rate is 500,000 (0.5 * UNIT_DENOMINATOR), 0.5 IR is minted per BGT.

If the rate is 2,000,000 (2 * UNIT_DENOMINATOR), 2 IR are minted per BGT.

The actuall calculation is done in the harvestVault function when BGT rewards are harvested and IR tokens are minted accordingly.

function updateIRMintRate(RewardsStorage storage $, uint256 newRate) external;

Parameters

delegateBGT

Delegates Berachain Governance Voting Power to a delegatee

function delegateBGT(address _delegatee, address bgt) external;

Parameters

updateInfraredBERABribeSplit

Update the split ratio for iBERA and iBGT rewards

function updateInfraredBERABribeSplit(RewardsStorage storage $, uint256 _split)
    external;

Parameters

updateFee

Update the fee rate for a given fee type

function updateFee(
    RewardsStorage storage $,
    ConfigTypes.FeeType _t,
    uint256 _fee
) external;

Parameters

claimProtocolFees

Claim protocol fees for a given token

function claimProtocolFees(
    RewardsStorage storage $,
    address _to,
    address _token
) external returns (uint256 _amountClaimed);

Parameters

harvestBase

Harvet's base rewards from the BGT contract, ie rewards from Distributor, given in BGT ref - https://github.com/berachain/contracts-monorepo/blob/main/src/pol/rewards/Distributor.sol#L160

The BGT accumilates in the contract, therfore can check balance(this) since all other BGT rewards are claimed and harvested atomically

Reward paid out to validators proposing a block, MUST be forwarded to IBERA.receivor, the fees are handled there. TODO: Link here.

function harvestBase(address ibgt, address bgt, address ibera)
    external
    returns (uint256 bgtAmt);

Parameters

Returns

harvestVault

Harvests the accrued BGT rewards to a vault.

BGT transferred here directly to the user https://github.com/berachain/contracts-monorepo/blob/c374de32077ede0147985cf2bf6ed89570244a7e/src/pol/rewards/RewardVault.sol#L404

function harvestVault(
    RewardsStorage storage $,
    IInfraredVault vault,
    address bgt,
    address ibgt,
    address voter,
    address ir,
    uint256 rewardsDuration
) external returns (uint256 bgtAmt);

Parameters

Returns

harvestOldVault

Harvests the accrued BGT rewards to a vault.

BGT transferred here directly to the user https://github.com/berachain/contracts-monorepo/blob/c374de32077ede0147985cf2bf6ed89570244a7e/src/pol/rewards/RewardVault.sol#L404

function harvestOldVault(
    RewardsStorage storage $,
    IInfraredVault vault,
    IInfraredVault newVault,
    address bgt,
    address ibgt,
    address voter
) external returns (uint256 bgtAmt);

Parameters

Returns

harvestBribes

Harvest Bribes in tokens from RewardVault, sent to us via processIncentive ref - https://github.com/berachain/contracts-monorepo/blob/c374de32077ede0147985cf2bf6ed89570244a7e/src/pol/rewards/RewardVault.sol#L421

function harvestBribes(
    RewardsStorage storage $,
    address collector,
    address[] memory _tokens,
    bool[] memory whitelisted
) external returns (address[] memory tokens, uint256[] memory amounts);

Parameters

harvestBoostRewards

Harvest boost rewards from the BGT staker (in HONEY -- likely)

function harvestBoostRewards(
    RewardsStorage storage $,
    address bgt,
    address ibgtVault,
    address voter,
    uint256 rewardsDuration
) external returns (address _token, uint256 _amount);

Parameters

Returns

collectBribesInWBERA

Callback from the BribeCollector to payout the WBERA bribes were auctioned off for ref - https://github.com/infrared-dao/infrared-contracts/blob/develop/src/core/BribeCollector.sol#L87

WBERA is split between the iBERA product (where it is redeemed for BERA) and the rest is sent to the IBGT vault.

function collectBribesInWBERA(
    RewardsStorage storage $,
    uint256 _amount,
    address wbera,
    address ibera,
    address ibgtVault,
    address voter,
    uint256 rewardsDuration
) external returns (uint256 amtInfraredBERA, uint256 amtIbgtVault);

Parameters

Returns

Events

ErrorMisconfiguredIRMinting

Emitted when protocol wants to mint IR but fails.

event ErrorMisconfiguredIRMinting(uint256 amount);

Parameters

Structs

RewardsStorage

struct RewardsStorage {
    mapping(address => uint256) protocolFeeAmounts;
    uint256 irMintRate;
    uint256 bribeSplitRatio;
    mapping(uint256 => uint256) fees;
}

ValidatorManagerLib

Git Source

Library for managing validator storage

*This library is used by the Infrared contract for:

• Adding and removing validators (to the set of validators and distributor contract)
• Queuing/Activating Boosts and Drop/Activate Boosts in BGT contract: https://github.com/berachain/contracts-monorepo/blob/main/src/pol/BGT.sol
• Getting the number of validators
• Checking if validator is an Infrared validator*

Ownership of Operator rewards is tied to the number of validators an operator has, which should be linear to their operating costs hence share of fees. ie if an operator has 10 validators and total validators is 100, they should receive 10% of the fees even if Effective Balances are not super equal.

Functions

isValidator

Checks if a validator is an Infrared validator, ie if the validator ID is in the set of validator IDs

function isValidator(ValidatorStorage storage $, bytes memory pubkey)
    external
    view
    returns (bool);

Parameters

_getValidatorId

Gets the validator ID for associated CL pubkey

function _getValidatorId(bytes memory pubkey) internal pure returns (bytes32);

Parameters

addValidators

Adds validator to the set of validators, and maps the validator ID to the public key.

Also adds the validator to a public key set in the distributor contract, for receiving operator rewards. (ie Commissions for running nodeds).address

function addValidators(
    ValidatorStorage storage $,
    address distributor,
    ValidatorTypes.Validator[] memory _validators
) external;

Parameters

removeValidators

Removes validators from the set of validators and also removes the validator from the distributor contract.

function removeValidators(
    ValidatorStorage storage $,
    address distributor,
    bytes[] memory _pubkeys
) external;

replaceValidator

Replaces a validator in the set of validators and also updates the validator in the distributor contract.

function replaceValidator(
    ValidatorStorage storage $,
    address distributor,
    bytes calldata _current,
    bytes calldata _new
) external;

Parameters

queueBoosts

Queues boosts for validators in the BGT smart contract

The sum of the boosts must be less than or equal to the total supply of iBGT

function queueBoosts(
    ValidatorStorage storage $,
    address bgt,
    address ibgt,
    bytes[] memory _pubkeys,
    uint128[] memory _amts
) external;

Parameters

cancelBoosts

Cancels boosts for validators in the BGT smart contract before they are activated

function cancelBoosts(
    address bgt,
    bytes[] memory _pubkeys,
    uint128[] memory _amts
) external;

Parameters

activateBoosts

Activates boosts for validators in the BGT smart contract

function activateBoosts(
    ValidatorStorage storage $,
    address bgt,
    bytes[] memory _pubkeys
) external;

Parameters

queueDropBoosts

Queues to drop the boosts for validators in the BGT smart contract

function queueDropBoosts(
    address bgt,
    bytes[] memory _pubkeys,
    uint128[] memory _amts
) external;

Parameters

cancelDropBoosts

Cancels drop boosts for validators in the BGT smart contract before they are activated

function cancelDropBoosts(
    ValidatorStorage storage $,
    address bgt,
    bytes[] memory _pubkeys,
    uint128[] memory _amts
) external;

Parameters

dropBoosts

Activates drop boosts for validators in the BGT smart contract

function dropBoosts(address bgt, bytes[] memory _pubkeys) external;

Parameters

infraredValidators

Returns the list of validators in the validator storage

function infraredValidators(ValidatorStorage storage $, address distributor)
    external
    view
    returns (ValidatorTypes.Validator[] memory validators);

Parameters

Returns

numInfraredValidators

Returns the number of validators in the validator storage

function numInfraredValidators(ValidatorStorage storage $)
    external
    view
    returns (uint256);

Parameters

Returns

_getValidatorAddress

helper function to get the vlaidator fee collecting address via the CL pubkey

function _getValidatorAddress(address distributor, bytes memory pubkey)
    internal
    view
    returns (address);

Parameters

Returns

Structs

ValidatorStorage

Storage structure for validator storage

This structure is used to store validator IDs and public keys

struct ValidatorStorage {
    EnumerableSet.Bytes32Set validatorIds;
    mapping(bytes32 => bytes) validatorPubkeys;
}

Properties

ValidatorTypes

Git Source

Structs

Validator

Validator information for validator set

struct Validator {
    bytes pubkey;
    address addr;
}

VaultManagerLib

Git Source

Library for managing:

• Vault registration
• Vault pausing
• Reward token whitelisting
• Default reward duration

Functions

vaultRegistrationNotPaused

Modifier to check if vault registration is paused.

modifier vaultRegistrationNotPaused(VaultStorage storage $);

Parameters

pauseStaking

Pauses staking functionality on a specific vault

function pauseStaking(VaultStorage storage $, address asset) external;

Parameters

unpauseStaking

Un-pauses staking functionality on a specific vault

function unpauseStaking(VaultStorage storage $, address asset) external;

Parameters

pauseOldStaking

Pauses staking functionality on an old vault

function pauseOldStaking(address _vault) external;

Parameters

unpauseOldStaking

Un-pauses staking functionality on an old vault

function unpauseOldStaking(address _vault) external;

Parameters

updateWhitelistedRewardTokens

Updates the whitelist status of a reward token.

function updateWhitelistedRewardTokens(
    VaultStorage storage $,
    address token,
    bool whitelisted
) external;

Parameters

addReward

Adds a reward to a vault, if the reward token is whitelisted.

function addReward(
    VaultStorage storage $,
    address _stakingToken,
    address _rewardsToken,
    uint256 _rewardsDuration
) external;

Parameters

removeReward

function removeReward(
    VaultStorage storage $,
    address _stakingToken,
    address _rewardsToken
) external;

updateRewardsDuration

Updates the global rewards duration for new vaults.

The rewards duration is used as the default duration for new vaults. Existing vaults will not be affected by this change.

function updateRewardsDuration(VaultStorage storage $, uint256 newDuration)
    external;

Parameters

recoverERC20FromVault

Recovers ERC20 tokens from a vault.

function recoverERC20FromVault(
    VaultStorage storage $,
    address _asset,
    address _to,
    address _token,
    uint256 _amount
) external;

Parameters

recoverERC20FromOldVault

Recovers ERC20 tokens from old vault.

removes reward token, cutting user claims. This should be a one time last ditch call for recovery after all users exited

function recoverERC20FromOldVault(
    address _vault,
    address _to,
    address _token,
    uint256 _amount
) external;

Parameters

updateRewardsDurationForVault

Updates the rewards duration for a specific reward token on a vault.

function updateRewardsDurationForVault(
    VaultStorage storage $,
    address _stakingToken,
    address _rewardsToken,
    uint256 _rewardsDuration
) external;

Parameters

setVaultRegistrationPauseStatus

Pauses or unpauses the registration of new vaults.

function setVaultRegistrationPauseStatus(VaultStorage storage $, bool pause)
    external;

Parameters

claimLostRewardsOnVault

Claims lost rewards from a vault.

function claimLostRewardsOnVault(VaultStorage storage $, address _asset)
    external;

Parameters

addIncentives

Adds a reward to a vault, if the reward token is whitelisted.

function addIncentives(
    VaultStorage storage $,
    address _stakingToken,
    address _rewardsToken,
    uint256 _amount
) external;

Parameters

registerVault

Registers a new vault for a specific asset.

function registerVault(VaultStorage storage $, address asset)
    external
    vaultRegistrationNotPaused($)
    returns (address);

Parameters

Returns

isWhitelisted

Checks if a token is whitelisted as a reward token.

function isWhitelisted(VaultStorage storage $, address token)
    public
    view
    returns (bool);

Parameters

Returns

Structs

VaultStorage

Storage structure for the VaultManagerLib

struct VaultStorage {
    bool pausedVaultRegistration;
    mapping(address => IInfraredVault) vaultRegistry;
    EnumerableSet.AddressSet whitelistedRewardTokens;
    uint256 rewardsDuration;
    mapping(address => uint8) vaultVersions;
}

Properties

Contents

• BribeCollectorV1_2
• InfraredV1_2
• InfraredV1_3
• InfraredV1_4

BribeCollectorV1_2

Git Source

Inherits: InfraredUpgradeable, IBribeCollector

The Bribe Collector contract is responsible for collecting bribes from Berachain rewards vaults and auctioning them for a Payout token which then is distributed among Infrared validators.

This contract is forked from Berachain POL which is forked from Uniswap V3 Factory Owner contract. https://github.com/uniswapfoundation/UniStaker/blob/main/src/V3FactoryOwner.sol

State Variables

payoutToken

Payout token, required to be WBERA token as its unwrapped and used to compound rewards in the iBera system.

address public payoutToken;

payoutAmount

Payout amount is a constant value that is paid by the caller of the claimFees function.

uint256 public payoutAmount;

__gap

uint256[40] private __gap;

Functions

setPayoutAmount

Set the payout amount for the bribe collector.

function setPayoutAmount(uint256 _newPayoutAmount) external onlyGovernor;

Parameters

claimFees

Claims accumulated bribes in exchange for payout token

Caller must approve payoutAmount of payout token to this contract.

function claimFees(
    address _recipient,
    address[] calldata _feeTokens,
    uint256[] calldata _feeAmounts
) external;

Parameters

sweepPayoutToken

function sweepPayoutToken() external;

InfraredV1_2

Git Source

Inherits: InfraredUpgradeable, IInfraredV1_2

Provides core functionalities for managing validators, vaults, and reward distribution in the Infrared protocol.

Serves as the main entry point for interacting with the Infrared protocol

The contract is upgradeable, ensuring flexibility for governance-led upgrades and chain compatibility.

State Variables

_bgt

The Canonical BGT token Contract

IBerachainBGT internal _bgt;

ibgt

The InfraredBGT liquid staked token

InfraredBGT public ibgt;

rewardsFactory

IBerachainRewardsVaultFactory instance of the rewards factory contract address

IBerachainRewardsVaultFactory public rewardsFactory;

chef

The Berachain chef contract for distributing validator rewards

IBeraChef public chef;

wbera

The WBERA token contract

IWBERA public wbera;

honey

The Honey token contract

ERC20 public honey;

collector

The Berachain Bribe Collector

IBribeCollector public collector;

distributor

The InfraredDistributor contract

IInfraredDistributor public distributor;

voter

The Infrared Voter contract

IVoter public voter;

ibera

iBera Contract Instance

IInfraredBERA public ibera;

ir

The Infrared Governance Token

IInfraredGovernanceToken public ir;

ibgtVault

The Infrared BGT Vault

IInfraredVault public ibgtVault;

VALIDATOR_STORAGE_LOCATION

Upgradeable ERC-7201 storage for Validator lib

keccak256(abi.encode(uint256(keccak256(bytes("infrared.validatorStorage"))) - 1)) & ~bytes32(uint256(0xff));

bytes32 public constant VALIDATOR_STORAGE_LOCATION =
    0x8ea5a3cc3b9a6be40b16189aeb1b6e6e61492e06efbfbe10619870b5bc1cc500;

VAULT_STORAGE_LOCATION

Upgradeable ERC-7201 storage for Vault lib

keccak256(abi.encode(uint256(keccak256(bytes("infrared.vaultStorage"))) - 1)) & ~bytes32(uint256(0xff));

bytes32 public constant VAULT_STORAGE_LOCATION =
    0x1bb2f1339407e6d63b93b8b490a9d43c5651f6fc4327c66addd5939450742a00;

REWARDS_STORAGE_LOCATION

Upgradeable ERC-7201 storage for Rewards lib

keccak256(abi.encode(uint256(keccak256(bytes("infrared.rewardsStorage"))) - 1)) & ~bytes32(uint256(0xff));

bytes32 public constant REWARDS_STORAGE_LOCATION =
    0xad12e6d08cc0150709acd6eed0bf697c60a83227922ab1d254d1ca4d3072ca00;

__gap

Reserve storage slots for future upgrades for safety

uint256[40] private __gap;

Functions

_validatorStorage

function _validatorStorage()
    internal
    pure
    returns (ValidatorManagerLib.ValidatorStorage storage vs);

Returns

_vaultStorage

function _vaultStorage()
    internal
    pure
    returns (VaultManagerLib.VaultStorage storage vs);

Returns

_rewardsStorage

function _rewardsStorage()
    internal
    pure
    returns (RewardsLib.RewardsStorage storage rs);

Returns

onlyCollector

Ensures that only the collector contract can call the function Reverts if the caller is not the collector

modifier onlyCollector();

initializeV1_2

function initializeV1_2(address[] calldata _stakingTokens)
    external
    onlyGovernor;

registerVault

Registers a new vault for a given asset

Infrared.sol must be admin over MINTER_ROLE on InfraredBGT to grant minter role to deployed vault

Note: emits: NewVault with the caller, asset address, and new vault address.

function registerVault(address _asset)
    external
    returns (IInfraredVault vault);

Parameters

Returns

setVaultRegistrationPauseStatus

Sets new vault registration paused or not

function setVaultRegistrationPauseStatus(bool pause) external onlyGovernor;

Parameters

addReward

Adds a new reward token to a specific staking vault

Only callable by governance when contract is initialized

Notes:

• error: ZeroAmount if _rewardsDuration is 0

• error: RewardTokenNotWhitelisted if _rewardsToken is not whitelisted

• error: NoRewardsVault if vault doesn't exist for _stakingToken

function addReward(
    address _stakingToken,
    address _rewardsToken,
    uint256 _rewardsDuration
) external onlyGovernor;

Parameters

removeReward

Removes a malicious or failing reward token from a staking vault

CAUTION: This is an emergency function that will result in loss of unclaimed rewards.

*Only callable by governance when:

1. The reward token is malfunctioning (e.g., transfers failing)
2. The reward token is malicious
3. The reward distribution needs to be forcefully terminated*

*Consequences:

• All unclaimed rewards will be permanently lost
• Users will not be able to claim outstanding rewards
• Remaining reward tokens will need to be recovered separately*

function removeReward(address _stakingToken, address _rewardsToken)
    external
    onlyGovernor;

Parameters

addIncentives

Adds reward incentives to a specific staking vault

Transfers reward tokens from caller to this contract, then notifies vault of new rewards

Notes:

• error: ZeroAmount if _amount is 0

• error: NoRewardsVault if vault doesn't exist for _stakingToken

• error: RewardTokenNotWhitelisted if reward token hasn't been configured for the vault

• access: Callable when contract is initialized

• security: Requires caller to have approved this contract to spend _rewardsToken

function addIncentives(
    address _stakingToken,
    address _rewardsToken,
    uint256 _amount
) external;

Parameters

migrateVault

Migrates reward vault from old v0 to new v1

function migrateVault(address _asset, uint8 versionToUpgradeTo)
    external
    onlyGovernor
    returns (address newVault);

Parameters

_migrateVault

function _migrateVault(address _asset, uint8 versionToUpgradeTo)
    internal
    returns (address newVault);

updateWhiteListedRewardTokens

Updates the whitelist status of a reward token

function updateWhiteListedRewardTokens(address _token, bool _whitelisted)
    external
    onlyGovernor;

Parameters

updateRewardsDuration

Sets the new duration for reward distributions in InfraredVaults

Only callable by governance

function updateRewardsDuration(uint256 _rewardsDuration)
    external
    onlyGovernor;

Parameters

updateRewardsDurationForVault

Updates the rewards duration for a specific reward token on a specific vault

Only callable by governance

function updateRewardsDurationForVault(
    address _stakingToken,
    address _rewardsToken,
    uint256 _rewardsDuration
) external onlyGovernor;

Parameters

pauseStaking

Pauses staking functionality on a specific vault

Only callable by pauser, will revert if vault doesn't exist

function pauseStaking(address _asset) external onlyPauser;

Parameters

unpauseStaking

Un-pauses staking functionality on a specific vault

Only callable by gov, will revert if vault doesn't exist

function unpauseStaking(address _asset) external onlyGovernor;

Parameters

pauseOldStaking

Pauses staking functionality on an old vault

function pauseOldStaking(address _vault) external onlyGovernor;

Parameters

unpauseOldStaking

Un-pauses staking functionality on an old vault

Only callable by gov, will revert if vault doesn't exist

function unpauseOldStaking(address _vault) external onlyGovernor;

Parameters

claimLostRewardsOnVault

Claims lost rewards on a specific vault

Only callable by governance, will revert if vault doesn't exist

function claimLostRewardsOnVault(address _asset) external onlyGovernor;

Parameters

recoverERC20

Recovers ERC20 tokens sent accidentally to the contract

function recoverERC20(address _to, address _token, uint256 _amount)
    external
    onlyGovernor;

Parameters

recoverERC20FromVault

Recover ERC20 tokens from a vault.

function recoverERC20FromVault(
    address _asset,
    address _to,
    address _token,
    uint256 _amount
) external onlyGovernor;

Parameters

recoverERC20FromOldVault

Recover ERC20 tokens from old vault.

function recoverERC20FromOldVault(
    address _vault,
    address _to,
    address _token,
    uint256 _amount
) external onlyGovernor;

Parameters

delegateBGT

Delegates BGT votes to _delegatee address.

function delegateBGT(address _delegatee) external onlyGovernor;

Parameters

updateInfraredBERABribeSplit

Updates the weight for iBERA bribes

function updateInfraredBERABribeSplit(uint256 _weight) external onlyGovernor;

Parameters

updateFee

Updates the fee rate charged on different harvest functions

Please harvest all assosiated rewards for a given type before updating

Fee rate in units of 1e6 or hundredths of 1 bip

function updateFee(ConfigTypes.FeeType _t, uint256 _fee)
    external
    onlyGovernor;

Parameters

claimProtocolFees

Claims accumulated protocol fees in contract

function claimProtocolFees(address _to, address _token) external onlyGovernor;

Parameters

setIR

Sets the address of the IR contract

Infrared must be granted MINTER_ROLE on IR to set the address

function setIR(address _ir) external onlyGovernor;

Parameters

setVoter

Sets the address of the Voter contract

function setVoter(address _voter) external onlyGovernor;

Parameters

updateIRMintRate

Updates the mint rate for IR

function updateIRMintRate(uint256 _irMintRate) external onlyGovernor;

Parameters

chargedFeesOnRewards

function chargedFeesOnRewards(
    uint256 _amt,
    uint256 _feeTotal,
    uint256 _feeProtocol
)
    public
    pure
    returns (uint256 amtRecipient, uint256 amtVoter, uint256 amtProtocol);

harvestBase

Claims all the BGT base and commission rewards minted to this contract for validators.

function harvestBase() public whenNotPaused;

harvestVault

Claims all the BGT rewards for the vault associated with the given staking token.

function harvestVault(address _asset) external whenNotPaused;

Parameters

harvestOldVault

Claims all the BGT rewards for the old vault

function harvestOldVault(address _vault, address _asset)
    external
    onlyKeeper
    whenNotPaused;

Parameters

harvestBribes

Claims all the bribes rewards in the contract forwarded from Berachain POL.

This should be called right before the collector claimFees function.

1. harvestBribes(), 2. collector.claimFees(), 3. collectBribes() (which handles the wBERA -> iBERA + fees distribution)

function harvestBribes(address[] calldata _tokens) external whenNotPaused;

Parameters

collectBribes

Collects bribes from bribe collector and distributes to wiBERA and iBGT Infrared vaults.

_token The payout token for the bribe collector.

_amount The amount of payout received from bribe collector.

Check against the whitelisted tokens so that we dont interact with non-whitelisted transfer method.

pass down the total list of _tokens and the whitelisted status of each token returning tokens and amounts harvested.

indexes should match for tokens,amounts, and whitelisted status.

function collectBribes(address _token, uint256 _amount)
    external
    onlyCollector;

harvestOperatorRewards

Credits all accumulated rewards to the operator

function harvestOperatorRewards() public whenNotPaused;

harvestBoostRewards

Claims all the BGT staker rewards from boosting validators.

Sends rewards to iBGT vault.

function harvestBoostRewards() external whenNotPaused;

addValidators

Adds validators to the set of InfraredValidators.

function addValidators(ValidatorTypes.Validator[] calldata _validators)
    external
    onlyGovernor;

Parameters

removeValidators

do not harvest if no validators in the system since Distributor::notifyRewardAmount will revert if there are rewards.

Removes validators from the set of InfraredValidators.

function removeValidators(bytes[] calldata _pubkeys) external onlyGovernor;

Parameters

replaceValidator

Replaces a validator in the set of InfraredValidators.

function replaceValidator(bytes calldata _current, bytes calldata _new)
    external
    onlyGovernor;

Parameters

queueNewCuttingBoard

Queues a new cutting board on BeraChef for reward weight distribution for validator

function queueNewCuttingBoard(
    bytes calldata _pubkey,
    uint64 _startBlock,
    IBeraChef.Weight[] calldata _weights
) external onlyKeeper;

Parameters

queueBoosts

Queue _amts of tokens to _validators for boosts.

function queueBoosts(bytes[] calldata _pubkeys, uint128[] calldata _amts)
    external
    onlyKeeper;

Parameters

cancelBoosts

Removes _amts from previously queued boosts to _validators.

_pubkeys need not be in the current validator set in case just removed but need to cancel.

function cancelBoosts(bytes[] calldata _pubkeys, uint128[] calldata _amts)
    external
    onlyKeeper;

Parameters

activateBoosts

Activates queued boosts for _pubkeys.

function activateBoosts(bytes[] calldata _pubkeys) external;

Parameters

queueDropBoosts

Queues a drop boost of the validators removing an amount of BGT for sender.

Reverts if user does not have enough boosted balance to cover amount.

function queueDropBoosts(bytes[] calldata _pubkeys, uint128[] calldata _amts)
    external
    onlyKeeper;

Parameters

cancelDropBoosts

Cancels a queued drop boost of the validator removing an amount of BGT for sender.

function cancelDropBoosts(bytes[] calldata _pubkeys, uint128[] calldata _amts)
    external
    onlyKeeper;

Parameters

dropBoosts

Drops an amount of BGT from an existing boost of validators by user.

function dropBoosts(bytes[] calldata _pubkeys) external;

Parameters

infraredValidators

Gets the set of infrared validator pubkeys.

function infraredValidators()
    public
    view
    virtual
    returns (ValidatorTypes.Validator[] memory validators);

Returns

numInfraredValidators

Gets the number of infrared validators in validator set.

function numInfraredValidators() external view returns (uint256);

Returns

isInfraredValidator

Checks if a validator is an infrared validator.

function isInfraredValidator(bytes calldata _pubkey)
    public
    view
    returns (bool);

Parameters

Returns

getBGTBalance

Gets the BGT balance for this contract

function getBGTBalance() public view returns (uint256);

Returns

whitelistedRewardTokens

Mapping of tokens that are whitelisted to be used as rewards or accepted as bribes

serves as central source of truth for whitelisted reward tokens for all Infrared contracts

function whitelistedRewardTokens(address token) public view returns (bool);

vaultRegistry

Mapping of staking token addresses to their corresponding InfraredVault

Each staking token can only have one vault

function vaultRegistry(address _stakingToken)
    public
    view
    returns (IInfraredVault vault);

rewardsDuration

The rewards duration

Used as gloabl variabel to set the rewards duration for all new reward tokens on InfraredVaults

function rewardsDuration() public view returns (uint256 duration);

Returns

fees

Protocol fee rates to charge for various harvest function distributions

function fees(uint256 t) public view override returns (uint256);

Parameters

Returns

protocolFeeAmounts

The unclaimed Infrared protocol fees of token accumulated by contract

function protocolFeeAmounts(address _token) external view returns (uint256);

Parameters

Returns

receive

receive() external payable;

InfraredV1_3

Git Source

Inherits: InfraredV1_2, IInfraredV1_3

Extension of V1.2 with validator commission management functionality

This upgrade adds support for queuing and activating validator commission changes

Functions

queueValCommission

Queues a commission rate change for a validator on incentive tokens.

Only the governor can call this function.

Reverts if a commission rate change is already queued.

function queueValCommission(bytes calldata _pubkey, uint96 _commissionRate)
    external
    onlyGovernor;

Parameters

_queueValCommission

function _queueValCommission(bytes calldata _pubkey, uint96 _commissionRate)
    internal;

queueMultipleValCommissions

Queues commission rate changes for multiple validators on incentive tokens.

Only the governor can call this function.

Reverts if any validator is invalid or if any have a commission rate change already queued.

function queueMultipleValCommissions(
    bytes[] calldata _pubkeys,
    uint96 _commissionRate
) external onlyGovernor;

Parameters

activateQueuedValCommission

Activates the queued commission rate of a validator on incentive tokens.

Anyone can call this function once the queued commission is ready.

function activateQueuedValCommission(bytes calldata _pubkey) external;

Parameters

InfraredV1_4

Git Source

Inherits: InfraredV1_3, IInfraredV1_4

Upgrade adds integration with BGTIncentiveDistributor for claiming booster rewards.

Implements IInfrared_V1_4, inheriting from InfraredV1_3. Maintains UUPS upgradeability. Uses potentially updated ValidatorManagerLib to allow external validator boosting via existing functions.

Functions

claimBGTIncentives

Claims BGT incentive rewards via BGTIncentiveDistributor.

Relays call for msg.sender. Distributor address is set once during initialization.

function claimBGTIncentives(IBGTIncentiveDistributor.Claim[] calldata _claims)
    external
    onlyKeeper;

Parameters

BribeCollector

Git Source

Inherits: InfraredUpgradeable, IBribeCollector

The Bribe Collector contract is responsible for collecting bribes from Berachain rewards vaults and auctioning them for a Payout token which then is distributed among Infrared validators.

This contract is forked from Berachain POL which is forked from Uniswap V3 Factory Owner contract. https://github.com/uniswapfoundation/UniStaker/blob/main/src/V3FactoryOwner.sol

State Variables

payoutToken

Payout token, required to be WBERA token as its unwrapped and used to compound rewards in the iBera system.

address public payoutToken;

payoutAmount

Payout amount is a constant value that is paid out the caller of the claimFees function.

uint256 public payoutAmount;

__gap

uint256[40] private __gap;

Functions

initialize

function initialize(
    address _infrared,
    address _gov,
    address _payoutToken,
    uint256 _payoutAmount
) external initializer;

setPayoutAmount

Set the payout token for the bribe collector.

Only callable by the governor and should be set to WBERA token since iBERA requires BERA to compound rewards.

function setPayoutAmount(uint256 _newPayoutAmount) external onlyGovernor;

claimFees

Claims accumulated bribes in exchange for payout token

Caller must approve payoutAmount of payout token to this contract.

function claimFees(
    address _recipient,
    address[] calldata _feeTokens,
    uint256[] calldata _feeAmounts
) external;

Parameters

Infrared

Git Source

Inherits: InfraredUpgradeable, IInfrared

Provides core functionalities for managing validators, vaults, and reward distribution in the Infrared protocol.

Serves as the main entry point for interacting with the Infrared protocol

The contract is upgradeable, ensuring flexibility for governance-led upgrades and chain compatibility.

State Variables

_bgt

The Canonical BGT token Contract

IBerachainBGT internal _bgt;

ibgt

The InfraredBGT liquid staked token

InfraredBGT public ibgt;

rewardsFactory

IBerachainRewardsVaultFactory instance of the rewards factory contract address

IBerachainRewardsVaultFactory public rewardsFactory;

chef

The Berachain chef contract for distributing validator rewards

IBeraChef public chef;

wbera

The WBERA token contract

IWBERA public wbera;

honey

The Honey token contract

ERC20 public honey;

collector

The Berachain Bribe Collector

IBribeCollector public collector;

distributor

The InfraredDistributor contract

IInfraredDistributor public distributor;

voter

The Infrared Voter contract

IVoter public voter;

ibera

iBera Contract Instance

IInfraredBERA public ibera;

ir

The Infrared Governance Token

IInfraredGovernanceToken public ir;

ibgtVault

The Infrared BGT Vault

IInfraredVault public ibgtVault;

VALIDATOR_STORAGE_LOCATION

Upgradeable ERC-7201 storage for Validator lib

keccak256(abi.encode(uint256(keccak256(bytes("infrared.validatorStorage"))) - 1)) & ~bytes32(uint256(0xff));

bytes32 public constant VALIDATOR_STORAGE_LOCATION =
    0x8ea5a3cc3b9a6be40b16189aeb1b6e6e61492e06efbfbe10619870b5bc1cc500;

VAULT_STORAGE_LOCATION

Upgradeable ERC-7201 storage for Vault lib

keccak256(abi.encode(uint256(keccak256(bytes("infrared.vaultStorage"))) - 1)) & ~bytes32(uint256(0xff));

bytes32 public constant VAULT_STORAGE_LOCATION =
    0x1bb2f1339407e6d63b93b8b490a9d43c5651f6fc4327c66addd5939450742a00;

REWARDS_STORAGE_LOCATION

Upgradeable ERC-7201 storage for Rewards lib

keccak256(abi.encode(uint256(keccak256(bytes("infrared.rewardsStorage"))) - 1)) & ~bytes32(uint256(0xff));

bytes32 public constant REWARDS_STORAGE_LOCATION =
    0xad12e6d08cc0150709acd6eed0bf697c60a83227922ab1d254d1ca4d3072ca00;

__gap

Reserve storage slots for future upgrades for safety

uint256[40] private __gap;

Functions

_validatorStorage

function _validatorStorage()
    internal
    pure
    returns (ValidatorManagerLib.ValidatorStorage storage vs);

Returns

_vaultStorage

function _vaultStorage()
    internal
    pure
    returns (VaultManagerLib.VaultStorage storage vs);

Returns

_rewardsStorage

function _rewardsStorage()
    internal
    pure
    returns (RewardsLib.RewardsStorage storage rs);

Returns

onlyCollector

Ensures that only the collector contract can call the function Reverts if the caller is not the collector

modifier onlyCollector();

initialize

function initialize(InitializationData calldata data) external initializer;

_validateInitializationData

function _validateInitializationData(InitializationData memory data)
    internal
    pure;

_initializeCoreContracts

function _initializeCoreContracts(InitializationData memory data) internal;

registerVault

Registers a new vault for a given asset

Infrared.sol must be admin over MINTER_ROLE on InfraredBGT to grant minter role to deployed vault

Note: emits: NewVault with the caller, asset address, and new vault address.

function registerVault(address _asset)
    external
    returns (IInfraredVault vault);

Parameters

Returns

setVaultRegistrationPauseStatus

Sets new vault registration paused or not

function setVaultRegistrationPauseStatus(bool pause) external onlyGovernor;

Parameters

addReward

Adds a new reward token to a specific staking vault

Only callable by governance when contract is initialized

Notes:

• error: ZeroAmount if _rewardsDuration is 0

• error: RewardTokenNotWhitelisted if _rewardsToken is not whitelisted

• error: NoRewardsVault if vault doesn't exist for _stakingToken

function addReward(
    address _stakingToken,
    address _rewardsToken,
    uint256 _rewardsDuration
) external onlyGovernor;

Parameters

removeReward

Removes a malicious or failing reward token from a staking vault

CAUTION: This is an emergency function that will result in loss of unclaimed rewards.

*Only callable by governance when:

1. The reward token is malfunctioning (e.g., transfers failing)
2. The reward token is malicious
3. The reward distribution needs to be forcefully terminated*

*Consequences:

• All unclaimed rewards will be permanently lost
• Users will not be able to claim outstanding rewards
• Remaining reward tokens will need to be recovered separately*

function removeReward(address _stakingToken, address _rewardsToken)
    external
    onlyGovernor;

Parameters

addIncentives

Adds reward incentives to a specific staking vault

Transfers reward tokens from caller to this contract, then notifies vault of new rewards

Notes:

• error: ZeroAmount if _amount is 0

• error: NoRewardsVault if vault doesn't exist for _stakingToken

• error: RewardTokenNotWhitelisted if reward token hasn't been configured for the vault

• access: Callable when contract is initialized

• security: Requires caller to have approved this contract to spend _rewardsToken

function addIncentives(
    address _stakingToken,
    address _rewardsToken,
    uint256 _amount
) external;

Parameters

updateWhiteListedRewardTokens

Updates the whitelist status of a reward token

function updateWhiteListedRewardTokens(address _token, bool _whitelisted)
    external
    onlyGovernor;

Parameters

updateRewardsDuration

Sets the new duration for reward distributions in InfraredVaults

Only callable by governance

function updateRewardsDuration(uint256 _rewardsDuration)
    external
    onlyGovernor;

Parameters

updateRewardsDurationForVault

Updates the rewards duration for a specific reward token on a specific vault

Only callable by governance

function updateRewardsDurationForVault(
    address _stakingToken,
    address _rewardsToken,
    uint256 _rewardsDuration
) external onlyGovernor;

Parameters

pauseStaking

Pauses staking functionality on a specific vault

Only callable by pauser, will revert if vault doesn't exist

function pauseStaking(address _asset) external onlyPauser;

Parameters

unpauseStaking

Un-pauses staking functionality on a specific vault

Only callable by gov, will revert if vault doesn't exist

function unpauseStaking(address _asset) external onlyGovernor;

Parameters

claimLostRewardsOnVault

Claims lost rewards on a specific vault

Only callable by governance, will revert if vault doesn't exist

function claimLostRewardsOnVault(address _asset) external onlyGovernor;

Parameters

recoverERC20

Recovers ERC20 tokens sent accidentally to the contract

function recoverERC20(address _to, address _token, uint256 _amount)
    external
    onlyGovernor;

Parameters

recoverERC20FromVault

Recover ERC20 tokens from a vault.

function recoverERC20FromVault(
    address _asset,
    address _to,
    address _token,
    uint256 _amount
) external onlyGovernor;

Parameters

delegateBGT

Delegates BGT votes to _delegatee address.

function delegateBGT(address _delegatee) external onlyGovernor;

Parameters

updateInfraredBERABribeSplit

Updates the weight for iBERA bribes

function updateInfraredBERABribeSplit(uint256 _weight) external onlyGovernor;

Parameters

updateFee

Updates the fee rate charged on different harvest functions

Please harvest all assosiated rewards for a given type before updating

Fee rate in units of 1e6 or hundredths of 1 bip

function updateFee(ConfigTypes.FeeType _t, uint256 _fee)
    external
    onlyGovernor;

Parameters

claimProtocolFees

Claims accumulated protocol fees in contract

function claimProtocolFees(address _to, address _token) external onlyGovernor;

Parameters

setIBGT

Sets the address of the iBGT contract

Infrared must be granted MINTER_ROLE on IBGT to set the address

function setIBGT(address _ibgt) external;

Parameters

setIR

Sets the address of the IR contract

Infrared must be granted MINTER_ROLE on IR to set the address

function setIR(address _ir) external onlyGovernor;

Parameters

setVoter

Sets the address of the Voter contract

function setVoter(address _voter) external onlyGovernor;

Parameters

updateIRMintRate

Updates the mint rate for IR

function updateIRMintRate(uint256 _irMintRate) external onlyGovernor;

Parameters

chargedFeesOnRewards

function chargedFeesOnRewards(
    uint256 _amt,
    uint256 _feeTotal,
    uint256 _feeProtocol
)
    public
    pure
    returns (uint256 amtRecipient, uint256 amtVoter, uint256 amtProtocol);

harvestBase

Claims all the BGT base and commission rewards minted to this contract for validators.

function harvestBase() public whenNotPaused;

harvestVault

Claims all the BGT rewards for the vault associated with the given staking token.

function harvestVault(address _asset) external whenNotPaused;

Parameters

harvestBribes

Claims all the bribes rewards in the contract forwarded from Berachain POL.

This should be called right before the collector claimFees function.

1. harvestBribes(), 2. collector.claimFees(), 3. collectBribes() (which handles the wBERA -> iBERA + fees distribution)

function harvestBribes(address[] calldata _tokens) external whenNotPaused;

Parameters

collectBribes

Collects bribes from bribe collector and distributes to wiBERA and iBGT Infrared vaults.

_token The payout token for the bribe collector.

_amount The amount of payout received from bribe collector.

Check against the whitelisted tokens so that we dont interact with non-whitelisted transfer method.

pass down the total list of _tokens and the whitelisted status of each token returning tokens and amounts harvested.

indexes should match for tokens,amounts, and whitelisted status.

function collectBribes(address _token, uint256 _amount)
    external
    onlyCollector;

harvestOperatorRewards

Credits all accumulated rewards to the operator

function harvestOperatorRewards() public whenNotPaused;

harvestBoostRewards

Claims all the BGT staker rewards from boosting validators.

Sends rewards to iBGT vault.

function harvestBoostRewards() external whenNotPaused;

addValidators

Adds validators to the set of InfraredValidators.

function addValidators(ValidatorTypes.Validator[] calldata _validators)
    external
    onlyGovernor;

Parameters

removeValidators

do not harvest if no validators in the system since Distributor::notifyRewardAmount will revert if there are rewards.

Removes validators from the set of InfraredValidators.

function removeValidators(bytes[] calldata _pubkeys) external onlyGovernor;

Parameters

replaceValidator

Replaces a validator in the set of InfraredValidators.

function replaceValidator(bytes calldata _current, bytes calldata _new)
    external
    onlyGovernor;

Parameters

queueNewCuttingBoard

Queues a new cutting board on BeraChef for reward weight distribution for validator

function queueNewCuttingBoard(
    bytes calldata _pubkey,
    uint64 _startBlock,
    IBeraChef.Weight[] calldata _weights
) external onlyKeeper;

Parameters

queueBoosts

Queue _amts of tokens to _validators for boosts.

function queueBoosts(bytes[] calldata _pubkeys, uint128[] calldata _amts)
    external
    onlyKeeper;

Parameters

cancelBoosts

Removes _amts from previously queued boosts to _validators.

_pubkeys need not be in the current validator set in case just removed but need to cancel.

function cancelBoosts(bytes[] calldata _pubkeys, uint128[] calldata _amts)
    external
    onlyKeeper;

Parameters

activateBoosts

Activates queued boosts for _pubkeys.

function activateBoosts(bytes[] calldata _pubkeys) external;

Parameters

queueDropBoosts

Queues a drop boost of the validators removing an amount of BGT for sender.

Reverts if user does not have enough boosted balance to cover amount.

function queueDropBoosts(bytes[] calldata _pubkeys, uint128[] calldata _amts)
    external
    onlyKeeper;

Parameters

cancelDropBoosts

Cancels a queued drop boost of the validator removing an amount of BGT for sender.

function cancelDropBoosts(bytes[] calldata _pubkeys, uint128[] calldata _amts)
    external
    onlyKeeper;

Parameters

dropBoosts

Drops an amount of BGT from an existing boost of validators by user.

function dropBoosts(bytes[] calldata _pubkeys) external;

Parameters

infraredValidators

Gets the set of infrared validator pubkeys.

function infraredValidators()
    public
    view
    virtual
    returns (ValidatorTypes.Validator[] memory validators);

Returns

numInfraredValidators

Gets the number of infrared validators in validator set.

function numInfraredValidators() external view returns (uint256);

Returns

isInfraredValidator

Checks if a validator is an infrared validator.

function isInfraredValidator(bytes calldata _pubkey)
    public
    view
    returns (bool);

Parameters

Returns

getBGTBalance

Gets the BGT balance for this contract

function getBGTBalance() public view returns (uint256);

Returns

whitelistedRewardTokens

Mapping of tokens that are whitelisted to be used as rewards or accepted as bribes

serves as central source of truth for whitelisted reward tokens for all Infrared contracts

function whitelistedRewardTokens(address token) public view returns (bool);

vaultRegistry

Mapping of staking token addresses to their corresponding InfraredVault

Each staking token can only have one vault

function vaultRegistry(address _stakingToken)
    public
    view
    returns (IInfraredVault vault);

rewardsDuration

The rewards duration

Used as gloabl variabel to set the rewards duration for all new reward tokens on InfraredVaults

function rewardsDuration() public view returns (uint256 duration);

Returns

fees

Protocol fee rates to charge for various harvest function distributions

function fees(uint256 t) public view override returns (uint256);

Parameters

Returns

protocolFeeAmounts

The unclaimed Infrared protocol fees of token accumulated by contract

function protocolFeeAmounts(address _token) external view returns (uint256);

Parameters

Returns

receive

receive() external payable;

Structs

InitializationData

struct InitializationData {
    address _gov;
    address _keeper;
    address __bgt;
    address _rewardsFactory;
    address _chef;
    address payable _wbera;
    address _honey;
    address _collector;
    address _distributor;
    address _voter;
    address _iBERA;
    uint256 _rewardsDuration;
}

InfraredBGT

Git Source

Inherits: ERC20PresetMinterPauser

This contract is the InfraredBGT token.

Functions

constructor

Constructor for InfraredBGT

constructor(address _admin, address _minter, address _pauser, address _burner)
    ERC20PresetMinterPauser(
        "Infrared BGT",
        "iBGT",
        _admin,
        _minter,
        _pauser,
        _burner
    );

Parameters

InfraredDistributor

Git Source

Inherits: InfraredUpgradeable, IInfraredDistributor

Distributes rewards to validators.

*Validator pubkeys are mapped to an EVM address and the pool of rewards from which they claim is porportional to the number of validators.

• for example, if there are 10 validators and 100 tokens are notified, each validator can claim 10 tokens.*

State Variables

token

Token used for reward distributions

ERC20 public token;

amountsCumulative

Tracks reward amount accumulation per validator

uint256 public amountsCumulative;

residualAmount

uint256 private residualAmount;

_snapshots

mapping(bytes32 pubkeyHash => Snapshot) internal _snapshots;

_validators

mapping(bytes32 pubkeyHash => address) internal _validators;

__gap

Reserve storage slots for future upgrades for safety

uint256[40] private __gap;

Functions

initialize

function initialize(address _infrared, address _gov, address _token)
    external
    initializer;

add

Register new validator for rewards

Only callable by Infrared contract

Notes:

• access-control: Requires INFRARED_ROLE

• error: ValidatorAlreadyExists if validator already registered

function add(bytes calldata pubkey, address validator) external onlyInfrared;

Parameters

remove

Removes validator from reward-eligible set

Only callable by Infrared contract

Note: access-control: Requires INFRARED_ROLE

function remove(bytes calldata pubkey) external onlyInfrared;

Parameters

purge

Purges validator from registry completely

Only possible after all rewards are claimed

Note: error: ClaimableRewardsExist if unclaimed rewards remain

function purge(bytes calldata pubkey) external onlyGovernor;

Parameters

notifyRewardAmount

Distributes new commission rewards to validator set

Note: error: ZeroAmount if amount is 0

function notifyRewardAmount(uint256 amount) external;

Parameters

claim

Claims outstanding commission rewards

Note: error: InvalidValidator if caller not authorized

function claim(bytes calldata pubkey, address recipient) external;

Parameters

getSnapshot

Get validator's reward snapshots

Returns (0,0) if validator doesn't exist

function getSnapshot(bytes calldata pubkey)
    external
    view
    returns (uint256 amountCumulativeLast, uint256 amountCumulativeFinal);

Parameters

Returns

getValidator

Get validator's registered claim address

function getValidator(bytes calldata pubkey) external view returns (address);

Parameters

Returns

InfraredGovernanceToken

Git Source

Inherits: ERC20PresetMinterPauser

This contract is the IR token.

State Variables

infrared

address public immutable infrared;

Functions

constructor

Construct the Infrared Governance Token contract

constructor(
    address _infrared,
    address _admin,
    address _minter,
    address _pauser,
    address _burner
)
    ERC20PresetMinterPauser(
        "Infrared Governance Token",
        "IR",
        _admin,
        _minter,
        _pauser,
        _burner
    );

Parameters

Errors

ZeroAddress

error ZeroAddress();

InfraredUpgradeable

Git Source

Inherits: Upgradeable

This contract provides base upgradeability functionality for Infrared.

State Variables

infrared

Infrared coordinator contract

IInfrared public infrared;

__gap

uint256[10] private __gap;

Functions

onlyInfrared

modifier onlyInfrared();

constructor

constructor();

__InfraredUpgradeable_init

function __InfraredUpgradeable_init(address _infrared)
    internal
    onlyInitializing;

InfraredVault

Git Source

Inherits: MultiRewards, IInfraredVault

This contract is the vault for staking tokens, and receiving rewards from the Proof of Liquidity protocol.

This contract uses the MultiRewards contract to distribute rewards to vault stakers, this is taken from curve.fi. (inspired by Synthetix).

Does not support staking tokens with non-standard ERC20 transfer tax behavior.

State Variables

MAX_NUM_REWARD_TOKENS

Maximum number of reward tokens that can be supported

Limited to prevent gas issues with reward calculations

uint256 public constant MAX_NUM_REWARD_TOKENS = 10;

infrared

The infrared contract address acts a vault factory and coordinator

address public immutable infrared;

rewardsVault

IBerachainRewardsVault public immutable rewardsVault;

Functions

onlyInfrared

Modifier to check that the caller is infrared contract

modifier onlyInfrared();

constructor

constructor(address _stakingToken, uint256 _rewardsDuration)
    MultiRewards(_stakingToken);

_createRewardsVaultIfNecessary

Gets or creates the berachain rewards vault for given staking token

function _createRewardsVaultIfNecessary(
    address _infrared,
    address _stakingToken
) private returns (IBerachainRewardsVault);

Parameters

Returns

onStake

Transfers to berachain low level module on staking of LP tokens with the vault after transferring tokens in

function onStake(uint256 amount) internal override;

Parameters

onWithdraw

Redeems from berachain low level module on withdraw of LP tokens from the vault before transferring tokens out

function onWithdraw(uint256 amount) internal override;

Parameters

onReward

hook called after the reward is claimed to harvest the rewards from the berachain rewards vault

function onReward() internal override;

updateRewardsDuration

Updates reward duration for a specific reward token

Only callable by Infrared contract

Note: access-control: Requires INFRARED_ROLE

function updateRewardsDuration(address _rewardsToken, uint256 _rewardsDuration)
    external
    onlyInfrared;

Parameters

unpauseStaking

Un-pauses staking functionality on a specific vault

Note: access-control: Requires INFRARED_ROLE

function unpauseStaking() external onlyInfrared;

pauseStaking

Pauses staking functionality on a specific vault

Note: access-control: Requires INFRARED_ROLE

function pauseStaking() external onlyInfrared;

addReward

Adds a new reward token to the vault

Cannot exceed maximum number of reward tokens

Note: access-control: Requires INFRARED_ROLE

function addReward(address _rewardsToken, uint256 _rewardsDuration)
    external
    onlyInfrared;

Parameters

removeReward

Used to remove malicious or unused reward tokens

Note: access-control: Requires INFRARED_ROLE

function removeReward(address _rewardsToken) external onlyInfrared;

Parameters

notifyRewardAmount

Notifies the vault of newly added rewards

Updates internal reward rate calculations

function notifyRewardAmount(address _rewardToken, uint256 _reward)
    external
    onlyInfrared;

Parameters

recoverERC20

Recovers accidentally sent tokens

Cannot recover staking token or active reward tokens

function recoverERC20(address _to, address _token, uint256 _amount)
    external
    onlyInfrared;

Parameters

getAllRewardTokens

Returns all reward tokens

function getAllRewardTokens() external view returns (address[] memory);

Returns

getAllRewardsForUser

Returns all rewards for a user

function getAllRewardsForUser(address _user)
    external
    view
    returns (UserReward[] memory);

Parameters

Returns

MultiRewards

Git Source

Inherits: ReentrancyGuard, Pausable, IMultiRewards

Fork of https://github.com/curvefi/multi-rewards with hooks on stake/withdraw of LP tokens

State Variables

stakingToken

The token that users stake to earn rewards

This is the base token that users deposit into the contract

ERC20 public immutable stakingToken;

rewardData

Stores reward-related data for each reward token

Maps reward token addresses to their Reward struct containing distribution parameters

mapping(address => Reward) public override rewardData;

rewardTokens

Array of all reward token addresses

Used to iterate through all reward tokens when updating or claiming rewards

address[] public rewardTokens;

userRewardPerTokenPaid

Tracks the reward per token paid to each user for each reward token

Maps user address to reward token address to amount already paid Used to calculate new rewards since last claim

mapping(address => mapping(address => uint256)) public userRewardPerTokenPaid;

rewards

Tracks the unclaimed rewards for each user for each reward token

Maps user address to reward token address to unclaimed amount

mapping(address => mapping(address => uint256)) public rewards;

_totalSupply

The total amount of staking tokens in the contract

Used to calculate rewards per token

uint256 internal _totalSupply;

_balances

Maps user addresses to their staked token balance

Internal mapping used to track individual stake amounts

mapping(address => uint256) internal _balances;

Functions

updateReward

Updates the reward for the given account before executing the function body.

modifier updateReward(address account);

Parameters

constructor

Constructs the MultiRewards contract.

constructor(address _stakingToken);

Parameters

totalSupply

Returns the total amount of staked tokens in the contract

function totalSupply() external view returns (uint256);

Returns

balanceOf

Returns the balance of staked tokens for the given account

function balanceOf(address account) external view returns (uint256 _balance);

Parameters

Returns

lastTimeRewardApplicable

Calculates the last time reward is applicable for a given rewards token

function lastTimeRewardApplicable(address _rewardsToken)
    public
    view
    returns (uint256);

Parameters

Returns

rewardPerToken

Calculates the reward per token for a given rewards token

function rewardPerToken(address _rewardsToken) public view returns (uint256);

Parameters

Returns

earned

Calculates the earned rewards for a given account and rewards token

function earned(address account, address _rewardsToken)
    public
    view
    returns (uint256);

Parameters

Returns

getRewardForDuration

Calculates the total reward for the duration of a given rewards token

function getRewardForDuration(address _rewardsToken)
    external
    view
    returns (uint256);

Parameters

Returns

stake

Stakes tokens into the contract

Transfers amount of staking tokens from the user to this contract

function stake(uint256 amount)
    external
    nonReentrant
    whenNotPaused
    updateReward(msg.sender);

Parameters

onStake

Hook called in the stake function after transfering staking token in

function onStake(uint256 amount) internal virtual;

Parameters

withdraw

Withdraws staked tokens from the contract

Transfers amount of staking tokens back to the user

function withdraw(uint256 amount)
    public
    nonReentrant
    updateReward(msg.sender);

Parameters

onWithdraw

Hook called in withdraw function before transferring staking token out

function onWithdraw(uint256 amount) internal virtual;

Parameters

getRewardForUser

Claims all pending rewards for a specified user

Iterates through all reward tokens and transfers any accrued rewards to the user

function getRewardForUser(address _user)
    public
    nonReentrant
    updateReward(_user);

Parameters

onReward

Hook called in getRewardForUser function

function onReward() internal virtual;

getReward

Claims all pending rewards for the caller

Transfers all accrued rewards to the caller

function getReward() public;

exit

Withdraws all staked tokens and claims pending rewards

Combines withdraw and getReward operations

function exit() external;

_addReward

Adds a reward token to the contract.

function _addReward(
    address _rewardsToken,
    address _rewardsDistributor,
    uint256 _rewardsDuration
) internal;

Parameters

_removeReward

Removes a reward token from the contract.

function _removeReward(address _rewardsToken) internal;

Parameters

_notifyRewardAmount

Notifies the contract that reward tokens is being sent to the contract.

function _notifyRewardAmount(address _rewardsToken, uint256 reward)
    internal
    updateReward(address(0));

Parameters

_recoverERC20

Recovers ERC20 tokens sent to the contract.

Added to support recovering LP Rewards from other systems such as BAL to be distributed to holders

function _recoverERC20(address to, address tokenAddress, uint256 tokenAmount)
    internal;

Parameters

_setRewardsDuration

Updates the reward duration for a reward token.

function _setRewardsDuration(address _rewardsToken, uint256 _rewardsDuration)
    internal;

Parameters

WrappedVault

Git Source

Inherits: ERC4626

A wrapper vault built on ERC4626 to facilitate staking operations and reward distribution through the Infrared protocol. Each staking token has a corresponding wrapped vault.

deploy 1 wrapped vault per staking token

State Variables

rewardDistributor

Address of the reward distributor, typically a multisig.

address public immutable rewardDistributor;

iVault

Instance of the associated InfraredVault for staking.

InfraredVault public immutable iVault;

deadShares

Inflation attack prevention

uint256 internal constant deadShares = 1e3;

Functions

constructor

Initializes a new WrappedVault contract for a specific staking token.

constructor(
    address _rewardDistributor,
    address _infrared,
    address _stakingToken,
    string memory _name,
    string memory _symbol
) ERC4626(ERC20(_stakingToken), _name, _symbol);

Parameters

totalAssets

Returns the total assets managed by the wrapped vault.

Overrides the ERC4626 totalAssets function to integrate with the InfraredVault balance.

function totalAssets() public view virtual override returns (uint256);

Returns

beforeWithdraw

Hook called before withdrawal operations.

This function ensures that the requested amount of staking tokens is withdrawn from the InfraredVault before being transferred to the user.

function beforeWithdraw(uint256 assets, uint256) internal virtual override;

Parameters

afterDeposit

Hook called after deposit operations.

This function stakes the deposited tokens into the InfraredVault.

function afterDeposit(uint256 assets, uint256) internal virtual override;

Parameters

claimRewards

Claims rewards from the InfraredVault and transfers them to the reward distributor.

Only rewards other than the staking token itself are transferred.

function claimRewards() external;

Events

RewardClaimed

Event emitted when reward tokens claimed

event RewardClaimed(address indexed token, uint256 amount);

Contents

• upgrades
• IBerachainBGT
• IBerachainBGTStaker
• IBribeCollector
• IERC20Mintable
• IInfrared
• IInfraredBERA
• IInfraredBERAClaimor
• IInfraredBERADepositor
• IInfraredBERAFeeReceivor
• IInfraredBERAWithdrawor
• IInfraredBGT
• IInfraredDistributor
• IInfraredGovernanceToken
• IInfraredUpgradeable
• IInfraredVault
• IMultiRewards
• IRED
• IWBERA

Contents

• IInfraredV1_2
• IInfraredV1_3
• IInfraredV1_4

IInfraredV1_2

Git Source

Functions

whitelistedRewardTokens

Checks if a token is a whitelisted reward token

function whitelistedRewardTokens(address _token) external view returns (bool);

Parameters

Returns

vaultRegistry

Returns the infrared vault address for a given staking token

function vaultRegistry(address _asset) external view returns (IInfraredVault);

Parameters

Returns

ibgt

The InfraredBGT liquid staked token

function ibgt() external view returns (InfraredBGT);

Returns

rewardsFactory

The Berachain rewards vault factory address

function rewardsFactory()
    external
    view
    returns (IBerachainRewardsVaultFactory);

Returns

chef

The Berachain chef contract for distributing validator rewards

function chef() external view returns (IBeraChef);

Returns

ibgtVault

The InfraredBGT vault

function ibgtVault() external view returns (IInfraredVault);

Returns

protocolFeeAmounts

The unclaimed Infrared protocol fees of token accumulated by contract

function protocolFeeAmounts(address token) external view returns (uint256);

Parameters

Returns

fees

Protocol fee rates to charge for various harvest function distributions

function fees(uint256 i) external view returns (uint256);

Parameters

Returns

wbera

Wrapped bera

function wbera() external view returns (IWBERA);

Returns

honey

Honey ERC20 token

function honey() external view returns (ERC20);

Returns

collector

bribe collector contract

function collector() external view returns (IBribeCollector);

Returns

distributor

Infrared distributor for BGT rewards to validators

function distributor() external view returns (IInfraredDistributor);

Returns

voter

IR voter

function voter() external view returns (IVoter);

Returns

ibera

collects all iBERA realted fees and revenue

function ibera() external view returns (IInfraredBERA);

Returns

ir

The IR token

function ir() external view returns (IInfraredGovernanceToken);

Returns

rewardsDuration

The rewards duration

Used as gloabl variabel to set the rewards duration for all new reward tokens on InfraredVaults

function rewardsDuration() external view returns (uint256);

Returns

registerVault

Registers a new vault for a given asset

Infrared.sol must be admin over MINTER_ROLE on InfraredBGT to grant minter role to deployed vault

Note: emits: NewVault with the caller, asset address, and new vault address.

function registerVault(address _asset)
    external
    returns (IInfraredVault vault);

Parameters

Returns

addReward

Adds a new reward token to a specific staking vault

Only callable by governance when contract is initialized

Notes:

• error: ZeroAmount if _rewardsDuration is 0

• error: RewardTokenNotWhitelisted if _rewardsToken is not whitelisted

• error: NoRewardsVault if vault doesn't exist for _stakingToken

function addReward(
    address _stakingToken,
    address _rewardsToken,
    uint256 _rewardsDuration
) external;

Parameters

addIncentives

Adds reward incentives to a specific staking vault

Transfers reward tokens from caller to this contract, then notifies vault of new rewards

Notes:

• error: ZeroAmount if _amount is 0

• error: NoRewardsVault if vault doesn't exist for _stakingToken

• error: RewardTokenNotWhitelisted if reward token hasn't been configured for the vault

• access: Callable when contract is initialized

• security: Requires caller to have approved this contract to spend _rewardsToken

function addIncentives(
    address _stakingToken,
    address _rewardsToken,
    uint256 _amount
) external;

Parameters

updateWhiteListedRewardTokens

Updates the whitelist status of a reward token

function updateWhiteListedRewardTokens(address _token, bool _whitelisted)
    external;

Parameters

updateRewardsDuration

Sets the new duration for reward distributions in InfraredVaults

Only callable by governance

function updateRewardsDuration(uint256 _rewardsDuration) external;

Parameters

updateRewardsDurationForVault

Updates the rewards duration for a specific reward token on a specific vault

Only callable by governance

function updateRewardsDurationForVault(
    address _stakingToken,
    address _rewardsToken,
    uint256 _rewardsDuration
) external;

Parameters

pauseStaking

Pauses staking functionality on a specific vault

Only callable by pauser or governance, will revert if vault doesn't exist

function pauseStaking(address _asset) external;

Parameters

unpauseStaking

Un-pauses staking functionality on a specific vault

Only callable by gov, will revert if vault doesn't exist

function unpauseStaking(address _asset) external;

Parameters

claimLostRewardsOnVault

Claims lost rewards on a specific vault

Only callable by governance, will revert if vault doesn't exist

function claimLostRewardsOnVault(address _asset) external;

Parameters

recoverERC20

Recovers ERC20 tokens sent accidentally to the contract

function recoverERC20(address _to, address _token, uint256 _amount) external;

Parameters

recoverERC20FromVault

Recover ERC20 tokens from a vault.

function recoverERC20FromVault(
    address _asset,
    address _to,
    address _token,
    uint256 _amount
) external;

Parameters

delegateBGT

Delegates BGT votes to _delegatee address.

function delegateBGT(address _delegatee) external;

Parameters

updateInfraredBERABribeSplit

Updates the weight for iBERA bribes

function updateInfraredBERABribeSplit(uint256 _weight) external;

Parameters

updateFee

Updates the fee rate charged on different harvest functions

Please harvest all assosiated rewards for a given type before updating

Fee rate in units of 1e6 or hundredths of 1 bip

function updateFee(ConfigTypes.FeeType _t, uint256 _fee) external;

Parameters

setIR

Sets the address of the IR contract

Infrared must be granted MINTER_ROLE on IR to set the address

function setIR(address _IR) external;

Parameters

updateIRMintRate

Updates the mint rate for IR

function updateIRMintRate(uint256 _IRMintRate) external;

Parameters

claimProtocolFees

Claims accumulated protocol fees in contract

function claimProtocolFees(address _to, address _token) external;

Parameters

harvestBase

Claims all the BGT base and commission rewards minted to this contract for validators.

function harvestBase() external;

harvestOperatorRewards

Credits all accumulated rewards to the operator

function harvestOperatorRewards() external;

harvestVault

Claims all the BGT rewards for the vault associated with the given staking token.

function harvestVault(address _asset) external;

Parameters

harvestBribes

Claims all the bribes rewards in the contract forwarded from Berachain POL.

function harvestBribes(address[] memory _tokens) external;

Parameters

collectBribes

Collects bribes from bribe collector and distributes to wiBERA and iBGT Infrared vaults.

_token The payout token for the bribe collector.

_amount The amount of payout received from bribe collector.

function collectBribes(address _token, uint256 _amount) external;

harvestBoostRewards

Claims all the BGT staker rewards from boosting validators.

Sends rewards to iBGT vault.

function harvestBoostRewards() external;

addValidators

Adds validators to the set of InfraredValidators.

function addValidators(ValidatorTypes.Validator[] memory _validators)
    external;

Parameters

removeValidators

Removes validators from the set of InfraredValidators.

function removeValidators(bytes[] memory _pubkeys) external;

Parameters

replaceValidator

Replaces a validator in the set of InfraredValidators.

function replaceValidator(bytes calldata _current, bytes calldata _new)
    external;

Parameters

queueBoosts

Queue _amts of tokens to _validators for boosts.

function queueBoosts(bytes[] memory _pubkeys, uint128[] memory _amts)
    external;

Parameters

cancelBoosts

Removes _amts from previously queued boosts to _validators.

_pubkeys need not be in the current validator set in case just removed but need to cancel.

function cancelBoosts(bytes[] memory _pubkeys, uint128[] memory _amts)
    external;

Parameters

activateBoosts

Activates queued boosts for _pubkeys.

function activateBoosts(bytes[] memory _pubkeys) external;

Parameters

queueDropBoosts

Queues a drop boost of the validators removing an amount of BGT for sender.

Reverts if user does not have enough boosted balance to cover amount.

function queueDropBoosts(bytes[] calldata pubkeys, uint128[] calldata amounts)
    external;

Parameters