0g-chain/x/incentive/keeper/rewards_usdx_unit_test.go
drklee3 f757d7ab15
feat: upgrade to Cosmos v0.46 (#1477)
* Update cosmos-sdk to v0.45.10-kava

* Add RegisterNodeService to app

* Update cosmos proto files

* Update cosmos proto files

* Use tagged v0.45.10-kava-v0.19-0.21 cosmos version

* update x/auth/legacy to x/auth/migrations

* Delete rest packages and registration

* Remove rest from proposal handlers

* Remove legacy types referencing removed sdk types

* Remove legacy tx broadcast handler

* Update incentive staking hooks to return error

* Remove grpc replace directive, use new grpc version

* Fix storetypes import

* Update tally_handler with updated gov types

* Delete legacy types

* Use new gov default config

* Update RegisterTendermintService params

Signed-off-by: drklee3 <derrick@dlee.dev>

* Replace sdk.StoreKey with storetypes.StoreKey

* Replace sdk.Int#ToDec with sdk.NewDecFromInt

* Replace sdk.NewUintFromBigInt with sdkmath.NewUintFromBigInt

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update most intances of govtypes to govv1beta1

* Unpack coin slice for Coins#Sub and Coins#SafeSub

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update committee gov codec registration

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update migrate utils period_vesting Coins#Sub

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update Coin#Sub in community proposal handler

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update Coin#Sub, FundModuleAccount/FundAccount in banktestutil

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update community, earn, kavadist proposal gov registration

* Update evm cli client EthSecp256k1Type check

* AccAddressFromHex to AccAddressFromHexUnsafe

* Add mint DefaultInflationCalculationFn to earn test

* Update use of removed staking.NewHandler

* Rename FlagIAVLFastNode -> FlagDisableIAVLFastNode

* cmd: Update new snapshot app option

Signed-off-by: drklee3 <derrick@dlee.dev>

* cmd: Add tendermint default config, use cosmos rpc status command

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update ethermint import path

github.com/tharsis/ethermint -> github.com/evmos/ethermint

* Upgrade ibc-go to v6

* Update proto dependencies

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update Tally handler test with new gov types

* Update helpers.GenTx -> helpers.GenSignedMockTx

* Update evmkeeper.NewKeeper params

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update ante authz, tests

* Add feemarket transient key, pass subspaces to evm/feemarket keepers

* Update new ante decorators

* Add new addModuleInitFlags to server commands

* Pass codec to keyring.New in genaccounts

* Pass codec to client keys add

* Add SendCoins to evmutil bank_keeper

* Use github.com/cosmos/iavl@v0.19.5

* Add ante HandlerOptions

* Add unimplemented SendCoins to evmutil bank keeper

Ethermint x/evm does not use this method

* Update init-new-chain script to disable post-london blocks

* Modify test genesis states to append 1 validator

* Update tally handler test to use string values

* Prevent querying balance for empty sdk.AccAddress in auction bidding test

* Set default bond denom to ukava

* Remove overwritten bank genesis total supply in committee proposal test

Signed-off-by: drklee3 <derrick@dlee.dev>

* Use ukava for testing staked balance

* Disable minting in community proposal handler test

Previously stake denom is used, which resulted in 0 minted coins

* Update hard APYToSPY test expected value

Increased iterations in sdk.ApproxRoot, updated closer to real value

* Fix NewDecCoinsFromCoins bug in incentive collectDerivativeStakingRewards

* Allow bkava earn incentive test values to match within small margin for rounding

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update invalid denom in issuance message coin validation

Colons are now valid in denoms

Signed-off-by: drklee3 <derrick@dlee.dev>

* Remove genesis validator in incentive delegation tests

* Update pricefeed market test for invalid denom

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update incentive delegator rewards test without genesis validator

Signed-off-by: drklee3 <derrick@dlee.dev>

* Add validator to export test

* Clear bank state in minting tests

Signed-off-by: drklee3 <derrick@dlee.dev>

* Remove validator for no stake tally test

Signed-off-by: drklee3 <derrick@dlee.dev>

* Clear incentive state before InitGenesis in incentive genesis export test

* Update swagger

Signed-off-by: drklee3 <derrick@dlee.dev>

* Update ethermint version to match replaced version

* Remove legacy swagger

* Add NewEthEmitEventDecorator

* Remove redundant func for AddModuleInitFlags

* Remove unused addBankBalanceForAddress func

* Add SetIAVLLazyLoading option to app cmd

* Use legacy.RegisterAminoMsg for committee msg concrete registration

* Remove unnecessary Amino field

* Add evm_util bankkeeper SendCoins comment

* Update test method ResetBankState to DeleteGenesisValidatorCoins to be more clear

* Validate incentive params.RewardsPerSecond to be non-zero

* Validate swap pools to disallow colons in token denoms

* Register all legacy amino types on gov modulecdc

* Remove redundant Comittee interface registration

* Pin goleveldb to v1.0.1-0.20210819022825-2ae1ddf74ef7

Causes failed to load state at height errors

* Update ethermint to new pinned version with minGasPrices parse error fix

* Update cosmos fork dependcy commit to include reverted account constructor patch

* Update Cosmos v0.46.11 and cometbft v0.34.27

* Bump minimum go version to 1.19

* Update tendermint proto

* Update internal testnet genesis

* Move NewCanTransferDecorator before NewEthGasConsumeDecorator

* Add hard borrow store tests (#1514)

* add store tests for Borrow type

* refactor Deposit tests to match

* Fix old bep3 tests (#1515)

* Update Ethermint to 1b17445 to fix duplicate proto registration

* Add custom status command to use snake_case and stdout

* Add SetInflation helper

* Reduce ambiguity with evm CanSignEthTx error

* Remove init genesis validator claim in test

* Add disabled evmante.NewMinGasPriceDecorator with x/feemarket note

* chore: use tagged versions for Cosmos and Ethermint forks

* update kvtool & increase wait for ibc transfer test

---------

Signed-off-by: drklee3 <derrick@dlee.dev>
Co-authored-by: Ruaridh <rhuairahrighairidh@users.noreply.github.com>
Co-authored-by: Robert Pirtle <astropirtle@gmail.com>
2023-04-03 20:08:45 -04:00

302 lines
9.4 KiB
Go

package keeper_test
import (
"testing"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/stretchr/testify/suite"
cdptypes "github.com/kava-labs/kava/x/cdp/types"
"github.com/kava-labs/kava/x/incentive/types"
)
// usdxRewardsUnitTester contains common methods for running unit tests for keeper methods related to the USDX minting rewards
type usdxRewardsUnitTester struct {
unitTester
}
func (suite *usdxRewardsUnitTester) storeGlobalUSDXIndexes(indexes types.RewardIndexes) {
for _, ri := range indexes {
suite.keeper.SetUSDXMintingRewardFactor(suite.ctx, ri.CollateralType, ri.RewardFactor)
}
}
func (suite *usdxRewardsUnitTester) storeClaim(claim types.USDXMintingClaim) {
suite.keeper.SetUSDXMintingClaim(suite.ctx, claim)
}
type InitializeUSDXMintingClaimTests struct {
usdxRewardsUnitTester
}
func TestInitializeUSDXMintingClaims(t *testing.T) {
suite.Run(t, new(InitializeUSDXMintingClaimTests))
}
func (suite *InitializeUSDXMintingClaimTests) TestClaimIndexIsSetWhenClaimDoesNotExist() {
collateralType := "bnb-a"
cdp := NewCDPBuilder(arbitraryAddress(), collateralType).Build()
globalIndexes := types.RewardIndexes{{
CollateralType: collateralType,
RewardFactor: d("0.2"),
}}
suite.storeGlobalUSDXIndexes(globalIndexes)
suite.keeper.InitializeUSDXMintingClaim(suite.ctx, cdp)
syncedClaim, f := suite.keeper.GetUSDXMintingClaim(suite.ctx, cdp.Owner)
suite.True(f)
suite.Equal(globalIndexes, syncedClaim.RewardIndexes)
}
func (suite *InitializeUSDXMintingClaimTests) TestClaimIndexIsSetWhenClaimExists() {
collateralType := "bnb-a"
claim := types.USDXMintingClaim{
BaseClaim: types.BaseClaim{
Owner: arbitraryAddress(),
},
RewardIndexes: types.RewardIndexes{{
CollateralType: collateralType,
RewardFactor: d("0.1"),
}},
}
suite.storeClaim(claim)
globalIndexes := types.RewardIndexes{{
CollateralType: collateralType,
RewardFactor: d("0.2"),
}}
suite.storeGlobalUSDXIndexes(globalIndexes)
cdp := NewCDPBuilder(claim.Owner, collateralType).Build()
suite.keeper.InitializeUSDXMintingClaim(suite.ctx, cdp)
syncedClaim, _ := suite.keeper.GetUSDXMintingClaim(suite.ctx, cdp.Owner)
suite.Equal(globalIndexes, syncedClaim.RewardIndexes)
}
type SynchronizeUSDXMintingRewardTests struct {
usdxRewardsUnitTester
}
func TestSynchronizeUSDXMintingReward(t *testing.T) {
suite.Run(t, new(SynchronizeUSDXMintingRewardTests))
}
func (suite *SynchronizeUSDXMintingRewardTests) TestRewardUnchangedWhenGlobalIndexesUnchanged() {
unchangingRewardIndexes := nonEmptyRewardIndexes
collateralType := extractFirstCollateralType(unchangingRewardIndexes)
claim := types.USDXMintingClaim{
BaseClaim: types.BaseClaim{
Owner: arbitraryAddress(),
Reward: c(types.USDXMintingRewardDenom, 0),
},
RewardIndexes: unchangingRewardIndexes,
}
suite.storeClaim(claim)
suite.storeGlobalUSDXIndexes(unchangingRewardIndexes)
cdp := NewCDPBuilder(claim.Owner, collateralType).WithSourceShares(1e12).Build()
suite.keeper.SynchronizeUSDXMintingReward(suite.ctx, cdp)
syncedClaim, _ := suite.keeper.GetUSDXMintingClaim(suite.ctx, claim.Owner)
suite.Equal(claim.Reward, syncedClaim.Reward)
}
func (suite *SynchronizeUSDXMintingRewardTests) TestRewardIsIncrementedWhenGlobalIndexIncreased() {
collateralType := "bnb-a"
claim := types.USDXMintingClaim{
BaseClaim: types.BaseClaim{
Owner: arbitraryAddress(),
Reward: c(types.USDXMintingRewardDenom, 0),
},
RewardIndexes: types.RewardIndexes{
{
CollateralType: collateralType,
RewardFactor: d("0.1"),
},
},
}
suite.storeClaim(claim)
globalIndexes := types.RewardIndexes{
{
CollateralType: collateralType,
RewardFactor: d("0.2"),
},
}
suite.storeGlobalUSDXIndexes(globalIndexes)
cdp := NewCDPBuilder(claim.Owner, collateralType).WithSourceShares(1e12).Build()
suite.keeper.SynchronizeUSDXMintingReward(suite.ctx, cdp)
syncedClaim, _ := suite.keeper.GetUSDXMintingClaim(suite.ctx, claim.Owner)
// reward is ( new index - old index ) * cdp.TotalPrincipal
suite.Equal(c(types.USDXMintingRewardDenom, 1e11), syncedClaim.Reward)
}
func (suite *SynchronizeUSDXMintingRewardTests) TestClaimIndexIsUpdatedWhenGlobalIndexIncreased() {
claimsRewardIndexes := nonEmptyRewardIndexes
collateralType := extractFirstCollateralType(claimsRewardIndexes)
claim := types.USDXMintingClaim{
BaseClaim: types.BaseClaim{
Owner: arbitraryAddress(),
Reward: c(types.USDXMintingRewardDenom, 0),
},
RewardIndexes: claimsRewardIndexes,
}
suite.storeClaim(claim)
globalIndexes := increaseRewardFactors(claimsRewardIndexes)
suite.storeGlobalUSDXIndexes(globalIndexes)
cdp := NewCDPBuilder(claim.Owner, collateralType).Build()
suite.keeper.SynchronizeUSDXMintingReward(suite.ctx, cdp)
syncedClaim, _ := suite.keeper.GetUSDXMintingClaim(suite.ctx, claim.Owner)
// Only the claim's index for `collateralType` should have been changed
i, _ := globalIndexes.Get(collateralType)
expectedIndexes := claimsRewardIndexes.With(collateralType, i)
suite.Equal(expectedIndexes, syncedClaim.RewardIndexes)
}
func (suite *SynchronizeUSDXMintingRewardTests) TestClaimIndexIsUpdatedWhenNewRewardAddedAndClaimAlreadyExists() {
claimsRewardIndexes := types.RewardIndexes{
{
CollateralType: "bnb-a",
RewardFactor: d("0.1"),
},
{
CollateralType: "busd-b",
RewardFactor: d("0.4"),
},
}
newRewardIndex := types.NewRewardIndex("xrp-a", d("0.0001"))
claim := types.USDXMintingClaim{
BaseClaim: types.BaseClaim{
Owner: arbitraryAddress(),
Reward: c(types.USDXMintingRewardDenom, 0),
},
RewardIndexes: claimsRewardIndexes,
}
suite.storeClaim(claim)
globalIndexes := increaseRewardFactors(claimsRewardIndexes)
globalIndexes = append(globalIndexes, newRewardIndex)
suite.storeGlobalUSDXIndexes(globalIndexes)
cdp := NewCDPBuilder(claim.Owner, newRewardIndex.CollateralType).Build()
suite.keeper.SynchronizeUSDXMintingReward(suite.ctx, cdp)
syncedClaim, _ := suite.keeper.GetUSDXMintingClaim(suite.ctx, claim.Owner)
// Only the claim's index for `collateralType` should have been changed
expectedIndexes := claimsRewardIndexes.With(newRewardIndex.CollateralType, newRewardIndex.RewardFactor)
suite.Equal(expectedIndexes, syncedClaim.RewardIndexes)
}
func (suite *SynchronizeUSDXMintingRewardTests) TestClaimIsUnchangedWhenGlobalFactorMissing() {
claimsRewardIndexes := nonEmptyRewardIndexes
claim := types.USDXMintingClaim{
BaseClaim: types.BaseClaim{
Owner: arbitraryAddress(),
Reward: c(types.USDXMintingRewardDenom, 0),
},
RewardIndexes: claimsRewardIndexes,
}
suite.storeClaim(claim)
// don't store any reward indexes
// create a cdp with collateral type that doesn't exist in the claim's indexes, and does not have a corresponding global factor
cdp := NewCDPBuilder(claim.Owner, "unrewardedcollateral").WithSourceShares(1e12).Build()
suite.keeper.SynchronizeUSDXMintingReward(suite.ctx, cdp)
syncedClaim, _ := suite.keeper.GetUSDXMintingClaim(suite.ctx, claim.Owner)
suite.Equal(claim.RewardIndexes, syncedClaim.RewardIndexes)
suite.Equal(claim.Reward, syncedClaim.Reward)
}
// CDPBuilder is a tool for creating a CDP in tests.
// The builder inherits from cdp.CDP, so fields can be accessed directly if a helper method doesn't exist.
type CDPBuilder struct {
cdptypes.CDP
}
// NewCDPBuilder creates a CdpBuilder containing a CDP with owner and collateral type set.
func NewCDPBuilder(owner sdk.AccAddress, collateralType string) CDPBuilder {
return CDPBuilder{
CDP: cdptypes.CDP{
Owner: owner,
Type: collateralType,
// The zero value of Principal and AccumulatedFees (type sdk.Coin) is invalid as the denom is ""
// Set them to the default denom, but with 0 amount.
Principal: c(cdptypes.DefaultStableDenom, 0),
AccumulatedFees: c(cdptypes.DefaultStableDenom, 0),
// zero value of sdk.Dec causes nil pointer panics
InterestFactor: sdk.OneDec(),
},
}
}
// Build assembles and returns the final deposit.
func (builder CDPBuilder) Build() cdptypes.CDP { return builder.CDP }
// WithSourceShares adds a principal amount and interest factor such that the source shares for this CDP is equal to specified.
// With a factor of 1, the total principal is the source shares. This picks an arbitrary factor to ensure factors are accounted for in production code.
func (builder CDPBuilder) WithSourceShares(shares int64) CDPBuilder {
if !builder.GetTotalPrincipal().Amount.Equal(sdk.ZeroInt()) {
panic("setting source shares on cdp with existing principal or fees not implemented")
}
if !(builder.InterestFactor.IsNil() || builder.InterestFactor.Equal(sdk.OneDec())) {
panic("setting source shares on cdp with existing interest factor not implemented")
}
// pick arbitrary interest factor
factor := sdk.NewInt(2)
// Calculate deposit amount that would equal the requested source shares given the above factor.
principal := sdk.NewInt(shares).Mul(factor)
builder.Principal = sdk.NewCoin(cdptypes.DefaultStableDenom, principal)
builder.InterestFactor = sdk.NewDecFromInt(factor)
return builder
}
func (builder CDPBuilder) WithPrincipal(principal sdk.Int) CDPBuilder {
builder.Principal = sdk.NewCoin(cdptypes.DefaultStableDenom, principal)
return builder
}
var nonEmptyRewardIndexes = types.RewardIndexes{
{
CollateralType: "bnb-a",
RewardFactor: d("0.1"),
},
{
CollateralType: "busd-b",
RewardFactor: d("0.4"),
},
}
func extractFirstCollateralType(indexes types.RewardIndexes) string {
if len(indexes) == 0 {
panic("cannot extract a collateral type from 0 length RewardIndexes")
}
return indexes[0].CollateralType
}