cosmos-sdk/x/gov/keeper/deposit_test.go

481 lines
20 KiB
Go

package keeper_test
import (
"fmt"
"testing"
"github.com/stretchr/testify/require"
"cosmossdk.io/collections"
sdkmath "cosmossdk.io/math"
v1 "cosmossdk.io/x/gov/types/v1"
"github.com/cosmos/cosmos-sdk/codec/address"
simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
sdk "github.com/cosmos/cosmos-sdk/types"
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
)
const (
baseDepositTestAmount = 100
baseDepositTestPercent = 25
)
func TestDeposits(t *testing.T) {
testcases := []struct {
name string
proposalType v1.ProposalType
}{
{
name: "regular",
proposalType: v1.ProposalType_PROPOSAL_TYPE_STANDARD,
},
{
name: "expedited",
proposalType: v1.ProposalType_PROPOSAL_TYPE_EXPEDITED,
},
}
for _, tc := range testcases {
t.Run(tc.name, func(t *testing.T) {
govKeeper, mocks, _, ctx := setupGovKeeper(t)
authKeeper, bankKeeper, stakingKeeper := mocks.acctKeeper, mocks.bankKeeper, mocks.stakingKeeper
err := trackMockBalances(bankKeeper)
require.NoError(t, err)
// With expedited proposals the minimum deposit is higher, so we must
// initialize and deposit an amount depositMultiplier times larger
// than the regular min deposit amount.
depositMultiplier := int64(1)
if tc.proposalType == v1.ProposalType_PROPOSAL_TYPE_EXPEDITED {
depositMultiplier = v1.DefaultMinExpeditedDepositTokensRatio
}
TestAddrs := simtestutil.AddTestAddrsIncremental(bankKeeper, stakingKeeper, ctx, 2, sdkmath.NewInt(10000000*depositMultiplier))
authKeeper.EXPECT().AddressCodec().Return(address.NewBech32Codec("cosmos")).AnyTimes()
addr0Str, err := authKeeper.AddressCodec().BytesToString(TestAddrs[0])
require.NoError(t, err)
addr1Str, err := authKeeper.AddressCodec().BytesToString(TestAddrs[1])
require.NoError(t, err)
tp := TestProposal
proposal, err := govKeeper.SubmitProposal(ctx, tp, "", "title", "summary", TestAddrs[0], tc.proposalType)
require.NoError(t, err)
proposalID := proposal.Id
fourStake := sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, stakingKeeper.TokensFromConsensusPower(ctx, 4*depositMultiplier)))
fiveStake := sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, stakingKeeper.TokensFromConsensusPower(ctx, 5*depositMultiplier)))
addr0Initial := bankKeeper.GetAllBalances(ctx, TestAddrs[0])
addr1Initial := bankKeeper.GetAllBalances(ctx, TestAddrs[1])
require.True(t, sdk.NewCoins(proposal.TotalDeposit...).Equal(sdk.NewCoins()))
// Check no deposits at beginning
_, err = govKeeper.Deposits.Get(ctx, collections.Join(proposalID, TestAddrs[1]))
require.ErrorIs(t, err, collections.ErrNotFound)
proposal, err = govKeeper.Proposals.Get(ctx, proposalID)
require.Nil(t, err)
require.Nil(t, proposal.VotingStartTime)
// Check first deposit
votingStarted, err := govKeeper.AddDeposit(ctx, proposalID, TestAddrs[0], fourStake)
require.NoError(t, err)
require.False(t, votingStarted)
deposit, err := govKeeper.Deposits.Get(ctx, collections.Join(proposalID, TestAddrs[0]))
require.Nil(t, err)
require.Equal(t, fourStake, sdk.NewCoins(deposit.Amount...))
require.Equal(t, addr0Str, deposit.Depositor)
proposal, err = govKeeper.Proposals.Get(ctx, proposalID)
require.Nil(t, err)
require.Equal(t, fourStake, sdk.NewCoins(proposal.TotalDeposit...))
require.Equal(t, addr0Initial.Sub(fourStake...), bankKeeper.GetAllBalances(ctx, TestAddrs[0]))
// Check a second deposit from same address
votingStarted, err = govKeeper.AddDeposit(ctx, proposalID, TestAddrs[0], fiveStake)
require.NoError(t, err)
require.False(t, votingStarted)
deposit, err = govKeeper.Deposits.Get(ctx, collections.Join(proposalID, TestAddrs[0]))
require.Nil(t, err)
require.Equal(t, fourStake.Add(fiveStake...), sdk.NewCoins(deposit.Amount...))
require.Equal(t, addr0Str, deposit.Depositor)
proposal, err = govKeeper.Proposals.Get(ctx, proposalID)
require.Nil(t, err)
require.Equal(t, fourStake.Add(fiveStake...), sdk.NewCoins(proposal.TotalDeposit...))
require.Equal(t, addr0Initial.Sub(fourStake...).Sub(fiveStake...), bankKeeper.GetAllBalances(ctx, TestAddrs[0]))
// Check third deposit from a new address
votingStarted, err = govKeeper.AddDeposit(ctx, proposalID, TestAddrs[1], fourStake)
require.NoError(t, err)
require.True(t, votingStarted)
deposit, err = govKeeper.Deposits.Get(ctx, collections.Join(proposalID, TestAddrs[1]))
require.Nil(t, err)
require.Equal(t, addr1Str, deposit.Depositor)
require.Equal(t, fourStake, sdk.NewCoins(deposit.Amount...))
proposal, err = govKeeper.Proposals.Get(ctx, proposalID)
require.Nil(t, err)
require.Equal(t, fourStake.Add(fiveStake...).Add(fourStake...), sdk.NewCoins(proposal.TotalDeposit...))
require.Equal(t, addr1Initial.Sub(fourStake...), bankKeeper.GetAllBalances(ctx, TestAddrs[1]))
// Check that proposal moved to voting period
proposal, err = govKeeper.Proposals.Get(ctx, proposalID)
require.Nil(t, err)
require.True(t, proposal.VotingStartTime.Equal(ctx.HeaderInfo().Time))
// Test deposit iterator
// NOTE order of deposits is determined by the addresses
var deposits v1.Deposits
err = govKeeper.Deposits.Walk(ctx, nil, func(_ collections.Pair[uint64, sdk.AccAddress], deposit v1.Deposit) (bool, error) {
deposits = append(deposits, &deposit)
return false, nil
})
require.NoError(t, err)
require.Len(t, deposits, 2)
propDeposits, _ := govKeeper.GetDeposits(ctx, proposalID)
require.Equal(t, deposits, propDeposits)
require.Equal(t, addr0Str, deposits[0].Depositor)
require.Equal(t, fourStake.Add(fiveStake...), sdk.NewCoins(deposits[0].Amount...))
require.Equal(t, addr1Str, deposits[1].Depositor)
require.Equal(t, fourStake, sdk.NewCoins(deposits[1].Amount...))
// Test Refund Deposits
deposit, err = govKeeper.Deposits.Get(ctx, collections.Join(proposalID, TestAddrs[1]))
require.Nil(t, err)
require.Equal(t, fourStake, sdk.NewCoins(deposit.Amount...))
err = govKeeper.RefundAndDeleteDeposits(ctx, proposalID)
require.NoError(t, err)
deposit, err = govKeeper.Deposits.Get(ctx, collections.Join(proposalID, TestAddrs[1]))
require.ErrorIs(t, err, collections.ErrNotFound)
require.Equal(t, addr0Initial, bankKeeper.GetAllBalances(ctx, TestAddrs[0]))
require.Equal(t, addr1Initial, bankKeeper.GetAllBalances(ctx, TestAddrs[1]))
// Test delete and burn deposits
proposal, err = govKeeper.SubmitProposal(ctx, tp, "", "title", "summary", TestAddrs[0], v1.ProposalType_PROPOSAL_TYPE_EXPEDITED)
require.NoError(t, err)
proposalID = proposal.Id
_, err = govKeeper.AddDeposit(ctx, proposalID, TestAddrs[0], fourStake)
require.NoError(t, err)
err = govKeeper.DeleteAndBurnDeposits(ctx, proposalID)
require.NoError(t, err)
deposits, _ = govKeeper.GetDeposits(ctx, proposalID)
require.Len(t, deposits, 0)
require.Equal(t, addr0Initial.Sub(fourStake...), bankKeeper.GetAllBalances(ctx, TestAddrs[0]))
})
}
}
func TestDepositAmount(t *testing.T) {
testcases := []struct {
name string
deposit sdk.Coins
minDepositRatio string
err string
}{
{
name: "good amount and denoms",
deposit: sdk.NewCoins(sdk.NewInt64Coin("stake", 10000)),
minDepositRatio: "0.001",
},
{
name: "good amount and denoms but not enough balance for zcoin",
deposit: sdk.NewCoins(sdk.NewInt64Coin("stake", 10000), sdk.NewInt64Coin("zcoin", 1)),
minDepositRatio: "0.001",
err: "not enough balance",
},
{
name: "too small amount",
deposit: sdk.NewCoins(sdk.NewInt64Coin("stake", 10)),
minDepositRatio: "0.001",
err: "received 10stake but need at least one of the following: 10000stake,10zcoin: minimum deposit is too small",
},
{
name: "too small amount with another coin",
deposit: sdk.NewCoins(sdk.NewInt64Coin("zcoin", 1)),
minDepositRatio: "0.001",
err: "received 1zcoin but need at least one of the following: 10000stake,10zcoin: minimum deposit is too small",
},
{
name: "bad denom",
deposit: sdk.NewCoins(sdk.NewInt64Coin("euro", 10000)),
minDepositRatio: "0.001",
err: "deposited 10000euro, but gov accepts only the following denom(s): [stake zcoin]: invalid deposit denom",
},
{
name: "mix containing bad and good denom",
deposit: sdk.NewCoins(sdk.NewInt64Coin("stake", 10000), sdk.NewInt64Coin("euro", 10000)),
minDepositRatio: "0.001",
err: "deposited 10000euro,10000stake, but gov accepts only the following denom(s): [stake zcoin]: invalid deposit denom",
},
{
name: "minDepositRatio is zero",
deposit: sdk.NewCoins(sdk.NewInt64Coin("stake", 10)),
minDepositRatio: "0.0",
},
}
for _, tc := range testcases {
t.Run(tc.name, func(t *testing.T) {
govKeeper, mocks, _, ctx := setupGovKeeper(t)
authKeeper, bankKeeper, stakingKeeper := mocks.acctKeeper, mocks.bankKeeper, mocks.stakingKeeper
err := trackMockBalances(bankKeeper)
require.NoError(t, err)
testAddrs := simtestutil.AddTestAddrsIncremental(bankKeeper, stakingKeeper, ctx, 2, sdkmath.NewInt(1000000000000000))
authKeeper.EXPECT().AddressCodec().Return(address.NewBech32Codec("cosmos")).AnyTimes()
params, _ := govKeeper.Params.Get(ctx)
params.MinDepositRatio = tc.minDepositRatio
params.MinDeposit = sdk.NewCoins(params.MinDeposit...).Add(sdk.NewCoin("zcoin", sdkmath.NewInt(10000))) // coins must be sorted by denom
err = govKeeper.Params.Set(ctx, params)
require.NoError(t, err)
tp := TestProposal
proposal, err := govKeeper.SubmitProposal(ctx, tp, "", "title", "summary", testAddrs[0], v1.ProposalType_PROPOSAL_TYPE_STANDARD)
require.NoError(t, err)
proposalID := proposal.Id
_, err = govKeeper.AddDeposit(ctx, proposalID, testAddrs[0], tc.deposit)
if tc.err != "" {
require.Error(t, err)
require.Equal(t, tc.err, err.Error())
} else {
require.NoError(t, err)
}
})
}
}
func TestValidateInitialDeposit(t *testing.T) {
testcases := map[string]struct {
minDeposit sdk.Coins
minInitialDepositPercent int64
initialDeposit sdk.Coins
expedited bool
expectError bool
}{
"min deposit * initial percent == initial deposit: success": {
minDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount))),
minInitialDepositPercent: baseDepositTestPercent,
initialDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100))),
},
"min deposit * initial percent < initial deposit: success": {
minDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount))),
minInitialDepositPercent: baseDepositTestPercent,
initialDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100+1))),
},
"min deposit * initial percent > initial deposit: error": {
minDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount))),
minInitialDepositPercent: baseDepositTestPercent,
initialDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100-1))),
expectError: true,
},
"min deposit * initial percent == initial deposit (non-base values and denom): success": {
minDeposit: sdk.NewCoins(sdk.NewCoin("uosmo", sdkmath.NewInt(56912))),
minInitialDepositPercent: 50,
initialDeposit: sdk.NewCoins(sdk.NewCoin("uosmo", sdkmath.NewInt(56912/2+10))),
},
"min deposit * initial percent == initial deposit but different denoms: error": {
minDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount))),
minInitialDepositPercent: baseDepositTestPercent,
initialDeposit: sdk.NewCoins(sdk.NewCoin("uosmo", sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100))),
expectError: true,
},
"min deposit * initial percent == initial deposit (multiple coins): success": {
minDeposit: sdk.NewCoins(
sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount)),
sdk.NewCoin("uosmo", sdkmath.NewInt(baseDepositTestAmount*2))),
minInitialDepositPercent: baseDepositTestPercent,
initialDeposit: sdk.NewCoins(
sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100)),
sdk.NewCoin("uosmo", sdkmath.NewInt(baseDepositTestAmount*2*baseDepositTestPercent/100)),
),
},
"min deposit * initial percent > initial deposit (multiple coins): error": {
minDeposit: sdk.NewCoins(
sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount)),
sdk.NewCoin("uosmo", sdkmath.NewInt(baseDepositTestAmount*2))),
minInitialDepositPercent: baseDepositTestPercent,
initialDeposit: sdk.NewCoins(
sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100)),
sdk.NewCoin("uosmo", sdkmath.NewInt(baseDepositTestAmount*2*baseDepositTestPercent/100-1)),
),
expectError: true,
},
"min deposit * initial percent < initial deposit (multiple coins - coin not required by min deposit): success": {
minDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount))),
minInitialDepositPercent: baseDepositTestPercent,
initialDeposit: sdk.NewCoins(
sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100)),
sdk.NewCoin("uosmo", sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100-1)),
),
},
"0 initial percent: success": {
minDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount))),
minInitialDepositPercent: 0,
initialDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100))),
},
"expedited min deposit * initial percent == initial deposit: success": {
minDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount))),
minInitialDepositPercent: baseDepositTestPercent,
initialDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100))),
expedited: true,
},
"expedited - 0 initial percent: success": {
minDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount))),
minInitialDepositPercent: 0,
initialDeposit: sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdkmath.NewInt(baseDepositTestAmount*baseDepositTestPercent/100))),
expedited: true,
},
}
for name, tc := range testcases {
t.Run(name, func(t *testing.T) {
govKeeper, _, _, ctx := setupGovKeeper(t)
params := v1.DefaultParams()
if tc.expedited {
params.ExpeditedMinDeposit = tc.minDeposit
} else {
params.MinDeposit = tc.minDeposit
}
params.MinInitialDepositRatio = sdkmath.LegacyNewDec(tc.minInitialDepositPercent).Quo(sdkmath.LegacyNewDec(100)).String()
err := govKeeper.Params.Set(ctx, params)
require.NoError(t, err)
if tc.expedited {
err = govKeeper.ValidateInitialDeposit(ctx, tc.initialDeposit, v1.ProposalType_PROPOSAL_TYPE_EXPEDITED)
} else {
err = govKeeper.ValidateInitialDeposit(ctx, tc.initialDeposit, v1.ProposalType_PROPOSAL_TYPE_STANDARD)
}
if tc.expectError {
require.Error(t, err)
return
}
require.NoError(t, err)
})
}
}
func TestChargeDeposit(t *testing.T) {
testCases := []struct {
name string
proposalCancelRatio string
proposalCancelDestAddress string
expectError bool
}{
{
name: "Success: CancelRatio=0",
proposalCancelRatio: "0",
proposalCancelDestAddress: "",
expectError: false,
},
{
name: "Success: CancelRatio=0.5",
proposalCancelRatio: "0.5",
proposalCancelDestAddress: "",
expectError: false,
},
{
name: "Success: CancelRatio=1",
proposalCancelRatio: "1",
proposalCancelDestAddress: "",
expectError: false,
},
}
for _, tc := range testCases {
for i := 0; i < 3; i++ {
testName := func(i int) string {
if i == 0 {
return fmt.Sprintf("%s and dest address is %s", tc.name, "nil")
} else if i == 1 {
return fmt.Sprintf("%s and dest address is normal address", tc.name)
}
return fmt.Sprintf("%s and dest address is community address", tc.name)
}
t.Run(testName(i), func(t *testing.T) {
govKeeper, mocks, _, ctx := setupGovKeeper(t)
authKeeper, bankKeeper, stakingKeeper := mocks.acctKeeper, mocks.bankKeeper, mocks.stakingKeeper
params := v1.DefaultParams()
params.ProposalCancelRatio = tc.proposalCancelRatio
TestAddrs := simtestutil.AddTestAddrsIncremental(bankKeeper, stakingKeeper, ctx, 2, sdkmath.NewInt(10000000000))
authKeeper.EXPECT().AddressCodec().Return(address.NewBech32Codec("cosmos")).AnyTimes()
switch i {
case 0:
// no dest address for cancel proposal, total cancellation charges will be burned
params.ProposalCancelDest = ""
case 1:
// normal account address for proposal cancel dest address
addrStr, err := authKeeper.AddressCodec().BytesToString(TestAddrs[1])
require.NoError(t, err)
params.ProposalCancelDest = addrStr
default:
// community address for proposal cancel dest address
addrStr, err := authKeeper.AddressCodec().BytesToString(authtypes.NewModuleAddress(protocolModuleName))
require.NoError(t, err)
params.ProposalCancelDest = addrStr
}
err := govKeeper.Params.Set(ctx, params)
require.NoError(t, err)
tp := TestProposal
proposal, err := govKeeper.SubmitProposal(ctx, tp, "", "title", "summary", TestAddrs[0], v1.ProposalType_PROPOSAL_TYPE_STANDARD)
require.NoError(t, err)
proposalID := proposal.Id
// deposit to proposal
fiveStake := sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, stakingKeeper.TokensFromConsensusPower(ctx, 300)))
_, err = govKeeper.AddDeposit(ctx, proposalID, TestAddrs[0], fiveStake)
require.NoError(t, err)
codec := address.NewBech32Codec("cosmos")
// get balances of dest address
var prevBalance sdk.Coin
if len(params.ProposalCancelDest) != 0 {
accAddr, err := codec.StringToBytes(params.ProposalCancelDest)
require.NoError(t, err)
prevBalance = bankKeeper.GetBalance(ctx, accAddr, sdk.DefaultBondDenom)
}
// get the deposits
allDeposits, _ := govKeeper.GetDeposits(ctx, proposalID)
addr0Str, err := authKeeper.AddressCodec().BytesToString(TestAddrs[0])
require.NoError(t, err)
// charge cancellation charges for cancel proposal
err = govKeeper.ChargeDeposit(ctx, proposalID, addr0Str, params.ProposalCancelRatio)
if tc.expectError {
require.Error(t, err)
return
}
require.NoError(t, err)
if len(params.ProposalCancelDest) != 0 {
accAddr, err := codec.StringToBytes(params.ProposalCancelDest)
require.NoError(t, err)
newBalanceAfterCancelProposal := bankKeeper.GetBalance(ctx, accAddr, sdk.DefaultBondDenom)
cancellationCharges := sdkmath.NewInt(0)
for _, deposits := range allDeposits {
for _, deposit := range deposits.Amount {
burnAmount := sdkmath.LegacyNewDecFromInt(deposit.Amount).Mul(sdkmath.LegacyMustNewDecFromStr(params.MinInitialDepositRatio)).TruncateInt()
cancellationCharges = cancellationCharges.Add(burnAmount)
}
}
require.True(t, newBalanceAfterCancelProposal.Equal(prevBalance.Add(sdk.NewCoin(sdk.DefaultBondDenom, cancellationCharges))))
}
})
}
}
}