0g-chain/x/community/abci_test.go
Nick DeLuca 102cc0fff3
Community Pool Staking Rewards Implementation & Improvements (#1742)
* add new field upgrade_time_set_staking_rewards_per_second with intention
of integrating into the disable inflation logic to set an initial
staking reward time

* when the disable inflation upgrade time occurs, set the staking rewards
per second to the value specified by the new
upgrade_time_set_staking_rewards_per_second.  This will allow a decoupled
implementation between the ugprade switching logic, and the core
functionality of paying staking rewards from the pool

* add staking rewards state to community keeper and community module
genesis that is required to calculate and track staking reward payouts
accross blocks

* add implementation of staking reward payouts

* remove unused error

* touch up tests and add a test case that fully tests behavior when pool
is drained

* add function comments

* refactor and pull out main calculation to private pure function with
no dependence on keeper

* zero out default parameters -- these are too chain specific to have
useful defaults

* small touch ups on comments, test cases

* use correct Int from sdkmath, not old sdk types; update protonet genesis
for new parmater

* fix copy pasta comment

* use bond denom from staking keeper instead of referncing ukava directly

* add staking reward state for valid genesis

* update kvtool genesis for new params and rewards state
2023-10-03 08:41:54 -07:00

75 lines
2.9 KiB
Go

package community_test
import (
"testing"
"time"
sdkmath "cosmossdk.io/math"
sdk "github.com/cosmos/cosmos-sdk/types"
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
"github.com/kava-labs/kava/app"
"github.com/kava-labs/kava/x/community"
"github.com/kava-labs/kava/x/community/types"
"github.com/stretchr/testify/require"
tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
)
func TestABCIStakingRewardsArePaidOutOnDisableInflationBlock(t *testing.T) {
app.SetSDKConfig()
tApp := app.NewTestApp()
tApp.InitializeFromGenesisStates()
keeper := tApp.GetCommunityKeeper()
accountKeeper := tApp.GetAccountKeeper()
bankKeeper := tApp.GetBankKeeper()
// a block that runs after addition of the disable inflation code on chain
// but before the disable inflation time
initialBlockTime := time.Now()
ctx := tApp.NewContext(true, tmproto.Header{Height: 1, Time: initialBlockTime})
poolAcc := accountKeeper.GetModuleAccount(ctx, types.ModuleName)
feeCollectorAcc := accountKeeper.GetModuleAccount(ctx, authtypes.FeeCollectorName)
disableTime := initialBlockTime.Add(9 * time.Second)
// set state
params, _ := keeper.GetParams(ctx)
params.UpgradeTimeDisableInflation = disableTime
params.UpgradeTimeSetStakingRewardsPerSecond = sdkmath.LegacyNewDec(1000000) // 1 KAVA
params.StakingRewardsPerSecond = sdkmath.LegacyZeroDec()
keeper.SetParams(ctx, params)
// fund community pool account
tApp.FundAccount(ctx, poolAcc.GetAddress(), sdk.NewCoins(sdk.NewCoin("ukava", sdkmath.NewInt(10000000)))) // 10 KAVA
initialFeeCollectorBalance := bankKeeper.GetBalance(ctx, feeCollectorAcc.GetAddress(), "ukava").Amount
// run one block
community.BeginBlocker(ctx, keeper)
// assert that staking rewards in parameters are still set to zero
params, found := keeper.GetParams(ctx)
require.True(t, found)
require.Equal(t, sdkmath.LegacyZeroDec(), params.StakingRewardsPerSecond)
// assert no rewards are given yet
rewards := bankKeeper.GetBalance(ctx, feeCollectorAcc.GetAddress(), "ukava").Amount.Sub(initialFeeCollectorBalance)
require.Equal(t, sdkmath.ZeroInt(), rewards)
// new block when disable inflation runs, 10 seconds from initial block for easy math
blockTime := disableTime.Add(1 * time.Second)
ctx = tApp.NewContext(true, tmproto.Header{Height: ctx.BlockHeight() + 1, Time: blockTime})
// run the next block
community.BeginBlocker(ctx, keeper)
// assert that staking rewards have been set and disable inflation time is zero
params, found = keeper.GetParams(ctx)
require.True(t, found)
require.True(t, params.UpgradeTimeDisableInflation.IsZero())
require.Equal(t, sdkmath.LegacyNewDec(1000000), params.StakingRewardsPerSecond)
// assert that 10 KAVA has been distributed in rewards
rewards = bankKeeper.GetBalance(ctx, feeCollectorAcc.GetAddress(), "ukava").Amount.Sub(initialFeeCollectorBalance)
require.Equal(t, sdkmath.NewInt(10000000).String(), rewards.String())
}