0g-chain/x/liquid/keeper/staking_test.go
Denali Marsh ceaed3f0e1
liquid staking (#1273)
* proto types

* proto generated types

* liquidstaking top level files: module, genesis

* liquidstaking types

* liquidstaking keeper

* liquidstaking client/cli

* add liquidstaking to app, simapp

* implement mint derivative

* set up liquidstaking keeper test suite

* test mint derivative

* rename module to liquid

* rename proto types, app.go to liquid

* use sdk.Coin instead of shares

* mint liquid tokens to delegator

* burn derivative tokens to receive delegation

* use conversion method instead of type cast

* simplify delegation transfer logic

* broaden delegation transfer tests

* simplify transfer delegation method
This removes a source of rounding errors

* move derivative denom to keeper config

* check for invalid coins in msg validation

* block 0share transfers to avoid handling edge case

* refactor MintDerivative to test calculations

* simplify burn method so shares and tokens equal

* convert TransferShares back to old design
this makes handling vesting tokens easier

* fix missed merge conflict

* remove deprecated constants

* tidy up msg.go

* add msg tests

* remove unused store key

* fix msg event sender

* remove unused params

* tidy up documentation and errors

* remove unused mocks

* remove unused keepers from AppModule

* tidy up msg return values
keeper return values to be used in router msgs

* reinstate unintentionally removed interface check

* catch invalid input for MnitDerivative
clear up test TODOs

* clear up InitGenesis TODO

* Update x/liquid/client/cli/tx.go

Co-authored-by: Derrick Lee <derrick@dlee.dev>

* Update x/liquid/client/cli/tx.go

Co-authored-by: Derrick Lee <derrick@dlee.dev>

* show error logs in devnet

* unblock mod account so it can receive dist rewards

* catch zero amout msgs early

* minor cli fixes

Co-authored-by: rhuairahrighairigh <ruaridh.odonnell@gmail.com>
Co-authored-by: Ruaridh <rhuairahrighairidh@users.noreply.github.com>
Co-authored-by: Derrick Lee <derrick@dlee.dev>
2022-09-15 23:00:32 +01:00

379 lines
14 KiB
Go

package keeper_test
import (
"github.com/cosmos/cosmos-sdk/crypto/keys/ed25519"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
"github.com/cosmos/cosmos-sdk/x/staking"
stakingkeeper "github.com/cosmos/cosmos-sdk/x/staking/keeper"
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
"github.com/kava-labs/kava/app"
"github.com/kava-labs/kava/x/liquid/types"
)
var (
// d is an alias for sdk.MustNewDecFromStr
d = sdk.MustNewDecFromStr
// i is an alias for sdk.NewInt
i = sdk.NewInt
// c is an alias for sdk.NewInt64Coin
c = sdk.NewInt64Coin
)
func (suite *KeeperTestSuite) TestTransferDelegation_ValidatorStates() {
_, addrs := app.GeneratePrivKeyAddressPairs(3)
valAccAddr, fromDelegator, toDelegator := addrs[0], addrs[1], addrs[2]
valAddr := sdk.ValAddress(valAccAddr)
initialBalance := i(1e9)
notBondedModAddr := authtypes.NewModuleAddress(stakingtypes.NotBondedPoolName)
bondedModAddr := authtypes.NewModuleAddress(stakingtypes.BondedPoolName)
testCases := []struct {
name string
createValidator func() (delegatorShares sdk.Dec, err error)
}{
{
name: "bonded validator",
createValidator: func() (sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, initialBalance)
delegatorShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
// Run end blocker to update validator state to bonded.
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
return delegatorShares, nil
},
},
{
name: "unbonded validator",
createValidator: func() (sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, initialBalance)
delegatorShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
// Don't run end blocker, new validators are by default unbonded.
return delegatorShares, nil
},
},
{
name: "ubonding (jailed) validator",
createValidator: func() (sdk.Dec, error) {
val := suite.CreateNewUnbondedValidator(valAddr, initialBalance)
delegatorShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
// Run end blocker to update validator state to bonded.
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
// Jail and run end blocker to transition validator to unbonding.
consAddr, err := val.GetConsAddr()
if err != nil {
return sdk.Dec{}, err
}
suite.StakingKeeper.Jail(suite.Ctx, consAddr)
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
return delegatorShares, nil
},
},
}
for _, tc := range testCases {
suite.Run(tc.name, func() {
suite.SetupTest()
suite.CreateAccountWithAddress(valAccAddr, suite.NewBondCoins(i(1e9)))
suite.CreateAccountWithAddress(fromDelegator, suite.NewBondCoins(i(1e9)))
fromDelegationShares, err := tc.createValidator()
suite.Require().NoError(err)
validator, found := suite.StakingKeeper.GetValidator(suite.Ctx, valAddr)
suite.Require().True(found)
notBondedBalance := suite.BankKeeper.GetAllBalances(suite.Ctx, notBondedModAddr)
bondedBalance := suite.BankKeeper.GetAllBalances(suite.Ctx, bondedModAddr)
shares := d("1000")
_, err = suite.Keeper.TransferDelegation(suite.Ctx, valAddr, fromDelegator, toDelegator, shares)
suite.Require().NoError(err)
// Transferring a delegation should move shares, and leave the validator and pool balances the same.
suite.DelegationSharesEqual(valAddr, fromDelegator, fromDelegationShares.Sub(shares))
suite.DelegationSharesEqual(valAddr, toDelegator, shares) // also creates new delegation
validatorAfter, found := suite.StakingKeeper.GetValidator(suite.Ctx, valAddr)
suite.Require().True(found)
suite.Equal(validator.GetTokens(), validatorAfter.GetTokens())
suite.Equal(validator.GetDelegatorShares(), validatorAfter.GetDelegatorShares())
suite.Equal(validator.GetStatus(), validatorAfter.GetStatus())
suite.AccountBalanceEqual(notBondedModAddr, notBondedBalance)
suite.AccountBalanceEqual(bondedModAddr, bondedBalance)
})
}
}
func (suite *KeeperTestSuite) TestTransferDelegation_Shares() {
_, addrs := app.GeneratePrivKeyAddressPairs(5)
valAccAddr, fromDelegator, toDelegator := addrs[0], addrs[1], addrs[2]
valAddr := sdk.ValAddress(valAccAddr)
initialBalance := i(1e12)
testCases := []struct {
name string
createDelegations func() (fromDelegatorShares, toDelegatorShares sdk.Dec, err error)
shares sdk.Dec
expectReceived sdk.Dec
expectedErr error
}{
{
name: "negative shares cannot be transferred",
createDelegations: func() (sdk.Dec, sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
fromDelegationShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
// Run end blocker to update validator state to bonded.
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
return fromDelegationShares, sdk.ZeroDec(), nil
},
shares: d("-1.0"),
expectedErr: types.ErrUntransferableShares,
},
{
name: "nil shares cannot be transferred",
createDelegations: func() (sdk.Dec, sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
fromDelegationShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
return fromDelegationShares, sdk.ZeroDec(), nil
},
shares: sdk.Dec{},
expectedErr: types.ErrUntransferableShares,
},
{
name: "0 shares cannot be transferred",
createDelegations: func() (sdk.Dec, sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
fromDelegationShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
toDelegationShares := suite.CreateDelegation(valAddr, toDelegator, i(2e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
return fromDelegationShares, toDelegationShares, nil
},
shares: sdk.ZeroDec(),
expectedErr: types.ErrUntransferableShares,
},
{
name: "all shares can be transferred",
createDelegations: func() (sdk.Dec, sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
fromDelegationShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
toDelegationShares := suite.CreateDelegation(valAddr, toDelegator, i(2e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
return fromDelegationShares, toDelegationShares, nil
},
shares: d("1000000000.0"),
expectReceived: d("1000000000.0"),
},
{
name: "excess shares cannot be transferred",
createDelegations: func() (sdk.Dec, sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
fromDelegationShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
return fromDelegationShares, sdk.ZeroDec(), nil
},
shares: d("1000000000.000000000000000001"),
expectedErr: stakingtypes.ErrNotEnoughDelegationShares,
},
{
name: "shares can be transferred to a non existent delegation",
createDelegations: func() (sdk.Dec, sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
fromDelegationShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
return fromDelegationShares, sdk.ZeroDec(), nil
},
shares: d("500000000.0"),
expectReceived: d("500000000.0"),
},
{
name: "shares cannot be transferred from a non existent delegation",
createDelegations: func() (sdk.Dec, sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
return sdk.ZeroDec(), sdk.ZeroDec(), nil
},
shares: d("500000000.0"),
expectedErr: types.ErrNoDelegatorForAddress,
},
{
name: "slashed validator shares can be transferred",
createDelegations: func() (sdk.Dec, sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
fromDelegationShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
suite.SlashValidator(valAddr, d("0.05"))
return fromDelegationShares, sdk.ZeroDec(), nil
},
shares: d("500000000.0"),
expectReceived: d("500000000.0"),
},
{
name: "zero shares received when transfer < 1 token",
createDelegations: func() (sdk.Dec, sdk.Dec, error) {
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
fromDelegationShares := suite.CreateDelegation(valAddr, fromDelegator, i(1e9))
toDelegationShares := suite.CreateDelegation(valAddr, toDelegator, i(1e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
// make 1 share worth more than 1 token
suite.SlashValidator(valAddr, d("0.05"))
return fromDelegationShares, toDelegationShares, nil
},
shares: d("1.0"), // send 1 share (truncates to zero tokens)
expectReceived: d("0.0"),
},
}
for _, tc := range testCases {
suite.Run(tc.name, func() {
suite.SetupTest()
suite.CreateAccountWithAddress(valAccAddr, suite.NewBondCoins(initialBalance))
suite.CreateAccountWithAddress(fromDelegator, suite.NewBondCoins(initialBalance))
suite.CreateAccountWithAddress(toDelegator, suite.NewBondCoins(initialBalance))
fromDelegationShares, toDelegationShares, err := tc.createDelegations()
suite.Require().NoError(err)
validator, found := suite.StakingKeeper.GetValidator(suite.Ctx, valAddr)
suite.Require().True(found)
_, err = suite.Keeper.TransferDelegation(suite.Ctx, valAddr, fromDelegator, toDelegator, tc.shares)
if tc.expectedErr != nil {
suite.ErrorIs(err, tc.expectedErr)
return
}
suite.NoError(err)
suite.DelegationSharesEqual(valAddr, fromDelegator, fromDelegationShares.Sub(tc.shares))
suite.DelegationSharesEqual(valAddr, toDelegator, toDelegationShares.Add(tc.expectReceived))
validatorAfter, found := suite.StakingKeeper.GetValidator(suite.Ctx, valAddr)
suite.Require().True(found)
// total tokens should not change
suite.Equal(validator.GetTokens(), validatorAfter.GetTokens())
// but total shares can differ
suite.Equal(
validator.GetDelegatorShares().Sub(tc.shares).Add(tc.expectReceived),
validatorAfter.GetDelegatorShares(),
)
})
}
}
func (suite *KeeperTestSuite) TestTransferDelegation_RedelegationsForbidden() {
_, addrs := app.GeneratePrivKeyAddressPairs(4)
val1AccAddr, val2AccAddr, fromDelegator, toDelegator := addrs[0], addrs[1], addrs[2], addrs[3]
val1Addr := sdk.ValAddress(val1AccAddr)
val2Addr := sdk.ValAddress(val2AccAddr)
initialBalance := i(1e12)
suite.CreateAccountWithAddress(val1AccAddr, suite.NewBondCoins(initialBalance))
suite.CreateAccountWithAddress(val2AccAddr, suite.NewBondCoins(initialBalance))
suite.CreateAccountWithAddress(fromDelegator, suite.NewBondCoins(initialBalance))
// create bonded validator 1 with a delegation
suite.CreateNewUnbondedValidator(val1Addr, i(1e9))
fromDelegationShares := suite.CreateDelegation(val1Addr, fromDelegator, i(1e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
// create validator 2 and redelegate to it
suite.CreateNewUnbondedValidator(val2Addr, i(1e9))
suite.CreateRedelegation(fromDelegator, val1Addr, val2Addr, i(1e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
_, err := suite.Keeper.TransferDelegation(suite.Ctx, val2Addr, fromDelegator, toDelegator, fromDelegationShares)
suite.ErrorIs(err, types.ErrRedelegationsNotCompleted)
suite.DelegationSharesEqual(val2Addr, fromDelegator, fromDelegationShares)
suite.DelegationSharesEqual(val2Addr, toDelegator, sdk.ZeroDec())
}
func (suite *KeeperTestSuite) TestTransferDelegation_CompliesWithMinSelfDelegation() {
_, addrs := app.GeneratePrivKeyAddressPairs(4)
valAccAddr, toDelegator := addrs[0], addrs[1]
valAddr := sdk.ValAddress(valAccAddr)
suite.CreateAccountWithAddress(valAccAddr, suite.NewBondCoins(i(1e12)))
// create bonded validator with minimum delegated
minSelfDelegation := i(1e9)
delegation := suite.NewBondCoin(i(1e9))
msg, err := stakingtypes.NewMsgCreateValidator(
valAddr,
ed25519.GenPrivKey().PubKey(),
delegation,
stakingtypes.Description{},
stakingtypes.NewCommissionRates(sdk.ZeroDec(), sdk.ZeroDec(), sdk.ZeroDec()),
minSelfDelegation,
)
suite.Require().NoError(err)
msgServer := stakingkeeper.NewMsgServerImpl(suite.StakingKeeper)
_, err = msgServer.CreateValidator(sdk.WrapSDKContext(suite.Ctx), msg)
suite.Require().NoError(err)
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
_, err = suite.Keeper.TransferDelegation(suite.Ctx, valAddr, valAccAddr, toDelegator, d("0.000000000000000001"))
suite.ErrorIs(err, types.ErrSelfDelegationBelowMinimum)
suite.DelegationSharesEqual(valAddr, valAccAddr, delegation.Amount.ToDec())
}
func (suite *KeeperTestSuite) TestTransferDelegation_CanTransferVested() {
_, addrs := app.GeneratePrivKeyAddressPairs(4)
valAccAddr, fromDelegator, toDelegator := addrs[0], addrs[1], addrs[2]
valAddr := sdk.ValAddress(valAccAddr)
suite.CreateAccountWithAddress(valAccAddr, suite.NewBondCoins(i(1e9)))
suite.CreateVestingAccountWithAddress(fromDelegator, suite.NewBondCoins(i(2e9)), suite.NewBondCoins(i(1e9)))
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
fromDelegationShares := suite.CreateDelegation(valAddr, fromDelegator, i(2e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
shares := d("1000000000.0")
_, err := suite.Keeper.TransferDelegation(suite.Ctx, valAddr, fromDelegator, toDelegator, shares)
suite.NoError(err)
suite.DelegationSharesEqual(valAddr, fromDelegator, fromDelegationShares.Sub(shares))
suite.DelegationSharesEqual(valAddr, toDelegator, shares)
}
func (suite *KeeperTestSuite) TestTransferDelegation_CannotTransferVesting() {
_, addrs := app.GeneratePrivKeyAddressPairs(4)
valAccAddr, fromDelegator, toDelegator := addrs[0], addrs[1], addrs[2]
valAddr := sdk.ValAddress(valAccAddr)
suite.CreateAccountWithAddress(valAccAddr, suite.NewBondCoins(i(1e9)))
suite.CreateVestingAccountWithAddress(fromDelegator, suite.NewBondCoins(i(2e9)), suite.NewBondCoins(i(1e9)))
suite.CreateNewUnbondedValidator(valAddr, i(1e9))
suite.CreateDelegation(valAddr, fromDelegator, i(2e9))
staking.EndBlocker(suite.Ctx, suite.StakingKeeper)
_, err := suite.Keeper.TransferDelegation(suite.Ctx, valAddr, fromDelegator, toDelegator, d("1000000001.0"))
suite.ErrorIs(err, sdkerrors.ErrInsufficientFunds)
}