mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-12-29 09:45:18 +00:00
364 lines
11 KiB
Go
364 lines
11 KiB
Go
package keeper
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"sort"
|
|
"time"
|
|
|
|
sdkmath "cosmossdk.io/math"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
|
|
earntypes "github.com/0glabs/0g-chain/x/earn/types"
|
|
"github.com/0glabs/0g-chain/x/incentive/types"
|
|
|
|
distrtypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
|
|
)
|
|
|
|
// AccumulateEarnRewards calculates new rewards to distribute this block and updates the global indexes to reflect this.
|
|
// The provided rewardPeriod must be valid to avoid panics in calculating time durations.
|
|
func (k Keeper) AccumulateEarnRewards(ctx sdk.Context, rewardPeriod types.MultiRewardPeriod) error {
|
|
if rewardPeriod.CollateralType == "bkava" {
|
|
return k.accumulateEarnBkavaRewards(ctx, rewardPeriod)
|
|
}
|
|
|
|
k.accumulateEarnRewards(
|
|
ctx,
|
|
rewardPeriod.CollateralType,
|
|
rewardPeriod.Start,
|
|
rewardPeriod.End,
|
|
sdk.NewDecCoinsFromCoins(rewardPeriod.RewardsPerSecond...),
|
|
)
|
|
|
|
return nil
|
|
}
|
|
|
|
func GetProportionalRewardsPerSecond(
|
|
rewardPeriod types.MultiRewardPeriod,
|
|
totalBkavaSupply sdkmath.Int,
|
|
singleBkavaSupply sdkmath.Int,
|
|
) sdk.DecCoins {
|
|
// Rate per bkava-xxx = rewardsPerSecond * % of bkava-xxx
|
|
// = rewardsPerSecond * (bkava-xxx / total bkava)
|
|
// = (rewardsPerSecond * bkava-xxx) / total bkava
|
|
|
|
newRate := sdk.NewDecCoins()
|
|
|
|
// Prevent division by zero, if there are no total shares then there are no
|
|
// rewards.
|
|
if totalBkavaSupply.IsZero() {
|
|
return newRate
|
|
}
|
|
|
|
for _, rewardCoin := range rewardPeriod.RewardsPerSecond {
|
|
scaledAmount := sdk.NewDecFromInt(rewardCoin.Amount).
|
|
Mul(sdk.NewDecFromInt(singleBkavaSupply)).
|
|
Quo(sdk.NewDecFromInt(totalBkavaSupply))
|
|
|
|
newRate = newRate.Add(sdk.NewDecCoinFromDec(rewardCoin.Denom, scaledAmount))
|
|
}
|
|
|
|
return newRate
|
|
}
|
|
|
|
// accumulateEarnBkavaRewards does the same as AccumulateEarnRewards but for
|
|
// *all* bkava vaults.
|
|
func (k Keeper) accumulateEarnBkavaRewards(ctx sdk.Context, rewardPeriod types.MultiRewardPeriod) error {
|
|
// All bkava vault denoms
|
|
bkavaVaultsDenoms := make(map[string]bool)
|
|
|
|
// bkava vault denoms from earn records (non-empty vaults)
|
|
k.earnKeeper.IterateVaultRecords(ctx, func(record earntypes.VaultRecord) (stop bool) {
|
|
if k.liquidKeeper.IsDerivativeDenom(ctx, record.TotalShares.Denom) {
|
|
bkavaVaultsDenoms[record.TotalShares.Denom] = true
|
|
}
|
|
|
|
return false
|
|
})
|
|
|
|
// bkava vault denoms from past incentive indexes, may include vaults
|
|
// that were fully withdrawn.
|
|
k.IterateEarnRewardIndexes(ctx, func(vaultDenom string, indexes types.RewardIndexes) (stop bool) {
|
|
if k.liquidKeeper.IsDerivativeDenom(ctx, vaultDenom) {
|
|
bkavaVaultsDenoms[vaultDenom] = true
|
|
}
|
|
|
|
return false
|
|
})
|
|
|
|
totalBkavaValue, err := k.liquidKeeper.GetTotalDerivativeValue(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
i := 0
|
|
sortedBkavaVaultsDenoms := make([]string, len(bkavaVaultsDenoms))
|
|
for vaultDenom := range bkavaVaultsDenoms {
|
|
sortedBkavaVaultsDenoms[i] = vaultDenom
|
|
i++
|
|
}
|
|
|
|
// Sort the vault denoms to ensure deterministic iteration order.
|
|
sort.Strings(sortedBkavaVaultsDenoms)
|
|
|
|
// Accumulate rewards for each bkava vault.
|
|
for _, bkavaDenom := range sortedBkavaVaultsDenoms {
|
|
derivativeValue, err := k.liquidKeeper.GetDerivativeValue(ctx, bkavaDenom)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
k.accumulateBkavaEarnRewards(
|
|
ctx,
|
|
bkavaDenom,
|
|
rewardPeriod.Start,
|
|
rewardPeriod.End,
|
|
GetProportionalRewardsPerSecond(
|
|
rewardPeriod,
|
|
totalBkavaValue.Amount,
|
|
derivativeValue.Amount,
|
|
),
|
|
)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (k Keeper) accumulateBkavaEarnRewards(
|
|
ctx sdk.Context,
|
|
collateralType string,
|
|
periodStart time.Time,
|
|
periodEnd time.Time,
|
|
periodRewardsPerSecond sdk.DecCoins,
|
|
) {
|
|
// Collect staking rewards for this validator, does not have any start/end
|
|
// period time restrictions.
|
|
stakingRewards := k.collectDerivativeStakingRewards(ctx, collateralType)
|
|
|
|
// Collect incentive rewards
|
|
// **Total rewards** for vault per second, NOT per share
|
|
perSecondRewards := k.collectPerSecondRewards(
|
|
ctx,
|
|
collateralType,
|
|
periodStart,
|
|
periodEnd,
|
|
periodRewardsPerSecond,
|
|
)
|
|
|
|
// **Total rewards** for vault per second, NOT per share
|
|
rewards := stakingRewards.Add(perSecondRewards...)
|
|
|
|
// Distribute rewards by incrementing indexes
|
|
indexes, found := k.GetEarnRewardIndexes(ctx, collateralType)
|
|
if !found {
|
|
indexes = types.RewardIndexes{}
|
|
}
|
|
|
|
totalSourceShares := k.getEarnTotalSourceShares(ctx, collateralType)
|
|
var increment types.RewardIndexes
|
|
if totalSourceShares.GT(sdk.ZeroDec()) {
|
|
// Divide total rewards by total shares to get the reward **per share**
|
|
// Leave as nil if no source shares
|
|
increment = types.NewRewardIndexesFromCoins(rewards).Quo(totalSourceShares)
|
|
}
|
|
updatedIndexes := indexes.Add(increment)
|
|
|
|
if len(updatedIndexes) > 0 {
|
|
// the store panics when setting empty or nil indexes
|
|
k.SetEarnRewardIndexes(ctx, collateralType, updatedIndexes)
|
|
}
|
|
}
|
|
|
|
func (k Keeper) collectDerivativeStakingRewards(ctx sdk.Context, collateralType string) sdk.DecCoins {
|
|
rewards, err := k.liquidKeeper.CollectStakingRewardsByDenom(ctx, collateralType, types.IncentiveMacc)
|
|
if err != nil {
|
|
if !errors.Is(err, distrtypes.ErrNoValidatorDistInfo) &&
|
|
!errors.Is(err, distrtypes.ErrEmptyDelegationDistInfo) {
|
|
panic(fmt.Sprintf("failed to collect staking rewards for %s: %s", collateralType, err))
|
|
}
|
|
|
|
// otherwise there's no validator or delegation yet
|
|
rewards = nil
|
|
}
|
|
|
|
// Bug with NewDecCoinsFromCoins when calling passing 0 amount Coin, see
|
|
// https://github.com/cosmos/cosmos-sdk/pull/12903
|
|
// Fix is in Cosmos-SDK v0.47.0
|
|
var decCoins sdk.DecCoins
|
|
for _, coin := range rewards {
|
|
if coin.IsValid() {
|
|
decCoins = append(decCoins, sdk.NewDecCoinFromCoin(coin))
|
|
}
|
|
}
|
|
|
|
return decCoins
|
|
}
|
|
|
|
func (k Keeper) collectPerSecondRewards(
|
|
ctx sdk.Context,
|
|
collateralType string,
|
|
periodStart time.Time,
|
|
periodEnd time.Time,
|
|
periodRewardsPerSecond sdk.DecCoins,
|
|
) sdk.DecCoins {
|
|
previousAccrualTime, found := k.GetEarnRewardAccrualTime(ctx, collateralType)
|
|
if !found {
|
|
previousAccrualTime = ctx.BlockTime()
|
|
}
|
|
|
|
rewards, accumulatedTo := types.CalculatePerSecondRewards(
|
|
periodStart,
|
|
periodEnd,
|
|
periodRewardsPerSecond,
|
|
previousAccrualTime,
|
|
ctx.BlockTime(),
|
|
)
|
|
|
|
k.SetEarnRewardAccrualTime(ctx, collateralType, accumulatedTo)
|
|
|
|
// Don't need to move funds as they're assumed to be in the IncentiveMacc module account already.
|
|
return rewards
|
|
}
|
|
|
|
func (k Keeper) accumulateEarnRewards(
|
|
ctx sdk.Context,
|
|
collateralType string,
|
|
periodStart time.Time,
|
|
periodEnd time.Time,
|
|
periodRewardsPerSecond sdk.DecCoins,
|
|
) {
|
|
previousAccrualTime, found := k.GetEarnRewardAccrualTime(ctx, collateralType)
|
|
if !found {
|
|
previousAccrualTime = ctx.BlockTime()
|
|
}
|
|
|
|
indexes, found := k.GetEarnRewardIndexes(ctx, collateralType)
|
|
if !found {
|
|
indexes = types.RewardIndexes{}
|
|
}
|
|
|
|
acc := types.NewAccumulator(previousAccrualTime, indexes)
|
|
|
|
totalSourceShares := k.getEarnTotalSourceShares(ctx, collateralType)
|
|
|
|
acc.AccumulateDecCoins(
|
|
periodStart,
|
|
periodEnd,
|
|
periodRewardsPerSecond,
|
|
totalSourceShares,
|
|
ctx.BlockTime(),
|
|
)
|
|
|
|
k.SetEarnRewardAccrualTime(ctx, collateralType, acc.PreviousAccumulationTime)
|
|
if len(acc.Indexes) > 0 {
|
|
// the store panics when setting empty or nil indexes
|
|
k.SetEarnRewardIndexes(ctx, collateralType, acc.Indexes)
|
|
}
|
|
}
|
|
|
|
// getEarnTotalSourceShares fetches the sum of all source shares for a earn reward.
|
|
// In the case of earn, these are the total (earn module) shares in a particular vault.
|
|
func (k Keeper) getEarnTotalSourceShares(ctx sdk.Context, vaultDenom string) sdk.Dec {
|
|
totalShares, found := k.earnKeeper.GetVaultTotalShares(ctx, vaultDenom)
|
|
if !found {
|
|
return sdk.ZeroDec()
|
|
}
|
|
return totalShares.Amount
|
|
}
|
|
|
|
// InitializeEarnReward creates a new claim with zero rewards and indexes matching the global indexes.
|
|
// If the claim already exists it just updates the indexes.
|
|
func (k Keeper) InitializeEarnReward(ctx sdk.Context, vaultDenom string, owner sdk.AccAddress) {
|
|
claim, found := k.GetEarnClaim(ctx, owner)
|
|
if !found {
|
|
claim = types.NewEarnClaim(owner, sdk.Coins{}, nil)
|
|
}
|
|
|
|
globalRewardIndexes, found := k.GetEarnRewardIndexes(ctx, vaultDenom)
|
|
if !found {
|
|
globalRewardIndexes = types.RewardIndexes{}
|
|
}
|
|
claim.RewardIndexes = claim.RewardIndexes.With(vaultDenom, globalRewardIndexes)
|
|
|
|
k.SetEarnClaim(ctx, claim)
|
|
}
|
|
|
|
// SynchronizeEarnReward updates the claim object by adding any accumulated rewards
|
|
// and updating the reward index value.
|
|
func (k Keeper) SynchronizeEarnReward(
|
|
ctx sdk.Context,
|
|
vaultDenom string,
|
|
owner sdk.AccAddress,
|
|
shares sdk.Dec,
|
|
) {
|
|
claim, found := k.GetEarnClaim(ctx, owner)
|
|
if !found {
|
|
return
|
|
}
|
|
claim = k.synchronizeEarnReward(ctx, claim, vaultDenom, owner, shares)
|
|
|
|
k.SetEarnClaim(ctx, claim)
|
|
}
|
|
|
|
// synchronizeEarnReward updates the reward and indexes in a earn claim for one vault.
|
|
func (k *Keeper) synchronizeEarnReward(
|
|
ctx sdk.Context,
|
|
claim types.EarnClaim,
|
|
vaultDenom string,
|
|
owner sdk.AccAddress,
|
|
shares sdk.Dec,
|
|
) types.EarnClaim {
|
|
globalRewardIndexes, found := k.GetEarnRewardIndexes(ctx, vaultDenom)
|
|
if !found {
|
|
// The global factor is only not found if
|
|
// - the vault has not started accumulating rewards yet (either there is no reward specified in params, or the reward start time hasn't been hit)
|
|
// - OR it was wrongly deleted from state (factors should never be removed while unsynced claims exist)
|
|
// If not found we could either skip this sync, or assume the global factor is zero.
|
|
// Skipping will avoid storing unnecessary factors in the claim for non rewarded vaults.
|
|
// And in the event a global factor is wrongly deleted, it will avoid this function panicking when calculating rewards.
|
|
return claim
|
|
}
|
|
|
|
userRewardIndexes, found := claim.RewardIndexes.Get(vaultDenom)
|
|
if !found {
|
|
// Normally the reward indexes should always be found.
|
|
// But if a vault was not rewarded then becomes rewarded (ie a reward period is added to params), then the indexes will be missing from claims for that vault.
|
|
// So given the reward period was just added, assume the starting value for any global reward indexes, which is an empty slice.
|
|
userRewardIndexes = types.RewardIndexes{}
|
|
}
|
|
|
|
newRewards, err := k.CalculateRewards(userRewardIndexes, globalRewardIndexes, shares)
|
|
if err != nil {
|
|
// Global reward factors should never decrease, as it would lead to a negative update to claim.Rewards.
|
|
// This panics if a global reward factor decreases or disappears between the old and new indexes.
|
|
panic(fmt.Sprintf("corrupted global reward indexes found: %v", err))
|
|
}
|
|
|
|
claim.Reward = claim.Reward.Add(newRewards...)
|
|
claim.RewardIndexes = claim.RewardIndexes.With(vaultDenom, globalRewardIndexes)
|
|
|
|
return claim
|
|
}
|
|
|
|
// GetSynchronizedEarnClaim fetches a earn claim from the store and syncs rewards for all rewarded vaults.
|
|
func (k Keeper) GetSynchronizedEarnClaim(ctx sdk.Context, owner sdk.AccAddress) (types.EarnClaim, bool) {
|
|
claim, found := k.GetEarnClaim(ctx, owner)
|
|
if !found {
|
|
return types.EarnClaim{}, false
|
|
}
|
|
|
|
shares, found := k.earnKeeper.GetVaultAccountShares(ctx, owner)
|
|
if !found {
|
|
shares = earntypes.NewVaultShares()
|
|
}
|
|
|
|
k.IterateEarnRewardIndexes(ctx, func(vaultDenom string, _ types.RewardIndexes) bool {
|
|
vaultAmount := shares.AmountOf(vaultDenom)
|
|
claim = k.synchronizeEarnReward(ctx, claim, vaultDenom, owner, vaultAmount)
|
|
|
|
return false
|
|
})
|
|
|
|
return claim, true
|
|
}
|