epoch_rewards

Documentation

Overview

Copyright 2017 The Celo Authors This file is part of the celo library.

The celo library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The celo library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the celo library. If not, see <http://www.gnu.org/licenses/>.

Index

• func CalculateTargetEpochRewards(vmRunner vm.EVMRunner) (*big.Int, *big.Int, *big.Int, *big.Int, error)
• func GetCarbonOffsettingPartnerAddress(vmRunner vm.EVMRunner) (common.Address, error)
• func IsReserveLow(vmRunner vm.EVMRunner) (bool, error)
• func UpdateTargetVotingYield(vmRunner vm.EVMRunner) error

Functions

func CalculateTargetEpochRewards

func CalculateTargetEpochRewards(vmRunner vm.EVMRunner) (*big.Int, *big.Int, *big.Int, *big.Int, error)

Returns the per validator epoch reward, the total voter reward, the total community reward, and the total carbon offsetting partner award, for the epoch.

func GetCarbonOffsettingPartnerAddress

func GetCarbonOffsettingPartnerAddress(vmRunner vm.EVMRunner) (common.Address, error)

Returns the address of the carbon offsetting partner

func IsReserveLow

func IsReserveLow(vmRunner vm.EVMRunner) (bool, error)

Determines if the reserve is below it's critical threshold

func UpdateTargetVotingYield

func UpdateTargetVotingYield(vmRunner vm.EVMRunner) error