Mukan Erkin Törük
20afb5db80
Some checks failed
Build SimApp / build (amd64) (push) Waiting to run
Build SimApp / build (arm64) (push) Waiting to run
CodeQL / Analyze (push) Waiting to run
Build & Push / build (push) Waiting to run
Run Gosec / Gosec (push) Waiting to run
Lint / golangci-lint (push) Waiting to run
Checks dependencies and mocks generation / Check go mod tidy (push) Waiting to run
Checks dependencies and mocks generation / Check up to date mocks (push) Waiting to run
System Tests / setup (push) Waiting to run
System Tests / test-system (push) Blocked by required conditions
System Tests / test-system-legacy (push) Blocked by required conditions
Tests / Code Coverage / split-test-files (push) Waiting to run
Tests / Code Coverage / tests (00) (push) Blocked by required conditions
Tests / Code Coverage / tests (01) (push) Blocked by required conditions
Tests / Code Coverage / tests (02) (push) Blocked by required conditions
Tests / Code Coverage / tests (03) (push) Blocked by required conditions
Tests / Code Coverage / test-integration (push) Waiting to run
Tests / Code Coverage / test-e2e (push) Waiting to run
Tests / Code Coverage / repo-analysis (push) Blocked by required conditions
Tests / Code Coverage / test-sim-nondeterminism (push) Waiting to run
Tests / Code Coverage / test-clientv2 (push) Waiting to run
Tests / Code Coverage / test-core (push) Waiting to run
Tests / Code Coverage / test-depinject (push) Waiting to run
Tests / Code Coverage / test-errors (push) Waiting to run
Tests / Code Coverage / test-math (push) Waiting to run
Tests / Code Coverage / test-schema (push) Waiting to run
Tests / Code Coverage / test-collections (push) Waiting to run
Tests / Code Coverage / test-cosmovisor (push) Waiting to run
Tests / Code Coverage / test-confix (push) Waiting to run
Tests / Code Coverage / test-store (push) Waiting to run
Tests / Code Coverage / test-log (push) Waiting to run
Tests / Code Coverage / test-x-tx (push) Waiting to run
Tests / Code Coverage / test-x-nft (push) Waiting to run
Tests / Code Coverage / test-x-circuit (push) Waiting to run
Tests / Code Coverage / test-x-feegrant (push) Waiting to run
Tests / Code Coverage / test-x-evidence (push) Waiting to run
Tests / Code Coverage / test-x-upgrade (push) Waiting to run
Tests / Code Coverage / test-tools-benchmark (push) Waiting to run
Build & Push SDK Proto Builder / build (push) Has been cancelled
693 lines
29 KiB
Go
693 lines
29 KiB
Go
package keeper_test
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
"time"
|
|
|
|
abci "github.com/cometbft/cometbft/abci/types"
|
|
cmtproto "github.com/cometbft/cometbft/proto/tendermint/types"
|
|
"github.com/stretchr/testify/require"
|
|
"go.uber.org/mock/gomock"
|
|
|
|
"cosmossdk.io/math"
|
|
storetypes "cosmossdk.io/store/types"
|
|
|
|
"github.com/cosmos/cosmos-sdk/codec/address"
|
|
"github.com/cosmos/cosmos-sdk/runtime"
|
|
"github.com/cosmos/cosmos-sdk/testutil"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
moduletestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"
|
|
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
|
|
"github.com/cosmos/cosmos-sdk/x/distribution"
|
|
"github.com/cosmos/cosmos-sdk/x/distribution/keeper"
|
|
distrtestutil "github.com/cosmos/cosmos-sdk/x/distribution/testutil"
|
|
disttypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
|
|
protocolpooltypes "github.com/cosmos/cosmos-sdk/x/protocolpool/types"
|
|
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
|
|
)
|
|
|
|
var testProposerAddress = sdk.ConsAddress("test")
|
|
|
|
var _ disttypes.ExternalCommunityPoolKeeper = &mockProtocolPoolKeeper{}
|
|
|
|
type mockProtocolPoolKeeper struct{}
|
|
|
|
func (m mockProtocolPoolKeeper) GetCommunityPoolModule() string {
|
|
return protocolpooltypes.ProtocolPoolEscrowAccount
|
|
}
|
|
|
|
func (m mockProtocolPoolKeeper) FundCommunityPool(_ sdk.Context, _ sdk.Coins, _ sdk.AccAddress) error {
|
|
panic("do not use me")
|
|
}
|
|
|
|
func (m mockProtocolPoolKeeper) DistributeFromCommunityPool(_ sdk.Context, _ sdk.Coins, _ sdk.AccAddress) error {
|
|
panic("do not use me")
|
|
}
|
|
|
|
type testSetup struct {
|
|
testCtx testutil.TestContext
|
|
bankKeeper *distrtestutil.MockBankKeeper
|
|
stakingKeeper *distrtestutil.MockStakingKeeper
|
|
accountKeeper *distrtestutil.MockAccountKeeper
|
|
distrKeeper keeper.Keeper
|
|
}
|
|
|
|
func setupTest(t *testing.T, protocolPoolEnabled bool) testSetup {
|
|
t.Helper()
|
|
|
|
ctrl := gomock.NewController(t)
|
|
key := storetypes.NewKVStoreKey(disttypes.StoreKey)
|
|
storeService := runtime.NewKVStoreService(key)
|
|
testCtx := testutil.DefaultContextWithDB(t, key, storetypes.NewTransientStoreKey("transient_test"))
|
|
encCfg := moduletestutil.MakeTestEncodingConfig(distribution.AppModuleBasic{})
|
|
|
|
bankKeeper := distrtestutil.NewMockBankKeeper(ctrl)
|
|
stakingKeeper := distrtestutil.NewMockStakingKeeper(ctrl)
|
|
accountKeeper := distrtestutil.NewMockAccountKeeper(ctrl)
|
|
|
|
accountKeeper.EXPECT().GetModuleAccount(gomock.Any(), "fee_collector").Return(feeCollectorAcc).AnyTimes()
|
|
stakingKeeper.EXPECT().ValidatorAddressCodec().Return(address.NewBech32Codec("cosmosvaloper")).AnyTimes()
|
|
accountKeeper.EXPECT().GetModuleAddress(disttypes.ModuleName).Return(distrAcc.GetAddress()).AnyTimes()
|
|
|
|
var opts []keeper.InitOption
|
|
if protocolPoolEnabled {
|
|
opts = append(opts, keeper.WithExternalCommunityPool(mockProtocolPoolKeeper{}))
|
|
// expect that we will verify that this module account is set
|
|
accountKeeper.EXPECT().GetModuleAddress(protocolpooltypes.ProtocolPoolEscrowAccount).Return(protocolPoolAcc.GetAddress()).AnyTimes()
|
|
}
|
|
|
|
distrKeeper := keeper.NewKeeper(
|
|
encCfg.Codec,
|
|
storeService,
|
|
accountKeeper,
|
|
bankKeeper,
|
|
stakingKeeper,
|
|
"fee_collector",
|
|
authtypes.NewModuleAddress("gov").String(),
|
|
opts...,
|
|
)
|
|
|
|
// empty initialize
|
|
err := distrKeeper.FeePool.Set(testCtx.Ctx, disttypes.FeePool{
|
|
CommunityPool: sdk.NewDecCoins(),
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
return testSetup{
|
|
testCtx: testCtx,
|
|
bankKeeper: bankKeeper,
|
|
distrKeeper: distrKeeper,
|
|
stakingKeeper: stakingKeeper,
|
|
accountKeeper: accountKeeper,
|
|
}
|
|
}
|
|
|
|
// Scenario:
|
|
// check no distribution occurs after begin block with no extra validator state
|
|
func TestBeginBlockNoOp(t *testing.T) {
|
|
ts := setupTest(t, false)
|
|
ctx := ts.testCtx.Ctx.
|
|
WithBlockHeader(cmtproto.Header{
|
|
ProposerAddress: testProposerAddress,
|
|
Time: time.Now(),
|
|
}).
|
|
WithBlockHeight(0)
|
|
|
|
feePoolBefore, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
err = ts.distrKeeper.BeginBlocker(ctx)
|
|
require.NoError(t, err)
|
|
feePoolAfter, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
|
|
require.True(t, feePoolBefore.CommunityPool.Equal(feePoolAfter.CommunityPool), fmt.Sprintf("before: %s, after: %s", feePoolBefore.CommunityPool.String(), feePoolAfter.CommunityPool.String()))
|
|
|
|
// check cons address
|
|
got, err := ts.distrKeeper.GetPreviousProposerConsAddr(ctx)
|
|
require.NoError(t, err)
|
|
require.Equal(t, testProposerAddress, got)
|
|
}
|
|
|
|
// Scenario:
|
|
// multiple validators with different commission and the same stake
|
|
// after the begin blocker, rewards should be distributed evenly based on their stake weight
|
|
// commission should differ based on their differing commission rates
|
|
// community pool should have portion of rewards distributed
|
|
func TestBeginBlockToMultipleValidators(t *testing.T) {
|
|
ts := setupTest(t, false)
|
|
|
|
ctx := ts.testCtx.Ctx.
|
|
WithBlockHeader(cmtproto.Header{
|
|
ProposerAddress: testProposerAddress,
|
|
Time: time.Now(),
|
|
})
|
|
|
|
// reset fee pool & set params
|
|
require.NoError(t, ts.distrKeeper.Params.Set(ctx, disttypes.DefaultParams()))
|
|
require.NoError(t, ts.distrKeeper.FeePool.Set(ctx, disttypes.InitialFeePool()))
|
|
|
|
// create validator with 50% commission
|
|
valAddr0 := sdk.ValAddress(valConsAddr0)
|
|
val0, err := distrtestutil.CreateValidator(valConsPk0, math.NewInt(100))
|
|
require.NoError(t, err)
|
|
val0.Commission = stakingtypes.NewCommission(math.LegacyNewDecWithPrec(5, 1), math.LegacyNewDecWithPrec(5, 1), math.LegacyNewDec(0))
|
|
ts.stakingKeeper.EXPECT().ValidatorByConsAddr(gomock.Any(), sdk.GetConsAddress(valConsPk0)).Return(val0, nil).AnyTimes()
|
|
|
|
// create second validator with 0% commission
|
|
valAddr1 := sdk.ValAddress(valConsAddr1)
|
|
val1, err := distrtestutil.CreateValidator(valConsPk1, math.NewInt(100))
|
|
require.NoError(t, err)
|
|
val1.Commission = stakingtypes.NewCommission(math.LegacyNewDec(0), math.LegacyNewDec(0), math.LegacyNewDec(0))
|
|
ts.stakingKeeper.EXPECT().ValidatorByConsAddr(gomock.Any(), sdk.GetConsAddress(valConsPk1)).Return(val1, nil).AnyTimes()
|
|
|
|
t.Run("assert initial state is zero", func(t *testing.T) {
|
|
// assert initial state: zero outstanding rewards, zero community pool, zero commission, zero current rewards
|
|
val0OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0OutstandingRewards.Rewards.IsZero())
|
|
|
|
val1OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1OutstandingRewards.Rewards.IsZero())
|
|
|
|
feePool, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
require.True(t, feePool.CommunityPool.IsZero())
|
|
|
|
val0Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0Commission.Commission.IsZero())
|
|
|
|
val1Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1Commission.Commission.IsZero())
|
|
|
|
val0CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0CurrentRewards.Rewards.IsZero())
|
|
|
|
val1CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1CurrentRewards.Rewards.IsZero())
|
|
})
|
|
|
|
// allocate tokens as if both had voted and second was proposer
|
|
fees := sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, math.NewInt(100)))
|
|
ts.bankKeeper.EXPECT().GetAllBalances(gomock.Any(), feeCollectorAcc.GetAddress()).Return(fees)
|
|
ts.bankKeeper.EXPECT().SendCoinsFromModuleToModule(gomock.Any(), "fee_collector", disttypes.ModuleName, fees)
|
|
|
|
votes := []abci.VoteInfo{
|
|
{
|
|
Validator: abci.Validator{
|
|
Address: valConsPk0.Address(),
|
|
Power: 100,
|
|
},
|
|
},
|
|
{
|
|
Validator: abci.Validator{
|
|
Address: valConsPk1.Address(),
|
|
Power: 100,
|
|
},
|
|
},
|
|
}
|
|
ctx = ctx.WithVoteInfos(votes).WithBlockHeight(2)
|
|
|
|
feePoolBefore, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
err = ts.distrKeeper.BeginBlocker(ctx)
|
|
require.NoError(t, err)
|
|
feePoolAfter, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
|
|
require.False(t, feePoolBefore.CommunityPool.Equal(feePoolAfter.CommunityPool), fmt.Sprintf("before: %s, after: %s", feePoolBefore.CommunityPool.String(), feePoolAfter.CommunityPool.String()))
|
|
|
|
t.Run("assert rewards and commission distributed", func(t *testing.T) {
|
|
// 98 outstanding rewards (100 less 2 to community pool) - distributed among the two validators with the same stake weight
|
|
val0OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDecWithPrec(490, 1)}}, val0OutstandingRewards.Rewards)
|
|
|
|
val1OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDecWithPrec(490, 1)}}, val1OutstandingRewards.Rewards)
|
|
|
|
// 2 community pool coins
|
|
feePool, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDec(2)}}, feePool.CommunityPool)
|
|
|
|
// 50% commission for first proposer, (0.5 * 98%) * 100 / 2 = 23.25
|
|
val0Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDecWithPrec(2450, 2)}}, val0Commission.Commission)
|
|
|
|
// zero commission for second proposer
|
|
val1Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1Commission.Commission.IsZero())
|
|
|
|
// just staking.proportional for first proposer less commission = (0.5 * 98%) * 100 / 2 = 24.50
|
|
val0CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDecWithPrec(2450, 2)}}, val0CurrentRewards.Rewards)
|
|
|
|
// proposer reward + staking.proportional for second proposer = (0.5 * (98%)) * 100 = 49
|
|
val1CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDecWithPrec(490, 1)}}, val1CurrentRewards.Rewards)
|
|
})
|
|
|
|
// check cons address
|
|
got, err := ts.distrKeeper.GetPreviousProposerConsAddr(ctx)
|
|
require.NoError(t, err)
|
|
require.Equal(t, testProposerAddress, got)
|
|
}
|
|
|
|
// Scenario:
|
|
// multiple validators with same commission and the same stake
|
|
// after the begin blocker, rewards should be distributed evenly based on their stake weight
|
|
// community pool should have portion of rewards distributed - should collect dust as decimal values
|
|
func TestBeginBlockCommunityPoolCollectsDust(t *testing.T) {
|
|
ts := setupTest(t, false)
|
|
ctx := ts.testCtx.Ctx.
|
|
WithBlockHeader(cmtproto.Header{
|
|
ProposerAddress: testProposerAddress,
|
|
Time: time.Now(),
|
|
})
|
|
|
|
// reset fee pool
|
|
require.NoError(t, ts.distrKeeper.FeePool.Set(ctx, disttypes.InitialFeePool()))
|
|
require.NoError(t, ts.distrKeeper.Params.Set(ctx, disttypes.DefaultParams()))
|
|
|
|
// create validator with 10% commission
|
|
valAddr0 := sdk.ValAddress(valConsAddr0)
|
|
val0, err := distrtestutil.CreateValidator(valConsPk0, math.NewInt(100))
|
|
require.NoError(t, err)
|
|
val0.Commission = stakingtypes.NewCommission(math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDec(0))
|
|
ts.stakingKeeper.EXPECT().ValidatorByConsAddr(gomock.Any(), sdk.GetConsAddress(valConsPk0)).Return(val0, nil).AnyTimes()
|
|
|
|
// create second validator with 10% commission
|
|
valAddr1 := sdk.ValAddress(valConsAddr1)
|
|
val1, err := distrtestutil.CreateValidator(valConsPk1, math.NewInt(100))
|
|
require.NoError(t, err)
|
|
val1.Commission = stakingtypes.NewCommission(math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDec(0))
|
|
ts.stakingKeeper.EXPECT().ValidatorByConsAddr(gomock.Any(), sdk.GetConsAddress(valConsPk1)).Return(val1, nil).AnyTimes()
|
|
|
|
// create third validator with 10% commission
|
|
valAddr2 := sdk.ValAddress(valConsAddr2)
|
|
val2, err := stakingtypes.NewValidator(sdk.ValAddress(valConsAddr2).String(), valConsPk1, stakingtypes.Description{})
|
|
require.NoError(t, err)
|
|
val2.Commission = stakingtypes.NewCommission(math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDec(0))
|
|
ts.stakingKeeper.EXPECT().ValidatorByConsAddr(gomock.Any(), sdk.GetConsAddress(valConsPk2)).Return(val2, nil).AnyTimes()
|
|
|
|
t.Run("assert initial state is zero", func(t *testing.T) {
|
|
// assert initial state: zero outstanding rewards, zero community pool, zero commission, zero current rewards
|
|
val0OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0OutstandingRewards.Rewards.IsZero())
|
|
|
|
val1OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1OutstandingRewards.Rewards.IsZero())
|
|
|
|
val2OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr2)
|
|
require.NoError(t, err)
|
|
require.True(t, val2OutstandingRewards.Rewards.IsZero())
|
|
|
|
feePool, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
require.True(t, feePool.CommunityPool.IsZero())
|
|
|
|
val0Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0Commission.Commission.IsZero())
|
|
|
|
val1Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1Commission.Commission.IsZero())
|
|
|
|
val0CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0CurrentRewards.Rewards.IsZero())
|
|
|
|
val1CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1CurrentRewards.Rewards.IsZero())
|
|
})
|
|
|
|
// allocate tokens as if both had voted and second was proposer
|
|
fees := sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, math.NewInt(634195840)))
|
|
expectedCommunityPool := sdk.NewDecCoins(sdk.NewDecCoinFromDec(sdk.DefaultBondDenom, math.LegacyMustNewDecFromStr("12683916.800000001243023848")))
|
|
ts.bankKeeper.EXPECT().GetAllBalances(gomock.Any(), feeCollectorAcc.GetAddress()).Return(fees)
|
|
ts.bankKeeper.EXPECT().SendCoinsFromModuleToModule(gomock.Any(), "fee_collector", disttypes.ModuleName, fees)
|
|
|
|
votes := []abci.VoteInfo{
|
|
{
|
|
Validator: abci.Validator{
|
|
Address: valConsPk0.Address(),
|
|
Power: 11,
|
|
},
|
|
},
|
|
{
|
|
Validator: abci.Validator{
|
|
Address: valConsPk1.Address(),
|
|
Power: 10,
|
|
},
|
|
},
|
|
{
|
|
Validator: abci.Validator{
|
|
Address: valConsPk2.Address(),
|
|
Power: 10,
|
|
},
|
|
},
|
|
}
|
|
ctx = ctx.WithVoteInfos(votes).WithBlockHeight(2)
|
|
|
|
feePoolBefore, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
err = ts.distrKeeper.BeginBlocker(ctx)
|
|
require.NoError(t, err)
|
|
feePoolAfter, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
|
|
// check that the community pool has collected all the dust from truncating rewards to sdk.Ints
|
|
require.False(t, feePoolBefore.CommunityPool.Equal(feePoolAfter.CommunityPool), fmt.Sprintf("before: %s, after: %s", feePoolBefore.CommunityPool.String(), feePoolAfter.CommunityPool.String()))
|
|
require.True(t, feePoolAfter.CommunityPool.Equal(expectedCommunityPool))
|
|
|
|
t.Run("assert rewards distributed", func(t *testing.T) {
|
|
val0OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0OutstandingRewards.Rewards.IsValid())
|
|
|
|
val1OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1OutstandingRewards.Rewards.IsValid())
|
|
|
|
val2OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr2)
|
|
require.NoError(t, err)
|
|
require.True(t, val2OutstandingRewards.Rewards.IsValid())
|
|
})
|
|
|
|
// check cons address
|
|
got, err := ts.distrKeeper.GetPreviousProposerConsAddr(ctx)
|
|
require.NoError(t, err)
|
|
require.Equal(t, testProposerAddress, got)
|
|
}
|
|
|
|
// Scenario:
|
|
// check no distribution occurs after begin block with no extra validator state
|
|
// - protocol pool module is enabled
|
|
func TestBeginBlockNoOpProtocolPool(t *testing.T) {
|
|
ts := setupTest(t, true)
|
|
ctx := ts.testCtx.Ctx.
|
|
WithBlockHeader(cmtproto.Header{
|
|
ProposerAddress: testProposerAddress,
|
|
Time: time.Now(),
|
|
}).
|
|
WithBlockHeight(0)
|
|
|
|
feePoolBefore, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
err = ts.distrKeeper.BeginBlocker(ctx)
|
|
require.NoError(t, err)
|
|
feePoolAfter, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
|
|
require.True(t, feePoolBefore.CommunityPool.Equal(feePoolAfter.CommunityPool), fmt.Sprintf("before: %s, after: %s", feePoolBefore.CommunityPool.String(), feePoolAfter.CommunityPool.String()))
|
|
|
|
// check cons address
|
|
got, err := ts.distrKeeper.GetPreviousProposerConsAddr(ctx)
|
|
require.NoError(t, err)
|
|
require.Equal(t, testProposerAddress, got)
|
|
}
|
|
|
|
// Scenario:
|
|
// multiple validators with different commission and the same stake
|
|
// after the begin blocker, rewards should be distributed evenly based on their stake weight
|
|
// commission should differ based on their differing commission rates
|
|
// community pool should have portion of rewards distributed
|
|
// protocol pool is enabled so funds should leave the module
|
|
func TestBeginBlockToMultipleValidatorsProtocolPool(t *testing.T) {
|
|
ts := setupTest(t, true)
|
|
|
|
ctx := ts.testCtx.Ctx.
|
|
WithBlockHeader(cmtproto.Header{
|
|
ProposerAddress: testProposerAddress,
|
|
Time: time.Now(),
|
|
})
|
|
|
|
// reset fee pool & set params
|
|
require.NoError(t, ts.distrKeeper.Params.Set(ctx, disttypes.DefaultParams()))
|
|
require.NoError(t, ts.distrKeeper.FeePool.Set(ctx, disttypes.InitialFeePool()))
|
|
|
|
// create validator with 50% commission
|
|
valAddr0 := sdk.ValAddress(valConsAddr0)
|
|
val0, err := distrtestutil.CreateValidator(valConsPk0, math.NewInt(100))
|
|
require.NoError(t, err)
|
|
val0.Commission = stakingtypes.NewCommission(math.LegacyNewDecWithPrec(5, 1), math.LegacyNewDecWithPrec(5, 1), math.LegacyNewDec(0))
|
|
ts.stakingKeeper.EXPECT().ValidatorByConsAddr(gomock.Any(), sdk.GetConsAddress(valConsPk0)).Return(val0, nil).AnyTimes()
|
|
|
|
// create second validator with 0% commission
|
|
valAddr1 := sdk.ValAddress(valConsAddr1)
|
|
val1, err := distrtestutil.CreateValidator(valConsPk1, math.NewInt(100))
|
|
require.NoError(t, err)
|
|
val1.Commission = stakingtypes.NewCommission(math.LegacyNewDec(0), math.LegacyNewDec(0), math.LegacyNewDec(0))
|
|
ts.stakingKeeper.EXPECT().ValidatorByConsAddr(gomock.Any(), sdk.GetConsAddress(valConsPk1)).Return(val1, nil).AnyTimes()
|
|
|
|
t.Run("assert initial state is zero", func(t *testing.T) {
|
|
// assert initial state: zero outstanding rewards, zero community pool, zero commission, zero current rewards
|
|
val0OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0OutstandingRewards.Rewards.IsZero())
|
|
|
|
val1OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1OutstandingRewards.Rewards.IsZero())
|
|
|
|
feePool, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
require.True(t, feePool.CommunityPool.IsZero())
|
|
|
|
val0Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0Commission.Commission.IsZero())
|
|
|
|
val1Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1Commission.Commission.IsZero())
|
|
|
|
val0CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0CurrentRewards.Rewards.IsZero())
|
|
|
|
val1CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1CurrentRewards.Rewards.IsZero())
|
|
})
|
|
|
|
// allocate tokens as if both had voted and second was proposer
|
|
fees := sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, math.NewInt(100)))
|
|
ts.bankKeeper.EXPECT().GetAllBalances(gomock.Any(), feeCollectorAcc.GetAddress()).Return(fees)
|
|
ts.bankKeeper.EXPECT().SendCoinsFromModuleToModule(gomock.Any(), "fee_collector", disttypes.ModuleName, fees).AnyTimes()
|
|
|
|
votes := []abci.VoteInfo{
|
|
{
|
|
Validator: abci.Validator{
|
|
Address: valConsPk0.Address(),
|
|
Power: 100,
|
|
},
|
|
},
|
|
{
|
|
Validator: abci.Validator{
|
|
Address: valConsPk1.Address(),
|
|
Power: 100,
|
|
},
|
|
},
|
|
}
|
|
|
|
ctx = ctx.WithVoteInfos(votes).WithBlockHeight(1000)
|
|
|
|
// we should fully remove everything that was in the community pool (2stake)
|
|
ts.bankKeeper.EXPECT().SendCoinsFromModuleToModule(gomock.Any(), disttypes.ModuleName, protocolpooltypes.ProtocolPoolEscrowAccount, sdk.NewCoins(sdk.NewInt64Coin(sdk.DefaultBondDenom, 2))).Return(nil).Times(1)
|
|
|
|
feePoolBefore, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
err = ts.distrKeeper.BeginBlocker(ctx)
|
|
require.NoError(t, err)
|
|
feePoolAfter, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
|
|
// here we are checking if the balance is back to what it was originally (0) because we have distributed the funds to protocolpool
|
|
require.True(t, feePoolBefore.CommunityPool.Equal(feePoolAfter.CommunityPool), fmt.Sprintf("before: %s, after: %s", feePoolBefore.CommunityPool.String(), feePoolAfter.CommunityPool.String()))
|
|
|
|
t.Run("assert rewards and commission distributed", func(t *testing.T) {
|
|
// 98 outstanding rewards (100 less 2 to community pool)
|
|
val0OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDecWithPrec(490, 1)}}, val0OutstandingRewards.Rewards)
|
|
|
|
val1OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDecWithPrec(490, 1)}}, val1OutstandingRewards.Rewards)
|
|
|
|
// 50% commission for first proposer, (0.5 * 98%) * 100 / 2 = 23.25
|
|
val0Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDecWithPrec(2450, 2)}}, val0Commission.Commission)
|
|
|
|
// zero commission for second proposer
|
|
val1Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1Commission.Commission.IsZero())
|
|
|
|
// just staking.proportional for first proposer less commission = (0.5 * 98%) * 100 / 2 = 24.50
|
|
val0CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDecWithPrec(2450, 2)}}, val0CurrentRewards.Rewards)
|
|
|
|
// proposer reward + staking.proportional for second proposer = (0.5 * (98%)) * 100 = 49
|
|
val1CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.Equal(t, sdk.DecCoins{{Denom: sdk.DefaultBondDenom, Amount: math.LegacyNewDecWithPrec(490, 1)}}, val1CurrentRewards.Rewards)
|
|
})
|
|
|
|
// check cons address
|
|
got, err := ts.distrKeeper.GetPreviousProposerConsAddr(ctx)
|
|
require.NoError(t, err)
|
|
require.Equal(t, testProposerAddress, got)
|
|
}
|
|
|
|
// Scenario:
|
|
// multiple validators with same commission and the same stake
|
|
// after the begin blocker, rewards should be distributed evenly based on their stake weight
|
|
// community pool should have portion of rewards distributed - should collect dust as decimal values
|
|
// - the non-decimal portion of the funds should be distributed as sdk.Coins to the protocol pool module
|
|
// - the remaining dust should be in the distribution community pool
|
|
func TestBeginBlockCommunityPoolCollectsDustProtocolPool(t *testing.T) {
|
|
ts := setupTest(t, true)
|
|
ctx := ts.testCtx.Ctx.
|
|
WithBlockHeader(cmtproto.Header{
|
|
ProposerAddress: testProposerAddress,
|
|
Time: time.Now(),
|
|
})
|
|
|
|
// reset fee pool
|
|
require.NoError(t, ts.distrKeeper.FeePool.Set(ctx, disttypes.InitialFeePool()))
|
|
require.NoError(t, ts.distrKeeper.Params.Set(ctx, disttypes.DefaultParams()))
|
|
|
|
// create validator with 10% commission
|
|
valAddr0 := sdk.ValAddress(valConsAddr0)
|
|
val0, err := distrtestutil.CreateValidator(valConsPk0, math.NewInt(100))
|
|
require.NoError(t, err)
|
|
val0.Commission = stakingtypes.NewCommission(math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDec(0))
|
|
ts.stakingKeeper.EXPECT().ValidatorByConsAddr(gomock.Any(), sdk.GetConsAddress(valConsPk0)).Return(val0, nil).AnyTimes()
|
|
|
|
// create second validator with 10% commission
|
|
valAddr1 := sdk.ValAddress(valConsAddr1)
|
|
val1, err := distrtestutil.CreateValidator(valConsPk1, math.NewInt(100))
|
|
require.NoError(t, err)
|
|
val1.Commission = stakingtypes.NewCommission(math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDec(0))
|
|
ts.stakingKeeper.EXPECT().ValidatorByConsAddr(gomock.Any(), sdk.GetConsAddress(valConsPk1)).Return(val1, nil).AnyTimes()
|
|
|
|
// create third validator with 10% commission
|
|
valAddr2 := sdk.ValAddress(valConsAddr2)
|
|
val2, err := stakingtypes.NewValidator(sdk.ValAddress(valConsAddr2).String(), valConsPk1, stakingtypes.Description{})
|
|
require.NoError(t, err)
|
|
val2.Commission = stakingtypes.NewCommission(math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDecWithPrec(1, 1), math.LegacyNewDec(0))
|
|
ts.stakingKeeper.EXPECT().ValidatorByConsAddr(gomock.Any(), sdk.GetConsAddress(valConsPk2)).Return(val2, nil).AnyTimes()
|
|
|
|
t.Run("assert initial state is zero", func(t *testing.T) {
|
|
// assert initial state: zero outstanding rewards, zero community pool, zero commission, zero current rewards
|
|
val0OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0OutstandingRewards.Rewards.IsZero())
|
|
|
|
val1OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1OutstandingRewards.Rewards.IsZero())
|
|
|
|
feePool, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
require.True(t, feePool.CommunityPool.IsZero())
|
|
|
|
val0Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0Commission.Commission.IsZero())
|
|
|
|
val1Commission, err := ts.distrKeeper.GetValidatorAccumulatedCommission(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1Commission.Commission.IsZero())
|
|
|
|
val0CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0CurrentRewards.Rewards.IsZero())
|
|
|
|
val1CurrentRewards, err := ts.distrKeeper.GetValidatorCurrentRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1CurrentRewards.Rewards.IsZero())
|
|
})
|
|
|
|
// allocate tokens as if both had voted and second was proposer
|
|
fees := sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, math.NewInt(634195840)))
|
|
ts.bankKeeper.EXPECT().GetAllBalances(gomock.Any(), feeCollectorAcc.GetAddress()).Return(fees)
|
|
ts.bankKeeper.EXPECT().SendCoinsFromModuleToModule(gomock.Any(), "fee_collector", disttypes.ModuleName, fees)
|
|
|
|
votes := []abci.VoteInfo{
|
|
{
|
|
Validator: abci.Validator{
|
|
Address: valConsPk0.Address(),
|
|
Power: 11,
|
|
},
|
|
},
|
|
{
|
|
Validator: abci.Validator{
|
|
Address: valConsPk1.Address(),
|
|
Power: 10,
|
|
},
|
|
},
|
|
{
|
|
Validator: abci.Validator{
|
|
Address: valConsPk2.Address(),
|
|
Power: 10,
|
|
},
|
|
},
|
|
}
|
|
ctx = ctx.WithVoteInfos(votes).WithBlockHeight(1000)
|
|
|
|
// expect us to send the truncated amount
|
|
// total amount in pool should be 12683916.800000001243023848 before the
|
|
// integer portion will be sent to the protocol pool as sdk.Coins
|
|
// decimal version will remain as "dust"
|
|
expectedCommunityPool := sdk.NewDecCoins(sdk.NewDecCoinFromDec(sdk.DefaultBondDenom, math.LegacyMustNewDecFromStr("0.800000001243023848")))
|
|
ts.bankKeeper.EXPECT().SendCoinsFromModuleToModule(gomock.Any(), disttypes.ModuleName, protocolpooltypes.ProtocolPoolEscrowAccount, sdk.NewCoins(sdk.NewInt64Coin(sdk.DefaultBondDenom, 12683916))).Return(nil).Times(1)
|
|
|
|
feePoolBefore, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
err = ts.distrKeeper.BeginBlocker(ctx)
|
|
require.NoError(t, err)
|
|
feePoolAfter, err := ts.distrKeeper.FeePool.Get(ctx)
|
|
require.NoError(t, err)
|
|
|
|
require.False(t, feePoolBefore.CommunityPool.Equal(feePoolAfter.CommunityPool), fmt.Sprintf("before: %s, after: %s", feePoolBefore.CommunityPool.String(), feePoolAfter.CommunityPool.String()))
|
|
require.True(t, feePoolAfter.CommunityPool.Equal(expectedCommunityPool))
|
|
|
|
t.Run("assert rewards distributed", func(t *testing.T) {
|
|
val0OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr0)
|
|
require.NoError(t, err)
|
|
require.True(t, val0OutstandingRewards.Rewards.IsValid())
|
|
|
|
val1OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr1)
|
|
require.NoError(t, err)
|
|
require.True(t, val1OutstandingRewards.Rewards.IsValid())
|
|
|
|
val2OutstandingRewards, err := ts.distrKeeper.GetValidatorOutstandingRewards(ctx, valAddr2)
|
|
require.NoError(t, err)
|
|
require.True(t, val2OutstandingRewards.Rewards.IsValid())
|
|
})
|
|
|
|
// check cons address
|
|
got, err := ts.distrKeeper.GetPreviousProposerConsAddr(ctx)
|
|
require.NoError(t, err)
|
|
require.Equal(t, testProposerAddress, got)
|
|
}
|