feat: include a percentage of deposit when submitting a proposal (#7)

* feat: include a percentage of deposit when submitting a proposal

* chore: correctly check protobuf breaking changes

* fix: throw a custom error

* fix: correctly adjust min deposit

Makefile

@@ -10,7 +10,7 @@ BINDIR ?= $(GOPATH)/bin
 BUILDDIR ?= $(CURDIR)/build
 SIMAPP = ./simapp
 MOCKS_DIR = $(CURDIR)/tests/mocks
-HTTPS_GIT := https://github.com/cosmos/cosmos-sdk.git
+HTTPS_GIT := https://github.com/KYVENetwork/cosmos-sdk.git
 DOCKER := $(shell which docker)
 DOCKER_BUF := $(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace bufbuild/buf
 
@@ -396,7 +396,7 @@ proto-lint:
 	@$(DOCKER_BUF) lint --error-format=json
 
 proto-check-breaking:
-	@$(DOCKER_BUF) breaking --against $(HTTPS_GIT)#branch=master
+	@$(DOCKER_BUF) breaking --against $(HTTPS_GIT)#branch=kyve-main
 
 
 TM_URL              = https://raw.githubusercontent.com/tendermint/tendermint/v0.34.0-rc6/proto/tendermint

docs/core/proto-docs.md

@@ -5088,6 +5088,7 @@ DepositParams defines the params for deposits on governance proposals.
 | `min_deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | Minimum deposit for a proposal to enter voting period. |
 | `max_deposit_period` | [google.protobuf.Duration](#google.protobuf.Duration) |  | Maximum period for Atom holders to deposit on a proposal. Initial value: 2 months. |
 | `min_expedited_deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | Minimum expedited deposit for a proposal to enter voting period. |
+| `min_deposit_percentage` | [bytes](#bytes) |  | TODO |
 
 
 

proto/cosmos/gov/v1beta1/gov.proto

@@ -168,6 +168,14 @@ message DepositParams {
     (gogoproto.moretags)     = "yaml:\"min_expedited_deposit\"",
     (gogoproto.jsontag)      = "min_expedited_deposit,omitempty"
   ];
+
+  //  TODO
+  bytes min_deposit_percentage = 4 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false,
+    (gogoproto.jsontag)    = "min_deposit_percentage,omitempty",
+    (gogoproto.moretags)   = "yaml:\"min_deposit_percentage\""
+  ];
 }
 
 // VotingParams defines the params for voting on governance proposals.

x/gov/client/testutil/cli_test.go

@@ -21,7 +21,7 @@ func TestIntegrationTestSuite(t *testing.T) {
 	suite.Run(t, NewIntegrationTestSuite(cfg))
 
 	genesisState := types.DefaultGenesisState()
-	genesisState.DepositParams = types.NewDepositParams(sdk.NewCoins(sdk.NewCoin(cfg.BondDenom, types.DefaultMinDepositTokens)), time.Duration(15)*time.Second, sdk.NewCoins(sdk.NewCoin(cfg.BondDenom, types.DefaultMinExpeditedDepositTokens)))
+	genesisState.DepositParams = types.NewDepositParams(sdk.NewCoins(sdk.NewCoin(cfg.BondDenom, types.DefaultMinDepositTokens)), time.Duration(15)*time.Second, sdk.NewCoins(sdk.NewCoin(cfg.BondDenom, types.DefaultMinExpeditedDepositTokens)), types.DefaultMinDepositPercentage)
 	genesisState.VotingParams = types.NewVotingParams(time.Duration(5)*time.Second, time.Duration(2)*time.Second, []types.ProposalVotingPeriod{})
 	bz, err := cfg.Codec.MarshalJSON(genesisState)
 	require.NoError(t, err)

x/gov/client/testutil/suite.go

@@ -88,7 +88,7 @@ func (s *IntegrationTestSuite) TestCmdParams() {
 		{
 			"json output",
 			[]string{fmt.Sprintf("--%s=json", tmcli.OutputFlag)},
-			`{"voting_params":{"voting_period":"172800000000000","proposal_voting_periods":null,"expedited_voting_period":"86400000000000"},"tally_params":{"quorum":"0.334000000000000000","threshold":"0.500000000000000000","veto_threshold":"0.334000000000000000","expedited_threshold":"0.667000000000000000"},"deposit_params":{"min_deposit":[{"denom":"stake","amount":"10000000"}],"max_deposit_period":"172800000000000","min_expedited_deposit":[{"denom":"stake","amount":"50000000"}]}}`,
+			`{"voting_params":{"voting_period":"172800000000000","proposal_voting_periods":null,"expedited_voting_period":"86400000000000"},"tally_params":{"quorum":"0.334000000000000000","threshold":"0.500000000000000000","veto_threshold":"0.334000000000000000","expedited_threshold":"0.667000000000000000"},"deposit_params":{"min_deposit":[{"denom":"stake","amount":"10000000"}],"max_deposit_period":"172800000000000","min_expedited_deposit":[{"denom":"stake","amount":"50000000"}],"min_deposit_percentage":"0.000000000000000000"}}`,
 		},
 		{
 			"text output",
@@ -99,6 +99,7 @@ deposit_params:
   min_deposit:
   - amount: "10000000"
     denom: stake
+  min_deposit_percentage: "0.000000000000000000"
   min_expedited_deposit:
   - amount: "50000000"
     denom: stake
@@ -159,7 +160,7 @@ func (s *IntegrationTestSuite) TestCmdParam() {
 				"deposit",
 				fmt.Sprintf("--%s=json", tmcli.OutputFlag),
 			},
-			`{"min_deposit":[{"denom":"stake","amount":"10000000"}],"max_deposit_period":"172800000000000","min_expedited_deposit":[{"denom":"stake","amount":"50000000"}]}`,
+			`{"min_deposit":[{"denom":"stake","amount":"10000000"}],"max_deposit_period":"172800000000000","min_expedited_deposit":[{"denom":"stake","amount":"50000000"}],"min_deposit_percentage":"0.000000000000000000"}`,
 		},
 	}
 

x/gov/keeper/deposit.go

@@ -117,6 +117,20 @@ func (keeper Keeper) AddDeposit(ctx sdk.Context, proposalID uint64, depositorAdd
 		return false, sdkerrors.Wrapf(types.ErrInactiveProposal, "%d", proposalID)
 	}
 
+	// Check if deposit is enough.
+	depositParams := keeper.GetDepositParams(ctx)
+	minDepositAmount := proposal.GetMinDepositFromParams(depositParams)
+
+	adjustedMinDeposit := sdk.NewCoins()
+	for _, coin := range minDepositAmount {
+		amount := coin.Amount.ToDec().Mul(depositParams.MinDepositPercentage).RoundInt()
+		adjustedMinDeposit = adjustedMinDeposit.Add(sdk.NewCoin(coin.Denom, amount))
+	}
+
+	if !depositAmount.IsAllGTE(adjustedMinDeposit) {
+		return false, sdkerrors.Wrapf(types.ErrInvalidDeposit, "%s", depositAmount.String())
+	}
+
 	// update the governance module's account coins pool
 	err := keeper.bankKeeper.SendCoinsFromAccountToModule(ctx, depositorAddr, types.ModuleName, depositAmount)
 	if err != nil {
@@ -130,7 +144,6 @@ func (keeper Keeper) AddDeposit(ctx sdk.Context, proposalID uint64, depositorAdd
 	// Check if deposit has provided sufficient total funds to transition the proposal into the voting period
 	activatedVotingPeriod := false
 
-	minDepositAmount := proposal.GetMinDepositFromParams(keeper.GetDepositParams(ctx))
 	if proposal.Status == types.StatusDepositPeriod && proposal.TotalDeposit.IsAllGTE(minDepositAmount) {
 		keeper.ActivateVotingPeriod(ctx, proposal)
 

x/gov/keeper/grpc_query_test.go

@@ -4,6 +4,7 @@ import (
 	gocontext "context"
 	"fmt"
 	"strconv"
+	"time"
 
 	"github.com/cosmos/cosmos-sdk/simapp"
 	sdk "github.com/cosmos/cosmos-sdk/types"
@@ -483,8 +484,9 @@ func (suite *KeeperTestSuite) TestGRPCQueryParams() {
 			func() {
 				req = &types.QueryParamsRequest{ParamsType: types.ParamVoting}
 				expRes = &types.QueryParamsResponse{
-					VotingParams: types.DefaultVotingParams(),
-					TallyParams:  types.NewTallyParams(sdk.NewDec(0), sdk.NewDec(0), sdk.NewDec(0), sdk.NewDec(0)),
+					VotingParams:  types.DefaultVotingParams(),
+					DepositParams: types.NewDepositParams(sdk.NewCoins(), time.Second*0, sdk.NewCoins(), sdk.ZeroDec()),
+					TallyParams:   types.NewTallyParams(sdk.NewDec(0), sdk.NewDec(0), sdk.NewDec(0), sdk.NewDec(0)),
 				}
 			},
 			true,
@@ -494,7 +496,8 @@ func (suite *KeeperTestSuite) TestGRPCQueryParams() {
 			func() {
 				req = &types.QueryParamsRequest{ParamsType: types.ParamTallying}
 				expRes = &types.QueryParamsResponse{
-					TallyParams: types.DefaultTallyParams(),
+					DepositParams: types.NewDepositParams(sdk.NewCoins(), time.Second*0, sdk.NewCoins(), sdk.ZeroDec()),
+					TallyParams:   types.DefaultTallyParams(),
 				}
 			},
 			true,
@@ -517,7 +520,7 @@ func (suite *KeeperTestSuite) TestGRPCQueryParams() {
 
 			if testCase.expPass {
 				suite.Require().NoError(err)
-				suite.Require().Equal(expRes.GetDepositParams(), params.GetDepositParams())
+				suite.Require().True(expRes.GetDepositParams().Equal(params.GetDepositParams()))
 				suite.Require().True(expRes.GetVotingParams().Equal(params.GetVotingParams()))
 				suite.Require().Equal(expRes.GetTallyParams(), params.GetTallyParams())
 			} else {

x/gov/legacy/v040/migrate_test.go

@@ -98,6 +98,7 @@ func TestMigrate(t *testing.T) {
 	"deposit_params": {
 		"max_deposit_period": "0s",
 		"min_deposit": [],
+		"min_deposit_percentage": "0",
 		"min_expedited_deposit": []
 	},
 	"deposits": [],

x/gov/legacy/v043/json_test.go

@@ -51,6 +51,7 @@ func TestMigrateJSON(t *testing.T) {
 	"deposit_params": {
 		"max_deposit_period": "0s",
 		"min_deposit": [],
+		"min_deposit_percentage": "0",
 		"min_expedited_deposit": []
 	},
 	"deposits": [],

x/gov/simulation/genesis.go

@@ -155,7 +155,7 @@ func RandomizedGenState(simState *module.SimulationState) {
 
 	govGenesis := types.NewGenesisState(
 		startingProposalID,
-		types.NewDepositParams(minDeposit, depositPeriod, minExpeditedDeposit),
+		types.NewDepositParams(minDeposit, depositPeriod, minExpeditedDeposit, sdk.ZeroDec()),
 		types.NewVotingParams(votingPeriod, expeditedVotingPeriod, proposalVotingPeriods),
 		types.NewTallyParams(quorum, threshold, expeditedThreshold, veto),
 	)

x/gov/types/errors.go

@@ -14,4 +14,5 @@ var (
 	ErrInvalidVote             = sdkerrors.Register(ModuleName, 7, "invalid vote option")
 	ErrInvalidGenesis          = sdkerrors.Register(ModuleName, 8, "invalid genesis state")
 	ErrNoProposalHandlerExists = sdkerrors.Register(ModuleName, 9, "no handler exists for proposal type")
+	ErrInvalidDeposit          = sdkerrors.Register(ModuleName, 1000, "invalid deposit amount")
 )

x/gov/types/genesis.go

@@ -86,6 +86,12 @@ func ValidateGenesis(data *GenesisState) error {
 			minDeposit.String())
 	}
 
+	minDepositPercentage := data.DepositParams.MinDepositPercentage
+	if minDepositPercentage.IsNegative() || minDepositPercentage.GT(sdk.OneDec()) {
+		return fmt.Errorf("governance min deposit percentage should be positive and less or equal to one, is %s",
+			minDepositPercentage.String())
+	}
+
 	return nil
 }